【Django源码浅析】——Django命令模块

下边是正文….

首先大概看一下Django 项目的主要目录，初步建立一下Django源码的世界观。

1
2
3
4
5
6
7
<span lang="EN-US">├── django          </span></code><span class="hljs-comment"><span lang="EN-US">//</span>工程代码存放路径
<span lang="EN-US">├── docs            </span></code><span lang="EN-US">//</span>文档
<span lang="EN-US">├── extras  
├── js_tests        //测试
├── scripts         //脚本
└── tests           //单元测试</span>
</span><code>

Django核心代码主要在django目录下边

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<span lang="EN-US">django/
├── apps（app模块）
├── bin（可执行命令）
├── conf（配置）
├── contrib（其他开发者贡献代码）
├── core（核心组件）
├── db（ORM模块）
├── dispatch
├── forms（表单模块）
├── http
├── middleware（中间件）
├── template（模板）
├── templatetags
├── <span class="hljs-builtin">test</span>（测试代码）
├── urls（url路由模块）
├── utils（工具代码）
└── views（视图模块）
</span>

在django中我们常用的命令主要有两个，一个是django-admin，一个是xxxx,我们先看一下django-admin

1、命令位置

1
<span lang="EN-US">lion</span></code><span class="hljs-variable"><span lang="EN-US">@localhost:</span></span><code><span lang="EN-US">~/django/django$ whereis django-admin</span>

1
<span class="hljs-attribute"><span lang="EN-US">django-admin</span></span><code><span lang="EN-US">: /usr/</span></code><span class="hljs-builtin"><span lang="EN-US">local</span></span><code><span lang="EN-US">/bin/django-admin /usr/</span></code><span class="hljs-builtin"><span lang="EN-US">local</span></span><code><span lang="EN-US">/bin/django-admin.py /usr/</span></code><span class="hljs-builtin"><span lang="EN-US">local</span></span><code><span lang="EN-US">/bin/django-admin.pyc</span>

2、命令内容

1
2
3
4
5
6
7
8
9
<span lang="EN-US">lion@localhost:~/django/django$ cat /usr/</span></code><span class="hljs-builtin"><span lang="EN-US">local</span></span><code><span lang="EN-US">/bin/django-admin
#!/usr/bin/python
# -*- coding: utf-8 -*-
import re
import sys
from django.core.management import execute_from_command_line
if __name__ == '__main__':
    sys.argv[0] = re.sub(r'(-script\.pyw?|\.exe)?$', '', sys.argv[0])
    sys.exit(execute_from_command_line()</span>

其实对比不难发现，django-admin命令其实对应的是django源码中的.django/bin/django-admin.py这个文件。

django-admin.py 引用了django.core中的management，并调用了其execute_from_command_line函数。

注：在最新版中django-admin和manage.py中调用的都是execute_from_command_line函数了，较旧版本的django中可能不同。

所以要分析django的命令系统，就要从execute_from_command_line函数入手。

execute_from_command_line函数定义：

1
2
3
4
5
6
7
<span class="hljs-keyword"><span lang="EN-US">def</span></span> <span class="hljs-title"><span lang="EN-US">execute_from_command_line</span></span><span class="hljs-params"><span lang="EN-US">(argv=None)</span></span><span class="hljs-function"><span lang="EN-US">:
    """
    A simple method that runs a ManagementUtility.
    """
    utility = ManagementUtility(argv)
    utility.execute()
</span></span>

函数初始化ManagementUtility类，传入argv（也就是命令行参数）参数，并执行execute方法

execute方法：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<span class="hljs-keyword"><span lang="EN-US">def</span></span> <span class="hljs-title"><span lang="EN-US">execute</span></span><span class="hljs-params"><span lang="EN-US">(self)</span></span><span class="hljs-function"><span lang="EN-US">:
    """
    Given the command-line arguments, this figures out which subcommand is
    being run, creates a parser appropriate to that command, and runs it.
    """
    try:
        subcommand = self.argv[1]
    except IndexError:
        subcommand = 'help'  # Display help if no arguments were given.
    # Preprocess options to extract --settings and --pythonpath.
    # These options could affect the commands that are available, so they
    # must be processed early.
    parser = CommandParser(None, usage="%(prog)s subcommand [options] [args]", add_help=False)
    parser.add_argument('--settings')
    parser.add_argument('--pythonpath')
    parser.add_argument('args', nargs='*')  # catch-all
    try:
        options, args = parser.parse_known_args(self.argv[2:])
        handle_default_options(options)
    except CommandError:
        pass  # Ignore any option errors at this point.
    no_settings_commands = [
        'help', 'version', '--help', '--version', '-h',
        'startapp', 'startproject', 'compilemessages',
    ]
    try:
        settings.INSTALLED_APPS
    except ImproperlyConfigured as exc:
        self.settings_exception = exc
        # A handful of built-in management commands work without settings.
        # Load the default settings -- where INSTALLED_APPS is empty.
        if subcommand in no_settings_commands:
            settings.configure()
    if settings.configured:
        # Start the auto-reloading dev server even if the code is broken.
        # The hardcoded condition is a code smell but we can't rely on a
        # flag on the command class because we haven't located it yet.
        if subcommand == 'runserver' and '--noreload' not in self.argv:
            try:
                autoreload.check_errors(django.setup)()
            except Exception:
                # The exception will be raised later in the child process
                # started by the autoreloader. Pretend it didn't happen by
                # loading an empty list of applications.
                apps.all_models = defaultdict(OrderedDict)
                apps.app_configs = OrderedDict()
                apps.apps_ready = apps.models_ready = apps.ready = True
        # In all other cases, django.setup() is required to succeed.
        else:
            django.setup()
    self.autocomplete()
    if subcommand == 'help':
        if '--commands' in args:
            sys.stdout.write(self.main_help_text(commands_only=True) + '\n')
        elif len(options.args) &lt; 1:
            sys.stdout.write(self.main_help_text() + '\n')
        else:
            self.fetch_command(options.args[0]).print_help(self.prog_name, options.args[0])
    # Special-cases: We want 'django-admin --version' and
    # 'django-admin --help' to work, for backwards compatibility.
    elif subcommand == 'version' or self.argv[1:] == ['--version']:
        sys.stdout.write(django.get_version() + '\n')
    elif self.argv[1:] in (['--help'], ['-h']):
        sys.stdout.write(self.main_help_text() + '\n')
   else:
        self.fetch_command(subcommand).run_from_argv(self.argv)
</span></span>

此方法主要解析命令行参数，加载settings配置，如果setting配置成功则执行django.setup函数（此函数主要是加载App），最后一步调用的核心命令为fetch_command命令，并执行run_from_argv函数

先看一下fetch_command函数

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
<span class="hljs-keyword"><span lang="EN-US">def</span></span> <span class="hljs-title"><span lang="EN-US">fetch_command</span></span><span class="hljs-params"><span lang="EN-US">(self, subcommand)</span></span><span class="hljs-function"><span lang="EN-US">:
 """
   Tries to fetch the given subcommand, printing a message with the
    appropriate command called from the command line (usually
    "django-admin" or "manage.py") if it can't be found.
    """
    # Get commands outside of try block to prevent swallowing exceptions
    commands = get_commands()
    try:
        app_name = commands[subcommand]
    except KeyError:
        if os.environ.get('DJANGO_SETTINGS_MODULE'):
            # If `subcommand` is missing due to misconfigured settings, the
            # following line will retrigger an ImproperlyConfigured exception
            # (get_commands() swallows the original one) so the user is
            # informed about it.
            settings.INSTALLED_APPS
        else:
            sys.stderr.write("No Django settings specified.\n")
        sys.stderr.write(
            "Unknown command: %r\nType '%s help' for usage.\n"
            % (subcommand, self.prog_name)
        )
        sys.exit(1)
    if isinstance(app_name, BaseCommand):
        # If the command is already loaded, use it directly.
        klass = app_name
    else:
        klass = load_command_class(app_name, subcommand)
    return klass
</span></span>

这个fetch_command函数类似一个工厂函数，由get_commands函数扫描出所有的子命令，包括managemen中的子命令和app下的managemen中commands的子命令（自定义），然后根据传入的subcommand初始化Command类。

如果子命令不在commands字典内的话，会抛出一个“Unknown command”的提示，如果子命令存在则返回初始化的Command类。

接着视角在返回到execute函数中，接着

1
2
<span class="hljs-selector-tag"><span lang="EN-US">self</span></span><span class="hljs-selector-class"><span lang="EN-US">.fetch_command</span></span><span lang="EN-US">(</span><span class="hljs-selector-tag"><span lang="EN-US">subcommand</span></span><span lang="EN-US">)</span><span class="hljs-selector-class"><span lang="EN-US">.run_from_argv</span></span><span lang="EN-US">(</span><span class="hljs-selector-tag"><span lang="EN-US">self</span></span><span class="hljs-selector-class"><span lang="EN-US">.argv</span></span><span lang="EN-US">)
</span>

将会调用fetch_command(subcommand)初始化Command类的run_from_argv方法。run_from_argv由各个Command的基类BaseCommand定义，最终将会调用各个子类实现的handle方法。从而执行子命令的业务逻辑。

至此，命令调用的逻辑基本完成。

笔者随笔：

通过阅读这一部分的代码，其中最值得学习的地方在于fetch_commands函数，这是一个运用工厂方法的最佳实践，这样不但最大程度的解耦了代码实现，同时使得命令系统更易于扩展（App 自定义子命令就是一个很好的说明）

再有一点就是Command基类的定义，对于各种子命令的定义，基类完整的抽象出了command业务的工作逻辑，提供了统一的命令调用接口使得命令系统更易于扩展。

声 明

本安全公告仅用来描述可能存在的安全问题，绿盟科技不为此安全公告提供任何保证或承诺。由于传播、利用此安全公告所提供的信息而造成的任何直接或者间接的后果及损失，均由使用者本人负责，绿盟科技以及安全公告作者不为此承担任何责任。绿盟科技拥有对此安全公告的修改和解释权。如欲转载或传播此安全公告，必须保证此安全公告的完整性，包括版权声明等全部内容。未经绿盟科技允许，不得任意修改或者增减此安全公告内容，不得以任何方式将其用于商业目的。

关于绿盟科技

北京神州绿盟信息安全科技股份有限公司（简称绿盟科技）成立于2000年4月，总部位于北京。在国内外设有30多个分支机构，为政府、运营商、金融、能源、互联网以及教育、医疗等行业用户，提供具有核心竞争力的安全产品及解决方案，帮助客户实现业务的安全顺畅运行。

基于多年的安全攻防研究，绿盟科技在网络及终端安全、互联网基础安全、合规及安全管理等领域，为客户提供入侵检测/防护、抗拒绝服务攻击、远程安全评估以及Web安全防护等产品以及专业安全服务。

北京神州绿盟信息安全科技股份有限公司于2014年1月29日起在深圳证券交易所创业板上市交易，股票简称：绿盟科技，股票代码：300369。

如果您需要了解更多内容，可以
加入QQ群：570982169
直接询问：010-68438880

 

 

源链接

Hacking more

...