Auf dem Weg zu mühelosen Python-Konfigurationsdateien Version 2

Einführung

Im vorherigen Artikel ist es uns gelungen, eine simulierte Eigenschaftsdatenklasse zu erstellen, um Konfigurationswerte für eine Anwendung zu verwalten. Allerdings handelte es sich im Grunde nur um eine Vorlage, die wir für jede Verwendung neu implementieren mussten. In Version 2 meiner Arbeit ist es mir gelungen, eine wiederverwendbare Klasse zu implementieren.

• Es erfordert ein Paar Dekorateure für die Eigenschaftsdefinitionen.
• Außerdem erfordert die Implementierung einen Abschnittsdatentyp, der einen Abschnittseintrag für jeden Konfigurationsabschnitt enthält.
• Jeder Abschnitt erfordert eine Liste von ConfigurationNameValue-Einträgen

Klassenvertretung

Das folgende Klassendiagramm zeigt die grundlegende wiederverwendbare Klasse und die Datenstrukturen, die ein Entwickler benötigt, um diese Funktionalität zu nutzen.

Konfigurationseigenschaften der Unterklasse

Der Entwickler startet den Prozess, indem er Konfigurationseigenschaften wie folgt in Unterklassen unterteilt.

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()

Der Aufruf von super erstellt einen vollständig qualifizierten Pfad zur Konfigurationsdatei. Der Code folgt einer Teilmenge der XDG-Basisverzeichnisspezifikation. Der Code versucht zuerst XDG_CONFIG_HOME, dann HOME und verwendet schließlich das aktuelle Verzeichnis, wenn beides fehlschlägt. In Zeile 13 ruft der Entwickler die geschützte Methode auf, um den Konfigurationsparser vorzubereiten. Darüber hinaus wird dieser Anruf

• Stellt sicher, dass die Konfigurationsdatei vorhanden ist, andernfalls wird eine leere Datei erstellt
• Erstellt fehlende Abschnitte
• Erstellt fehlende Schlüssel in den Abschnitten

Die vorherigen Funktionen führen dann zu einer Menge wiederverwendbarem Code und Bootstraps-Konfigurationsdateien. Darüber hinaus machen wir die Klasse zu einem Singleton, um die Erstellungskosten zu senken, während wir sie in unserer gesamten Anwendungscodebasis instanziieren.

Abschnitte definieren

Beachten Sie die Parameterabschnitte im Superaufruf. Diese Definition von Abschnitten sieht folgendermaßen aus:

from codeallybasic.ConfigurationProperties import Sections

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

Das Obige ist ein Wörterbuch, bei dem der Schlüssel ein Abschnittsname und der Wert ein Abschnitt ist.

Abschnitt definieren

Ein Abschnitt ist nur eine Liste von ConfigurationNameValue-Einträgen. Ein ConfigurationNameValue ist eine Datenklasse mit zwei Werten, einem PropertyName und seinem Standardwert. Hier sind unsere Abschnitte.

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'),
    ]
)

Beachten Sie, dass ich zwei neue Aufzählungseigenschaften angegeben habe. Einer, bei dem wir bestehen bleiben wollen, ist der Wert, der andere sein Name.

Hier finden Sie Aufzählungsdefinitionen.

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

Wir werden sehen, wie sich diese auf die Eigenschaftsdefinitionen in einer Entwicklerklasse auswirken

Eigenschaftsdefinitionen

String-Eigenschaften werden wie folgt definiert.

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()

Was wir entfernt haben, ist die Boiler-Plate für den Zugriff auf den configParser, um die Werte abzurufen und festzulegen. Was wir hinzugefügt haben, waren die Dekoratoren „configurationGetter“ und „configurationSetter“. Ich werde nicht auf die Implementierungsdetails der Dekorateure eingehen und dies als Übung für den Leser überlassen. Diese Dekoratoren kümmern sich um die Interaktion mit dem Konfigurationsparser, um Werte abzurufen und festzulegen. Beim Festlegen von Werten führt der ConfigurationSetter-Dekorator das Durchschreiben durch.

Entwickler definieren Ganzzahleigenschaften wie folgt.

from codeallybasic.ConfigurationProperties import Sections

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

Beachten Sie, dass der ConfigurationGetter-Dekorator einen optionalen Parameter hat. Es handelt sich um eine Funktion, die den String-Eigenschaftswert übernimmt und ihn in einen geeigneten typisierten Wert umwandelt, bevor sie zu den Aufrufereigenschaften zurückkehrt. Dies kann auf Float-Eigenschaften angewendet werden.

Aufzählungseigenschaften, bei denen wir den Aufzählungsnamen beibehalten möchten, sind wie folgt definiert:

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'),
    ]
)

Beachten Sie neben der Verwendung der entsprechenden Dekoratoren, dass Sie zum Beibehalten des Enumerationsnamens den Parameter enumUseName verwenden und ihn auf True setzen.

Das Folgende ist eine Aufzählungseigenschaft, deren Wert der Entwickler beibehalten möchte. Beachten Sie, dass der Dekorator setter angibt, dass es sich um eine Aufzählung handelt. Beachten Sie außerdem, dass der Entwickler eine Deserialisierungsmethode bereitstellen muss, die den Wert in den spezifischen Aufzählungswert konvertieren kann.

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

Auf Eigenschaften zugreifen und diese ändern

Der Zugriff auf und die Änderung von Eigenschaften erfolgt genau wie in Version 1.

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

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

Das obige Snippet erzeugt die folgende Ausgabe.

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

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

Abschluss

Der Quellcode für diesen Artikel ist hier. Siehe die Support-Klasse SingletonV3. Sehen Sie sich die Implementierung von ConfigurationProperties

an

Das Ergebnis der Implementierung hat mich als Konsumenten des Codes zufrieden gestellt. Ich konnte typisierte Eigenschaften abrufen und festlegen. Es wurde nicht so viel Code entfernt, wie ich ursprünglich gehofft hatte. Es stellte mir jedoch wiederverwendbaren Code zur Verfügung. Es hat mich jedoch dazu veranlasst, eine Live-Vorlage in PyCharm zu schreiben, um mir die Generierung einzelner Eigenschaften zu erleichtern.

Vorteile

• Einfacher typsicherer Zugriff auf Anwendungseigenschaften
• Wiederverwendbare übergeordnete Klasse für verschiedene Implementierungen
• Datenstrukturgesteuerter Code zum Hinzufügen neuer Abschnitte und Konfigurationsschlüssel

Nachteile

• Immer noch jede Menge KesselplatteCode
• Ich habe das Gefühl, dass der Einsatz von Dekorateuren ein Missbrauch von ihnen war

In meinem nächsten Beitrag habe ich das implementiert, was ich dynamische Eigenschaften nenne. Der gesamte Standardplattencode wurde vollständig entfernt und dennoch blieben die oben genannten Vorteile erhalten.

Das obige ist der detaillierte Inhalt vonAuf dem Weg zu mühelosen Python-Konfigurationsdateien Version 2. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!