14.2. "configparser" — Lecture et écriture de fichiers de configuration
***********************************************************************

**Code source :** Lib/configparser.py

======================================================================

Ce module fournit la classe "ConfigParser". Cette classe implémente un
langage de configuration basique, proche de ce que l'on peut trouver
dans les fichiers *INI* de Microsoft Windows. Vous pouvez utiliser ce
module pour écrire des programmes Python qui sont facilement
configurables par l'utilisateur final.

Note:

  Ce module *n'implémente pas* la version étendue de la syntaxe *INI*
  qui permet de lire ou d'écrire des valeurs dans la base de registre
  Windows en utilisant divers préfixes.

Voir aussi:

  Module "shlex"
     Ce module fournit les outils permettant de créer des mini-
     langages de programmation ressemblant au shell Unix, qui peuvent
     être utilisés comme alternative pour les fichiers de
     configuration d'une application.

  Module "json"
     Le module *json* implémente un sous-ensemble de la syntaxe
     JavaScript, qui peut aussi être utilisée à cet effet.


14.2.1. Premiers pas
====================

Prenons pour exemple un fichier de configuration très simple
ressemblant à ceci :

   [DEFAULT]
   ServerAliveInterval = 45
   Compression = yes
   CompressionLevel = 9
   ForwardX11 = yes

   [bitbucket.org]
   User = hg

   [topsecret.server.com]
   Port = 50022
   ForwardX11 = no

La structure des fichiers *INI* est décrite dans la section suivante.
En bref,  chaque fichier est constitué de sections, chacune des
sections comprenant des clés associées à des valeurs. Les classes du
module "configparser" peuvent écrire et lire de tels fichiers.
Commençons par le code qui permet de générer le fichier ci-dessus.

   >>> import configparser
   >>> config = configparser.ConfigParser()
   >>> config['DEFAULT'] = {'ServerAliveInterval': '45',
   ...                      'Compression': 'yes',
   ...                      'CompressionLevel': '9'}
   >>> config['bitbucket.org'] = {}
   >>> config['bitbucket.org']['User'] = 'hg'
   >>> config['topsecret.server.com'] = {}
   >>> topsecret = config['topsecret.server.com']
   >>> topsecret['Port'] = '50022'     # mutates the parser
   >>> topsecret['ForwardX11'] = 'no'  # same here
   >>> config['DEFAULT']['ForwardX11'] = 'yes'
   >>> with open('example.ini', 'w') as configfile:
   ...   config.write(configfile)
   ...

Comme vous pouvez le voir, nous pouvons manipuler l'instance renvoyée
par l'analyse du fichier de configuration comme s'il s'agissait d'un
dictionnaire. Il y a des différences, comme explicité ci-dessous, mais
le comportement de l'instance est très proche de ce que vous pourriez
attendre d'un dictionnaire.

Nous venons de créer et sauvegarder un fichier de configuration.
Voyons maintenant comment nous pouvons le lire et accéder aux données
qu'il contient.

   >>> import configparser
   >>> config = configparser.ConfigParser()
   >>> config.sections()
   []
   >>> config.read('example.ini')
   ['example.ini']
   >>> config.sections()
   ['bitbucket.org', 'topsecret.server.com']
   >>> 'bitbucket.org' in config
   True
   >>> 'bytebong.com' in config
   False
   >>> config['bitbucket.org']['User']
   'hg'
   >>> config['DEFAULT']['Compression']
   'yes'
   >>> topsecret = config['topsecret.server.com']
   >>> topsecret['ForwardX11']
   'no'
   >>> topsecret['Port']
   '50022'
   >>> for key in config['bitbucket.org']: print(key)
   ...
   user
   compressionlevel
   serveraliveinterval
   compression
   forwardx11
   >>> config['bitbucket.org']['ForwardX11']
   'yes'

Comme vous le voyez, l'API est assez simple à utiliser. La seule
partie un peu magique concerne la section "DEFAULT", qui fournit les
valeurs par défaut pour toutes les autres sections [1]. Notez
également que les clés à l’intérieur des sections ne sont pas
sensibles à la casse et qu'elles sont stockées en minuscules. [1].


14.2.2. Types de données prises en charge
=========================================

Les lecteurs de configuration n'essayent jamais de deviner le type des
valeurs présentes dans les fichiers de configuration, et elles sont
toujours stockées en tant que chaînes de caractères. Ainsi, si vous
avez besoin d'un type différent, vous devez effectuer la conversion
vous-même :

   >>> int(topsecret['Port'])
   50022
   >>> float(topsecret['CompressionLevel'])
   9.0

Puisque que cette tâche doit être fréquemment accomplie, les lecteurs
de configurations fournissent un ensemble d'accesseurs permettant de
gérer les entiers, les flottants et les booléens plus facilement. Le
cas des booléens est le plus pertinent. En effet, vous ne pouvez pas
vous contenter d'utiliser la fonction "bool()" directement puisque
"bool('False')" renvoie "True". C'est pourquoi les lecteurs
fournissent également la méthode "getboolean()". Cette méthode n'est
pas sensible à la casse et interprète correctement les valeurs
booléennes associées aux chaînes de caractères comme "'yes'"-"'no'",
"'on'"-"'off'", "'true'"-"'false'" et "'1'"-"'0'" [1]. Par exemple :

   >>> topsecret.getboolean('ForwardX11')
   False
   >>> config['bitbucket.org'].getboolean('ForwardX11')
   True
   >>> config.getboolean('bitbucket.org', 'Compression')
   True

En plus de "getboolean()", les lecteurs de configurations fournissent
également des méthodes similaires comme "getint()" et "getfloat()".
Vous pouvez enregistrer vos propres convertisseurs et personnaliser
ceux déjà fournis. [1]


14.2.3. Valeurs de substitution
===============================

Comme pour un dictionnaire, vous pouvez utiliser la méthode "get()"
d'une section en spécifiant une valeur de substitution :

   >>> topsecret.get('Port')
   '50022'
   >>> topsecret.get('CompressionLevel')
   '9'
   >>> topsecret.get('Cipher')
   >>> topsecret.get('Cipher', '3des-cbc')
   '3des-cbc'

Notez que les valeurs par défaut sont prioritaires par rapport aux
valeurs de substitution. Dans note exemple, la valeur de la clé
"CompressionLevel" était spécifiée uniquement dans la section
"DEFAULT". Si nous essayons de la récupérer depuis la section
"'topsecret.server.com'", nous obtenons la valeur par défaut, même en
ayant spécifié une valeur de substitution :

   >>> topsecret.get('CompressionLevel', '3')
   '9'

Il est important de savoir que la méthode "get()" appelée au niveau de
l'analyseur fournit une interface particulière et plus complexe, qui
est maintenue pour des raisons de rétrocompatibilité. Vous pouvez
fournir une valeur de substitution via l'argument obligatoirement
nommé "fallback" :

   >>> config.get('bitbucket.org', 'monster',
   ...            fallback='No such things as monsters')
   'No such things as monsters'

L'argument "fallback" peut être utilisé de la même façon avec les
méthodes "getint()", "getfloat()" et "getboolean()". Par exemple :

   >>> 'BatchMode' in topsecret
   False
   >>> topsecret.getboolean('BatchMode', fallback=True)
   True
   >>> config['DEFAULT']['BatchMode'] = 'no'
   >>> topsecret.getboolean('BatchMode', fallback=True)
   False


14.2.4. Structure des fichiers *INI* prise en change
====================================================

Un fichier de configuration est constitué de sections. Chacune des
sections commence par un en-tête "[section]", suivi d'une liste de
définitions clés-valeurs séparées par une chaîne de caractères
spécifique ("=" ou ":" par défaut [1]). Par défaut, les noms des
sections sont sensibles à la casse mais pas les clés [1]. Les
caractères d'espacement en début et en fin des clés et des valeurs
sont supprimés. Les valeurs peuvent être absentes, auquel cas il est
possible d'omettre le délimiteur entre clé et valeur. Les valeurs
peuvent s'étendre sur plusieurs lignes, à partir du moment où les
lignes supplémentaires sont plus indentées que la première ligne. Les
lignes vides peuvent être considérées comme faisant partie des valeurs
multi lignes, en fonction de la configuration de l'analyseur.

Les fichiers de configuration peuvent contenir des commentaires,
préfixés par des caractères spécifiques ("#" et ";" par défaut [1]).
Les commentaires peuvent apparaître à l'emplacement d'une ligne vide,
et peuvent aussi être indentés. [1]

Par exemple :

   [Simple Values]
   key=value
   spaces in keys=allowed
   spaces in values=allowed as well
   spaces around the delimiter = obviously
   you can also use : to delimit keys from values

   [All Values Are Strings]
   values like this: 1000000
   or this: 3.14159265359
   are they treated as numbers? : no
   integers, floats and booleans are held as: strings
   can use the API to get converted values directly: true

   [Multiline Values]
   chorus: I'm a lumberjack, and I'm okay
       I sleep all night and I work all day

   [No Values]
   key_without_value
   empty string value here =

   [You can use comments]
   # like this
   ; or this

   # By default only in an empty line.
   # Inline comments can be harmful because they prevent users
   # from using the delimiting characters as parts of values.
   # That being said, this can be customized.

       [Sections Can Be Indented]
           can_values_be_as_well = True
           does_that_mean_anything_special = False
           purpose = formatting for readability
           multiline_values = are
               handled just fine as
               long as they are indented
               deeper than the first line
               of a value
           # Did I mention we can indent comments, too?


14.2.5. Interpolation des valeurs
=================================

La classe "ConfigParser" prend en charge l’interpolation, en plus des
fonctionnalités de base. Cela signifie que les valeurs peuvent être
traitées avant d'être renvoyées par les appels aux méthodes "get()".

class configparser.BasicInterpolation

   Implémentation par défaut utilisée par la classe "ConfigParser".
   Celle-ci permet aux valeurs de contenir des chaînes de formatage se
   référant à d'autres valeurs dans la même section, ou bien à des
   valeurs dans la section spéciale par défaut [1]. D'autres valeurs
   par défaut peuvent être fournies au moment de l'initialisation de
   cette classe.

   Par exemple :

      [Paths]
      home_dir: /Users
      my_dir: %(home_dir)s/lumberjack
      my_pictures: %(my_dir)s/Pictures

   Dans l'exemple ci-dessus, une classe "Configparser" dont l'attribut
   *interpolation* vaut "BasicInterpolation()" interprète la chaîne de
   caractères "%(home_dir)s" en utilisant la valeur de la clé
   "home_dir" ("/Users" dans ce cas). "%(my_dir)s" est interprétée
   comme "/Users/lumberjack". Les interpolations sont effectuées à la
   volée. Ainsi, les clés utilisées comme référence à l’intérieur des
   chaînes de formatage peuvent être définies dans le fichier de
   configuration dans n'importe quel ordre.

   Si l'attribut "interpolation" vaut "None", le lecteur renvoie
   "%(my_dir)s/Pictures" comme valeur pour "my_pictures" et
   "%(home_dir)s/lumberjack" comme valeur pour "my_dir".

class configparser.ExtendedInterpolation

   Autre façon de gérer l'interpolation en utilisant une syntaxe plus
   avancée, utilisée par exemple par "zc.buildout". Cette syntaxe
   étendue utilise la chaîne de formatage "{section:option}}" pour
   désigner une valeur appartenant à une autre section.
   L'interpolation peut s'étendre sur plusieurs niveaux. Par
   commodité, si la partie "{section}" est absente, l'interpolation
   utilise la section courante par défaut (et, le cas échéant, les
   valeurs de la section par défaut spéciale).

   Voici comment transformer la configuration ci-dessus avec la
   syntaxe d'interpolation étendue :

      [Paths]
      home_dir: /Users
      my_dir: ${home_dir}/lumberjack
      my_pictures: ${my_dir}/Pictures

   Vous pouvez également récupérer des valeurs appartenant aux autres
   sections :

      [Common]
      home_dir: /Users
      library_dir: /Library
      system_dir: /System
      macports_dir: /opt/local

      [Frameworks]
      Python: 3.2
      path: ${Common:system_dir}/Library/Frameworks/

      [Arthur]
      nickname: Two Sheds
      last_name: Jackson
      my_dir: ${Common:home_dir}/twosheds
      my_pictures: ${my_dir}/Pictures
      python_dir: ${Frameworks:path}/Python/Versions/${Frameworks:Python}


14.2.6. Protocole d'accès associatif
====================================

Nouveau dans la version 3.2.

Le terme « protocole d'accès associatif » est utilisé pour décrire la
fonctionnalité qui permet d'utiliser des objets personnalisés comme
s'il s'agissait de dictionnaires. Dans le cas du module
"configparser", l’implémentation du protocole utilise la notation
"parser['section']['option']".

En particulier, "parser['section']" renvoie un mandataire vers les
données de la section correspondantes dans l'analyseur. Cela signifie
que les valeurs ne sont pas copiées, mais prélevées depuis l'analyseur
initial à la demande. Plus important encore, lorsque les valeurs sont
changées dans un mandataire pour une section, elles sont en réalité
changées dans l'analyseur initial.

Les objets du module "configparser" se comportent le plus possible
comme des vrais dictionnaires. L'interface est complète et suit les
définitions fournies par la classe abstraite  "MutableMapping".
Cependant, il faut prendre en compte un certain nombre de différences
:

* Par défaut, toutes les clés des sections sont accessibles sans
  respect de la casse [1]. Par exemple, "for option in
  parser["section"]" renvoie uniquement les clés telles que
  transformées par la méthode "optionxform", c'est-à-dire des clés
  transformées en minuscules. De même, pour une section contenant la
  clé "a", les deux expressions suivantes renvoient "True" :

     "a" in parser["section"]
     "A" in parser["section"]

* All sections include "DEFAULTSECT" values as well which means that
  ".clear()" on a section may not leave the section visibly empty.
  This is because default values cannot be deleted from the section
  (because technically they are not there).  If they are overridden in
  the section, deleting causes the default value to be visible again.
  Trying to delete a default value causes a "KeyError".

* La section "DEFAULTSECT" ne peut pas être supprimée :

  * trying to delete it raises "ValueError",

  * appeler "parser.clear()" la laisse intacte ;

  * appeler "`parser.popitem()" ne la renvoie jamais.

* Le deuxième argument de "parser.get(section, option, **kwargs)"
  n'est **pas** une valeur de substitution. Notez cependant que les
  méthodes "get()" fournies par les sections sont compatibles à la
  fois avec le protocole associatif et avec l'API classique de
  *configparser*.

* La méthode "parser.items()" est compatible avec le protocole d'accès
  associatif et renvoie une liste de paires *section_name*,
  *section_proxy*, en incluant la section *DEFAULTSECT*. Cependant,
  cette méthode peut aussi être appelée avec des arguments :
  "parser.items(section, raw, vars)". Dans ce cas, la méthode renvoie
  une liste de paires *option*, *value* pour la section spécifiée, en
  interprétant les interpolations (à moins d'utiliser "raw=True").

Le protocole d'accès est implémenté au-dessus de l'ancienne API.
Ainsi, les sous-classes qui écrasent des méthodes de l'interface
originale se comportent correctement du point de vue du protocole
d'accès.


14.2.7. Personnalisation du comportement de l'analyseur
=======================================================

Il existe pratiquement autant de variations du format *INI* que
d'applications qui l'utilisent. Le module "configparser" fait son
possible pour gérer le plus grand nombre de variantes raisonnables du
style *INI*. Le comportement par défaut est principalement contraint
par des raisons historiques. De ce fait, il est très probable qu'il
soit nécessaire de personnaliser certaines des fonctionnalités de ce
module.

La méthode la plus fréquemment utilisée pour changer la façon dont se
comporte un analyseur est d’utiliser les options de la méthode
"__init__()" :

* *defaults*, valeur par défaut : "None"

  Cette option accepte un dictionnaire de paires clé—valeurs qui
  seront placées dans la section "DEFAULT" initialement. Ceci est une
  façon élégante de prendre en charge des fichiers de configuration
  qui n'ont pas besoin de spécifier de valeurs lorsque celles-ci sont
  identiques aux valeurs par défaut documentées.

  Conseil : utilisez la méthode "read_dict()" avant de lire le ficher
  de configuration si vous voulez spécifier des valeurs par défaut
  pour une section spécifique.

* *dict_type*, default value: "collections.OrderedDict"

  This option has a major impact on how the mapping protocol will
  behave and how the written configuration files look.  With the
  default ordered dictionary, every section is stored in the order
  they were added to the parser.  Same goes for options within
  sections.

  An alternative dictionary type can be used for example to sort
  sections and options on write-back.  You can also use a regular
  dictionary for performance reasons.

  Please note: there are ways to add a set of key-value pairs in a
  single operation.  When you use a regular dictionary in those
  operations, the order of the keys may be random.  For example:

     >>> parser = configparser.ConfigParser()
     >>> parser.read_dict({'section1': {'key1': 'value1',
     ...                                'key2': 'value2',
     ...                                'key3': 'value3'},
     ...                   'section2': {'keyA': 'valueA',
     ...                                'keyB': 'valueB',
     ...                                'keyC': 'valueC'},
     ...                   'section3': {'foo': 'x',
     ...                                'bar': 'y',
     ...                                'baz': 'z'}
     ... })
     >>> parser.sections()
     ['section3', 'section2', 'section1']
     >>> [option for option in parser['section3']]
     ['baz', 'foo', 'bar']

  In these operations you need to use an ordered dictionary as well:

     >>> from collections import OrderedDict
     >>> parser = configparser.ConfigParser()
     >>> parser.read_dict(
     ...   OrderedDict((
     ...     ('s1',
     ...      OrderedDict((
     ...        ('1', '2'),
     ...        ('3', '4'),
     ...        ('5', '6'),
     ...      ))
     ...     ),
     ...     ('s2',
     ...      OrderedDict((
     ...        ('a', 'b'),
     ...        ('c', 'd'),
     ...        ('e', 'f'),
     ...      ))
     ...     ),
     ...   ))
     ... )
     >>> parser.sections()
     ['s1', 's2']
     >>> [option for option in parser['s1']]
     ['1', '3', '5']
     >>> [option for option in parser['s2'].values()]
     ['b', 'd', 'f']

* *allow_no_value*, valeur par défaut : "False"

  Certains fichiers de configurations sont connus pour contenir des
  options sans valeur associée, tout en se conformant à la syntaxe
  prise en charge par le module "configparser" par ailleurs. Pour
  indiquer que de telles valeurs sont acceptables, utilisez le
  paramètre *allow_no_value* lors de la construction de l'instance :

     >>> import configparser

     >>> sample_config = """
     ... [mysqld]
     ...   user = mysql
     ...   pid-file = /var/run/mysqld/mysqld.pid
     ...   skip-external-locking
     ...   old_passwords = 1
     ...   skip-bdb
     ...   # we don't need ACID today
     ...   skip-innodb
     ... """
     >>> config = configparser.ConfigParser(allow_no_value=True)
     >>> config.read_string(sample_config)

     >>> # Settings with values are treated as before:
     >>> config["mysqld"]["user"]
     'mysql'

     >>> # Settings without values provide None:
     >>> config["mysqld"]["skip-bdb"]

     >>> # Settings which aren't specified still raise an error:
     >>> config["mysqld"]["does-not-exist"]
     Traceback (most recent call last):
       ...
     KeyError: 'does-not-exist'

* *delimiters*, valeur par défaut : "('=', ':')"

  Chaînes de caractères qui séparent les clés des valeurs à
  l'intérieur d'une section. La première occurrence d'une telle chaîne
  à l'intérieur d'une ligne est considérée comme un délimiteur. Cela
  signifie que les valeurs peuvent contenir certains des délimiteurs
  (mais pas les clés).

  Voir aussi l'argument *space_around_delimiters* de la méthode
  "ConfigParser.write()".

* *comment_prefixes* (préfixes de commentaire) — valeur par défaut :
  "('#', ';')"

* *inline_comment_prefixes* (préfixes de commentaire en ligne) —
  valeur par défaut : "('#', ';')"

  Les préfixes de commentaire indiquent le début d'un commentaire
  valide au sein d'un fichier de configuration. Ils ne peuvent être
  utilisés qu'à l'emplacement d'une ligne vide (potentiellement
  indentée). En revanche, les préfixes de commentaires en ligne
  peuvent être utilisés après n'importe quelle valeur valide (comme
  les noms des sections, les options et les lignes vides). Par défaut,
  les commentaires en ligne sont désactivés et les préfixes utilisés
  pour les commentaires à l'emplacement d'une ligne vide sont *'#'`*
  et "';'".

  Modifié dans la version 3.2: Les précédentes versions du module
  "configparser" se comportent comme en utilisant
  "comment_prefixes=('#',';')" et "inline_comment_prefixes=(';',)".

  Notez que les analyseurs ne prennent pas en charge l'échappement des
  préfixes de commentaires. Ainsi, l'utilisation de
  *inline_comment_prefixes* peut empêcher les utilisateurs de
  spécifier des valeurs qui contiennent des caractères utilisés comme
  préfixe de commentaire. Dans le doute, il est recommandé de ne pas
  utiliser *inline_comment_prefixes*. Dans tous les cas, la seule
  façon de stocker des préfixes de commentaires au début d'une valeur
  multi lignes est d'interpoler ceux-ci, par exemple :

     >>> from configparser import ConfigParser, ExtendedInterpolation
     >>> parser = ConfigParser(interpolation=ExtendedInterpolation())
     >>> # the default BasicInterpolation could be used as well
     >>> parser.read_string("""
     ... [DEFAULT]
     ... hash = #
     ...
     ... [hashes]
     ... shebang =
     ...   ${hash}!/usr/bin/env python
     ...   ${hash} -*- coding: utf-8 -*-
     ...
     ... extensions =
     ...   enabled_extension
     ...   another_extension
     ...   #disabled_by_comment
     ...   yet_another_extension
     ...
     ... interpolation not necessary = if # is not at line start
     ... even in multiline values = line #1
     ...   line #2
     ...   line #3
     ... """)
     >>> print(parser['hashes']['shebang'])

     #!/usr/bin/env python
     # -*- coding: utf-8 -*-
     >>> print(parser['hashes']['extensions'])

     enabled_extension
     another_extension
     yet_another_extension
     >>> print(parser['hashes']['interpolation not necessary'])
     if # is not at line start
     >>> print(parser['hashes']['even in multiline values'])
     line #1
     line #2
     line #3

* *scrict*, valeur par défaut : "True"

  Quand la valeur "True" est spécifiée, le parseur refuse toute
  section ou option dupliquée lors de la lecture d'une source unique
  (lorsque "read_file()", "read_string()" ou "read_dict()" sont
  utilisées). Il est recommandé d'utiliser un mode de fonctionnement
  strict pour les analyseurs employés par de nouvelles applications.

  Modifié dans la version 3.2: Les versions précédentes du module
  "configparser" se comportent comme en utilisant "strict=False".

* *empty_lines_in_values*, valeur par défaut : "True"

  Du point de vue des analyseurs, les valeurs peuvent s'étendre sur
  plusieurs lignes à partir du moment où elles sont plus indentées que
  la clé qui les contient. Par défaut les analyseurs autorisent les
  lignes vides à faire partie de telles valeurs. Dans le même temps,
  les clés elles-mêmes peuvent être indentées de façon à rendre le
  fichier plus lisible. En conséquence, il est probable que
  l'utilisateur perde de vue la structure du fichier lorsque celui-ci
  devient long et complexe. Prenez par exemple :

     [Section]
     key = multiline
       value with a gotcha

      this = is still a part of the multiline value of 'key'

  Ceci est particulièrement problématique si l'utilisateur a configuré
  son éditeur pour utiliser une police à chasse variable. C'est
  pourquoi il est conseillé de ne pas prendre en charge les valeurs
  avec des lignes vides, à moins que votre application en ait besoin.
  Dans ce cas, les lignes vides sont toujours interprétées comme
  séparant des clés. Dans l'exemple ci-dessus, cela produit deux clés
  : "key" et "this".

* *default_section*, valeur par défaut : "configparser.DEFAULTSECT"
  (autrement dit : ""DEFAULT"")

  The convention of allowing a special section of default values for
  other sections or interpolation purposes is a powerful concept of
  this library, letting users create complex declarative
  configurations.  This section is normally called ""DEFAULT"" but
  this can be customized to point to any other valid section name.
  Some typical values include: ""general"" or ""common"".  The name
  provided is used for recognizing default sections when reading from
  any source and is used when writing configuration back to a file.
  Its current value can be retrieved using the
  "parser_instance.default_section" attribute and may be modified at
  runtime (i.e. to convert files from one format to another).

* *interpolation*, default value: "configparser.BasicInterpolation"

  Interpolation behaviour may be customized by providing a custom
  handler through the *interpolation* argument. "None" can be used to
  turn off interpolation completely, "ExtendedInterpolation()"
  provides a more advanced variant inspired by "zc.buildout".  More on
  the subject in the dedicated documentation section.
  "RawConfigParser" has a default value of "None".

* *converters*, default value: not set

  Config parsers provide option value getters that perform type
  conversion.  By default "getint()", "getfloat()", and "getboolean()"
  are implemented.  Should other getters be desirable, users may
  define them in a subclass or pass a dictionary where each key is a
  name of the converter and each value is a callable implementing said
  conversion.  For instance, passing "{'decimal': decimal.Decimal}"
  would add "getdecimal()" on both the parser object and all section
  proxies.  In other words, it will be possible to write both
  "parser_instance.getdecimal('section', 'key', fallback=0)" and
  "parser_instance['section'].getdecimal('key', 0)".

  If the converter needs to access the state of the parser, it can be
  implemented as a method on a config parser subclass.  If the name of
  this method starts with "get", it will be available on all section
  proxies, in the dict-compatible form (see the "getdecimal()" example
  above).

More advanced customization may be achieved by overriding default
values of these parser attributes.  The defaults are defined on the
classes, so they may be overridden by subclasses or by attribute
assignment.

ConfigParser.BOOLEAN_STATES

   Par défaut, la méthode "getboolean()" considère les valeurs
   suivantes comme vraies : *'1'`*, "'yes'", "'true'", "'on'", et les
   valeurs suivantes comme fausses : "'0'", "'no'", "'false'",
   "'off'". Vous pouvez changer ce comportement en spécifiant votre
   propre dictionnaire associant des chaînes de caractères à des
   valeurs booléennes. Par exemple :

      >>> custom = configparser.ConfigParser()
      >>> custom['section1'] = {'funky': 'nope'}
      >>> custom['section1'].getboolean('funky')
      Traceback (most recent call last):
      ...
      ValueError: Not a boolean: nope
      >>> custom.BOOLEAN_STATES = {'sure': True, 'nope': False}
      >>> custom['section1'].getboolean('funky')
      False

   Other typical Boolean pairs include "accept"/"reject" or
   "enabled"/"disabled".

ConfigParser.optionxform(option)

   This method transforms option names on every read, get, or set
   operation.  The default converts the name to lowercase.  This also
   means that when a configuration file gets written, all keys will be
   lowercase.  Override this method if that's unsuitable. For example:

      >>> config = """
      ... [Section1]
      ... Key = Value
      ...
      ... [Section2]
      ... AnotherKey = Value
      ... """
      >>> typical = configparser.ConfigParser()
      >>> typical.read_string(config)
      >>> list(typical['Section1'].keys())
      ['key']
      >>> list(typical['Section2'].keys())
      ['anotherkey']
      >>> custom = configparser.RawConfigParser()
      >>> custom.optionxform = lambda option: option
      >>> custom.read_string(config)
      >>> list(custom['Section1'].keys())
      ['Key']
      >>> list(custom['Section2'].keys())
      ['AnotherKey']

ConfigParser.SECTCRE

   A compiled regular expression used to parse section headers.  The
   default matches "[section]" to the name ""section"".  Whitespace is
   considered part of the section name, thus "[  larch  ]" will be
   read as a section of name ""  larch  "".  Override this attribute
   if that's unsuitable.  For example:

      >>> config = """
      ... [Section 1]
      ... option = value
      ...
      ... [  Section 2  ]
      ... another = val
      ... """
      >>> typical = ConfigParser()
      >>> typical.read_string(config)
      >>> typical.sections()
      ['Section 1', '  Section 2  ']
      >>> custom = ConfigParser()
      >>> custom.SECTCRE = re.compile(r"\[ *(?P<header>[^]]+?) *\]")
      >>> custom.read_string(config)
      >>> custom.sections()
      ['Section 1', 'Section 2']

   Note:

     While ConfigParser objects also use an "OPTCRE" attribute for
     recognizing option lines, it's not recommended to override it
     because that would interfere with constructor options
     *allow_no_value* and *delimiters*.


14.2.8. Legacy API Examples
===========================

Mainly because of backwards compatibility concerns, "configparser"
provides also a legacy API with explicit "get"/"set" methods.  While
there are valid use cases for the methods outlined below, mapping
protocol access is preferred for new projects.  The legacy API is at
times more advanced, low-level and downright counterintuitive.

An example of writing to a configuration file:

   import configparser

   config = configparser.RawConfigParser()

   # Please note that using RawConfigParser's set functions, you can assign
   # non-string values to keys internally, but will receive an error when
   # attempting to write to a file or when you get it in non-raw mode. Setting
   # values using the mapping protocol or ConfigParser's set() does not allow
   # such assignments to take place.
   config.add_section('Section1')
   config.set('Section1', 'an_int', '15')
   config.set('Section1', 'a_bool', 'true')
   config.set('Section1', 'a_float', '3.1415')
   config.set('Section1', 'baz', 'fun')
   config.set('Section1', 'bar', 'Python')
   config.set('Section1', 'foo', '%(bar)s is %(baz)s!')

   # Writing our configuration file to 'example.cfg'
   with open('example.cfg', 'w') as configfile:
       config.write(configfile)

An example of reading the configuration file again:

   import configparser

   config = configparser.RawConfigParser()
   config.read('example.cfg')

   # getfloat() raises an exception if the value is not a float
   # getint() and getboolean() also do this for their respective types
   a_float = config.getfloat('Section1', 'a_float')
   an_int = config.getint('Section1', 'an_int')
   print(a_float + an_int)

   # Notice that the next output does not interpolate '%(bar)s' or '%(baz)s'.
   # This is because we are using a RawConfigParser().
   if config.getboolean('Section1', 'a_bool'):
       print(config.get('Section1', 'foo'))

To get interpolation, use "ConfigParser":

   import configparser

   cfg = configparser.ConfigParser()
   cfg.read('example.cfg')

   # Set the optional *raw* argument of get() to True if you wish to disable
   # interpolation in a single get operation.
   print(cfg.get('Section1', 'foo', raw=False))  # -> "Python is fun!"
   print(cfg.get('Section1', 'foo', raw=True))   # -> "%(bar)s is %(baz)s!"

   # The optional *vars* argument is a dict with members that will take
   # precedence in interpolation.
   print(cfg.get('Section1', 'foo', vars={'bar': 'Documentation',
                                          'baz': 'evil'}))

   # The optional *fallback* argument can be used to provide a fallback value
   print(cfg.get('Section1', 'foo'))
         # -> "Python is fun!"

   print(cfg.get('Section1', 'foo', fallback='Monty is not.'))
         # -> "Python is fun!"

   print(cfg.get('Section1', 'monster', fallback='No such things as monsters.'))
         # -> "No such things as monsters."

   # A bare print(cfg.get('Section1', 'monster')) would raise NoOptionError
   # but we can also use:

   print(cfg.get('Section1', 'monster', fallback=None))
         # -> None

Default values are available in both types of ConfigParsers.  They are
used in interpolation if an option used is not defined elsewhere.

   import configparser

   # New instance with 'bar' and 'baz' defaulting to 'Life' and 'hard' each
   config = configparser.ConfigParser({'bar': 'Life', 'baz': 'hard'})
   config.read('example.cfg')

   print(config.get('Section1', 'foo'))     # -> "Python is fun!"
   config.remove_option('Section1', 'bar')
   config.remove_option('Section1', 'baz')
   print(config.get('Section1', 'foo'))     # -> "Life is hard!"


14.2.9. ConfigParser Objects
============================

class configparser.ConfigParser(defaults=None, dict_type=collections.OrderedDict, allow_no_value=False, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section=configparser.DEFAULTSECT, interpolation=BasicInterpolation(), converters={})

   The main configuration parser.  When *defaults* is given, it is
   initialized into the dictionary of intrinsic defaults.  When
   *dict_type* is given, it will be used to create the dictionary
   objects for the list of sections, for the options within a section,
   and for the default values.

   When *delimiters* is given, it is used as the set of substrings
   that divide keys from values.  When *comment_prefixes* is given, it
   will be used as the set of substrings that prefix comments in
   otherwise empty lines. Comments can be indented.  When
   *inline_comment_prefixes* is given, it will be used as the set of
   substrings that prefix comments in non-empty lines.

   When *strict* is "True" (the default), the parser won't allow for
   any section or option duplicates while reading from a single source
   (file, string or dictionary), raising "DuplicateSectionError" or
   "DuplicateOptionError".  When *empty_lines_in_values* is "False"
   (default: "True"), each empty line marks the end of an option.
   Otherwise, internal empty lines of a multiline option are kept as
   part of the value. When *allow_no_value* is "True" (default:
   "False"), options without values are accepted; the value held for
   these is "None" and they are serialized without the trailing
   delimiter.

   When *default_section* is given, it specifies the name for the
   special section holding default values for other sections and
   interpolation purposes (normally named ""DEFAULT"").  This value
   can be retrieved and changed on runtime using the "default_section"
   instance attribute.

   Interpolation behaviour may be customized by providing a custom
   handler through the *interpolation* argument. "None" can be used to
   turn off interpolation completely, "ExtendedInterpolation()"
   provides a more advanced variant inspired by "zc.buildout".  More
   on the subject in the dedicated documentation section.

   All option names used in interpolation will be passed through the
   "optionxform()" method just like any other option name reference.
   For example, using the default implementation of "optionxform()"
   (which converts option names to lower case), the values "foo
   %(bar)s" and "foo %(BAR)s" are equivalent.

   When *converters* is given, it should be a dictionary where each
   key represents the name of a type converter and each value is a
   callable implementing the conversion from string to the desired
   datatype.  Every converter gets its own corresponding "get*()"
   method on the parser object and section proxies.

   Modifié dans la version 3.1: The default *dict_type* is
   "collections.OrderedDict".

   Modifié dans la version 3.2: *allow_no_value*, *delimiters*,
   *comment_prefixes*, *strict*, *empty_lines_in_values*,
   *default_section* and *interpolation* were added.

   Modifié dans la version 3.5: The *converters* argument was added.

   defaults()

      Return a dictionary containing the instance-wide defaults.

   sections()

      Return a list of the sections available; the *default section*
      is not included in the list.

   add_section(section)

      Add a section named *section* to the instance.  If a section by
      the given name already exists, "DuplicateSectionError" is
      raised.  If the *default section* name is passed, "ValueError"
      is raised.  The name of the section must be a string; if not,
      "TypeError" is raised.

      Modifié dans la version 3.2: Non-string section names raise
      "TypeError".

   has_section(section)

      Indicates whether the named *section* is present in the
      configuration. The *default section* is not acknowledged.

   options(section)

      Return a list of options available in the specified *section*.

   has_option(section, option)

      If the given *section* exists, and contains the given *option*,
      return "True"; otherwise return "False".  If the specified
      *section* is "None" or an empty string, DEFAULT is assumed.

   read(filenames, encoding=None)

      Attempt to read and parse an iterable of filenames, returning a
      list of filenames which were successfully parsed.

      If *filenames* is a string or *path-like object*, it is treated
      as a single filename.  If a file named in *filenames* cannot be
      opened, that file will be ignored.  This is designed so that you
      can specify an iterable of potential configuration file
      locations (for example, the current directory, the user's home
      directory, and some system-wide directory), and all existing
      configuration files in the iterable will be read.

      If none of the named files exist, the "ConfigParser" instance
      will contain an empty dataset.  An application which requires
      initial values to be loaded from a file should load the required
      file or files using "read_file()" before calling "read()" for
      any optional files:

         import configparser, os

         config = configparser.ConfigParser()
         config.read_file(open('defaults.cfg'))
         config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')],
                     encoding='cp1250')

      Nouveau dans la version 3.2: The *encoding* parameter.
      Previously, all files were read using the default encoding for
      "open()".

      Nouveau dans la version 3.6.1: The *filenames* parameter accepts
      a *path-like object*.

   read_file(f, source=None)

      Read and parse configuration data from *f* which must be an
      iterable yielding Unicode strings (for example files opened in
      text mode).

      Optional argument *source* specifies the name of the file being
      read.  If not given and *f* has a "name" attribute, that is used
      for *source*; the default is "'<???>'".

      Nouveau dans la version 3.2: Replaces "readfp()".

   read_string(string, source='<string>')

      Parse configuration data from a string.

      Optional argument *source* specifies a context-specific name of
      the string passed.  If not given, "'<string>'" is used.  This
      should commonly be a filesystem path or a URL.

      Nouveau dans la version 3.2.

   read_dict(dictionary, source='<dict>')

      Load configuration from any object that provides a dict-like
      "items()" method.  Keys are section names, values are
      dictionaries with keys and values that should be present in the
      section.  If the used dictionary type preserves order, sections
      and their keys will be added in order. Values are automatically
      converted to strings.

      Optional argument *source* specifies a context-specific name of
      the dictionary passed.  If not given, "<dict>" is used.

      This method can be used to copy state between parsers.

      Nouveau dans la version 3.2.

   get(section, option, *, raw=False, vars=None[, fallback])

      Get an *option* value for the named *section*.  If *vars* is
      provided, it must be a dictionary.  The *option* is looked up in
      *vars* (if provided), *section*, and in *DEFAULTSECT* in that
      order.  If the key is not found and *fallback* is provided, it
      is used as a fallback value.  "None" can be provided as a
      *fallback* value.

      All the "'%'" interpolations are expanded in the return values,
      unless the *raw* argument is true.  Values for interpolation
      keys are looked up in the same manner as the option.

      Modifié dans la version 3.2: Arguments *raw*, *vars* and
      *fallback* are keyword only to protect users from trying to use
      the third argument as the *fallback* fallback (especially when
      using the mapping protocol).

   getint(section, option, *, raw=False, vars=None[, fallback])

      A convenience method which coerces the *option* in the specified
      *section* to an integer.  See "get()" for explanation of *raw*,
      *vars* and *fallback*.

   getfloat(section, option, *, raw=False, vars=None[, fallback])

      A convenience method which coerces the *option* in the specified
      *section* to a floating point number.  See "get()" for
      explanation of *raw*, *vars* and *fallback*.

   getboolean(section, option, *, raw=False, vars=None[, fallback])

      A convenience method which coerces the *option* in the specified
      *section* to a Boolean value.  Note that the accepted values for
      the option are "'1'", "'yes'", "'true'", and "'on'", which cause
      this method to return "True", and "'0'", "'no'", "'false'", and
      "'off'", which cause it to return "False".  These string values
      are checked in a case-insensitive manner.  Any other value will
      cause it to raise "ValueError".  See "get()" for explanation of
      *raw*, *vars* and *fallback*.

   items(raw=False, vars=None)
   items(section, raw=False, vars=None)

      When *section* is not given, return a list of *section_name*,
      *section_proxy* pairs, including DEFAULTSECT.

      Otherwise, return a list of *name*, *value* pairs for the
      options in the given *section*.  Optional arguments have the
      same meaning as for the "get()" method.

   set(section, option, value)

      If the given section exists, set the given option to the
      specified value; otherwise raise "NoSectionError".  *option* and
      *value* must be strings; if not, "TypeError" is raised.

   write(fileobject, space_around_delimiters=True)

      Write a representation of the configuration to the specified
      *file object*, which must be opened in text mode (accepting
      strings).  This representation can be parsed by a future
      "read()" call.  If *space_around_delimiters* is true, delimiters
      between keys and values are surrounded by spaces.

   remove_option(section, option)

      Remove the specified *option* from the specified *section*.  If
      the section does not exist, raise "NoSectionError".  If the
      option existed to be removed, return "True"; otherwise return
      "False".

   remove_section(section)

      Remove the specified *section* from the configuration.  If the
      section in fact existed, return "True".  Otherwise return
      "False".

   optionxform(option)

      Transforms the option name *option* as found in an input file or
      as passed in by client code to the form that should be used in
      the internal structures.  The default implementation returns a
      lower-case version of *option*; subclasses may override this or
      client code can set an attribute of this name on instances to
      affect this behavior.

      You don't need to subclass the parser to use this method, you
      can also set it on an instance, to a function that takes a
      string argument and returns a string.  Setting it to "str", for
      example, would make option names case sensitive:

         cfgparser = ConfigParser()
         cfgparser.optionxform = str

      Note that when reading configuration files, whitespace around
      the option names is stripped before "optionxform()" is called.

   readfp(fp, filename=None)

      Obsolète depuis la version 3.2: Use "read_file()" instead.

      Modifié dans la version 3.2: "readfp()" now iterates on *fp*
      instead of calling "fp.readline()".

      For existing code calling "readfp()" with arguments which don't
      support iteration, the following generator may be used as a
      wrapper around the file-like object:

         def readline_generator(fp):
             line = fp.readline()
             while line:
                 yield line
                 line = fp.readline()

      Instead of "parser.readfp(fp)" use
      "parser.read_file(readline_generator(fp))".

configparser.MAX_INTERPOLATION_DEPTH

   The maximum depth for recursive interpolation for "get()" when the
   *raw* parameter is false.  This is relevant only when the default
   *interpolation* is used.


14.2.10. RawConfigParser Objects
================================

class configparser.RawConfigParser(defaults=None, dict_type=collections.OrderedDict, allow_no_value=False, *, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section=configparser.DEFAULTSECT[, interpolation])

   Legacy variant of the "ConfigParser" with interpolation disabled by
   default and unsafe "add_section" and "set" methods.

   Note:

     Consider using "ConfigParser" instead which checks types of the
     values to be stored internally.  If you don't want interpolation,
     you can use "ConfigParser(interpolation=None)".

   add_section(section)

      Add a section named *section* to the instance.  If a section by
      the given name already exists, "DuplicateSectionError" is
      raised.  If the *default section* name is passed, "ValueError"
      is raised.

      Type of *section* is not checked which lets users create non-
      string named sections.  This behaviour is unsupported and may
      cause internal errors.

   set(section, option, value)

      If the given section exists, set the given option to the
      specified value; otherwise raise "NoSectionError".  While it is
      possible to use "RawConfigParser" (or "ConfigParser" with *raw*
      parameters set to true) for *internal* storage of non-string
      values, full functionality (including interpolation and output
      to files) can only be achieved using string values.

      This method lets users assign non-string values to keys
      internally.  This behaviour is unsupported and will cause errors
      when attempting to write to a file or get it in non-raw mode.
      **Use the mapping protocol API** which does not allow such
      assignments to take place.


14.2.11. Exceptions
===================

exception configparser.Error

   Base class for all other "configparser" exceptions.

exception configparser.NoSectionError

   Exception raised when a specified section is not found.

exception configparser.DuplicateSectionError

   Exception raised if "add_section()" is called with the name of a
   section that is already present or in strict parsers when a section
   if found more than once in a single input file, string or
   dictionary.

   Nouveau dans la version 3.2: Optional "source" and "lineno"
   attributes and arguments to "__init__()" were added.

exception configparser.DuplicateOptionError

   Exception raised by strict parsers if a single option appears twice
   during reading from a single file, string or dictionary. This
   catches misspellings and case sensitivity-related errors, e.g. a
   dictionary may have two keys representing the same case-insensitive
   configuration key.

exception configparser.NoOptionError

   Exception raised when a specified option is not found in the
   specified section.

exception configparser.InterpolationError

   Base class for exceptions raised when problems occur performing
   string interpolation.

exception configparser.InterpolationDepthError

   Exception raised when string interpolation cannot be completed
   because the number of iterations exceeds "MAX_INTERPOLATION_DEPTH".
   Subclass of "InterpolationError".

exception configparser.InterpolationMissingOptionError

   Exception raised when an option referenced from a value does not
   exist. Subclass of "InterpolationError".

exception configparser.InterpolationSyntaxError

   Exception raised when the source text into which substitutions are
   made does not conform to the required syntax.  Subclass of
   "InterpolationError".

exception configparser.MissingSectionHeaderError

   Exception raised when attempting to parse a file which has no
   section headers.

exception configparser.ParsingError

   Exception raised when errors occur attempting to parse a file.

   Modifié dans la version 3.2: The "filename" attribute and
   "__init__()" argument were renamed to "source" for consistency.

-[ Notes ]-

[1] Config parsers allow for heavy customization.  If you are
    interested in changing the behaviour outlined by the footnote
    reference, consult the Customizing Parser Behaviour section.
