zpp_config 1.2.3

Module pour le chargement et la modification de fichier de configuration

zpp-config

Informations

Librairie pour l'utilisation et la modification de fichier de configuration:

• Charger un ou plusieurs paramètres
• Modifier un paramètre existant
• Ajout un paramètre ou une section
• Supprimer un paramètre ou une section
• Lister les sections disponibles
• Lister les paramètres et/ou sections désactivés

Prends en compte les paramètres commentés.
Compatible avec les fichiers de configuration indentés.

Traduit les paramètres pour les types str, int, float, bool, list, dict

Prérequis

• Python 3

Installation

pip install zpp_config

Utilisation

Conseil d'importation du module

from zpp_config import Config

Exemple de fichier de config

[section]
	value1 = key1
	value2 = key2
	value3 = key3

[section2]
	value1 = key1
	value2 = key2
	value3 = key3

Initialisaton d'un fichier de configuration

c = Config("conf.ini")

En paramètre supplémentaire, nous pouvons mettre:

• separator: Définir le séparateur entre la clé et la valeur dans le fichier. (Par défaut: " = ")
• escape_line: Définir le caractère utilisé pour commenter une valeur ou une section. (Par défaut: "#")
• auto_create: Créer le fichier de configuration s'il n'existe pas. (Par défaut: "False")
• read_only: Ouvrir le fichier de configuration en lecture seule. (Par défaut: "False")

Chargement de paramètre

La fonction renvoie la valeur si un unique paramètre a été trouvé, sinon renvoie un dictionnaire avec les différentes valeurs trouvées (classé par section) Renvoie un tableau vide si aucun paramètre n'a été trouvé

Chargement de tous les paramètres

data = c.load()

Chargement d'une section du fichier

data = c.load(section='section_name')

Chargement d'une valeur dans tout le fichier

data = c.load(val='value_name')

Chargement d'une valeur dans une section spécifique

data = c.load(val='value_name', section='section_name')

En paramètre supplémentaire, nous pouvons mettre:

• default: Pour initialiser une valeur par défaut si aucun résultat est trouvé

Changement de paramètre

Changement d'une valeur dans tout le fichier

c.change(val='value_name', key='key_value')

Changement d'une valeur dans une section spécifique

c.change(val='value_name', key='key_value', section='section_name')

Ajout de paramètre ou de section

Ajoute une section ou un paramètre dans le fichier de configuration. Dans le cas de l'ajout d'un paramètre, rajoute la section si elle n'existe pas.

Ajout d'une section

c.add(section='section_name')

Ajout d'un paramètre dans une section

c.add(val='value_name', key='key_value', section='section_name')

Si aucune section est défini, rajoute le paramètre en dehors des sections.

Suppression de paramètre ou de section

Suppression d'une section

c.delete(section='section_name')

Suppression d'un paramètre dans une section

c.delete(val='value_name', section='section_name')

Si aucune section est défini, recherche le paramètre en dehors des sections.

Liste des paramètres non pris en compte

Retourne la liste des paramètres qui sont non pris en compte dans le fichier de configuration.

data = c.disabled_line()

Possibilité de préciser la section en utilisant le paramètre section

Liste les sections disponibles

data = c.list_section()