Django settings懒加载

目录

• 关于动态导入模块（importlib）
• 起步
• settings的懒加载
• 配置文件的加载
• 从setting.py配置文件到Setting类

 

---

回到顶部

关于动态导入模块（importlib）#

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

动态导入模块方法1： __import__ 说明： 　　1. 函数功能用于动态的导入模块，主要用于反射或者延迟加载模块。 　　2. __import__(module)相当于import module 举例说明： 首先创建一个模块目录lib,然后在目录内创建一个模块为：aa.py 模块代码为： class c(object):     def __str__(self):         return 'C language' 在lib目录平级新建一个测试的模块，使用 __import__ 动态以字符串形式导入lib下的aa模块。 lib = __import__('lib.aa') # 相当于import lib c = lib.aa.c() print(c)<br> 动态导入模块方法2：import importlib 实例还是上面的lib.aa模块，这里使用importlib进行动态导入（这个方法好理解，也是官方建议使用的） import importlib aa = importlib.import_module('lib.aa') c = aa.c() print(c)

回到顶部

起步#

上一篇提到过，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() 函数了。

 

回到顶部

从setting.py配置文件到Setting类#

（1）启动的时候，指定默认的配置文件

django在启动的时候，会调用manage.py文件运行server的实例，在文件一开始的时候，manage.py会调用下面代码

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

设置默认的配置文件的环境变量DJANGO_SETTINGS_MODULE，该环境变量的名称，定义在django/conf/_init.py文件里面

ENVIRONMENT_VARIABLE = "DJANGO_SETTINGS_MODULE"

（2）根据配置文件里面的配置项，提取到django/conf/_init.py里面的Setting类里面

过程主要包含两步

1. 根据DJANGO_SETTINGS_MODULE指定的配置文件调用mod = importlib.import_module(self.SETTINGS_MODULE)，将该模块import

2. 调用for setting in dir(mod)  遍历该mod的属性，将所有的大写的配置属性，提出取来，利用setattr(self, setting, setting_value)，保存为自己的属性。

 

class Settings(BaseSettings):
    def __init__(self, settings_module):
        # update this dict from global settings (but only for ALL_CAPS settings)
        for setting in dir(global_settings):
            if setting.isupper():
                setattr(self, setting, getattr(global_settings, setting))

        # store the settings module in case someone later cares
        self.SETTINGS_MODULE = settings_module

        try:
            # 根据 manage.py 中的os.environ.setdefault("DJANGO_SETTINGS_MODULE", "djtest.settings")，设置的配置文件，import该配置文件
            mod = importlib.import_module(self.SETTINGS_MODULE)
        except ImportError as e:
            raise ImportError(
                "Could not import settings '%s' (Is it on sys.path? Is there an import error in the settings file?): %s"
                % (self.SETTINGS_MODULE, e)
            )


        tuple_settings = ("INSTALLED_APPS", "TEMPLATE_DIRS")
        # setting文件里面显示申明的属性集合，是个set类型的，是个集合
        self._explicit_settings = set()
        # dir（object）返回object的属性方法列表，因此，这里dir会返回setting文件里面的所有等号左边的属性
        for setting in dir(mod):
            if setting.isupper():
                setting_value = getattr(mod, setting)

                if (setting in tuple_settings and
                        isinstance(setting_value, six.string_types)):
                    raise ImproperlyConfigured("The %s setting must be a tuple. "
                            "Please fix your settings." % setting)
                # 将setting文件里面的所有属性提出来，放到这个Setting类里面来
                setattr(self, setting, setting_value)
                self._explicit_settings.add(setting)

        if not self.SECRET_KEY:
            raise ImproperlyConfigured("The SECRET_KEY setting must not be empty.")

        if hasattr(time, 'tzset') and self.TIME_ZONE:
            # When we can, attempt to validate the timezone. If we can't find
            # this file, no check happens and it's harmless.
            zoneinfo_root = '/usr/share/zoneinfo'
            if (os.path.exists(zoneinfo_root) and not
                    os.path.exists(os.path.join(zoneinfo_root, *(self.TIME_ZONE.split('/'))))):
                raise ValueError("Incorrect timezone setting: %s" % self.TIME_ZONE)
            # Move the time zone info into os.environ. See ticket #2315 for why
            # we don't do this unconditionally (breaks Windows).
            os.environ['TZ'] = self.TIME_ZONE
            time.tzset()
            
    def is_overridden(self, setting):
        return setting in self._explicit_settings

（3）django的其他模块在使用配置文件里面的配置项的时候，就是从Setting类中获取，而不从配置文件直接获取。