【一】Django配置文件介绍#

Django框架默认提供给我们一个配置文件
在我们项目根目录下的 setting.py 文件中，在里面我们可以看到很多的配置项
并且我们能够自主的添加相应的配置
但是其实这个文件只是Django暴露出来给我们的一个接口文件，在Django内部还存在一个更加强大的配置文件

1
# Django项目暴露出来，我们可以自主修改的配置文件
2
from 项目名 import settings
3

4
# Django内置的配置文件(用户不指定的前提下，使用默认的配置)
5
from django.conf import settings

【二】配置文件的优先级#

当我们不对配置文件进行额外的配置修改时，项目会使用默认的配置文件
当我们在自定义的配置文件中修改了相关配置后，项目就会使用自定义的配置

1
# 比如 在项目目录下的配置文件中有一个配置项
2
# 这个配置的配置项含义是，当前项目所使用的语言为英文
3
# 在Django的后台登录上游很好的展现，我们看到的提示信息都是英文的
4
LANGUAGE_CODE = 'en-us'

1
# 但是其实在Django的默认配置文件中我们可以看到这个配置项还有很多其他的选择
2
# from django.conf.settings import global_settings
3

4
LANGUAGE_CODE = 'en-us'
5

6
# Language code for this installation. All choices can be found here:
7
# http://www.i18nguy.com/unicode/language-identifiers.html
8
# Languages we provide translations for, out of the box.
9
LANGUAGES = [
10
    ('af', gettext_noop('Afrikaans')),
11
    ('ar', gettext_noop('Arabic')),
12
    ('ar-dz', gettext_noop('Algerian Arabic')),
13
    ('ast', gettext_noop('Asturian')),
14
    ('az', gettext_noop('Azerbaijani')),
15
    ('bg', gettext_noop('Bulgarian')),
16
    ('be', gettext_noop('Belarusian')),
17
    ('bn', gettext_noop('Bengali')),
18
    ('br', gettext_noop('Breton')),
19
    ('bs', gettext_noop('Bosnian')),
20
    ('ca', gettext_noop('Catalan')),
21
    ('cs', gettext_noop('Czech')),
22
    ('cy', gettext_noop('Welsh')),
23
    ('da', gettext_noop('Danish')),
24
    ('de', gettext_noop('German')),
25
    ('dsb', gettext_noop('Lower Sorbian')),
26
    ('el', gettext_noop('Greek')),
27
    ('en', gettext_noop('English')),
28
    ('en-au', gettext_noop('Australian English')),
29
    ('en-gb', gettext_noop('British English')),
30
    ('eo', gettext_noop('Esperanto')),
31
    ('es', gettext_noop('Spanish')),
32
    ('es-ar', gettext_noop('Argentinian Spanish')),
33
    ('es-co', gettext_noop('Colombian Spanish')),
34
    ('es-mx', gettext_noop('Mexican Spanish')),
35
    ('es-ni', gettext_noop('Nicaraguan Spanish')),
36
    ('es-ve', gettext_noop('Venezuelan Spanish')),
37
    ('et', gettext_noop('Estonian')),
38
    ('eu', gettext_noop('Basque')),
39
    ('fa', gettext_noop('Persian')),
40
    ('fi', gettext_noop('Finnish')),
41
    ('fr', gettext_noop('French')),
42
    ('fy', gettext_noop('Frisian')),
43
    ('ga', gettext_noop('Irish')),
44
    ('gd', gettext_noop('Scottish Gaelic')),
45
    ('gl', gettext_noop('Galician')),
46
    ('he', gettext_noop('Hebrew')),
47
    ('hi', gettext_noop('Hindi')),
48
    ('hr', gettext_noop('Croatian')),
49
    ('hsb', gettext_noop('Upper Sorbian')),
50
    ('hu', gettext_noop('Hungarian')),
51
    ('hy', gettext_noop('Armenian')),
52
    ('ia', gettext_noop('Interlingua')),
53
    ('id', gettext_noop('Indonesian')),
54
    ('ig', gettext_noop('Igbo')),
55
    ('io', gettext_noop('Ido')),
56
    ('is', gettext_noop('Icelandic')),
57
    ('it', gettext_noop('Italian')),
58
    ('ja', gettext_noop('Japanese')),
59
    ('ka', gettext_noop('Georgian')),
60
    ('kab', gettext_noop('Kabyle')),
61
    ('kk', gettext_noop('Kazakh')),
62
    ('km', gettext_noop('Khmer')),
63
    ('kn', gettext_noop('Kannada')),
64
    ('ko', gettext_noop('Korean')),
65
    ('ky', gettext_noop('Kyrgyz')),
66
    ('lb', gettext_noop('Luxembourgish')),
67
    ('lt', gettext_noop('Lithuanian')),
68
    ('lv', gettext_noop('Latvian')),
69
    ('mk', gettext_noop('Macedonian')),
70
    ('ml', gettext_noop('Malayalam')),
71
    ('mn', gettext_noop('Mongolian')),
72
    ('mr', gettext_noop('Marathi')),
73
    ('my', gettext_noop('Burmese')),
74
    ('nb', gettext_noop('Norwegian Bokmål')),
75
    ('ne', gettext_noop('Nepali')),
76
    ('nl', gettext_noop('Dutch')),
77
    ('nn', gettext_noop('Norwegian Nynorsk')),
78
    ('os', gettext_noop('Ossetic')),
79
    ('pa', gettext_noop('Punjabi')),
80
    ('pl', gettext_noop('Polish')),
81
    ('pt', gettext_noop('Portuguese')),
82
    ('pt-br', gettext_noop('Brazilian Portuguese')),
83
    ('ro', gettext_noop('Romanian')),
84
    ('ru', gettext_noop('Russian')),
85
    ('sk', gettext_noop('Slovak')),
86
    ('sl', gettext_noop('Slovenian')),
87
    ('sq', gettext_noop('Albanian')),
88
    ('sr', gettext_noop('Serbian')),
89
    ('sr-latn', gettext_noop('Serbian Latin')),
90
    ('sv', gettext_noop('Swedish')),
91
    ('sw', gettext_noop('Swahili')),
92
    ('ta', gettext_noop('Tamil')),
93
    ('te', gettext_noop('Telugu')),
94
    ('tg', gettext_noop('Tajik')),
95
    ('th', gettext_noop('Thai')),
96
    ('tk', gettext_noop('Turkmen')),
97
    ('tr', gettext_noop('Turkish')),
98
    ('tt', gettext_noop('Tatar')),
99
    ('udm', gettext_noop('Udmurt')),
100
    ('uk', gettext_noop('Ukrainian')),
101
    ('ur', gettext_noop('Urdu')),
102
    ('uz', gettext_noop('Uzbek')),
103
    ('vi', gettext_noop('Vietnamese')),
104
    ('zh-hans', gettext_noop('Simplified Chinese')),
105
    ('zh-hant', gettext_noop('Traditional Chinese')),
106
]
107

108
# 我们可以将默认的 en-us 替换成 zh-hans
109
# 这样我们在看到Django的提示信息的时候就会发现变成了简体中文

【三】配置文件的包含关系#

在项目根目录下的配置文件存在的配置项，在项目的全局配置文件中肯定也有
但是在项目的全局配置文件中有的配置项，项目根目录下的配置文件未必有

【四】正确的配置文件使用#

1
# 我们如果在Django项目的其他位置想要试用Django的配置文件，最正确的导入方式应该是
2

3
from django.conf import settings
4

5
# 这样导入的配置文件我们既可以使用自定义的，也可以使用全局默认的配置

【五】settings源码剖析#

【1】入口#

我们通过导入全局的配置文件，从全局的配置文件进入到源码中

1
from django.conf import settings

【2】settings其实是一个对象#

我们可以看到在源码的最后一行是 settings = LazySettings()
也就是说，我们当前使用的 settings 其实是 LazySettings 类产生的一个对象

【3】剖析LazySettings#

剖析源码时，我们应该只剖析我们想要的核心部分，而不是所有源码都进行解读
如果把所有源码都解读一遍，只会让我们的精力大大消耗掉

1
class LazySettings(LazyObject):
2

3
    def _setup(self, name=None):
4
        # 在这里我们可以看到 通过项目环境变量获取到了键为 ENVIRONMENT_VARIABLE 的值
5
        # os.environ ： 当前项目的环境变量
6
        # ENVIRONMENT_VARIABLE ： 在上面有
7
        # ENVIRONMENT_VARIABLE = "DJANGO_SETTINGS_MODULE"
8
        # DJANGO_SETTINGS_MODULE 在哪里能看到呢？，其实就是在我们项目文件 manage.py 中
9
        # os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'BulletinBoardSystem.settings')
10
        settings_module = os.environ.get(ENVIRONMENT_VARIABLE)
11

12
        # 入股没有加载到配置文件就会抛出异常
13
        if not settings_module:
14
            desc = ("setting %s" % name) if name else "settings"
15
            raise ImproperlyConfigured(
16
                "Requested %s, but settings are not configured. "
17
                "You must either define the environment variable %s "
18
                "or call settings.configure() before accessing settings."
19
                % (desc, ENVIRONMENT_VARIABLE))
20
        # 将获取到的本地配置文件的路径传给 Settings 实例化得到一个对象
21
        self._wrapped = Settings(settings_module)

manage.py

1
"""Django's command-line utility for administrative tasks."""
2
import os
3
import sys
4

5

6
def main():
7
    """Run administrative tasks."""
8
    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'BulletinBoardSystem.settings')
9
    try:
10
        from django.core.management import execute_from_command_line
11
    except ImportError as exc:
12
        raise ImportError(
13
            "Couldn't import Django. Are you sure it's installed and "
14
            "available on your PYTHONPATH environment variable? Did you "
15
            "forget to activate a virtual environment?"
16
        ) from exc
17
    execute_from_command_line(sys.argv)
18

19

20
if __name__ == '__main__':
21
    main()

【4】剖析Settings#

1
class Settings:
2
    def __init__(self, settings_module):
3
        # settings_module ： 是本地的项目配置文件路径
4
        # settings_module : 项目名.settings.py
5

6
        # 获取全局配置文件中所有的变量名
7
        for setting in dir(global_settings):
8
            # 校验变量名是否是全大写
9
            # 这也是为什么在配置文件中所有的配置变量名都是大写的原因
10
            if setting.isupper():
11
                # 在配置文件变量名全大写的前提下，设置相应的属性
12
                # setting ： 当前配置的变量名
13
                # getattr(global_settings, setting) ： 在全局配置文件中反射出指定键对应的属性值
14
                setattr(self, setting, getattr(global_settings, setting))
15

16
        # 将当前项目根目录的配置文件地址添加到自己的属性中
17
        self.SETTINGS_MODULE = settings_module
18

19
        # 将配置文件路径导入成一个模块对象
20
        mod = importlib.import_module(self.SETTINGS_MODULE)
21

22
        # 声明配置变量名元祖
23
        tuple_settings = (
24
            "INSTALLED_APPS",
25
            "TEMPLATE_DIRS",
26
            "LOCALE_PATHS",
27
        )
28
        self._explicit_settings = set()
29

30
        # 遍历当前项目根目录下的所有变量名
31
        for setting in dir(mod):
32
            # 判断变量名是否为大写
33
            if setting.isupper():
34
                # 获取到变量名对应的变量值
35
                setting_value = getattr(mod, setting)

【六】案例#

【1】自定义配置文件#

conf.settings.py

1
SOME_NAME = "some_name"
2
SOME_PASSWORD = "some_password"

【2】根配置文件#

lib.conf.global_settings.py

1
GLOBAL_NAME = "base_name"
2
GLOBAL_PASSWORD = "base_password"

lib.init.py

1
import os
2
import importlib
3

4
# 包初始化文件
5

6
# 导入全局配置文件
7
from lib.conf import global_settings
8

9

10
# 导入跟录下的配置文件
11
class Settings(object):
12
    def __init__(self):
13
        # 【一】设置全局变量名和变量值
14
        # 【1】循环获取当前全局配置文件中所有的变量名
15
        for name in dir(global_settings):
16
            # 【2】判断变量名是否为大写
17
            if name.isupper():
18
                # 【3】设置全局变量名和变量值
19
                setattr(self, name, getattr(global_settings, name))
20

21
        # 【二】设置项目变量名和变量值
22
        # 【1】获取得到当前模块路径
23
        module_path = os.environ.get("PROJECT_MODAL_SETTINGS")
24
        # 【2】获取得到当前模块对象
25
        mod = importlib.import_module(module_path)
26
        # 【3】遍历获取变量名设置值
27
        for name in dir(mod):
28
            if name.isupper():
29
                setattr(self, name, getattr(mod, name))
30

31

32
settings = Settings()

【3】启动文件#

start.py

1
import os
2
import sys
3

4
sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
5

6
if __name__ == '__main__':
7
    # 设置当前根目录下的环境变量路径
8
    os.environ.setdefault("PROJECT_MODAL_SETTINGS", "conf.settings")
9
    from lib.conf import settings
10

11
    print(settings.GLOBAL_NAME)
12
    print(settings.SOME_NAME)

音乐

音乐

【一】Django配置文件介绍#

【二】配置文件的优先级#

【三】配置文件的包含关系#

【四】正确的配置文件使用#

【五】settings源码剖析#

【1】入口#

【2】settings其实是一个对象#

【3】剖析LazySettings#

【4】剖析Settings#

【六】案例#

【1】自定义配置文件#

【2】根配置文件#

【3】启动文件#

支持与分享

音乐

Django框架之settings源码

【一】Django配置文件介绍#

【二】配置文件的优先级#

【三】配置文件的包含关系#

【四】正确的配置文件使用#

【五】settings源码剖析#

【1】入口#

【2】settings其实是一个对象#

【3】剖析LazySettings#

【4】剖析Settings#

【六】案例#

【1】自定义配置文件#

【2】根配置文件#

【3】启动文件#

支持与分享