Inside Flask - 配置的实现

flask 的配置对象 app.config 本身使用很简单,无非就是以字典的形式使用,而它的实现,本身就是以字典的形式的。

flask/config.py 文件中,包含了 flask 配置的实现代码,就两个类 ConfigAttribute 和 Config 。

ConfigAttribute 表示一个配置属性,它的代码只有简单几行,但由于使用了 descriptor 模式,对 python 不熟悉的人不容易理解。先看看 descriptor 是个什么东西。

descriptor 属于 python 元编程方面的概念(即是对编程的编程,%>_<%),本质上是提供一种编程的协议,也就是制定某种框架供业务编程时使用(像 C# / java 的反射也属于元编程范畴)。由于动态语言的特性,元编程在 python 里面实现起来非常简单。作为 descriptor 的对象,它提供的描述属性的协议,它需要实现 __get__ __set____delete__,来描述某个某个对象(被描述对象)应该如何获取数据、设置数据和删除对象。

现在再来看看 ConfigAttribute 类 ::

class ConfigAttribute(object):
"""Makes an attribute forward to the config""" def __init__(self, name, get_converter=None):
self.__name__ = name
self.get_converter = get_converter def __get__(self, obj, type=None):
if obj is None:
return self
rv = obj.config[self.__name__]
if self.get_converter is not None:
rv = self.get_converter(rv)
return rv def __set__(self, obj, value):
obj.config[self.__name__] = value

这里的约定是定义 ConfigAttribute 的对象里,应该包含一个 config 字典,然后取值或设置值时,改为取或设置 config 中对应的 key 的值(在 flask 的 Flask 类里面,包含 config,类型就是接下来要看的 Config 类)。

Config 类继承 dict ,就是一个保存了 ConfigAttribute 的字典 ::

class Config(dict):
...

同时,Config 类提供几个加载配置的方法,分别是 ::

from_envvar(...)    # 从环境变量读取所要加载的 py 文件路径,然后用 from_pyfile 加载
from_pyfile(...) # 从 py 文件中加载文件,然后用 from_object 加载
from_object(...) # 从对象加载,把 dir(obj) 中,名字是大写的数据载入到 self
from_json(...) # 从 json 文件加载,然后调用 from_mapping 加载
from_mapping(...) # 从多个字典,或 **kwargs 形式的参数,且名字是大写的数据加载到 self

在加载文件时,可以使用该 flask 应用内的相对路径(见下文),或者是使用绝对路径,代码在处理时,都用 ::

filename = os.path.join(self.root_path, filename)

当文件为相对路径时,就会用当前 flask app 的路径结合相对路径来定位文件。

Config 中的配置有个 namespace 的概念,通过下划线对参数进行分类,方便一次获取多个配置项 ::

def get_namespace(self, namespace, lowercase=True, trim_namespace=True):
"""Returns a dictionary containing a subset of configuration options
that match the specified namespace/prefix. Example usage:: app.config['IMAGE_STORE_TYPE'] = 'fs'
app.config['IMAGE_STORE_PATH'] = '/var/app/images'
app.config['IMAGE_STORE_BASE_URL'] = 'http://img.website.com'
image_store_config = app.config.get_namespace('IMAGE_STORE_') The resulting dictionary `image_store_config` would look like:: {
'type': 'fs',
'path': '/var/app/images',
'base_url': 'http://img.website.com'
}

从源代码层面看,这里有几点是需要注意的:(1)最后起作用的 from_objectfrom_mapping,其它几个是做预处理;(2)配置的 key 应该是大写的,然后以下划线做分隔

OK,现在看看 flask 里面怎样使用配置。

首先在 flask/app.py 里面,Flask 类代码中包含了一个 config_class ,它默认就是 Config 类。然后 config 属性通过 make_config 生成 ::

self.config = self.make_config(instance_relative_config)

make_config 的代码如下 ::

def make_config(self, instance_relative=False):
"""Used to create the config attribute by the Flask constructor.
The `instance_relative` parameter is passed in from the constructor
of Flask (there named `instance_relative_config`) and indicates if
the config should be relative to the instance path or the root path
of the application. .. versionadded:: 0.8
"""
root_path = self.root_path
if instance_relative:
root_path = self.instance_path
return self.config_class(root_path, self.default_config)

这里有个概念是 instance_relative 的配置,即与实例相关的配置。如果在一个应用里面用到了几个 flask app ,并且这些 app 的配置不一样时,就要用到实例相关的配置,将当前的 root_path 设置为初始化 flask app 时的参数 instance_path(可自由设置)。

self.default_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,
...
})

而使用到 ConfigAttribute 的几个代码如下 ::

debug = ConfigAttribute('DEBUG')
...
testing = ConfigAttribute('TESTING')
...

flask 设置完配置项后,用户可根据自己的需要,用操作字典的方式修改、更新配置 ::

app.config.update({'DEBUG': False})
app.config.from_object(config_obj)
app.config.setdefault('DEBUG', False)
...

Inside Flask - 配置的实现的更多相关文章

  1. Inside Flask - json 处理

    Inside Flask - json 处理 在处理 web api 时,json 是非常好用的数据交换格式,它结构简单,基本上各种主流的编程语言都有良好的支持工具. flask 中处理 json 时 ...

  2. Inside Flask - app.py - 2

    Inside Flask - app.py - 2 Flask 初始化参数 Flass 类是 Flask 框架的核心,一个 flask 对象处理视图函数注册.URL规则.模板配置.参数设置等等. 一般 ...

  3. Inside Flask - app.py - 1

    Inside Flask - app.py - 1 除 werkzeug 和 jinja2 等依赖库外,app.py 是在 Flask 的 __init__.py 中导入的第一个 Flask 自身的模 ...

  4. Inside Flask - signal 信号机制

    Inside Flask - signal 信号机制 singal 在平常的 flask web 开发过程中较少接触到,但对于使用 flask 进行框架级别的开发时,则必须了解相关的工作机制.flas ...

  5. Inside Flask - globals 全局变量(对象代理)

    Inside Flask - globals 全局变量(对象代理) 框架是一个容器,在框架内编程,一般是要遵守框架的约定和使用模式.通常这样的模式是 IoC,即由框架调用用户的代码,而不是用户调用框架 ...

  6. Inside Flask - flask 扩展加载过程

    Inside Flask - flask 扩展加载过程 flask 扩展(插件)通常是以 flask_<扩展名字> 为扩展的 python 包名,而使用时,可用 import flask. ...

  7. Inside Flask - flask.__init__.py 和核心组件

    Inside Flask - flask.__init__.py 和核心组件 简单的示例 首先看看一个简单的示例.使用 Flask ,通常是从 flask 模块导入 Flask . request 等 ...

  8. Inside Flask - Flask 简介

    Inside Flask - Flask 简介 前言 Flask 的设计目标是实现一个 wsgi 的微框架,其核心代码保持简单和可扩展性,很容易学习.对于有一定经验初学者而言,跟着例子和一些书的代码来 ...

  9. 第八篇 Flask配置

    Flask 是一个非常灵活且小而精的web框架 , 那么灵活性从什么地方体现呢? 列如  Flask配置,这个东西怎么用呢? 它能给我们带来怎么样的方便呢? app配置 首先展示一下: from fl ...

随机推荐

  1. Redis内存缓存系统入门

    网站:http://redis.io/ key-value cache and store    data structure server 1. 服务器端 1.1 安装 下载安装包:http://r ...

  2. Prime & 反素数plus

    题意: 求因数个数为n的最小正整数k. n<=10^9输出其唯一分解形式 SOL: 模拟题,一眼看过去有点惊讶...这不是我刚看过的反素数吗... 咦数据怎么这么大,恩搞个高精吧... 于是T了 ...

  3. ACM: POJ 3259 Wormholes - SPFA负环判定

     POJ 3259 Wormholes Time Limit:2000MS     Memory Limit:65536KB     64bit IO Format:%lld & %llu   ...

  4. 野路子土鳖ASP.NETer谈互联网的发展趋势

    有些话别在憋在心里太久了,容易伤身体,总得找个借口吐槽一下,今日不小心看到园有关于互联网发函趋势的文章,作为一名ASP.NET程序员,自然要说说什么是趋势,机会找到了,好高兴. http://zzk. ...

  5. 简单图解设置MYSQL可以通过其他机器远程访问,开启远程访问权限

    开始,运行---cmd,然后cd到mysql.exe目录,然后照着下图红色框中输入 注意: 1.MySQL 5.7查询时候应该输入select host,user,authentication_str ...

  6. 【noiOJ】p8208

    03:切分矩形组 查看 提交 统计 提问 总时间限制:  1000ms 内存限制:  65536kB 描述 给定若干个平行于坐标轴的互不重叠的矩形,矩形的顶点都是整点.要求画一根平行于y轴的直线x=k ...

  7. C语言工具---Code::Blocks

    Code::Blocks Code::Blocks 是一个开源的全功能的跨平台C/C++集成开发环境. Code::Blocks是开放源码软件.由纯粹的C++语言开发完成,它使用了著名的图形界面库wx ...

  8. 深入浅出 - Android系统移植与平台开发(五)- 定制手机模拟器ROM

    一. 修改化定制Android4.0系统 Android系统启动时,先加载Linux内核,在Linux的framebuffer驱动里可以定制开 机界面,Linux内核启动成功后,挂载根文件系统,启动A ...

  9. JS中常遇到的浏览器兼容问题和解决方法【转】

    今天整理了一下浏览器对JS的兼容问题,希望能给你们带来帮助,我没想到的地方请留言给我,我再加上: 常遇到的关于浏览器的宽高问题: //以下均可console.log()实验 var winW=docu ...

  10. wamp下多域名配置

    1.找到wamp安装目录的apache安装目录 找到 httpd.conf文件 例如我安装的目录为 E:\wamp\bin\apache\apache2.2.8\conf\httpd.conf 也可以 ...