django如何自定义manage.py管理命令


Posted in Python onApril 27, 2021

每次在启动Django服务之前,我们都会在终端运行python manage.py xxx的管理命令。其实我们还可以自定义管理命令,这对于执行独立的脚本或任务非常有用,比如清除缓存、导出用户邮件清单或发送邮件等等。

自定义的管理命令不仅可以通过manage.py运行,还可以通过Linux或Celery的crontab服务将其设成定时任务。本文主要讲解如何自定义Django-admin命令,并提供一些演示案例。

自定义Django-admin命令一共分三步:创建文件夹布局、编写命令代码和测试使用。

创建文件夹布局

自定义的Django-admin管理命令本质上是一个python脚本文件,它的存放路径必须遵循一定的规范,一般位于app/management/commands目录。整个文件夹的布局如下所示:

 app01/
    __init__.py
    models.py
    management/
        __init__.py
        commands/
            __init__.py
            _private.py # 以下划线开头文件不能用作管理命令
            my_commands.py # 这个就是自定义的管理命令脚本,文件名即为命令名
    tests.py
    views.py

注意:

  • management和commands每个目录下都必须有个__init__.py空文件,表明这是一个python包。另外以下划线开头的文件名不能用作管理命令脚本。
  • management/commands目录可以位于任何一个app的目录下,Django都能找到它。
  • 一般建议每个python脚本文件对应一条管理命令。

编写命令代码

每一个自定义的管理命令本质是一个Command类, 它继承了Django的Basecommand或其子类, 主要通过重写handle()方法实现自己的业务逻辑代码,而add_arguments()则用于帮助处理命令行的参数,如果运行命令时不需要额外参数,可以不写这个方法。

 from django.core.management.base import BaseCommand
 
 class Command(BaseCommand):
     # 帮助文本, 一般备注命令的用途及如何使用。
     help = 'Some help texts'
 
     # 处理命令行参数,可选
     def add_arguments(self, parser):
        pass
 
     # 核心业务逻辑
     def handle(self, *args, **options):
         pass

我们现在来看一个最简单的例子,希望定义一个名为hello_world的命令。这样当我们运行python manage.py hello_world命令时,控制台会打印出Hello World!字样。在app/management/commands目录下新建hello_world.py, 添加如下代码:

 from django.core.management.base import BaseCommand
 
 class Command(BaseCommand):
    # 帮助文本, 一般备注命令的用途及如何使用。
    help = "Print Hello World!"
 
    # 核心业务逻辑
    def handle(self, *args, **options):
        self.stdout.write('Hello World!')

注意:当你使用管理命令并希望在控制台输出指定信息时,你应该使用self.stdout和self.stderr方法,而不能直接使用python的print方法。另外,你不需要在消息的末尾加上换行符,它将被自动添加。

此时当你进入项目文件夹运行python manage.py hello_world命令时,你将得到如下输出结果:

django如何自定义manage.py管理命令

现在我们来增加点难度,来通过命令行给hello_world命令传递一个name参数,以实现运行python manage.py helloworld John命令时 打印出Hello World! John。

现在修改我们的hello_world.py, 添加add_arguments方法,该方法的作用是给自定义的handle方法添加1个或多个参数。

 from django.core.management.base import BaseCommand
 
 class Command(BaseCommand):
    # 帮助文本, 一般备注命令的用途及如何使用。
    help = "Print Hello World!"
 
    # 给命令添加一个名为name的参数
    def add_arguments(self, parser):
        parser.add_argument('name')
 
    # 核心业务逻辑,通过options字典接收name参数值,拼接字符串后输出
    def handle(self, *args, **options):
        msg = 'Hello World ! '+ options['name']
        self.stdout.write(msg)

此时当你再次运行python manage.py hello_world John命令时,你将得到如下输出结果:

django如何自定义manage.py管理命令

如果你直接运行命令而不携带参数,将会报错,如下所示:

django如何自定义manage.py管理命令

实际应用场景

前面的案例过于简单,我们现在来看两个自定义管理命令的实际应用案例。

案例1:检查数据库连接是否已就绪

无论你使用常规方式还是Docker在生产环境中部署Django项目,你需要确保数据库连接已就绪后才进行数据库迁移(migrate)的命令(Docker-compose的depends选项并不能确保这点),否则Django应用程序会出现报错。

这时你可以自定义一个wait_for_db的命令,如下所示:

 # app/management/commands/wait_for_db.py
 
 import time
 from django.db import connections
 from django.db.utils import OperationalError
 from django.core.management import BaseCommand
 
 
 class Command(BaseCommand):
     help = 'Run data migrations until db is available.'
 
     def handle(self, *args, **options):
         self.stdout.write('Waiting for database...')
         db_conn = None
         while not db_conn:
             try:
                 # 尝试连接
                 db_conn = connections['default']
             except OperationalError:
                 # 连接失败,就等待1秒钟
                 self.stdout.write('Database unavailable, waiting 1 second...')
                 time.sleep(1)
 
         self.stdout.write(self.style.SUCCESS('Database available!'))

定义好这个命令后每次在运行python manage.py migrate命令前先运行python manage.py wait_for_db即可。

案例2:周期性发送邮件

如果你是网站管理员,你肯定希望知道每天有多少新用户已注册,这时你可以自定义一条mail_admin的管理命令,将每天新注册用户数量以邮件形式发给自己,如下所示:

 # app/management/commands/mail_admin.py
 
 #-*- coding:utf-8 -*-
 from datetime import timedelta, time, datetime
 from django.core.mail import mail_admins
 from django.core.management import BaseCommand
 from django.utils import timezone
 from django.contrib.auth import get_user_model
 
 User = get_user_model()
 
 today = timezone.now()
 yesterday = today - timedelta(1)
 
 
 class Command(BaseCommand):
     help = "Send The Daily Count of New Users to Admins"
 
     def handle(self, *args, **options):
         # 获取过去一天注册用户数量
         user_count =User.objects.filter(date_joined__range=(yesterday, today)).count()
         
         # 当注册用户数量多余1个,才发送邮件给管理员
         if user_count >= 1:
             message = "You have got {} user(s) in the past 24 hours".format(user_count)
 
             subject = (
                 f"New user count for {today.strftime('%Y-%m-%d')}: {user_count}"
            )
 
             mail_admins(subject=subject, message=message, html_message=None)
 
             self.stdout.write("E-mail was sent.")
         else:
             self.stdout.write("No new users today.")

如果你在终端运行python manage.py mail_admin命令,你将得到如下输出结果:

django如何自定义manage.py管理命令

注意:真正发送邮件成功需要设置Email后台及管理员,测试环境下可以使用如下简单配置:

 EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
 DEFAULT_FROM_EMAIL = "noreply@example.com"
 ADMINS = [("大江狗", "yunbo.shi@example.com"), ]

但是如果每天都要进入终端运行这个命令实在太麻烦了,我们完全可以使用Linux的crontab服务或Celery-Beat将其设成周期性定时任务task,这时只需要调用Django的call_command方法即可。

 # app/tasks.py, 可以任一app目录下新建task
 from celery import shared_task
 from django.core.management import call_command
 
 @shared_task
 def mail_admin():
     call_command("mail_admin", )

关于Django项目中如何使用Celery执行异步和周期性任务,请参加下篇Django进阶-异步和周期任务篇。

以上就是django如何自定义manage.py管理命令的详细内容,更多关于django 自定义manage.py管理命令的资料请关注三水点靠木其它相关文章!

Python 相关文章推荐
python中bisect模块用法实例
Sep 25 Python
利用scrapy将爬到的数据保存到mysql(防止重复)
Mar 31 Python
Python通过属性手段实现只允许调用一次的示例讲解
Apr 21 Python
python 从文件夹抽取图片另存的方法
Dec 04 Python
详解Python 定时框架 Apscheduler原理及安装过程
Jun 14 Python
解决Pytorch 训练与测试时爆显存(out of memory)的问题
Aug 20 Python
使用pickle存储数据dump 和 load实例讲解
Dec 30 Python
pytorch 改变tensor尺寸的实现
Jan 03 Python
Python3.7实现验证码登录方式代码实例
Feb 14 Python
iPython pylab模式启动方式
Apr 24 Python
小结Python的反射机制
Sep 28 Python
pip/anaconda修改镜像源,加快python模块安装速度的操作
Mar 04 Python
Python爬虫之爬取二手房信息
七个Python必备的GUI库
Python实战之用tkinter库做一个鼠标模拟点击器
Python基础之pandas数据合并
上手简单,功能强大的Python爬虫框架——feapder
python绘制箱型图
基于Python实现的购物商城管理系统
Apr 27 #Python
You might like
长波有什么东西
2021/03/01 无线电
PHP 可阅读随机字符串代码
2010/05/26 PHP
php生成数组的使用示例 php全组合算法
2014/01/16 PHP
javascript数组与php数组的地址传递及值传递用法实例
2015/01/22 PHP
关于PHP文件的自动运行方法分析
2016/05/13 PHP
PHP屏蔽关键字实现方法
2016/11/17 PHP
Thinkphp5 微信公众号token验证不成功的原因及解决方法
2017/11/12 PHP
javascript 数组学习资料收集
2010/04/11 Javascript
flexigrid 参数说明
2010/11/23 Javascript
js对列表中第一个值处理与jsp页面对列表中第一个值处理的区别详解
2013/11/05 Javascript
原生js制作简单的数字键盘
2015/04/24 Javascript
JavaScript实现清空(重置)文件类型INPUT元素值的方法
2016/11/17 Javascript
node.js实现回调的方法示例
2017/03/01 Javascript
vue.js前后端数据交互之提交数据操作详解
2018/04/24 Javascript
不使用JavaScript实现菜单的打开和关闭效果demo
2018/05/01 Javascript
vue相关配置文件详解及多环境配置详细步骤
2020/05/19 Javascript
vue实现评价星星功能
2020/06/30 Javascript
Python Sql数据库增删改查操作简单封装
2016/04/18 Python
python抓取并保存html页面时乱码问题的解决方法
2016/07/01 Python
Python如何读取MySQL数据库表数据
2017/03/11 Python
python:接口间数据传递与调用方法
2018/12/17 Python
Python实现计算字符串中出现次数最多的字符示例
2019/01/21 Python
Python小白必备的8个最常用的内置函数(推荐)
2019/04/03 Python
Python列表操作方法详解
2020/02/09 Python
给keras层命名,并提取中间层输出值,保存到文档的实例
2020/05/23 Python
python怎么提高计算速度
2020/06/11 Python
Django创建一个后台的基本步骤记录
2020/10/02 Python
python实现无边框进度条的实例代码
2020/12/30 Python
ghd澳大利亚官方网站:英国最受欢迎的美发工具品牌
2018/05/21 全球购物
某公司.Net方向面试题
2014/04/24 面试题
护理专科毕业推荐信
2013/11/10 职场文书
个人自我剖析材料
2014/02/07 职场文书
基层党组织建设整改方案
2014/09/16 职场文书
2016年最美孝心少年事迹材料
2016/02/26 职场文书
服务器SVN搭建图文安装过程
2022/06/21 Servers
python playwrigh框架入门安装使用
2022/07/23 Python