haufe.hrs.configuration 0.5.18

简介

haufe.hrs.configuration为基于Zope的应用程序提供了一种伪分层的配置机制，以提供中央配置服务。

特性

• 基于INI文件的配置

• 配置是伪分层的（部分名称可以是点名称（如cms.somepath，foo.bat.something.else）

• 所有有效的配置选项都通过模型定义（一个定义部分、它们的选项、它们的类型和默认值的INI样式文件）。该模型用于执行类型检查和提供默认值

• 模型和配置文件可以一次性或增量加载到配置服务中

• 可选地监督配置文件的更改（配置文件的更改可以触发配置的立即重新加载）

• 非常简单的API

• 用于定义模型和配置文件位置的ZCML指令

• 易于与Zope 2和Zope 3集成

• 可以在Zope之外（纯Python应用程序）使用 - 该包对其他zope.*包的依赖性很少

• 良好的测试覆盖率

定义一个模型

模型定义可能如下所示

[cms]
HRSCheckoutPath=string,default=42
HRSCheckoutURL=string
HRSImportPath=string
HRSImportClientPath=string
HRSPreviewPath=string
HRSPreviewClientPath=string
CvtSGMLtoRtfPath=string
CvtSGMLtoRtfMaxWait=int
ADB2StartURLbase=string
ADB2Version=int
ToolboxStartURLbase=string
NormenDBStartURLbase=string
VADBStartURLbase=string
LauflistenStartURL=string
HRS2UIStartURLbase=string
MedienStartURLbase=string

[cms.db]
datenbank1=
datenbank2=
datenbank3=

您可以看到语法相当简单。语法始终是

<optionname> = <type>, [default=<default-value>]

<optionname>是必填项。<type>默认为‘string’，可以省略（其他类型有‘int’，‘list’，‘float’，‘complex’或‘bool’）。‘=’是必填项（否则Python的配置解析器会报错。可以定义一个可选的默认值（否则将使用None）。提示：作为默认值使用的字符串必须使用引号。

相关的配置文件可能如下所示

[cms]
HRSCheckout = /foo/bar
adb2version = 44
hrscheckoutpath = 12
port = 22


[toolbox]
partition_id = Toolbox
nginx_baseurl = http://weiss.nix.de/

配置值的访问方式如下

cms.ADB2Version
cms.HRSCheckoutURL
cms.db.datenbank

用法

从Python

from haufe.hrs.configuration import ConfigurationService

service = ConfigurationService(watch=True)
service.registerModel('example/model')
service.loadConfiguration('example/sample_config/all-in-one.ini')
print service.getConfiguration()
print service.get('cms.ADB2Version')
print service.get('datenbank', domain='cms.db')

ZCML集成

haufe.hrs.configuration提供了两个ZCML指令haufe:registerModel和haufe:registerConfiguration

<configure xmlns="http://namespaces.zope.org/zope"
           xmlns:haufe="http://namespaces.haufe.de/haufe">

  <haufe:registerModel
      model="haufe/hrs/configuration/tests/model"
  />

  <haufe:registerConfiguration
      configuration="haufe/hrs/configuration/tests/example-config.ini"
  />

</configure>

模型和配置的路径名称可以是绝对路径，相对于当前ZCML文件的路径，或者包含环境变量的路径字符串（将自动替换）。

致谢

实现基于Dann Gass的cfgparse模块

作者

haufe.hrs.configuration是由德国弗莱堡的Haufe Mediengruppe和德国图宾根的ZOPYX Ltd. & Co. KG的Andreas Jung编写的。

许可证

haufe.hrs.configuration根据Zope公共许可证2.1授权。请参阅包含的ZPL.txt文件。

变更日志