Vers une version 2 des fichiers de configuration Python sans effort

Introduction

Dans l'article précédent, nous avons réussi à créer une classe de données de propriétés simulée pour gérer les valeurs de configuration d'une application. Cependant, il s’agissait simplement d’un modèle que nous devions réimplémenter pour chaque utilisation. Dans la version 2, de mon travail j'ai réussi à implémenter une classe réutilisable.

• Cela nécessite un binôme de décorateurs sur les définitions des propriétés.
• De plus, l'implémentation nécessite un type de données Sections qui contient une entrée Section pour chaque section de configuration.
• Chaque section nécessite une liste d'entrées ConfigurationNameValue

Représentation de classe

Le diagramme de classes suivant montre la classe réutilisable de base et les structures de données nécessaires à un développeur pour utiliser cette fonctionnalité.

Propriétés de configuration de sous-classe

Le développeur démarre le processus en sous-classant les propriétés de configuration comme suit.

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

L'appel à super crée un chemin complet vers le fichier de configuration. Le code suit un sous-ensemble de la spécification du répertoire de base XDG. Le code essaie d'abord XDG_CONFIG_HOME, puis HOME, et utilise enfin le répertoire courant si les deux échouent. À la ligne 13, le développeur appelle la méthode protégée pour préparer l'analyseur de configuration. De plus, cet appel sera

• S'assure que le fichier de configuration existe, sinon il en crée un vide
• Crée les sections manquantes
• Crée les clés manquantes dans les sections

Les fonctionnalités précédentes se traduisent alors par de nombreux fichiers de configuration de code et d'amorçage réutilisables. De plus, nous faisons de la classe un Singleton pour atténuer les coûts de création lorsque nous l'instancions dans notre base de code d'application.

Définir des sections

Remarquez les sections de paramètres dans le super appel. Cette définition des sections ressemble à ceci :

from codeallybasic.ConfigurationProperties import Sections

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

Ce qui précède est un dictionnaire où la clé est un nom de section et la valeur est une section.

Définir une section

Une section est simplement une liste d'entrées ConfigurationNameValue. Un ConfigurationNameValue est une classe de données avec 2 valeurs, un PropertyName et sa valeur par défaut. Voici nos rubriques.

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

Remarquez que j'ai spécifié deux nouvelles propriétés d'énumération. L'un où nous souhaitons persister est la valeur et l'autre son nom.

Voici les définitions de l'énumération.

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

Nous verrons comment cela affecte les définitions de propriétés dans une classe de développeur

Définitions de propriétés

Les propriétés des chaînes sont définies comme suit.

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

Ce dont nous nous sommes débarrassés, c'est la plaque passe-partout permettant d'accéder au configParser pour obtenir et définir les valeurs. Ce que nous avons ajouté, ce sont les décorateurs configurationGetter et configurationSetter. Je ne vais pas aborder les détails de mise en œuvre des décorateurs et laisser cela comme un exercice pour le lecteur. Ces décorateurs se chargent d'interagir avec l'analyseur de configuration pour obtenir et définir des valeurs. Lors de la définition des valeurs, le décorateur configurationSetter effectue l'écriture directe.

Les développeurs définissent les propriétés entières comme suit.

from codeallybasic.ConfigurationProperties import Sections

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

Remarquez que le décorateur configurationGetter a un paramètre facultatif. Il s'agit d'une fonction qui prend la valeur de la propriété de chaîne et la convertit en une valeur typée appropriée avant de revenir aux propriétés de l'appelant. Cela peut être appliqué aux propriétés float.

Les propriétés d'énumération où nous voulons conserver le nom de l'énumération sont définies comme suit :

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

En plus d'utiliser les décorateurs appropriés, notez que pour conserver le nom de l'énumération, utilisez le paramètre enumUseName et définissez-le sur True.

Ce qui suit est une propriété d'énumération où le développeur souhaite conserver sa valeur. Notez que le décorateur setter indique qu'il s'agit d'une énumération. De plus, notez que le développeur doit fournir une méthode de désérialisation capable de convertir la valeur en valeur d'énumération spécifique.

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

Accès et modification des propriétés

L'accès et la modification des propriétés sont exactement les mêmes que dans la version 1.

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

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

L'extrait ci-dessus produit le résultat suivant.

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

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

Conclusion

Le code source de cet article est ici. Voir la classe de support SingletonV3. Voir l'implémentation de ConfigurationProperties

Le résultat de la mise en œuvre m'a laissé satisfait en tant que consommateur du code. J'ai pu obtenir et définir des propriétés typées. Cela n’a pas supprimé autant de code que je l’avais initialement espéré. Cependant, cela m'a fourni du code réutilisable. Cependant, cela m'a incité à écrire un Live Template dans PyCharm pour m'empêcher de générer des propriétés individuelles.

Avantages

• Accès facile et sécurisé aux propriétés de l'application
• Classe parent réutilisable pour différentes implémentations
• Code basé sur la structure des données pour ajouter de nouvelles sections et clés de configuration

Inconvénients

• Encore beaucoup de plaque chaude code
• J'ai le sentiment que l'utilisation de décorateurs était une mauvaise utilisation de ceux-ci

Dans mon prochain article, j'ai implémenté ce que j'appelle des propriétés dynamiques. Il a entièrement supprimé tout le code de la plaque chauffante tout en conservant les avantages susmentionnés.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!