New in version 0.3.

配置入门¶

config 实质上是一个字典的子类，可以像字典一样操作:

app = Flask(__name__)
app.config['DEBUG'] = True

某些配置值还转移到了 Flask 对象中，可以直接通过 Flask 来操作:

app.debug = True

一次更新多个配置值可以使用 dict.update() 方法:

app.config.update(
    DEBUG=True,
    SECRET_KEY='...'
)

内置配置变量¶

以下配置变量由 Flask 内部使用：

使用配置文件¶

如果把配置放在一个单独的文件中会更有用。理想情况下配置文件应当放在应用包的 外面。这样可以在修改配置文件时不影响应用的打包与分发（ 使用 Distribute 部署 ）。

因此，常见用法如下:

app = Flask(__name__)
app.config.from_object('yourapplication.default_settings')
app.config.from_envvar('YOURAPPLICATION_SETTINGS')

首先从 yourapplication.default_settings 模块载入配置，然后根据 YOURAPPLICATION_SETTINGS 环境变量所指向的文件的内容重载配置的值。在 启动服务器前，在 Linux 或 OS X 操作系统中，这个环境变量可以在终端中使用 export 命令来设置:

$ export YOURAPPLICATION_SETTINGS=/path/to/settings.cfg
$ python run-app.py
 * Running on http://127.0.0.1:5000/
 * Restarting with reloader...

在 Windows 系统中使用内置的 set 来代替:

>set YOURAPPLICATION_SETTINGS=pathtosettings.cfg

配置文件本身实质是 Python 文件。只有全部是大写字母的变量才会被配置对象所使用。 因此请确保使用大写字母。

一个配置文件的例子:

# 配置示例
DEBUG = False
SECRET_KEY = '?xbf,xb4x8dxa3"<x9cxb0@x0f5xab,wxeex8d$0x13x8b83'

请确保尽早载入配置，以便于扩展在启动时可以访问相关配置。除了从文件载入配置外， 配置对象还有其他方法可以载入配置，详见 Config 对象的文档。

配置的最佳实践¶

前述的方法的缺点是测试有一点点麻烦。通常解决这个问题没有标准答案，但有些好的 好的建议：

1. 在一个函数中创建你的应用并注册“蓝图”。这样就可以使用不同配置创建多个 实例，极大方便单元测试。你可以按需载入配置。
2. 不要编写在导入时就访问配置的代码。如果你限制自己只能通过请求访问代码，那么 你可以以后按需配置对象。

开发/生产¶

大多数应用需要一个以上的配置。最起码需要一个配置用于生产服务器，另一个配置用于 开发。应对这种情况的最简单的方法总是载入一个缺省配置，并把这个缺省配置作为版本 控制的一部分。然后，把需要重载的配置，如前文所述，放在一个独立的文件中:

app = Flask(__name__)
app.config.from_object('yourapplication.default_settings')
app.config.from_envvar('YOURAPPLICATION_SETTINGS')

然后你只要增加一个独立的 config.py 文件并导出 YOURAPPLICATION_SETTINGS=/path/to/config.py 就可了。当然还有其他方法可选， 例如可以使用导入或子类。

在 Django 应用中，通常的做法是在文件的开关增加 from yourapplication.default_settings import * 进行显式地导入，然后手工重载 配置。你还可以通过检查一个 YOURAPPLICATION_MODE 之类的环境变量（变量值设置 为 production 或 development 等等）来导入不同的配置文件。

一个有趣的方案是使用类和类的继承来配置:

class Config(object):
    DEBUG = False
    TESTING = False
    DATABASE_URI = 'sqlite://:memory:'

class ProductionConfig(Config):
    DATABASE_URI = 'mysql://user@localhost/foo'

class DevelopmentConfig(Config):
    DEBUG = True

class TestingConfig(Config):
    TESTING = True

如果要使用这样的方案，那么必须使用 from_object():

app.config.from_object('configmodule.ProductionConfig')

配置的方法多种多样，由你定度。以下是一些建议：

• 在版本控制中保存一个缺省配置。要么在应用中使用这些缺省配置，要么先导入缺省 配置然后用你自己的配置文件来重载缺省配置。
• 使用一个环境变量来切换不同的配置。这样就可以在 Python 解释器外进行切换，而 根本不用改动代码，使开发和部署更方便，更快捷。如果你经常在不同的项目间 切换，那么你甚至可以创建代码来激活 virtualenv 并导出开发配置。
• 在生产应用中使用 fabric 之类的工具，向服务器分别传送代码和配置。更多细节 参见 使用 Fabric 部署 方案。

实例文件夹¶

Flask 0.8 引入了实例文件夹。 Flask 花了很长时间才能够直接使用应用文件夹的路径（ 通过 Flask.root_path ）。这也是许多开发者载入应用文件夹外的配置的方法。 不幸的是这种方法只能用于应用不是一个包的情况下，即根路径指向包的内容的情况。

Flask 0.8 引入了一个新的属性： Flask.instance_path 。它指向一个新名词： “实例文件夹”。实例文件夹应当处于版本控制中并进行特殊部署。这个文件夹特别适合 存放需要在应用运行中改变的东西或者配置文件。

可以要么在创建 Flask 应用时显式地提供实例文件夹的路径，要么让 Flask 自动探测 实例文件夹。显式定义使用 instance_path 参数:

app = Flask(__name__, instance_path='/path/to/instance/folder')

请记住，这里提供的路径 必须 是绝对路径。

如果 instance_path 参数没有提供，那么会使用以下缺省位置：

• 未安装的模块:

  /myapp.py
  /instance
  

• 未安装的包:

  /myapp
      /__init__.py
  /instance
  

• 已安装的模块或包:

  $PREFIX/lib/python2.X/site-packages/myapp
  $PREFIX/var/myapp-instance
  

  $PREFIX 是你的 Python 安装的前缀。可能是 /usr 或你的 virtualenv 的 路径。可以通过打印 sys.prefix 的值来查看当前的前缀的值。

既然可以通过使用配置对象来根据关联文件名从文件中载入配置，那么就可以通过改变与 实例路径相关联的文件名来按需要载入不同配置。在配置文件中的关联路径的行为可以在 “关联到应用的根路径”（缺省的）和 “关联到实例文件夹”之间变换，具体通过应用 构建函数中的 instance_relative_config 来实现:

app = Flask(__name__, instance_relative_config=True)

以下是一个完整的配置 Flask 的例子，从一个模块预先载入配置，然后从配置文件夹中的 一个配置文件（如果这个文件存在的话）载入要重载的配置:

app = Flask(__name__, instance_relative_config=True)
app.config.from_object('yourapplication.default_settings')
app.config.from_pyfile('application.cfg', silent=True)

通过 Flask.instance_path 可以找到实例文件夹的路径。 Flask 还提供一个打开实例文件夹中的文件的快捷方法： Flask.open_instance_resource() 。

举例说明:

filename = os.path.join(app.instance_path, 'application.cfg')
with open(filename) as f:
    config = f.read()

# 或者通过使用 open_instance_resource:
with app.open_instance_resource('application.cfg') as f:
    config = f.read()