详解Python的Django框架中manage命令的使用与扩展


Posted in Python onApril 11, 2016

【简介】

django-admin.py是Django的一个用于管理任务的命令行工具。本文将描述它的大概用法。

另外,在每一个Django project中都会有一个manage.py。manage.py是对django-admin.py的简单包装,它额外帮助我们做了两件事情:

它将你的project的包放到sys.path中
它将DJANGO_SETTINGS_MODULE环境变量设置为了你的project的setting.py文件的位置。
如果你是通过setup.py工具来安装Django的,那么django-admin.py脚本应该在你的系统目录中。如果不存在,你可以到你的python安装目录下的site-package/django/bin中去找找看。

通常来说,如果你经常是在一个独立的Django project里工作,那么使用manage.py会更方便一些。但如果你有很多Django project,那么可以使用django-admin.py,同时需要经常变更DJANGO_SETTINGS_MODULE或使用?settings选项来设置不同的setting.py。

本文中都会使用django-admin.py来给大家做演示,但所有的例子,都也可以使用manage.py来实现。

【用法】

djang-admin.py的语法为:

django-admin.py <subcommand> [options]
manage.py <subcommand> [options]

其中,subcommand是子命令;options是可选的,可以有0个到多个option。

获得帮助的方法是使用help这个命令,共有两种方法:

1 运行django-admin.py help会显示用法信息,并给出所有可用的subcommand列表

2 运行django-admin.py help <subcommand>会显示特定的subcommand的描述信息,以及所有可用的options

运行django-admin.py ?version可以显示django的版本号。

如果使用django-admin.py时加入?verbosity,则会显示大量通知信息和调试信息。

【runfcgi】- subcommand

用于启动一个支持FastCGI协议的进程,以便接收WebServer发来的请求。可以使用flup作为Python FastCGI模块。

runfcgi的选项如下:

  • protocol:用于设定所使用的cgi协议,包括fcgi、scgi和ajp等,默认是fcgi。
  • host:用于设置监听所在的主机名
  • port:用于设定监听的端口
  • socket:用于设置监听的UNIX socket
  • method:可以设置为prefork或threaded。默认是prefork。
  • maxrequests:一个子进程所能处理的请求的最大数量。一旦超过此数量,则子进程会被kill掉,并创建一个新进程。设置为0意味着对子进程无限制。
  • maxspare:空闲进程/线程的最大数量
  • minspare:空闲进程/线程的最小数量
  • maxchildren:进程/线程数的硬限制值
  • daemonize:为boolean值,表示是否放到后台运行。
  • pidfile:设置一个文件,用于将产生的PID信息写入。
  • workdir:用于设置工作目录
  • debug:为boolean值,用于设置是否开启flup的信息跟踪
  • outlog:用于设置将标准输出写入到的文件
  • errlog:用于设置将标准错误输出写入到的文件
  • umask:用于设置在进程运行时所用的umask。默认是022.

举例来说:

django-admin.py runfcgi socket=/tmp/fcgi.sock method=prefork daemonize=true \
  pidfile=/var/run/django-fcgi.pid

此命令用于在后台启动fastCGI,并将pid写入文件中。

【runserver】- subcommand

用于在本机启动一个轻量级的Web server。默认情况下,这个server会在127.0.0.1上监听8000端口。你也可以传入参数来改变默认配置。

如果你并非特权用户,那么你所设置的端口号不能低于1024,因为小于1024的端口已经被系统预定了。

一定不要用这个轻量级Server作为你的生产环境下的Server,因为它只能用于开发自测阶段。它既没有安全审计功能,而且又是单线程的。

另外,每来一个请求,Web Server都会从新载入一遍Python代码,因此如果你的代码有改动,不需要重启Web Server即可生效。

你可以在一个project中启动多个fastcgi server,只要设置不同的端口就可以了。

如果你设定的IP为默认的127.0.0.1,那么你只能从本机的浏览器来登录浏览,无法从其他机器来访问。为了能让其他机器浏览本机,需要将IP设置为目标机器的IP或者0.0.0.0(IPv4地址)或::(IPv6地址)。

在指定IP地址时,也可以使用主机名或域名来代替。

【shell】- subcommand

用于开启一个Python解释器。

Django默认会使用IPython或bpython。但如果你没有安装它们或者就是要使用简装版的话,可以加上?plain选项,即:

django-admin.py shell --plain

【startapp】- subcommand

在当前路径或指定目录下创建一个Django app的文件夹结构。

默认情况下,文件夹中会包括module.py文件和其他必备文件。

如下命令用于在特定目录下创建一个app:

django-admin.py startapp myapp /Users/jezdez/Code/myapp

【startproject】- subcommand

In Django, Projects can have many apps. Apps can be shared among many projects.

在当前目录或指定位置创建一个Django project文件夹结构。

默认情况下,新文件夹中会包括manage.py和一系列必备文件。

目标位置参数是可选的参数,可以设置project所创建的路径。

例如,如下命令可以在指定位置创建一个project:

django-admin.py startproject myproject /Users/jezdez/Code/myproject_repo

和startapp命令一样,--template命令准许你指定一个文件夹,文件路径,或者一个自定义项目模板的链接,关于对项目模板的支持可以查看startapp的文档

下面的例子,在创建myproject项目的时候,会在指定的路径查找模板

django-admin.py startproject --template=/users/jezdez/code/my_project_template myproject

When Django copies the project template files, it also renders certain files through the template engine: the files whose extensions match the --extension option (py by default) and the files whose names are passed with the --name option. The template context used is:

Any option passed to the startproject command
project_name -- the project name as passed to the command
project_directory -- the full path of the newly created project
secret_key -- a random key for the SECRET_KEY setting
Please also see the rendering warning as mentioned for startapp.

syncdb

django-admin.py syncdb

这个命令将为以安装的(INSTALLED_APPS)apps创建数据表,如果数据表还没创建的话。

【扩展manage命令】
我们都用过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-admin.py调用django.core.management来执行命令:

#!/usr/bin/env python
from django.core import management
  
if __name__ == "__main__":
  management.execute_from_command_line()

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

所谓管理模块,是指在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的直接或间接子类。

原理搞清楚了,扩展manage命令就很容易了。创建一个app并加入到settings的INSTALLED_APPS中,在该app下面创建management.commands模块,并创建hello.py文件:

from django.core.management.base import BaseCommand, CommandError
from django.db import models
#from placeholders import *
import os
  
class Command(BaseCommand):
   def handle(self, *args, **options):
     print 'hello, django!'

就可以使用hello命令了:

$ python manage.py hello
hello, django!
Python 相关文章推荐
在Python中处理字符串之isdecimal()方法的使用
May 20 Python
在windows系统中实现python3安装lxml
Mar 23 Python
django开发教程之利用缓存文件进行页面缓存的方法
Nov 10 Python
Python使用requests发送POST请求实例代码
Jan 25 Python
python 异或加密字符串的实例
Oct 14 Python
在Mac下使用python实现简单的目录树展示方法
Nov 01 Python
django ManyToManyField多对多关系的实例详解
Aug 09 Python
Django xadmin开启搜索功能的实现
Nov 15 Python
python实现输入的数据在地图上生成热力图效果
Dec 06 Python
调整Jupyter notebook的启动目录操作
Apr 10 Python
Python轻量级web框架bottle使用方法解析
Jun 13 Python
通过Python把学姐照片做成拼图游戏
Feb 15 Python
对Python的Django框架中的项目进行单元测试的方法
Apr 11 #Python
使用Python的Django框架结合jQuery实现AJAX购物车页面
Apr 11 #Python
Python的Django REST框架中的序列化及请求和返回
Apr 11 #Python
python中的错误处理
Apr 10 #Python
python脚本实现xls(xlsx)转成csv
Apr 10 #Python
Python使用gensim计算文档相似性
Apr 10 #Python
Python调用SQLPlus来操作和解析Oracle数据库的方法
Apr 09 #Python
You might like
example2.php
2006/10/09 PHP
Zend Framework 2.0事件管理器(The EventManager)入门教程
2014/08/11 PHP
比较完整的微信开发php代码
2016/08/02 PHP
PHP下 Mongodb 连接远程数据库的实例代码
2017/08/30 PHP
PHP创建文件及写入数据(覆盖写入,追加写入)的方法详解
2019/02/15 PHP
CSDN轮换广告图片轮换效果
2007/03/27 Javascript
jQuery中的.bind()、.live()和.delegate()之间区别分析
2011/06/08 Javascript
jQuery调用WebService的实现代码
2011/06/19 Javascript
javascript处理表单示例(javascript提交表单)
2014/04/28 Javascript
nodejs 实现模拟form表单上传文件
2014/07/14 NodeJs
JavaScript控制listbox列表框的项目上下移动的方法
2015/03/18 Javascript
JS实现1000以内被3或5整除的数字之和
2016/02/18 Javascript
微信公众号 客服接口的开发实例详解
2016/09/28 Javascript
js实现对table的增加行和删除行的操作方法
2016/10/13 Javascript
jquery-mobile表单的创建方法详解
2016/11/23 Javascript
详解用webpack2.0构建vue2.0超详细精简版
2017/04/05 Javascript
vue自定义指令的创建和使用方法实例分析
2018/12/04 Javascript
[02:23]2016国际邀请赛中国区预选赛wings晋级之路
2016/06/29 DOTA
python实现的登录和操作开心网脚本分享
2014/07/09 Python
Python实现字符串逆序输出功能示例
2017/06/24 Python
Python爬取十篇新闻统计TF-IDF
2018/01/03 Python
Django权限机制实现代码详解
2018/02/05 Python
python中实现字符串翻转的方法
2018/07/11 Python
深入理解Python中的 __new__ 和 __init__及区别介绍
2018/09/17 Python
Python Pillow Image Invert
2019/01/22 Python
django rest framework vue 实现用户登录详解
2019/07/29 Python
Python内置数据类型list各方法的性能测试过程解析
2020/01/07 Python
tensorflow 实现数据类型转换
2020/02/17 Python
python程序如何进行保存
2020/07/03 Python
浅析Python requests 模块
2020/10/09 Python
美国伊甸园兄弟种子公司:Eden Brothers
2018/07/01 全球购物
Tessabit美国:集世界奢侈品和设计师品牌的意大利精品买手店
2020/06/29 全球购物
机电专业毕业生推荐信
2013/11/10 职场文书
婚礼迎宾词大全
2015/08/10 职场文书
安全伴我行主题班会
2015/08/13 职场文书
关于EntityWrapper的in用法
2022/03/22 Java/Android