生态 2.0.0

入门

生态 会根据配置类定义自动获取和转换环境变量。

例如，假设你的应用程序有一个可配置的（整数）端口和一个（布尔）调试标志，以及一个（字符串）日志级别，默认为INFO，你可以简单地声明你的配置为

class Configuration(ecological.Config):
    port: int
    debug: bool
    log_level: str = "INFO"

然后设置环境变量 PORT、DEBUG 和 LOG_LEVEL。 生态 将自动将具有相同（但大写）名称的环境变量设置为类的属性。

默认情况下，值设置为类定义的类型，并分配给类本身（即类不需要实例化）。如果需要，可以更改此行为（请参阅自动加载部分）。

类型支持

Ecological还支持一些在PEP484中定义的类型，例如

class Configuration(ecological.Config):
    list_of_values: List[str]

将自动解析环境变量值作为列表。

带前缀的配置

您还可以选择为您的应用程序配置添加前缀，例如，以避免冲突

class Configuration(ecological.Config, prefix='myapp'):
    home: str

在这种情况下，home属性将从MYAPP_HOME环境属性中获取。

嵌套配置

Ecological.Config还支持嵌套配置，例如

class Configuration(ecological.Config):
    integer: int

    class Nested(ecological.Config, prefix='nested'):
        boolean: bool

这样，您可以将相关的配置属性分层分组。

高级

my_source = {"KEY1": "VALUE1"}

class Configuration(ecological.Config, transform=lambda v, wt: v, wanted_type=int, ...):
    my_var1: WantedType = ecological.Variable(transform=lambda v, wt: wt(v), source=my_source, ...)
    my_var2: str
    # ...

class Configuration(ecological.Config):
    port: int
# Values already read and set at this point.
# assert Configuration.port == <value-of-PORT-env-var>

class Configuration(ecological.Config, autoload=ecological.Autoload.NEVER):
    port: int
# Values not set at this point.
# Accessing Configuration.port would throw AttributeError.

Configuration.load()
# Values read and set at this point.
# assert Configuration.port == <value-of-PORT-env-var>

class Configuration(ecological.Config, autoload=ecological.Autoload.OBJECT):
    port: int
# Values not set at this point.

config = Configuration()
# Values read and set at this point on ``config``.
# assert config.port == <value-of-PORT-env-var>
# Accessing ``Configuration.port`` would throw AttributeError.

注意事项和已知限制

• Ecological不支持（公共）在Config类中的方法。