Flask-INIConfig 0.1.0

Basic Usage

您可以通过调用扩展的构造函数来初始化它：

fromflaskimportFlaskfromflask.ext.iniconfigimportINIConfigapp=Flask(__name__)INIConfig(app)# or use the init_app form# INIConfig().init_app(app)app.config.from_inifile('/path/to/file.ini')property=(app.config.get('section')or{}).get('property')

^{tt1}$

当在ini文件中使用from_inifile节时，它们是config对象中的单个属性。例如，如果您有以下内容：

[section]a_property=1

您可以使用：

app.config.from_inifile('/path/to/file.ini')

您可以通过以下方式访问：

section=current_app.config.get('section')property=section['a_property']

从v0.0.8开始，如果您向from_inifile提供一个名为objectify的标志，它将把节作为实例变量添加到配置对象中。然后您可以使用：

app.config.from_inifile('/path/to/file.ini',objectify=True)

它将允许您以：

section=current_app.config.sectionproperty=section['a_property']

有一个专门用于Flask应用程序的部分，名为flask，可用于指定应用程序属性。因此，如果您有以下信息：

[flask]DEBUG=1

您可以使用current_app.config['DEBUG']，而不必指定节。烧瓶部分中的所有属性名称都转换为大写，就像from_inifile_sections中那样，但仅适用于烧瓶部分。

^{tt2}$

使用from_inifile_sections时，只有相关节和flask节（如果存在）从ini文件加载。另一个主要区别是，所有属性都附加到app.config对象上，而不是app.config具有节名称的属性。

此外，所有属性名都转换为大写，因为大多数扩展名和flask的内部configuration properties都是大写的。

唯一的异常是当您向此方法提供preserve_case标志时。当给定此值时，将保留所有非烧瓶选项的大小写。烧瓶选项仍将转换为大写。这允许您将sqlalchemy的engine_from_config直接用于config对象。

如果您有一个ini文件，其中包含开发、登台、生产和测试设置，则这非常有用。您只能加载所需的文件，然后烧瓶可以直接使用这些文件。

例如，如果您有以下物品：

[flask]DEBUG=1[common]a=1b=0[dev]b=2[prod]b=3

您可以使用：

app.config.from_inifile_sections('/path/to/file.ini',['common','dev'])

将属性A和B添加到app.config。

Customizing SafeConfigParser

如果要自定义内部SafeConfigParser的工作方式，可以使用RawConfigParser构造函数文档中指定的参数。

例如：

INIConfig(app,defaults={...},dict_type=OrderedDict,allow_no_value=True)

注意

• 您不能直接访问解析器实例，但是构造器将接受SafeConfigParser的参数并将它们传递出去。
• 扩展偏离了SafeConfigParser对布尔值的处理，因为对int的类型强制发生在对boolean的类型强制之前。因此，如果您想要布尔值，请将其设置为yes, no, on, off, true or false中的一个。

警告

扩展不尝试将值强制为已在应用程序配置中指定的键的类型。因此，如果要重写ini文件中的配置属性，则需要注意实际类型。