详解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中的is和id用法分析
Jan 26 Python
Python编程中实现迭代器的一些技巧小结
Jun 21 Python
python:接口间数据传递与调用方法
Dec 17 Python
python 多进程共享全局变量之Manager()详解
Aug 15 Python
Django中间件拦截未登录url实例详解
Sep 03 Python
PyQT5 emit 和 connect的用法详解
Dec 13 Python
利用Pytorch实现简单的线性回归算法
Jan 15 Python
python利用百度云接口实现车牌识别的示例
Feb 21 Python
基于Django OneToOneField和ForeignKey的区别详解
Mar 30 Python
Python request操作步骤及代码实例
Apr 13 Python
什么是python的自省
Jun 21 Python
Pygame如何使用精灵和碰撞检测
Nov 17 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
一个目录遍历函数
2006/10/09 PHP
叫你如何修改Nginx与PHP的文件上传大小限制
2014/09/10 PHP
php实现TCP端口检测的方法
2015/04/01 PHP
用PHP生成excel文件到指定目录
2015/06/22 PHP
利用php输出不同的心形图案
2016/04/22 PHP
PHP 表单提交及处理表单数据详解及实例
2016/12/27 PHP
PHP微信支付结果通知与回调策略分析
2019/01/10 PHP
详解PHP素材图片上传、下载功能
2019/04/12 PHP
JavaScript加入收藏夹功能(兼容IE、firefox、chrome)
2014/05/05 Javascript
自定义jQuery插件方式实现强制对象重绘的方法
2015/03/23 Javascript
使用jquery+CSS3实现仿windows10开始菜单的下拉导航菜单特效
2015/09/24 Javascript
jQuery获取父元素及父节点的方法小结
2016/04/14 Javascript
JS简单实现点击复制链接的方法
2016/08/03 Javascript
Node.js配合node-http-proxy解决本地开发ajax跨域问题
2016/08/31 Javascript
js无提示关闭浏览器窗口的两种方法分析
2016/11/06 Javascript
easyui combobox开启搜索自动完成功能的实例代码
2016/11/08 Javascript
element 结合vue 在表单验证时有值却提示错误的解决办法
2018/01/22 Javascript
JavaScript实现的简单Tab点击切换功能示例
2018/07/06 Javascript
webpack4.x打包过程详解
2018/07/18 Javascript
详解Vue中watch对象内属性的方法
2019/02/01 Javascript
JavaScript之Blob对象类型的具体使用方法
2019/11/29 Javascript
使用webpack/gulp构建TypeScript项目的方法示例
2019/12/18 Javascript
javascript+css实现俄罗斯方块小游戏
2020/06/28 Javascript
[02:17]2016完美“圣”典风云人物:Sccc专访
2016/12/03 DOTA
python使用Queue在多个子进程间交换数据的方法
2015/04/18 Python
Python fileinput模块使用实例
2015/05/28 Python
CentOS 6.5下安装Python 3.5.2(与Python2并存)
2017/06/05 Python
Python编程pygal绘图实例之XY线
2017/12/09 Python
python如何将图片转换为字符图片
2020/08/19 Python
Python实现html转换为pdf报告(生成pdf报告)功能示例
2019/05/04 Python
CSS3使用border-radius属性制作圆角
2014/12/22 HTML / CSS
整理HTML5的一些新特性与Canvas的常用属性
2016/01/29 HTML / CSS
Java里面如何创建一个内部类的实例
2015/01/19 面试题
农业资源与环境专业自荐信范文
2013/12/30 职场文书
个人工作决心书
2015/09/22 职场文书
房屋转让协议书(标准范本)
2016/03/21 职场文书