Les modules de configuration Python

Il s'agit d'un simple fichier texte. Le contenu de ce fichier est constitué de sections, dont le nom est placé entre crochets, et de paramètres intégrés dans les diverses sections sous la forme « paramètre=valeur ». Chaque section est séparée par une ligne vide.

Le caractère de commentaire est « ; ».

Voici un exemple.

;fichier INI de demonstration
[Section_01]
parametre1=valeur1
parametre2=''valeur2''

[Section_02]
parametre3=125
parametre4=127.0.0.1   ; equivalent a localhost

Les fichiers INI portent généralement l'extension « .ini ». Cependant, cette extension étant historiquement très connotée Windows, les développeurs préfèrent en général l'extension « .cfg ».

Par défaut, Python, en branche 3, gère les fichiers INI comme des dictionnaires Python. De fait, la manipulation des sections et paramètres repose sur les mêmes principes.

De plus, quelle que soit l'opération que vous désirez effectuer, il vous faudra passer par un objet conteneur. En effet, il ne vous est pas possible de manipuler directement le fichier.

II-B-1. Créer un objet conteneur▲

import configparser
mon_conteneur = ConfigParser.ConfigParser()

II-B-2. Charger le conteneur▲

config.read('example.cfg')

II-B-3. Sauver le contenu du conteneur▲

with open('example.cfg', 'w') as configfile:
    config.write(configfile)

II-B-4. Créer une section▲

mon_conteneur['section_01']={}

II-B-5. Créer un paramètre▲

mon_conteneur['section_01']['parametre_01']='valeur_01'

II-B-6. Modifier le nom d'une section ou d'un paramètre▲

mon_conteneur['section_01']['parametre_02']=mon_conteneur['section_01']['parametre_01']
del mon_conteneur['section_01']['parametre_01']

II-B-7. Modifier la valeur d'un paramètre▲

mon_conteneur['section_02']['parametre_02']='nouvelle_valeur'

II-B-8. Connaître les sections et paramètres disponibles▲

liste_section = list(mon_conteneur.keys())

liste_section = list(mon_conteneur['section_02'].keys())

II-B-9. Lire le contenu d'une section ou d'un paramètre▲

for section, dict_parameters in mon_conteneur.items():
    ...

for parameter, value in mon_conteneur['section_02'].items():
    ...

parametres = mon_conteneur['section_02']
valeur = mon_conteneur['section_02']['parametre_02']

Le format JSON a été créé entre 2002 et 2005 par Douglas Crockford.

Il sert principalement à échanger des données entre programmes. Il permet de définir des types composés de données simples, communes à pratiquement tous les langages.

Il est assimilable à un dictionnaire Python, et est de fait parfaitement lisible par les humains.

Le format JSON n'accepte pas les commentaires.

{
    "test0": "valeur01",
    "test1":
    {
        "test2": 2,
        "test3": 3
    }
}

Comme on peut le voir ici, il ne faut pas oublier les virgules quand on change de ligne, sauf sur la dernière ligne.

Lire un fichier JSON depuis un fichier est relativement simple. Nous passons par une variable intermédiaire, un conteneur, au même titre que le module configparser.

import json

with open('./json.txt', 'r') as fichier:
    data = json.load(fichier)

print(data["test0"])
print(data["test1"])
print(data["test1"]["test2"])

Comme on peut le constater ici, nous récupérons un objet JSON sous la forme d'un dictionnaire Python.

Comme dit précédemment, nous disposons maintenant d'un simple dictionnaire Python. La manipulation se passe alors de tout commentaire.

import json

with open('./json.txt', 'r') as fichier:
    data = json.load(fichier)

assert type(data) is dict

print(data["test0"])
print(data["test1"])
print(data["test1"]["test2"])
data["test1"]["test2"] = 56
print(data["test1"]["test2"])

Redéfinir une valeur dans le conteneur, s'effectue de la même façon que pour un dictionnaire. Cependant, attention : nous n'avons modifié ici que le contenu de notre dictionnaire. Pour modifier le JSON, il faut maintenant sauvegarder le contenu de notre dictionnaire dans notre fichier JSON.

Une fois que vous vous sentez prêt à enregistrer votre conteneur, il ne vous faudra que quelques lignes.

import json

with open('./json.txt', 'r') as fichier:
    data = json.load(fichier)

print(data["test0"])
print(data["test1"])
print(data["test1"]["test2"])
data["test1"]["test2"] = 56
print(data["test1"]["test2"])

with open('./json.txt', 'w') as fichier:
    json.dump(data, fichier, sort_keys=True, indent=4,
              ensure_ascii=False)

Nous voyons ici que nous passons par la fonction dump. Le premier argument doit être les données (votre conteneur), le deuxième le fichier de sortie. Viennent ensuite divers arguments possibles. Nous en utilisons ici deux : « indent » permet de paramétrer le nombre d'espaces pour l'indentation et « ensure_ascii » vous permet de stipuler si vous stockez les caractères spéciaux sous forme échappée (True) ou non.

Il existe une méthode alternative qui revient, a priori au même.

Vous avez la possibilité de transformer une chaîne de caractères, contenant un dictionnaire Python, directement en dictionnaire, et vice-versa. De fait, il est possible de se passer d'une librairie dédiée. J'attire cependant votre attention sur le fait qu'en faisant cela, nombre de mécanismes et le respect de la norme seront mis à mal.

s="{'Hello':1, 'World':2}"
print(s)
print(type(s))
d=eval(s)
print(d)
print(type(d))
print(d['Hello'])
s2=str(d)
print(s2)
print(type(s2))

Comme le laisse penser le titre de cette section, il s'agit là d'une fausse bonne idée. Pourquoi ? Principalement parce que cela représente une faille potentielle et que du code malveillant peut être alors exécuté.

En effet, imaginons qu'une de vos valeurs soit une commande, au format texte, exécutant un 'rm -rf /'. Pour peu que vous soyez en train d'exécuter votre code en tant que root (ce qui est fortement décommandé), vous risqueriez d'avoir quelques soucis.

La librairie json est spécialement conçue pour traiter les fichiers du même nom, avec des mécanismes de sécurité. Enfin, comme toute librairie dédiée, elle est optimisée afin que les temps de traitement soient les moins longs possible.

Avant d'aborder notre comparatif, nous allons commencer par traiter les limitations de ces formats. Cela est nécessaire, car certaines limites brideront notre comparatif.

IV-A-1. Fichier INI▲

IV-A-2. Fichier JSON▲

Nous allons ici nous attaquer à un comparatif de type performance. Outre les INI et JSON, nous allons en plus effectuer une comparaison avec le XML, ce dernier étant également assez répandu.

Imaginons ici une entreprise. Les données identitaires de chaque utilisateur sont conservées dans un fichier dédié. Nous y trouverons filiale, nom, prénom, numéro de poste interne, mail et adresse IP du poste.

Afin de faire simple, nous nous contenterons uniquement d'analyser le chargement des données dans Python.

IV-B-1. Au plus simple▲

[employe]
nom=Leguenec
prenom=Yann
telephone=3441
mail=yann.leguenec@societe.bzh
ip=192.168.29.35

{
    "nom":"Leguenec",
    "prenom":"Yann",
    "telephone":"3441",
    "mail":"yann.leguenec@societe.bzh",
    "ip":"192.168.29.35"
}

<?xml version="1.0" encoding="utf-8"?>
<employe>
    <nom>
        Leguenec
    </nom>
    <prenom>
        Yann
    </prenom>
    <telephone>
        3441
    </telephone>
    <mail>
        yann.leguenec@societe.bzh
    </mail>
    <ip>
        192.168.29.35
    </ip>
</employe>

import configparser
import time

start = time.time()

mon_conteneur = configparser.ConfigParser()
for i in range(10000):
    mon_conteneur.read('test.cfg')
stop = time.time()

print("Execution time: %.4fs" % (stop-start))

import json
import time

start = time.time()

for i in range(10000):
    with open('./test.json', 'r') as fichier:
        data = json.load(fichier)
stop = time.time()

print("Execution time: %.4fs" % (stop-start))

from lxml import etree
import time

start = time.time()
for i in range(10000):
    xml_file = etree.parse("./test.xml")
stop = time.time()

print("Execution time: %.4fs" % (stop-start))

IV-B-2. Un cran plus haut▲

[employe]
Nom=Leguenec
Prenom=Yann

[coordonnees]
Telephone=3441
Mail=yann.leguenec@societe.bzh
Ip=192.168.29.35

{
    "employe":
    {
        "Nom":"Leguenec",
        "Prenom":"Yann"
    },
    "coordonnees":
    {
        "Telephone":"3441",
        "Mail":"yann.leguenec@societe.bzh",
        "Ip":"192.168.29.35"
    }
}

<?xml version="1.0" encoding="utf-8"?>
<employes>
    <employe>
        <nom>
            Leguenec
        </nom>
        <prenom>
            Yann
        </prenom>
    </employe>
    <coordonnees>
        <telephone>
            3441
        </telephone>
        <mail>
            yann.leguenec@societe.bzh
        </mail>
        <ip>
            192.168.29.35
        </ip>
    </coordonnees>
</employes>