django manage.py command处理流程分析

首先要弄明白,manage.py运行的每一个命令都是去运行django/core/management/commands/ 目录下以这个命令命名的.py文件,这个文件中有一个继承basecommand的command类,最后这命令运行的其实就是command类的handle函数。我们如果自己想添加一个command,那么也只要在即的project中创建一个management/commands/包, 包下面是我们的以命令+.py够成的文件,这个文件中有一个继承basecommand的command类,然后有一个实现自己的处理逻辑的handle函数就好了。

django项目中的manage.py  command,他会执行manage.py中的execute_from_command_line函数

if __name__ == "__main__":

    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testdjango.settings")

    """

    中间忽略

    """

    execute_from_command_line(sys.argv)

而关于execute_from_command_line函数

def execute_from_command_line(argv=None):

    """

    A simple method that runs a ManagementUtility.

    """

    utility = ManagementUtility(argv)

    utility.execute()

这里重点是ManagementUtility.execute函数,它主要是对输入的参数命令进行拆分和验证,然后调用ManagementUtility.fetch_command去调用ManagementUtility.load_command_class获取要执行的command类,也就是定义在django/core/management/commands/目录下的命令文件中的command类。

然后开始执行self.fetch_command(subcommand).run_from_argv(self.argv),即command(继承自BaseCommand)类的run_from_argv函数,这个函数会去执行目录下的对应命令文件的command类的execute函数,这个函数最终将执行output = self.handle(*args, **options),也就是在command类的handle函数。因此,这里我们就可以在django/core/management/commands包类找到对应的命令文件,去跟踪对应的handle函数,然后去查看对应的handle函数执行就可以了。

现在我们以manage.py runserver为例:

我们查看django/core/management/commands/runserver.py中的handle函数即可

def handle(self, *args, **options):

    from django.conf import settings

    if not settings.DEBUG and not settings.ALLOWED_HOSTS:

        raise CommandError('You must set settings.ALLOWED_HOSTS if DEBUG is False.')

    """

    中间做一些配置检查,环境的准备,细节省略

    """

    self.run(**options)

这里重点关注run函数,run函数调用inner_run(),在inner_run中重点关注以下代码块:

try:

    handler = self.get_handler(*args, **options) #这个handler其实就一个get_uwsgi_application返回的application对象

    run(self.addr, int(self.port), handler,   

    ipv6=self.use_ipv6, threading=threading)

except socket.error as e:

首先通过get_handler获取一个处理request请求的uwsgi对象(这个在django正式应用环境中,写在了项目的wsgi.py中的)。然后调用django/core/servers/basehttps.py中的run方法(在runserver.py的顶层中可以看到这样的语句from django.core.servers.basehttp import get_internal_wsgi_application, run)。

django/core/servers/basehttps.py的这个run方法首先会去创建一个TCPServer来代替apache或者nginx作为web服务器的作用,去监听端口,(我们知道,web服务器的作用就是监听端口,接收、管理请求数据,并返回相应数据)。apache,ngnix等web服务器是一个在应用层的采用http协议进行数据传输的应用,他的下层还是一个基于tcp的socket server,所以内部服务器使用socket server作为web服务器。源码如下:

def run(addr, port, wsgi_handler, ipv6=False, threading=False):

    server_address = (addr, port)

    if threading:

        httpd_cls = type(str('WSGIServer'), (socketserver.ThreadingMixIn, WSGIServer), {})

    else:

        httpd_cls = WSGIServer

    httpd = httpd_cls(server_address, WSGIRequestHandler, ipv6=ipv6)

    if threading:

        httpd.daemon_threads = True

    httpd.set_app(wsgi_handler)

    httpd.serve_forever()

首先创建一个WSGIServer,关于创建这个WSGIServer需要特别关注一个参数,那就是WSGIRequestHandler,这个WSGIRequestHandler在最后的调用process_response()的时候会用到,而run函数里面的wsgi_handler,其实就是get_uwsgi_application返回的uwsgi对象。这个在最后也会用到。

接下来就到了serve_forever函数,serve_forever调用select模型监听,如果有请求到来,就执行_handle_request_noblock(),真正的执行是

process_request() -> finish_request -> RequestHandlerClass,注意了,这个RequestHandlerClass就是在创建socket server的时候传递的参数WSGIRequestHandler,也就是django/core/servers/basehttps.py中的WSGIRequestHandler类。

WSGIRequestHandler会去调用自己的handle函数,为什么会去调用自己的handle函数呢,我们看源码。


class BaseRequestHandler:

"""Base class for request handler classes."""

    def __init__(self, request, client_address, server):

    self.request = request

    self.client_address = client_address

    self.server = server

    self.setup()

    try:

         self.handle()

    finally:

        self.finish()

上面贴出的源码是BaseRequestHandler类,它在__init__函数中调用了handle函数。但是这跟WSGIRequestHandler有什么关系,现在是要WSGIRequestHandler去调用它的handle函数。其实我们从BaseRequestHandler的继承关系中是可以看到,BaseRequestHandler最终继承自BaseRequestHandler类,这个类在它的__init__函数中调用了handle函数,这个我们可以在上面贴出的源码中可以看到。也就是在实例化WSGIRequestHandler的最后会调用handle函数。那关于WSGIRequestHandler类的handle函数,其源码如下:

def handle(self):

    """Copy of WSGIRequestHandler, but with different ServerHandler"""

    self.raw_requestline = self.rfile.readline(65537)

    """

    中间省略

    """

    handler = ServerHandler(

    self.rfile, self.wfile, self.get_stderr(), self.get_environ()

    )

    handler.request_handler = self      # backpointer for logging

    handler.run(self.server.get_app())

handle函数里面调用ServerHandler.run,run函数的源码如下:

def run(self, application):

    """Invoke the application"""

    """

    中间忽略

    """

    self.setup_environ()

    self.result = application(self.environ, self.start_response)


run函数的关键就看self.result = application(self.environ, self.start_response),而这里的application就是传进来的wsgi_handler,他是一个具有__call__函数的实例,所以application()就会调用自身的__call__()函数,这个就到了django服务在正式环境中对url请求的处理流程了。详见《django框架在正式环境中的请求处理流程分析www.jianshu.com/writer#/notebooks/14133407/notes/14482608》

你可能感兴趣的:(django manage.py command处理流程分析)