config.processor.os_env
=======================

.. py:module:: config.processor.os_env

.. autoapi-nested-parse::

   环境变量配置数据处理器

   .. versionadded:: 0.2.0



Classes
-------

.. autoapisummary::

   config.processor.os_env.OSEnvSL


Module Contents
---------------

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

   Bases: :py:obj:`config.main.BasicConfigSL`


   :py:data:`os.environ` 格式处理器

   :param reg_alias: sl处理器注册别名
   :type reg_alias: str | None
   :param prefix: (从环境变量)导出的环境变量前缀，留空则为所有
   :type prefix: str
   :param strip_prefix: (从环境变量)导出时是否去除前缀，导入(到环境变量)时会自动加回
   :type strip_prefix: bool

   .. versionchanged:: 0.3.0
      添加参数 ``prefix``
      添加参数 ``strip_prefix``


   .. py:method:: __eq__(other: Any) -> bool


   .. py:method:: __hash__() -> int


   .. py:method:: initialize(processor_pool: config.abc.ABCSLProcessorPool, root_path: str, namespace: str, file_name: str, *args: Any, **kwargs: Any) -> config.abc.ABCConfigFile[Any]

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

      :param processor_pool: 配置池
      :type processor_pool: ABCSLProcessorPool
      :param root_path: 保存的根目录
      :type root_path: str
      :param namespace: 配置的命名空间
      :type namespace: str
      :param file_name: 配置文件名
      :type file_name: str

      :return: 配置对象
      :rtype: ABCConfigFile

      .. versionadded:: 0.2.0



   .. py:method:: 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]

      加载处理器

      :param processor_pool: 配置池
      :type processor_pool: ABCSLProcessorPool
      :param root_path: 保存的根目录
      :type root_path: str
      :param namespace: 配置的命名空间
      :type namespace: str
      :param file_name: 配置文件名
      :type file_name: str

      :return: 配置对象
      :rtype: ABCConfigFile

      :raise FailedProcessConfigFileError: 处理配置文件失败

      .. versionchanged:: 0.2.0
         删除参数 ``config_file_cls``

         添加参数 ``processor_pool``



   .. py:method:: register_to(config_pool: config.abc.ABCSLProcessorPool | None = None) -> Self

      注册到配置池中

      :param config_pool: 配置池
      :type config_pool: ABCSLProcessorPool | None

      :return: 返回当前实例便于链式调用
      :rtype: Self

      .. versionchanged:: 0.3.0
         返回当前实例便于链式调用



   .. py:method:: 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

      保存处理器

      :param processor_pool: 配置池
      :type processor_pool: ABCSLProcessorPool
      :param config_file: 待保存配置
      :type config_file: ABCConfigFile
      :param root_path: 保存的根目录
      :type root_path: str
      :param namespace: 配置的命名空间
      :type namespace: str
      :param file_name: 配置文件名
      :type file_name: str

      :raise FailedProcessConfigFileError: 处理配置文件失败

      .. versionchanged:: 0.2.0
         添加参数 ``processor_pool``



   .. py:attribute:: __slots__
      :value: ()



   .. py:attribute:: _reg_alias
      :type:  str | None
      :value: None



   .. py:attribute:: prefix
      :value: ''



   .. py:property:: processor_reg_name
      :type: str


      SL处理器的默认注册名



   .. py:property:: reg_alias
      :type: str | None


      处理器的别名



   .. py:property:: reg_name
      :type: str


      处理器的注册名



   .. py:attribute:: strip_prefix
      :value: False



   .. py:attribute:: supported_file_classes

      :return: 支持的配置文件类

      .. versionadded:: 0.2.0



   .. py:property:: supported_file_patterns
      :type: tuple[str, Ellipsis]


      :return: 支持的文件名匹配

      .. versionchanged:: 0.2.0
         重命名 ``file_ext`` 为 ``supported_file_patterns``