详解django实现自定义manage命令的扩展


Posted in Python onAugust 13, 2019

在Django开发过程中我们都用过django-admin.py和manage.py命令。

django-admin.py是一个命令行工具,可以执行一些管理任务,比如创建Django项目。而manage.py是在创建每个Django project时自动添加在项目目录下的,只是对manage.py的一个简单包装,其功能是将Django project放到sys.path目录中,同时设置DJANGO_SETTINGS_MODULE环境变量为当前project的setting.py文件。

Django 对于命令的添加有自己的一套规范,我们可以为每个app 指定命令。简单来书就是我们在使用manage.py文件执行命令的时候,可以自定制自己的命令,来实现命令的扩充。

对于自定义Command我们从两方面介绍一是内部执行原理,二是如何实行自定义Command

一、内部原理实现

django-admin.py调用django.core.management来执行命令:

创建django项目会自动生成manage.py文件:

import os
import sys


def main():
  os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'gaoyou.settings')
  try:
    from django.core.management import execute_from_command_line
  except ImportError as exc:
    raise ImportError(
      "Couldn't import Django. Are you sure it's installed and "
      "available on your PYTHONPATH environment variable? Did you "
      "forget to activate a virtual environment?"
    ) from exc
  execute_from_command_line(sys.argv)


if __name__ == '__main__':
  main()

excute_from_command_line()函数会根据命令行参数解析出命令的名称,根据命令名称调用相应的Command执行命令。Command位于各个管理模块的commands模块下面。

commands的创建方法:

1、在app内创建一个名字为:management文件夹(在你自己指定的应用下创建即可)
2、在management文件夹里面创建名为:commands的文件夹
3、在commands文件夹下创建名为:任意py文件(启动的时候就是根据该文件名进行启动的,注意:commands目录内都包含__init__.py文件)

此时py文件名就是你的自定制命令,我们可以使用下面方式进行执行

python manage.py 命令名(即任意py文件名不用加.py)
#类似我们迁移数据库命令
#python manage.py makemigrations
#python manage.py migrate

所谓管理模块,是指在app模块下的名字为management的模块。Django通过

django.core.management.find_management_module函数发现"管理模块":

django.core.management.find_management_module()
def find_management_module(app_name):
  """
  Determines the path to the management module for the given app_name,
  without actually importing the application or the management module.

  Raises ImportError if the management module cannot be found for any reason.
  """
  parts = app_name.split('.')
  parts.append('management')
  parts.reverse()
  part = parts.pop()
  path = None

然后通过django.core.management.find_commands函数找到命令类。find_commands函数会在管理模块下查找.py文件,并将.py文件的名称匹配到命令名称:

def find_commands(management_dir):
  """
  Given a path to a management directory, returns a list of all the command
  names that are available.

  Returns an empty list if no commands are defined.
  """
  command_dir = os.path.join(management_dir, 'commands')
  try:
    return [f[:-3] for f in os.listdir(command_dir)
      if not f.startswith('_') and f.endswith('.py')]
  except OSError:
  return []

最后,通过django.core.management.load_command_class函数加载该.py文件中的Command类:

def load_command_class(app_name, name):
  """
  Given a command name and an application name, returns the Command
  class instance. All errors raised by the import process
  (ImportError, AttributeError) are allowed to propagate.
  """
  module = import_module('%s.management.commands.%s' % (app_name, name))
  return module.Command()

在执行命令的时候,会执行相应Command类的handle方法。所有的Command类都应该是django.core.management.base.BaseCommand的直接或间接子类。

二、自定义应用

Django的Command命令是要放到我们创建app下的management/commands目录下的( 需自己手动创建该文件目录 )。

注意:请确保management/commands目录下包含 __init__.py 文件

首先对于文件名可以自行定义没有要求,内部需要定义一个Command类并继承BaseCommand类或其子类。

  1. 它必须定义一个Command类并扩展自BaseCommand或其 子类。
  2. 其中help是command功能作用简介,handle函数是主处理程序,add_arguments函数是用来接收可选参数的( 如果没有参数该方法可以不写 )

我们通过在输入命令后再控制台输出一个hello world为例:

task.py

from django.core.management.base import BaseCommand, CommandError
from django.db import models

class Command(BaseCommand):
  help = '每日凌晨对当天数据库进行更新'

  def handle(self, *args, **options):
    print('hello world')

在Terminal控制台将目录切换到你创建的Django项目目录下执行: python manage.py task

执行后即可在控制台看到输出hello world 说明自定义Commond成功!!!

如果在输入命令想要输出参数怎么办呢?例如: python mange.py task 参数

task.py

from django.core.management.base import BaseCommand, CommandError
from django.db import models


class Command(BaseCommand):
  help = '每日凌晨对当天数据库进行更新'

  # 接收参数
  def add_arguments(self, parser):
    parser.add_argument('offset', type=int, help='天数转移量')

  def handle(self, *args, **options):
    offset = options['offset'] # 拿到参数的值
    print(offset)
    print('hello world')
    self.stdout.write(self.style.SUCCESS('{} Successfully {}'.format('接收成功', offset))) #可以自定制在控制台输出的内容

在Terminal控制台将目录切换到你创建的Django项目目录下执行: python manage.py task  1314

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
Python 代码性能优化技巧分享
Aug 07 Python
Python多进程同步简单实现代码
Apr 27 Python
Python3中使用PyMongo的方法详解
Jul 28 Python
Python3.x对JSON的一些操作示例
Sep 01 Python
Python 多进程和数据传递的理解
Oct 09 Python
python3.4+pycharm 环境安装及使用方法
Jun 13 Python
解决pycharm remote deployment 配置的问题
Jun 27 Python
Python List列表对象内置方法实例详解
Oct 22 Python
使用TFRecord存取多个数据案例
Feb 17 Python
python中安装django模块的方法
Mar 12 Python
pyspark对Mysql数据库进行读写的实现
Dec 30 Python
matplotlib对象拾取事件处理的实现
Jan 14 Python
Python一键安装全部依赖包的方法
Aug 12 #Python
Python之time模块的时间戳,时间字符串格式化与转换方法(13位时间戳)
Aug 12 #Python
浅谈Python2之汉字编码为unicode的问题(即类似\xc3\xa4)
Aug 12 #Python
基于Python2、Python3中reload()的不同用法介绍
Aug 12 #Python
Python递归函数 二分查找算法实现解析
Aug 12 #Python
基于Python安装pyecharts所遇的问题及解决方法
Aug 12 #Python
Django实现发送邮件找回密码功能
Aug 12 #Python
You might like
php 学习资料零碎东西
2010/12/04 PHP
thinkphp验证码显示不出来的解决方法
2014/03/29 PHP
PHP调用MySQL存储过程并返回值的方法
2014/12/26 PHP
JQery 渐变图片导航效果代码 漂亮
2010/01/01 Javascript
jquery 学习之二 属性相关
2010/11/23 Javascript
JQuery中$之选择器用法介绍
2011/04/05 Javascript
javascript 树形导航菜单实例代码
2013/08/13 Javascript
Javascript学习笔记之函数篇(四):arguments 对象
2014/11/23 Javascript
JavaScript中检查对象property的存在性方法介绍
2014/12/30 Javascript
js实现Select头像选择实时预览代码
2015/08/17 Javascript
js制作带有遮罩弹出层实现登录注册表单特效代码分享
2015/09/05 Javascript
用户代理字符串userAgent可实现的四个识别
2015/09/20 Javascript
浅谈bootstrap源码分析之tab(选项卡)
2016/06/06 Javascript
jQuery实现底部浮动窗口效果
2016/09/07 Javascript
js以及jquery实现手风琴效果
2020/04/17 Javascript
详解vue-router 2.0 常用基础知识点之router.push()
2017/05/10 Javascript
微信小程序实现的点击按钮 弹出底部上拉菜单功能示例
2018/12/20 Javascript
JavaScript使用闭包模仿块级作用域操作示例
2019/01/21 Javascript
微信小程序如何实现全局重新加载
2019/06/05 Javascript
Vue路由 重定向和别名的区别说明
2020/09/09 Javascript
浅谈Python 对象内存占用
2016/07/15 Python
Python基于贪心算法解决背包问题示例
2017/11/27 Python
有趣的python小程序分享
2017/12/05 Python
python爬取微信公众号文章
2018/08/31 Python
python实现转盘效果 python实现轮盘抽奖游戏
2019/01/22 Python
K最近邻算法(KNN)---sklearn+python实现方式
2020/02/24 Python
pyecharts调整图例与各板块的位置间距实例
2020/05/16 Python
布鲁明戴尔百货店:Bloomingdale’s
2016/12/21 全球购物
瑞典时尚耳机品牌:Urbanears
2017/07/26 全球购物
英国川宁茶官方网站:Twinings茶
2019/05/21 全球购物
大学生秋游活动方案
2014/02/17 职场文书
大学生职业生涯规划书参考模板
2014/03/05 职场文书
市场营销专业求职信
2014/06/17 职场文书
校庆标语集锦
2014/06/25 职场文书
2014年工程部工作总结
2014/11/25 职场文书
微信小程序结合ThinkPHP5授权登陆后获取手机号
2021/11/23 PHP