Django 源码阅读(二): settings懒加载

Python 2017-11-17

起步

上一篇提到过,django 会根据不同的 subcommand 来加载不同的模块。在 django 程序的配置文件 settings.py 也能看到 INSTALLED_APPS 用来加载应用模块。而作为可能在整个 web 程序其配置作用的配置模块是如何构建的呢?

settings的懒加载

配置文件上可能会用到其他模块,那么就有可能导致循环引用。django 的配置采用了懒加载机制,或者说是延时加载。根据 from django.conf import settings 查看得知:

settings = LazySettings()

class LazySettings(LazyObject):
    def _setup(self, name=None):
        settings_module = os.environ.get(ENVIRONMENT_VARIABLE)
        self._wrapped = Settings(settings_module)

    def __getattr__(self, name):
        if self._wrapped is empty:
            self._setup(name)
        return getattr(self._wrapped, name)
    # 其他函数

所谓的延时加载,就是在需要用到的时候再加载。一般手段有代理类,线程。计时器。django 中使用 LazyObject 代理类。加载函数是 _setup 函数,当获取属性时才会去加载。

LazySettings 继承自 LazyObject 类,它重写了 __getattr____setattr__ 方法,那么在调用 settings.INSTALLED_APPS 时,会通过其自定义的 __getattr__ 方法实现,从中可以看出,所有属性都是从 self._wrapped 也就是 Settings(settings_module) 这个实例中取得的。

配置文件的加载

_setup方法从当前环境变量中获取 ENVIRONMENT_VARIABLE("DJANGO_SETTINGS_MODULE") 这个值就是 manage.py 中定义的:

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

通过 getter/setter 方法,对 settings 对象的操作转到其私有成员 self._wrapped 对象的调用上,这里在第一次使用settings对象时,将其私有成员 self._wrapped 初始化为 Settings 类实例:

class Settings(BaseSettings):
    def __init__(self, settings_module):
        for setting in dir(global_settings): # 设置默认配置
            if setting.isupper():
                setattr(self, setting, getattr(global_settings, setting))

        self.SETTINGS_MODULE = settings_module
        # 加载配置文件 settings.py
        mod = importlib.import_module(self.SETTINGS_MODULE)

        self._explicit_settings = set()
        for setting in dir(mod):    # 将用户配置的属性覆盖默认配置
            if setting.isupper():
                setting_value = getattr(mod, setting)
                setattr(self, setting, setting_value)

构造函数会先通过 global_settings 来设置其属性,接着读取 webui.settings ,设置其特定的属性,主要有 ALLOWED_INCLUDE_ROOTS、INSTALLED_APPS、TEMPLATE_DIRS、LOCALE_PATHS 这几个key,默认都是空元组,这几个key的解释如下:

  • ALLOWED_INCLUDE_ROOTS,它表示嵌入文件根路径的字符串——只有在某字符串存在于该元组的情况下,Django的 {% ssi %} 模板标签才会嵌入以其为前缀的文件。 这样做是出于安全考虑,从而使模板作者不能访问到他们不该访问的文件。
  • INSTALLED_APPS,它表示项目中哪些 app 处于激活状态。元组中的字符串,除了django默认自带的命令之外,就是我们自己定义的app,也就是用python manage.py所启动的app了。
  • TEMPLATE_DIRS,它表示模板文件的处处路径。
  • LOCALE_PATHS,它表示Django将在这些路径中查找包含实际翻译文件的 <locale_code>/LC_MESSAGES 目录

代码中,使用 importlib.import_module 来加载用户自定义的配置模块,完成全局实例的初始化。实例化后,配置懒加载也就完成了,程序就回到 execute 函数,接下去就是运行 django.setup() 函数了。


本文由 hongweipeng 创作,采用 知识共享署名 3.0,可自由转载、引用,但需署名作者且注明文章出处。

如果对您有用,您的支持将鼓励我继续创作!