Inside Flask - app.py - 1

Inside Flask - app.py - 1

除 werkzeug 和 jinja2 等依赖库外，app.py 是在 Flask 的 __init__.py 中导入的第一个 Flask 自身的模块。 app.py 的注释中已明确说明这个模块的作用：

flask.app
~~~~~~~~~

This module implements the central WSGI application object.

依赖分析

在这个模块中，导入了 Flask 中的其它工具模块，并组合起来实现所需的功能，包括：

1. 内置模块

   app.py 导入了以下的内置模块

    import os
    import sys
    from threading import Lock
    from datetime import timedelta
    from itertools import chain
    from functools import update_wrapper
   

   线程锁 Lock 用在日志初始化（行 40 ，579）和第一次请求时回调用已注册在 before_first_request_funcs 的函数（行 499 ，1492）

   timedelta 用来处理 Flask 中和时间相关的配置信息（行 220），一般以秒为单位。

   chain 处理可迭代变量，如多个函数列表的合并等（行 713）。

   update_wrapper 是个函数装饰器工具，让函数看起来过像是原来的函数，可跳转到代码看看它的实现。

2. 依赖库模块

   从 werkzeug 导入了一些简单的类工具

    from werkzeug.datastructures import ImmutableDict
    from werkzeug.routing import Map, Rule, RequestRedirect, BuildError
    from werkzeug.exceptions import HTTPException, InternalServerError, \
         MethodNotAllowed, BadRequest
   

   后面在涉及到代码时再分析。

3. Flask 其它工具模块

   基本上把其它的工具模块都导了进来，并整合到 Flask 类中，这些后面涉及到时再分析。

代码分析

这个模块中包含 _make_timedelta setupmethod Flask 3 个 object。

1. _make_timedelta

   这只是一个简单的工具函数，把数字当作秒数，并转换为 datetime.timedelta。

2. setupmethod

   它是个装饰器，用来标记一个函数是 setup 函数。为了提高代码的规范性，它要求被装饰的函数，如 register_blueprint 等，只允许未有任务请求前调用。在 debug 状态下，如果已经有 URL 被请求过，此时再执行这类函数，就会抛出异常。

   它的作用在于，提示开发者，别做出在类似于在飞机飞行途中更换引擎的危险行为。但是如果非要这样做，那么它也没有阻止你，在非 debug 下调用这类 setup 函数并不会抛出异常，但记住，后果自负。

3. Flask 类

   Flask 类可能是 Flask 里面最大最复杂的类。 Flask 类的代码从 66 行到 1842 行，一共 1776 行。整个 Flask 的源代码才 5374 行，而 Flask 类已经占了 1/3 ！

   但不要担心，在去掉了注释和 docstring 后，统计出来的代码并不多，只有 794 行！！ ::

    sed -e '/^[[:space:]]*#/d' -e '/""".*"""/d' \
        -e '/"""/,/"""/d' app.py | wc -l
   

   真让人激动，这 794 行的代码里隐藏着怎样的秘密 _。

   Flask 类里面的方法较多，大体上分成几类：

   1. 配置处理
   2. 模板处理
   3. 会话管理
   4. 路由
   5. blueprint 扩展
   6. 回调函数管理
   7. 上下文管理
   8. 错误和异常处理
   9. wsgi 和请求分发
   10. 测试支持

   后续逐个分析相关的功能的设计。