迈向轻松的 Python 配置文件版本 2

介绍

在上一篇文章中，我们成功创建了一个模拟属性数据类来管理应用程序的配置值。 然而，它基本上只是一个模板，我们必须为每次使用重新实现。 在我的工作的第二版中，我成功地实现了一个可重用的类。

• 它需要属性定义上的一对装饰器。
• 另外，该实现需要一个Sections 数据类型，其中包含每个配置节的一个Section 条目。
• 每个部分都需要一个 ConfigurationNameValue 条目列表

班级代表

下面的类图显示了基本的可重用类以及开发人员使用此功能所需的数据结构。

子类配置属性

开发人员通过如下方式子类化配置属性来开始该过程。

BASE_FILE_NAME: str = 'config.ini'
MODULE_NAME:    str = 'version2properties'

class ConfigurationPropertiesVersion2(ConfigurationProperties, metaclass=SingletonV3):

    def __init__(self):
        self.logger: Logger = getLogger(LOGGER_NAME)

        super().__init__(baseFileName=BASE_FILE_NAME, moduleName=MODULE_NAME, sections=CONFIGURATION_SECTIONS)

        self._configParser.optionxform = self._toStr    # type: ignore

        self._loadConfiguration()

对 super 的调用会创建配置文件的完全限定路径。 该代码遵循 XDG 基本目录规范的子集。 该代码首先尝试 XDG_CONFIG_HOME，然后尝试 HOME，如果两者都失败，最后使用当前目录。 在第 13 行中，开发人员调用受保护的方法来准备配置解析器。 此外，该调用将

• 确保配置文件存在，如果不存在，则创建一个空文件
• 创建缺失的部分
• 在部分中创建缺失的键

之前的功能会产生大量可重用的代码和引导配置文件。 此外，我们将该类设为单例，以降低在我们的应用程序代码库中实例化该类时的创建成本。

定义部分

注意 super 调用中的参数部分。 部分的定义如下所示：

from codeallybasic.ConfigurationProperties import Sections

CONFIGURATION_SECTIONS: Sections = Sections(
    {
        SectionName('General'):  SECTION_GENERAL,
        SectionName('Database'): SECTION_DATABASE,
    }
)

上面是一个字典，其中键是节名称，值是节。

定义部分

Section 只是 ConfigurationNameValue 条目的列表。 ConfigurationNameValue 是一个具有 2 个值的数据类，即 PropertyName 及其默认值。这是我们的部分。

from codeallybasic.ConfigurationProperties import Section
from codeallybasic.ConfigurationProperties import ConfigurationNameValue
from codeallybasic.ConfigurationProperties import PropertyName

SECTION_GENERAL: Section = Section(
    [
        ConfigurationNameValue(name=PropertyName('debug'),                           defaultValue='False'),
        ConfigurationNameValue(name=PropertyName('logLevel'),                     defaultValue='Info'),
        ConfigurationNameValue(name=PropertyName('phoneyEnumByValue'),  defaultValue=DEFAULT_PHONEY_ENUM_BY_VALUE.value),
        ConfigurationNameValue(name=PropertyName('impostorEnumByName'), defaultValue=DEFAULT_IMPOSTOR_ENUM_BY_NAME.name),
    ]
)

SECTION_DATABASE: Section = Section(
    [
        ConfigurationNameValue(name=PropertyName('dbName'), defaultValue='example_db'),
        ConfigurationNameValue(name=PropertyName('dbHost'), defaultValue='localhost'),
        ConfigurationNameValue(name=PropertyName('dbPort'), defaultValue='5432'),
    ]
)

请注意，我指定了两个新的枚举属性。 我们希望坚持的一个是价值，另一个是名字。

这里有枚举定义。

class PhoneyEnumByValue(Enum):
    TheWanderer = 'The Wanderer'
    Mentiroso   = 'Mentiroso'
    FakeBrenda  = 'Faker Extraordinaire'
    NotSet          = 'Not Set'

    @classmethod
    def deSerialize(cls, value: str) -> 'PhoneyEnumByValue':

    @classmethod
    def deSerialize(cls, value: str) -> 'PhoneyEnumByValue':

        match value:
            case PhoneyEnumByValue.TheWanderer.value:
                phoneyEnum: PhoneyEnumByValue = PhoneyEnumByValue.TheWanderer
            case PhoneyEnumByValue.Mentiroso.value:
                phoneyEnum = PhoneyEnumByValue.Mentiroso
            case PhoneyEnumByValue.FakeBrenda.value:
                phoneyEnum = PhoneyEnumByValue.FakeBrenda
            case _:
                raise Exception('Unknown PhoneyEnumByValue')

        return phoneyEnum


class ImpostorEnumByName(Enum):
    Low       = 0.1
    Medium = 0.5
    High     = 1.0
    NotSet = -1.0

我们将了解这些如何影响开发者类中的属性定义

属性定义

字符串属性定义如下。

BASE_FILE_NAME: str = 'config.ini'
MODULE_NAME:    str = 'version2properties'

class ConfigurationPropertiesVersion2(ConfigurationProperties, metaclass=SingletonV3):

    def __init__(self):
        self.logger: Logger = getLogger(LOGGER_NAME)

        super().__init__(baseFileName=BASE_FILE_NAME, moduleName=MODULE_NAME, sections=CONFIGURATION_SECTIONS)

        self._configParser.optionxform = self._toStr    # type: ignore

        self._loadConfiguration()

我们摆脱的是访问 configParser 来获取和设置值的样板。 我们添加的是configurationGetter 和configurationSetter 装饰器。 我不会介绍装饰器的实现细节，并将其作为读者的练习。 这些装饰器负责与配置解析器交互以获取和设置值。 在设置值时，configurationSetter 装饰器执行直写.

开发者定义整数属性如下。

from codeallybasic.ConfigurationProperties import Sections

CONFIGURATION_SECTIONS: Sections = Sections(
    {
        SectionName('General'):  SECTION_GENERAL,
        SectionName('Database'): SECTION_DATABASE,
    }
)

请注意，configurationGetter 装饰器有一个可选参数。 它是一个函数，它获取字符串属性值并将其转换为适当的类型值，然后返回调用者属性。 这可以应用于浮动属性。

我们想要保留枚举名称的枚举属性定义如下：

from codeallybasic.ConfigurationProperties import Section
from codeallybasic.ConfigurationProperties import ConfigurationNameValue
from codeallybasic.ConfigurationProperties import PropertyName

SECTION_GENERAL: Section = Section(
    [
        ConfigurationNameValue(name=PropertyName('debug'),                           defaultValue='False'),
        ConfigurationNameValue(name=PropertyName('logLevel'),                     defaultValue='Info'),
        ConfigurationNameValue(name=PropertyName('phoneyEnumByValue'),  defaultValue=DEFAULT_PHONEY_ENUM_BY_VALUE.value),
        ConfigurationNameValue(name=PropertyName('impostorEnumByName'), defaultValue=DEFAULT_IMPOSTOR_ENUM_BY_NAME.name),
    ]
)

SECTION_DATABASE: Section = Section(
    [
        ConfigurationNameValue(name=PropertyName('dbName'), defaultValue='example_db'),
        ConfigurationNameValue(name=PropertyName('dbHost'), defaultValue='localhost'),
        ConfigurationNameValue(name=PropertyName('dbPort'), defaultValue='5432'),
    ]
)

除了使用适当的装饰器之外，请注意，要保留枚举名称，请使用 enumUseName 参数并将其设置为 True.

以下是开发人员希望保留其值的枚举属性。 请注意，setter 装饰器表明它是一个枚举。 另外请注意，开发者必须提供反序列化方法，将值转换为特定的枚举值。

class PhoneyEnumByValue(Enum):
    TheWanderer = 'The Wanderer'
    Mentiroso   = 'Mentiroso'
    FakeBrenda  = 'Faker Extraordinaire'
    NotSet          = 'Not Set'

    @classmethod
    def deSerialize(cls, value: str) -> 'PhoneyEnumByValue':

    @classmethod
    def deSerialize(cls, value: str) -> 'PhoneyEnumByValue':

        match value:
            case PhoneyEnumByValue.TheWanderer.value:
                phoneyEnum: PhoneyEnumByValue = PhoneyEnumByValue.TheWanderer
            case PhoneyEnumByValue.Mentiroso.value:
                phoneyEnum = PhoneyEnumByValue.Mentiroso
            case PhoneyEnumByValue.FakeBrenda.value:
                phoneyEnum = PhoneyEnumByValue.FakeBrenda
            case _:
                raise Exception('Unknown PhoneyEnumByValue')

        return phoneyEnum


class ImpostorEnumByName(Enum):
    Low       = 0.1
    Medium = 0.5
    High     = 1.0
    NotSet = -1.0

访问和修改属性

访问和修改属性与版本 1 完全相同。

    @property
    @configurationGetter(sectionName='General')
    def debug(self) -> str:
        return ''       # never executed

    @debug.setter
    @configurationSetter(sectionName='General')
    def debug(self, newValue: str):
        pass

上面的代码片段产生以下输出。

    @property
    @configurationGetter(sectionName='Database', deserializeFunction=int)
    def dbPort(self) -> int:
        return -1

    @dbPort.setter
    @configurationSetter(sectionName='Database',)
    def dbPort(self, newValue: int):
        pass

结论

本文的源代码在这里。 请参阅支持类 SingletonV3。 查看ConfigurationProperties的实现

实现的结果让我作为代码的使用者感到满意。 我能够获取和设置类型属性。 它并没有像我最初希望的那样删除那么多代码。 然而，它确实为我提供了可重用的代码。 然而，它确实提示我在 PyCharm 中编写一个实时模板来帮助我生成单独的属性。

优点

• 轻松类型安全地访问应用程序属性
• 用于不同实现的可重用父类
• 数据结构驱动的代码，用于添加新部分和配置键

缺点

• 还有很多样板 代码
• 我觉得使用装饰器是对它们的误用

我的下一篇文章我实现了所谓的动态属性。 它完全删除了所有样板代码，并且仍然保留了上述优点。

以上是迈向轻松的 Python 配置文件版本 2的详细内容。更多信息请关注PHP中文网其他相关文章！