详解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 相关文章推荐
Python3实现的腾讯微博自动发帖小工具
Nov 11 Python
剖析Python的Twisted框架的核心特性
May 25 Python
Python获取SQLite查询结果表列名的方法
Jun 21 Python
解决Python安装时报缺少DLL问题【两种解决方法】
Jul 15 Python
Python编程中类与类的关系详解
Aug 08 Python
详解Python Opencv和PIL读取图像文件的差别
Dec 27 Python
tensorflow入门:TFRecordDataset变长数据的batch读取详解
Jan 20 Python
Python列表解析操作实例总结
Feb 26 Python
Python的Django框架实现数据库查询(不返回QuerySet的方法)
May 19 Python
PyInstaller的安装和使用的详细步骤
Jun 02 Python
python 从list中随机取值的方法
Nov 16 Python
详解分布式系统中如何用python实现Paxos
May 18 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函数preg_match_all正则表达式的基本使用详细解析
2013/08/31 PHP
php上传文件并存储到mysql数据库的方法
2015/03/16 PHP
php中简单的对称加密算法实现
2017/01/05 PHP
PHP创建对象的六种方式实例总结
2019/06/27 PHP
js Flash插入函数免激活代码
2009/03/31 Javascript
JavaScript 动态改变图片大小
2009/06/11 Javascript
jQuery 使用手册(一)
2009/09/23 Javascript
javascript 二维数组的实现与应用
2010/03/16 Javascript
jquery 学习笔记一
2010/04/07 Javascript
Kibo 用于处理键盘事件的Javascript工具库
2011/10/28 Javascript
有关javascript的性能优化 (repaint和reflow)
2013/04/12 Javascript
Javascript计算两个marker之间的距离(Google Map V3)
2013/04/26 Javascript
JS 拼凑字符串的简单实例
2016/09/02 Javascript
jQuery插件ajaxFileUpload异步上传文件
2016/10/19 Javascript
es6学习笔记之Async函数基本教程
2017/05/11 Javascript
详解RequireJs官方使用教程
2017/10/31 Javascript
vue2.0路由切换后页面滚动位置不变BUG的解决方法
2018/03/14 Javascript
使用jQuery动态设置单选框的选中效果
2018/12/06 jQuery
教你如何用Node实现API的转发(某音乐)
2019/09/20 Javascript
JS Html转义和反转义(html编码和解码)的实现与使用方法总结
2020/03/10 Javascript
Vue 实现对quill-editor组件中的工具栏添加title
2020/08/03 Javascript
[02:41]《西雅图我们来了》2015国际邀请赛出征全记录
2015/07/23 DOTA
python基于xmlrpc实现二进制文件传输的方法
2015/06/02 Python
python深度优先搜索和广度优先搜索
2018/02/07 Python
python try except返回异常的信息字符串代码实例
2019/08/15 Python
python实现代码统计器
2019/09/19 Python
HTML5页面无缝闪开的问题及解决方案
2020/06/11 HTML / CSS
联强国际笔试题面试题
2013/07/10 面试题
编码实现字符串转整型的函数
2012/06/02 面试题
什么是Oracle的后台进程background processes?都有哪些后台进程?
2012/04/26 面试题
地下停车场租赁协议范本
2014/10/07 职场文书
大学生简历自我评价2015
2015/03/03 职场文书
2015年办公室文员工作总结
2015/04/24 职场文书
解决python3安装pandas出错的问题
2021/05/20 Python
Golang的继承模拟实例
2021/06/30 Golang
Python接口自动化之文件上传/下载接口详解
2022/04/05 Python