간편한 Python 구성 파일 버전 2를 향하여

소개

이전 기사에서는 애플리케이션의 구성 값을 관리하기 위해 시뮬레이션된 속성 데이터 클래스를 생성했습니다. 그러나 이는 기본적으로 각 용도에 대해 다시 구현해야 하는 템플릿에 불과했습니다. 버전 2에서는 재사용 가능한 클래스를 구현하는 데 성공했습니다.

• 속성 정의에는 한 쌍의 데코레이터가 필요합니다.
• 또한 구현에는 각 구성 섹션에 대한 섹션 항목을 포함하는 섹션 데이터 유형이 필요합니다.
• 각 섹션에는 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행에서 개발자는 보호된 메서드를 호출하여 구성 파서를 준비합니다. 또한 해당 통화는

• 구성 파일이 있는지 확인하고, 없으면 빈 파일을 생성합니다
• 누락된 섹션 생성
• 섹션에 누락된 키가 생성됩니다

이전 기능을 사용하면 재사용 가능한 코드와 부트스트랩 구성 파일이 많이 생성됩니다. 또한 애플리케이션 코드 기반 전체에서 클래스를 인스턴스화할 때 생성 비용을 줄이기 위해 클래스를 싱글톤으로 만듭니다.

섹션 정의

수퍼 호출의 매개변수 섹션을 확인하세요. 섹션 정의는 다음과 같습니다.

from codeallybasic.ConfigurationProperties import Sections

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

위는 키가 섹션 이름이고 값이 섹션인 사전입니다.

섹션 정의

섹션은 단지 ConfigurationNameValue 항목의 목록입니다. ConfigurationNameValue는 PropertyName과 해당 기본값이라는 2개의 값이 있는 데이터 클래스입니다. 다음은 우리 섹션입니다.

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 중국어 웹사이트의 기타 관련 기사를 참조하세요!