三十三、Django进阶：自定义manage.py shell管理命令以及案例（附源码）

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

自定义的管理命令不仅可以通过manage.py运行，还可以通过Linux或Celery的crontab服务将其设成定时任务。

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

本篇末尾将实现三个自定义管理命令的实际应用案例（系统参数初始化、数据库连接状态、邮件发送）。

自定义shell注意事项

1. management和commands每个目录下都必须有个__init__.py空文件，表明这是一个python包。另外以下划线开头的文件名不能用作管理命令脚本。
2. management/commands目录可以位于任何一个app的目录下，Django都能找到它。
3. 一般建议每个python脚本文件对应一条管理命令。
4. 当使用管理命令并希望在控制台输出指定信息时，应该使用self.stdout和self.stderr方法，而不能直接使用python的print方法。另外，不需要在消息的末尾加上换行符，它将被自动添加。

创建文件夹布局

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

app/
	__init__.py
	models.py
	management/
    __init__.py
    commands/
    __init__.py
    _private.py # 以下划线开头文件不能用作管理命令
    init.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

 定义一个名为show_version的命令。当运行python manage.py show_version命令时，控制台会打印出提示和版本信息。在drf_pro/management/commands目录下新建show_version.py, 添加如下代码：

import sys
from django.core.management.base import BaseCommand

class Command(BaseCommand):
    """
    执行指令：python manage.py show_version
    显示帮助信息 python manage.py show_version -h
    输入库名称，显示库的帮助信息 python manage.py show_version sys
    """
    # 帮助信息 用于备注命令的用途及如何使用
    help = f"帮助信息"

    # 可选
    def add_arguments(self, parser):
pass

    # 业务逻辑
    def handle(self, *args, **options):
        self.stdout.write(f"{self.help}，当前系统环境版本：{sys.version}")
        self.stdout.write("this is django custom command line")

 

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

此时当进入项目文件夹运行python manage.py show_version命令时，将得到如下输出结果：

添加参数

通过命令行给show_version命令传递一个name参数，以实现运行python manage.py show_version命令时 打印出对应库的信息。

修改show_version.py, 添加add_arguments方法，该方法的作用是给自定义的handle方法添加1个或多个参数。

import sys
from importlib import import_module
from django.core.management.base import BaseCommand

# class CommandHello(BaseCommand): # error 错误的命名
class Command(BaseCommand):
    """
    执行指令：python manage.py show_version
    显示帮助信息 python manage.py show_version -h
    输入库名称，显示库的帮助信息 python manage.py show_version sys
    """
    # 帮助信息 用于备注命令的用途及如何使用
    help = f"当前系统环境版本：{sys.version}"

    # 可选
    def add_arguments(self, parser):
        # 给命令添加一个名为name的参数
        parser.add_argument('name')

    # 业务逻辑 通过options字典接收name参数值
    def handle(self, *args, **options):
        self.stdout.write(f"{self.help}")
        self.stdout.write("this is django custom command line")
        help(import_module(options.get("name")))

再次运行python manage.py show_version os命令时，将得到如下输出结果：

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

案例

案例1：初始化系统参数

定义一个init的系统参数初始化脚本，将静态文件的信息全部录入到数据库中。static/files/sys_config.json的文件内容格式如下：

定义init,py的命令文件，内容如下：

 # packages/drf_pro/management/commands/init.py

import os
import json
from django.conf import settings
from django.core.management.base import BaseCommand
from packages.drf_pro.models import Config


class Command(BaseCommand):
    help = "系统初始化配置"
    tags = "[init conf]"

    def add_arguments(self, parser):
        pass

    def handle(self, *args, **options):
        self.stdout.write(f"{self.tags} start initializer config tbale...")

        conf_file = os.path.join(settings.BASE_DIR, "static", "files", "sys_config.json").replace("\\","/")
        if os.path.exists(conf_file):
            with open(conf_file,encoding="utf-8") as conf_f:
                configs = json.loads(conf_f.read())

                try:
                    for conf in configs:
                        is_exists = Config.objects.filter(name_en=conf["name_en"])
                        if is_exists:
                            conf_item = is_exists.first()
                            conf_item.name_zh = conf.get("name_zh", "")
                            conf_item.remark = conf.get("remark", "")
                            conf_item.conf_type = conf.get("conf_type", "")
                            conf_item.save()
                        else:
                            Config.objects.create(**conf)
                    self.stdout.write(f"{self.tags} sync over.....")
                except Exception as e:
                    self.stderr.write(f"{self.tags} sync error, info:{e}")
        else:
            self.stderr.write(f"not exists:{conf_file}")

 

输出

PGSQL中查看初始结果

案例2：检查数据库连接是否正常

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

这时可以自定义一个check_db_server的命令，如下所示：

 # packages/drf_pro/management/commands/check_db_server.py
 
import time
from django.db import connections
from django.db.utils import OperationalError
from django.core.management import BaseCommand


class Command(BaseCommand):
    help = "[Check] 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:
                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 check_db_server即可。

案例3：周期性发送邮件

希望知道每天有多少新用户已注册，这时可以自定义一条send_email的管理命令，将每天新注册用户数量以邮件形式发给自己，如下所示：

# packages/drf_pro/management/commands/send_email.py
 
from datetime import timedelta
from django.core.mail import mail_admins
from django.utils import timezone
from django.contrib.auth import get_user_model
from django.core.management.base import BaseCommand

User = get_user_model()


class Command(BaseCommand):
    help = 'Send Email Information to Admin....'

    def handle(self, *args, **options):
        today = timezone.now()
        yesterday = today - timedelta(1)
        user_count = User.objects.filter(date_joined__range=(yesterday, today)).count()
        if user_count:
            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}")
            try:
                mail_admins(subject=subject, message=message, html_message=None)
            except Exception as e:
                self.stderr.write(f"Send email error, msg:{e}")
            self.stdout.write(f'Send email success, user count:{user_count}')
        else:
            self.stdout.write('No new users today')

如果在终端运行python manage.py send_email命令，将得到如下输出结果：

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

EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
DEFAULT_FROM_EMAIL = "[email protected]"
ADMINS = [("steverocket", "[email protected]"), ]

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

# drf_pro/tasks.py, 可以任一app目录下新建task
from celery import shared_task
from django.core.management import call_command
# 将django自定义的指令放入到定时任务中
@shared_task
def send_email():
    call_command("send_email", )

代码示例：https://download.csdn.net/download/zhouruifu2015/87611608https://download.csdn.net/download/zhouruifu2015/87611608

输入才有输出，吸收才能吐纳。——码字不易