源码解析Flask的配置文件

在flask里,我们常在主文件中定义某些配置,比如:
app.debug = True
app.secret_key = 'helloworld!!'

实际上,flask中默认可以进行可选的配置项有很多。
如果在开发的过程中,把所有需要的配置项都定义在主文件中,就会造成整个程序的目录结构不合理,
如果需要重写的flask配置项很多的时候,就可以把配置项用别的方式进行定义,然后导入使用

flask的配置文件是一个flask.config.Config对象

导入Config对象,可以发现Config对象继承字典,

Config默认的配置有:
default_config = ImmutableDict({
    'DEBUG':                                get_debug_flag(default=False),
    'TESTING':                              False,
    'PROPAGATE_EXCEPTIONS':                None,
    'PRESERVE_CONTEXT_ON_EXCEPTION':        None,
    'SECRET_KEY':                          None,
    'PERMANENT_SESSION_LIFETIME':          timedelta(days=31),
    'USE_X_SENDFILE':                      False,
    'LOGGER_NAME':                          None,
    'LOGGER_HANDLER_POLICY':              'always',
    'SERVER_NAME':                          None,
    'APPLICATION_ROOT':                    None,
    'SESSION_COOKIE_NAME':                  'session',
    'SESSION_COOKIE_DOMAIN':                None,
    'SESSION_COOKIE_PATH':                  None,
    'SESSION_COOKIE_HTTPONLY':              True,
    'SESSION_COOKIE_SECURE':                False,
    'SESSION_REFRESH_EACH_REQUEST':        True,
    'MAX_CONTENT_LENGTH':                  None,
    'SEND_FILE_MAX_AGE_DEFAULT':            timedelta(hours=12),
    'TRAP_BAD_REQUEST_ERRORS':              False,
    'TRAP_HTTP_EXCEPTIONS':                False,
    'EXPLAIN_TEMPLATE_LOADING':            False,
    'PREFERRED_URL_SCHEME':                'http',
    'JSON_AS_ASCII':                        True,
    'JSON_SORT_KEYS':                      True,
    'JSONIFY_PRETTYPRINT_REGULAR':          True,
    'JSONIFY_MIMETYPE':                    'application/json',
    'TEMPLATES_AUTO_RELOAD':                None,
})

通过查看Config对象的源码,可以知道flask的配置可以有以下几种方式

1.在主文件中定义(通常使用的方式)
app.debug = True
app.secret_key = 'helloworld!!'


由于Config对象继承了dict的方法和属性,所以还可以使用app.config.update(配置项)的方式导入配置项

2.从环境变量中导入配置项

导入配置项的方式:
app.config.from_envvar("环境变量名称")

from_envvar方法的源码:
def from_envvar(self, variable_name, silent=False):
   
    rv = os.environ.get(variable_name)
    if not rv:
        if silent:
            return False
        raise RuntimeError('The environment variable %r is not set '
                          'and as such configuration could not be '
                          'loaded.  Set this variable and make it '
                          'point to a configuration file' %
                          variable_name)
    return self.from_pyfile(rv, silent=silent)

可以看到,从环境变量中导入配置项的方法,就是从环境变量中找到并读取对应的py文件名称,然后内部调用from_pyfile方法处理读取到的内容得到配置

3.从Python文件中导入

从python文件中获取配置项的方式:
app.config.from_pyfile("python文件名称")

例如,创建一个名为setting.py的文件

setting.py文件的内容为:
DEBUG=True

然后使用app.config.from_pyfile("setting.py")的方式导入配置项

from_pyfile方法的源码:
def from_pyfile(self, filename, silent=False):

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/649cf92f761fe7aa627705494ff4e734.html