config.processor.os_env

环境变量配置数据处理器

在 0.2.0 版本加入.

Classes

OSEnvSL

os.environ 格式处理器

Module Contents

class OSEnvSL(*, reg_alias: str | None = None, prefix: str = '', strip_prefix: bool = False)

Bases: config.main.BasicConfigSL

os.environ 格式处理器

参数:

  • reg_alias (str | None) -- sl处理器注册别名

  • prefix (str) -- (从环境变量)导出的环境变量前缀，留空则为所有

  • strip_prefix (bool) -- (从环境变量)导出时是否去除前缀，导入(到环境变量)时会自动加回

在 0.3.0 版本发生变更: 添加参数 prefix 添加参数 strip_prefix

__eq__(other: Any) → bool
__hash__() → int
initialize(processor_pool: config.abc.ABCSLProcessorPool, root_path: str, namespace: str, file_name: str, *args: Any, **kwargs: Any) → config.abc.ABCConfigFile[Any]

初始化一个受SL处理器支持的配置文件

参数:

  • processor_pool (ABCSLProcessorPool) -- 配置池

  • root_path (str) -- 保存的根目录

  • namespace (str) -- 配置的命名空间

  • file_name (str) -- 配置文件名

返回:

配置对象

返回类型:

ABCConfigFile

在 0.2.0 版本加入.

load(processor_pool: config.abc.ABCSLProcessorPool, root_path: str, namespace: str, file_name: str, *args: Any, **kwargs: Any) → config.basic.core.ConfigFile[config.basic.environment.EnvironmentConfigData]

加载处理器

参数:

  • processor_pool (ABCSLProcessorPool) -- 配置池

  • root_path (str) -- 保存的根目录

  • namespace (str) -- 配置的命名空间

  • file_name (str) -- 配置文件名

返回:

配置对象

返回类型:

ABCConfigFile

抛出:

FailedProcessConfigFileError -- 处理配置文件失败

在 0.2.0 版本发生变更: 删除参数 config_file_cls

添加参数 processor_pool

register_to(config_pool: config.abc.ABCSLProcessorPool | None = None) → Self

注册到配置池中

参数:

config_pool (ABCSLProcessorPool | None) -- 配置池

返回:

返回当前实例便于链式调用

返回类型:

Self

在 0.3.0 版本发生变更: 返回当前实例便于链式调用

save(processor_pool: config.abc.ABCSLProcessorPool, config_file: config.abc.ABCConfigFile[config.basic.environment.EnvironmentConfigData], root_path: str, namespace: str, file_name: str, *args: Any, **kwargs: Any) → None

保存处理器

参数:

  • processor_pool (ABCSLProcessorPool) -- 配置池

  • config_file (ABCConfigFile) -- 待保存配置

  • root_path (str) -- 保存的根目录

  • namespace (str) -- 配置的命名空间

  • file_name (str) -- 配置文件名

抛出:

FailedProcessConfigFileError -- 处理配置文件失败

在 0.2.0 版本发生变更: 添加参数 processor_pool

__slots__ = ()
_reg_alias: str | None = None
prefix = ''
property processor_reg_name: str

SL处理器的默认注册名

property reg_alias: str | None

处理器的别名

property reg_name: str

处理器的注册名

strip_prefix = False
supported_file_classes
返回:

支持的配置文件类

在 0.2.0 版本加入.

property supported_file_patterns: tuple[str, Ellipsis]
返回:

支持的文件名匹配

在 0.2.0 版本发生变更: 重命名 file_ext 为 supported_file_patterns