Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
bb27c128
Commit
bb27c128
authored
Nov 11, 2010
by
Georg Brandl
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Review the new configparser docs.
parent
8d9a4e66
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
475 additions
and
473 deletions
+475
-473
Doc/library/configparser.rst
Doc/library/configparser.rst
+475
-473
No files found.
Doc/library/configparser.rst
View file @
bb27c128
...
@@ -34,12 +34,13 @@ customized by end users easily.
...
@@ -34,12 +34,13 @@ customized by end users easily.
Support for a creating Unix shell-like mini-languages which can be used
Support for a creating Unix shell-like mini-languages which can be used
as an alternate format for application configuration files.
as an alternate format for application configuration files.
Quick Start
Quick Start
-----------
-----------
.. highlightlang:: none
Let's take a very basic configuration file that looks like this:
Let's take a very basic configuration file that looks like this::
.. code-block:: ini
[DEFAULT]
[DEFAULT]
ServerAliveInterval = 45
ServerAliveInterval = 45
...
@@ -55,12 +56,11 @@ Let's take a very basic configuration file that looks like this::
...
@@ -55,12 +56,11 @@ Let's take a very basic configuration file that looks like this::
ForwardX11 = no
ForwardX11 = no
The supported file structure of INI files is described `in the following section
The supported file structure of INI files is described `in the following section
<#supported-ini-file-structure>`_, fow now all there
'
s to know is that the file
<#supported-ini-file-structure>`_, fow now all there
i
s to know is that the file
consists of sections, each of which contains keys with values.
consists of sections, each of which contains keys with values.
:mod:`configparser` classes can read and write such files. Let's start by
:mod:`configparser` classes can read and write such files. Let's start by
creating the above configuration file programatically.
creating the above configuration file programatically.
.. highlightlang:: python
.. doctest::
.. doctest::
>>> import configparser
>>> import configparser
...
@@ -81,12 +81,11 @@ creating the above configuration file programatically.
...
@@ -81,12 +81,11 @@ creating the above configuration file programatically.
As you can see, we can treat a config parser just like a dictionary. There are
As you can see, we can treat a config parser just like a dictionary. There are
a few differences, `outlined later on <#mapping-protocol-access>`_, but the
a few differences, `outlined later on <#mapping-protocol-access>`_, but the
behaviour is very close to what you
'
d expect from a dictionary.
behaviour is very close to what you
woul
d expect from a dictionary.
Now that we
'
ve created and saved a configuration file, let's try reading it
Now that we
ha
ve created and saved a configuration file, let's try reading it
back and exploring the data it holds.
back and exploring the data it holds.
.. highlightlang:: python
.. doctest::
.. doctest::
>>> import configparser
>>> import configparser
...
@@ -122,17 +121,17 @@ back and exploring the data it holds.
...
@@ -122,17 +121,17 @@ back and exploring the data it holds.
As we can see above, the API is pretty straight forward. The only bit of magic
As we can see above, the API is pretty straight forward. The only bit of magic
involves the ``DEFAULT`` section which provides default values for all other
involves the ``DEFAULT`` section which provides default values for all other
sections [customizable]_. Another thing to note is that keys in sections are
sections [1]_. Another thing to note is that keys in sections are
case-insensitive so they're stored in lowercase [customizable]_.
case-insensitive so they're stored in lowercase [1]_.
Supported Datatypes
Supported Datatypes
-------------------
-------------------
Config parsers do not guess datatypes of values in configuration files, always
Config parsers do not guess datatypes of values in configuration files, always
storing them internally as strings.
This means that if you need other datatypes,
storing them internally as strings.
This means that if you need other
you should convert on your own:
datatypes,
you should convert on your own:
.. highlightlang:: python
.. doctest::
.. doctest::
>>> int(topsecret['Port'])
>>> int(topsecret['Port'])
...
@@ -142,12 +141,11 @@ you should convert on your own:
...
@@ -142,12 +141,11 @@ you should convert on your own:
Converting to the boolean type is not that simple, though. Wrapping the return
Converting to the boolean type is not that simple, though. Wrapping the return
value around ``bool()`` would do us no good since ``bool('False')`` is still
value around ``bool()`` would do us no good since ``bool('False')`` is still
``True``.
This is why config parsers also provide :meth:`getboolean`. This handy
``True``.
This is why config parsers also provide :meth:`getboolean`. This
method is also case insensitive and correctly recognizes boolean values from
handy method is also case insensitive and correctly recognizes boolean values
``'yes'``/``'no'``, ``'on'``/``'off'`` and ``'1'``/``'0'`` [customizable
]_. An
from ``'yes'``/``'no'``, ``'on'``/``'off'`` and ``'1'``/``'0'`` [1
]_. An
example of getting the boolean value:
example of getting the boolean value:
.. highlightlang:: python
.. doctest::
.. doctest::
>>> topsecret.getboolean('ForwardX11')
>>> topsecret.getboolean('ForwardX11')
...
@@ -158,16 +156,16 @@ example of getting the boolean value:
...
@@ -158,16 +156,16 @@ example of getting the boolean value:
True
True
Apart from :meth:`getboolean`, config parsers also provide equivalent
Apart from :meth:`getboolean`, config parsers also provide equivalent
:meth:`getint` and :meth:`getfloat` methods but these are far less useful
:meth:`getint` and :meth:`getfloat` methods
,
but these are far less useful
because explicit casting is enough for these types.
because explicit casting is enough for these types.
Fallback Values
Fallback Values
---------------
---------------
As with a regular dictionary, you can use a section's :meth:`get` method to
As with a regular dictionary, you can use a section's :meth:`get` method to
provide fallback values:
provide fallback values:
.. highlightlang:: python
.. doctest::
.. doctest::
>>> topsecret.get('Port')
>>> topsecret.get('Port')
...
@@ -181,10 +179,9 @@ provide fallback values:
...
@@ -181,10 +179,9 @@ provide fallback values:
Please note that default values have precedence over fallback values. For
Please note that default values have precedence over fallback values. For
instance, in our example the ``CompressionLevel`` key was specified only in the
instance, in our example the ``CompressionLevel`` key was specified only in the
``DEFAULT`` section. If we try to get it from the section
``DEFAULT`` section. If we try to get it from the section
``topsecret.server.com``, we will always get the default, even if we specify
``topsecret.server.com``, we will always get the default, even if we specify
a
a
fallback:
fallback:
.. highlightlang:: python
.. doctest::
.. doctest::
>>> topsecret.get('CompressionLevel', '3')
>>> topsecret.get('CompressionLevel', '3')
...
@@ -195,7 +192,6 @@ provides a custom, more complex interface, maintained for backwards
...
@@ -195,7 +192,6 @@ provides a custom, more complex interface, maintained for backwards
compatibility. When using this method, a fallback value can be provided via the
compatibility. When using this method, a fallback value can be provided via the
``fallback`` keyword-only argument:
``fallback`` keyword-only argument:
.. highlightlang:: python
.. doctest::
.. doctest::
>>> config.get('bitbucket.org', 'monster',
>>> config.get('bitbucket.org', 'monster',
...
@@ -205,7 +201,6 @@ compatibility. When using this method, a fallback value can be provided via the
...
@@ -205,7 +201,6 @@ compatibility. When using this method, a fallback value can be provided via the
The same ``fallback`` argument can be used with the :meth:`getint`,
The same ``fallback`` argument can be used with the :meth:`getint`,
:meth:`getfloat` and :meth:`getboolean` methods, for example:
:meth:`getfloat` and :meth:`getboolean` methods, for example:
.. highlightlang:: python
.. doctest::
.. doctest::
>>> 'BatchMode' in topsecret
>>> 'BatchMode' in topsecret
...
@@ -216,33 +211,34 @@ The same ``fallback`` argument can be used with the :meth:`getint`,
...
@@ -216,33 +211,34 @@ The same ``fallback`` argument can be used with the :meth:`getint`,
>>> topsecret.getboolean('BatchMode', fallback=True)
>>> topsecret.getboolean('BatchMode', fallback=True)
False
False
Supported INI File Structure
Supported INI File Structure
----------------------------
----------------------------
A configuration file consists of sections, each led by a ``[section]`` header,
A configuration file consists of sections, each led by a ``[section]`` header,
followed by key/value entries separated by a specific string (``=`` or ``:`` by
followed by key/value entries separated by a specific string (``=`` or ``:`` by
default [
customizable]_). By default, section names are case sensitive but keys
default [
1]_). By default, section names are case sensitive but keys are not
are not [customizable]_.
Leading und trailing whitespace is removed from keys and from values.
[1]_.
Leading und trailing whitespace is removed from keys and from values.
Values can be omitted, in which case the key/value delimiter may also be left
Values can be omitted, in which case the key/value delimiter may also be left
out. Values can also span multiple lines, as long as they are indented deeper
out. Values can also span multiple lines, as long as they are indented deeper
than the first line of the value. Depending on the parser's mode, blank lines
than the first line of the value. Depending on the parser's mode, blank lines
may be treated as parts of multiline values or ignored.
may be treated as parts of multiline values or ignored.
Configuration files may include comments, prefixed by specific characters (``#``
Configuration files may include comments, prefixed by specific characters (``#``
and ``;`` by default [
customizable]_). Comments may appear on their own in an
and ``;`` by default [
1]_). Comments may appear on their own in an otherwise
otherwise empty line, or may be entered in lines holding values or section
empty line, or may be entered in lines holding values or section names. In the
names. In the latter case, they need to be preceded by a whitespace character
latter case, they need to be preceded by a whitespace character to be recognized
to be recognized as a comment. (For backwards compatibility, by default only
as a comment. (For backwards compatibility, by default only ``;`` starts an
``;`` starts an inline comment, while ``#`` does not [customizable
]_.)
inline comment, while ``#`` does not [1
]_.)
On top of the core functionality, :class:`SafeConfigParser` supports
On top of the core functionality, :class:`SafeConfigParser` supports
interpolation. This means values can contain format strings which refer to
interpolation. This means values can contain format strings which refer to
other values in the same section, or values in a special ``DEFAULT`` section
other values in the same section, or values in a special ``DEFAULT`` section
[
customizable
]_. Additional defaults can be provided on initialization.
[
1
]_. Additional defaults can be provided on initialization.
.. highlightlang:: none
For example:
For example::
.. code-block:: ini
[Paths]
[Paths]
home_dir: /Users
home_dir: /Users
...
@@ -286,11 +282,11 @@ value of ``my_pictures`` and ``%(home_dir)s/lumberjack`` as the value of
...
@@ -286,11 +282,11 @@ value of ``my_pictures`` and ``%(home_dir)s/lumberjack`` as the value of
``my_dir``. Other features presented in the example are handled in the same
``my_dir``. Other features presented in the example are handled in the same
manner by both parsers.
manner by both parsers.
Mapping Protocol Access
Mapping Protocol Access
-----------------------
-----------------------
.. versionadded:: 3.2
.. versionadded:: 3.2
.. highlightlang:: python
Mapping protocol access is a generic name for functionality that enables using
Mapping protocol access is a generic name for functionality that enables using
custom objects as if they were dictionaries. In case of :mod:`configparser`,
custom objects as if they were dictionaries. In case of :mod:`configparser`,
...
@@ -307,40 +303,40 @@ parser.
...
@@ -307,40 +303,40 @@ parser.
The mapping interface is complete and adheres to the ``MutableMapping`` ABC.
The mapping interface is complete and adheres to the ``MutableMapping`` ABC.
However, there are a few differences that should be taken into account:
However, there are a few differences that should be taken into account:
* by default, all keys in sections are accessible in a case-insensitive manner
* By default, all keys in sections are accessible in a case-insensitive manner
[customizable]_. E.g. ``for option in parser["section"]`` yields only
[1]_. E.g. ``for option in parser["section"]`` yields only ``optionxform``'ed
``optionxform``'ed option key names. This means lowercased keys by default.
option key names. This means lowercased keys by default. At the same time,
At the same time, for a section that holds the key ``"a"``, both expressions
for a section that holds the key ``"a"``, both expressions return ``True``::
return ``True``::
"a" in parser["section"]
"a" in parser["section"]
"A" in parser["section"]
"A" in parser["section"]
*
a
ll sections include ``DEFAULTSECT`` values as well which means that
*
A
ll sections include ``DEFAULTSECT`` values as well which means that
``.clear()`` on a section may not leave the section visibly empty. This is
``.clear()`` on a section may not leave the section visibly empty. This is
because default values cannot be deleted from the section (because technically
because default values cannot be deleted from the section (because technically
they are not there).
If they are overriden in the section, deleting causes the
they are not there).
If they are overriden in the section, deleting causes
default value to be visible again. Trying to delete a default value causes
the default value to be visible again. Trying to delete a default value
a ``KeyError``.
causes
a ``KeyError``.
*
trying to delete the ``DEFAULTSECT`` throws ``ValueError``
*
Trying to delete the ``DEFAULTSECT`` throws ``ValueError``.
*
there are two parser-level methods in the legacy API that hide
*
There are two parser-level methods in the legacy API that hide the dictionary
the dictionary
interface and are incompatible:
interface and are incompatible:
* ``parser.get(section, option, **kwargs)`` - the second argument is **not**
* ``parser.get(section, option, **kwargs)`` - the second argument is **not**
a
a
fallback value
fallback value
* ``parser.items(section)`` - this returns a list of ``(option, value)``
* ``parser.items(section)`` - this returns a list of ``(option, value)``
pairs
pairs for a specified ``section``.
for a specified ``section``
The mapping protocol is implemented on top of the existing legacy API so that
The mapping protocol is implemented on top of the existing legacy API so that
subclassing the original interface makes the mappings work as expected as well.
subclassing the original interface makes the mappings work as expected as well.
One difference is the explicit lack of support for the `
__name__
` special key.
One difference is the explicit lack of support for the `
`__name__`
` special key.
This is because the existing behaviour of `
__name__
` is very inconsistent and
This is because the existing behaviour of `
`__name__`
` is very inconsistent and
supporting it would only lead to problems. Details `here
supporting it would only lead to problems. Details `here
<http://mail.python.org/pipermail/python-dev/2010-July/102556.html>`_.
<http://mail.python.org/pipermail/python-dev/2010-July/102556.html>`_.
Customizing Parser Behaviour
Customizing Parser Behaviour
----------------------------
----------------------------
...
@@ -375,10 +371,9 @@ the :meth:`__init__` options:
...
@@ -375,10 +371,9 @@ the :meth:`__init__` options:
reasons.
reasons.
Please note: there are ways to add a set of key-value pairs in a single
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
operation.
When you use a regular dictionary in those operations, the order
the keys may be random.
For example:
of the keys may be random.
For example:
.. highlightlang:: python
.. doctest::
.. doctest::
>>> parser = configparser.RawConfigParser()
>>> parser = configparser.RawConfigParser()
...
@@ -399,7 +394,6 @@ the :meth:`__init__` options:
...
@@ -399,7 +394,6 @@ the :meth:`__init__` options:
In these operations you need to use an ordered dictionary as well:
In these operations you need to use an ordered dictionary as well:
.. highlightlang:: python
.. doctest::
.. doctest::
>>> from collections import OrderedDict
>>> from collections import OrderedDict
...
@@ -436,7 +430,6 @@ the :meth:`__init__` options:
...
@@ -436,7 +430,6 @@ the :meth:`__init__` options:
*allow_no_value* parameter to the :meth:`__init__` method can be used to
*allow_no_value* parameter to the :meth:`__init__` method can be used to
indicate that such values should be accepted:
indicate that such values should be accepted:
.. highlightlang:: python
.. doctest::
.. doctest::
>>> import configparser
>>> import configparser
...
@@ -495,19 +488,19 @@ the :meth:`__init__` options:
...
@@ -495,19 +488,19 @@ the :meth:`__init__` options:
If set to ``True``, the parser will not allow for any section or option
If set to ``True``, the parser will not allow for any section or option
duplicates while reading from a single source (using :meth:`read_file`,
duplicates while reading from a single source (using :meth:`read_file`,
:meth:`read_string` or :meth:`read_dict`). The default is ``False`` only
:meth:`read_string` or :meth:`read_dict`). The default is ``False`` only
because of backwards compatibility reasons.
It'
s recommended to use strict
because of backwards compatibility reasons.
It i
s recommended to use strict
parsers in new applications.
parsers in new applications.
* *empty_lines_in_values*, default value: ``True``
* *empty_lines_in_values*, default value: ``True``
.. highlightlang:: none
In config parsers, values can be multiline as long as they are indented deeper
In config parsers, values can be multiline as long as they're indented deeper
than the key that holds them. By default parsers also let empty lines to be
than the key that holds them. By default parsers also let empty lines to be
parts of values. At the same time, keys can be arbitrarily indented themselves
parts of values. At the same time, keys can be arbitrarily indented
to improve readability. In consequence, when configuration files get big and
themselves to improve readability. In consequence, when configuration files
complex, it's easy for the user to lose track of the file structure. Take for
get big and complex, it is easy for the user to lose track of the file
instance::
structure. Take for instance:
.. code-block:: ini
[Section]
[Section]
key = multiline
key = multiline
...
@@ -516,13 +509,12 @@ the :meth:`__init__` options:
...
@@ -516,13 +509,12 @@ the :meth:`__init__` options:
this = is still a part of the multiline value of 'key'
this = is still a part of the multiline value of 'key'
This can be especially problematic for the user to see if she's using
This can be especially problematic for the user to see if she's using
a
a proportional font to edit the file. That'
s why when your application does
proportional font to edit the file. That i
s why when your application does
not need values with empty lines, you should consider disallowing them. This
not need values with empty lines, you should consider disallowing them. This
will make empty lines split keys every time. In the example above, it would
will make empty lines split keys every time. In the example above, it would
produce two keys, ``key`` and ``this``.
produce two keys, ``key`` and ``this``.
.. highlightlang:: python
More advanced customization may be achieved by overriding default values of the
More advanced customization may be achieved by overriding default values of the
following parser members:
following parser members:
...
@@ -531,11 +523,10 @@ following parser members:
...
@@ -531,11 +523,10 @@ following parser members:
By default when using :meth:`getboolean`, config parsers consider the
By default when using :meth:`getboolean`, config parsers consider the
following values ``True``: ``'1'``, ``'yes'``, ``'true'``, ``'on'`` and the
following values ``True``: ``'1'``, ``'yes'``, ``'true'``, ``'on'`` and the
following values ``False``: ``'0'``, ``'no'``, ``'false'``, ``'off'``.
You can
following values ``False``: ``'0'``, ``'no'``, ``'false'``, ``'off'``.
You
override this by specifying a custom dictionary of strings and their boolean
can override this by specifying a custom dictionary of strings and their
outcomes. For example:
boolean
outcomes. For example:
.. highlightlang:: python
.. doctest::
.. doctest::
>>> custom = configparser.RawConfigParser()
>>> custom = configparser.RawConfigParser()
...
@@ -554,11 +545,10 @@ following parser members:
...
@@ -554,11 +545,10 @@ following parser members:
* :meth:`RawConfigParser.optionxform`
* :meth:`RawConfigParser.optionxform`
This is a method that transforms option names on every read or set operation.
This is a method that transforms option names on every read or set operation.
By default it converts the name to lowercase.
This also means that when
By default it converts the name to lowercase.
This also means that when a
a configuration file gets written, all keys will be lowercase. If you find
configuration file gets written, all keys will be lowercase. If you find that
that
behaviour unsuitable, you can override this method. For example:
behaviour unsuitable, you can override this method. For example:
.. highlightlang:: python
.. doctest::
.. doctest::
>>> config = """
>>> config = """
...
@@ -582,14 +572,15 @@ following parser members:
...
@@ -582,14 +572,15 @@ following parser members:
>>> list(custom['Section2'].keys())
>>> list(custom['Section2'].keys())
['AnotherKey']
['AnotherKey']
Legacy API Examples
Legacy API Examples
-------------------
-------------------
Mainly because of backwards compatibility concerns, :mod:`configparser`
Mainly because of backwards compatibility concerns, :mod:`configparser`
provides
provides also a legacy API with explicit ``get``/``set`` methods. While there
also a legacy API with explicit ``get``/``set`` methods. While there are valid
are valid use cases for the methods outlined below, mapping protocol access
use cases for the methods outlined below, mapping protocol access is preferred
is preferred for new projects. The legacy API is at times more advanced,
for new projects. The legacy API is at times more advanced, low-level and
low-level and
downright counterintuitive.
downright counterintuitive.
An example of writing to a configuration file::
An example of writing to a configuration file::
...
@@ -682,6 +673,7 @@ interpolation if an option used is not defined elsewhere. ::
...
@@ -682,6 +673,7 @@ interpolation if an option used is not defined elsewhere. ::
config.remove_option('Section1', 'baz')
config.remove_option('Section1', 'baz')
print(config.get('Section1', 'foo')) # -> "Life is hard!"
print(config.get('Section1', 'foo')) # -> "Life is hard!"
.. _rawconfigparser-objects:
.. _rawconfigparser-objects:
RawConfigParser Objects
RawConfigParser Objects
...
@@ -720,82 +712,84 @@ RawConfigParser Objects
...
@@ -720,82 +712,84 @@ RawConfigParser Objects
*empty_lines_in_values* were added.
*empty_lines_in_values* were added.
.. method:: RawConfigParser.
defaults()
.. method::
defaults()
Return a dictionary containing the instance-wide defaults.
Return a dictionary containing the instance-wide defaults.
.. method:: RawConfigParser.
sections()
.. method::
sections()
Return a list of the sections available; ``DEFAULT`` is not included in the
Return a list of the sections available; ``DEFAULT`` is not included in
list.
the
list.
.. method:: RawConfigParser.
add_section(section)
.. method::
add_section(section)
Add a section named *section* to the instance. If a section by the given name
Add a section named *section* to the instance. If a section by the given
already exists, :exc:`DuplicateSectionError` is raised.
If the name
name already exists, :exc:`DuplicateSectionError` is raised.
If the name
``DEFAULT`` (or any of it's case-insensitive variants) is passed,
``DEFAULT`` (or any of it's case-insensitive variants) is passed,
:exc:`ValueError` is raised.
:exc:`ValueError` is raised.
.. method:: RawConfigParser.has_section(section)
.. method:: has_section(section)
Indicates whether the named section is present in the configuration. The
Indicates whether the named section is present in the configuration. The
``DEFAULT`` section is not acknowledged.
``DEFAULT`` section is not acknowledged.
.. method:: RawConfigParser.
options(section)
.. method::
options(section)
Returns
a list of options available in the specified *section*.
Return
a list of options available in the specified *section*.
.. method:: RawConfigParser.
has_option(section, option)
.. method::
has_option(section, option)
If the given section exists, and contains the given option, return
If the given section exists, and contains the given option, return
:const:`True`; otherwise return :const:`False`.
:const:`True`; otherwise return :const:`False`.
.. method:: RawConfigParser.
read(filenames, encoding=None)
.. method::
read(filenames, encoding=None)
Attempt to read and parse a list of filenames, returning a list of filenames
Attempt to read and parse a list of filenames, returning a list of
which were successfully parsed. If *filenames* is a string, it is treated as
filenames which were successfully parsed. If *filenames* is a string, it
a single filename. If a file named in *filenames* cannot be opened, that
is treated as a single filename. If a file named in *filenames* cannot be
file will be ignored. This is designed so that you can specify a list of
opened, that file will be ignored. This is designed so that you can
potential configuration file locations (for example, the current directory,
specify a list of potential configuration file locations (for example, the
the user's home directory, and some system-wide directory), and all existing
current directory, the user's home directory, and some system-wide
configuration files in the list will be read. If none of the named files
directory), and all existing configuration files in the list will be read.
exist, the :class:`ConfigParser` instance will contain an empty dataset. An
If none of the named files exist, the :class:`ConfigParser` instance will
application which requires initial values to be loaded from a file should
contain an empty dataset. An application which requires initial values to
load the required file or files using :meth:`read_file` before call
ing
be loaded from a file should load the required file or files us
ing
:meth:`read` for any optional files::
:meth:`read_file` before calling
:meth:`read` for any optional files::
import configparser, os
import configparser, os
config = configparser.ConfigParser()
config = configparser.ConfigParser()
config.read_file(open('defaults.cfg'))
config.read_file(open('defaults.cfg'))
config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')], encoding='cp1250')
config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')],
encoding='cp1250')
.. versionadded:: 3.2
.. versionadded:: 3.2
The *encoding* parameter. Previously, all files were read using the
The *encoding* parameter. Previously, all files were read using the
default encoding for :func:`open`.
default encoding for :func:`open`.
.. method:: RawConfigParser.
read_file(f, source=None)
.. method::
read_file(f, source=None)
Read and parse configuration data from the file or file-like object in *f*
Read and parse configuration data from the file or file-like object in *f*
(only the :meth:`readline` method is used). The file-like object must
(only the :meth:`readline` method is used). The file-like object must
operate in text mode, i.e. return strings from :meth:`readline`.
operate in text mode, i.e. return strings from :meth:`readline`.
Optional argument *source* specifies the name of the file being read. It not
Optional argument *source* specifies the name of the file being read. If
given and *f* has a :attr:`name` attribute, that is used for *source*; the
not given and *f* has a :attr:`name` attribute, that is used for *source*;
default is ``<???>``.
the
default is ``<???>``.
.. versionadded:: 3.2
.. versionadded:: 3.2
Renamed from :meth:`readfp` (with the ``filename`` attribute renamed to
Renamed from :meth:`readfp` (with the ``filename`` attribute renamed to
``source`` for consistency with other ``read_*`` methods).
``source`` for consistency with other ``read_*`` methods).
.. method:: RawConfigParser.
read_string(string, source='<string>')
.. method::
read_string(string, source='<string>')
Parse configuration data from a given string.
Parse configuration data from a given string.
...
@@ -805,25 +799,25 @@ RawConfigParser Objects
...
@@ -805,25 +799,25 @@ RawConfigParser Objects
.. versionadded:: 3.2
.. versionadded:: 3.2
.. method:: RawConfigParser.
read_dict(dictionary, source='<dict>')
.. method::
read_dict(dictionary, source='<dict>')
Load configuration from a dictionary. Keys are section names, values are
Load configuration from a dictionary. Keys are section names, values are
dictionaries with keys and values that should be present in the section. If
dictionaries with keys and values that should be present in the section.
the used dictionary type preserves order, sections and their keys will be
If the used dictionary type preserves order, sections and their keys will
added in order.
Values are automatically converted to strings.
be added in order.
Values are automatically converted to strings.
Optional argument *source* specifies a context-specific name of the
Optional argument *source* specifies a context-specific name of the
dictionary passed. If not given, ``<dict>`` is used.
dictionary passed. If not given, ``<dict>`` is used.
.. versionadded:: 3.2
.. versionadded:: 3.2
.. method:: RawConfigParser.
get(section, option, [vars, fallback])
.. method::
get(section, option, [vars, fallback])
Get an *option* value for the named *section*. If *vars* is provided, it
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),
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 a
nd
*section*, and in *DEFAULTSECT* in that order. If the key is not fou
nd
*fallback* is provided, it is used as a fallback value. ``None`` can be
and *fallback* is provided, it is used as a fallback value. ``None`` can
provided as a *fallback* value.
be
provided as a *fallback* value.
.. versionchanged:: 3.2
.. versionchanged:: 3.2
Arguments *vars* and *fallback* are keyword only to protect users from
Arguments *vars* and *fallback* are keyword only to protect users from
...
@@ -831,97 +825,99 @@ RawConfigParser Objects
...
@@ -831,97 +825,99 @@ RawConfigParser Objects
when using the mapping protocol).
when using the mapping protocol).
.. method:: RawConfigParser.
getint(section, option, [vars, fallback])
.. method::
getint(section, option, [vars, fallback])
A convenience method which coerces the *option* in the specified *section* to
A convenience method which coerces the *option* in the specified *section*
an integer.
See :meth:`get` for explanation of *vars* and *fallback*.
to an integer.
See :meth:`get` for explanation of *vars* and *fallback*.
.. method:: RawConfigParser.
getfloat(section, option, [vars, fallback])
.. method::
getfloat(section, option, [vars, fallback])
A convenience method which coerces the *option* in the specified *section* to
A convenience method which coerces the *option* in the specified *section*
a floating point number. See :meth:`get` for explanation of *vars* and
to
a floating point number. See :meth:`get` for explanation of *vars* and
*fallback*.
*fallback*.
.. method:: RawConfigParser.
getboolean(section, option, [vars, fallback])
.. method::
getboolean(section, option, [vars, fallback])
A convenience method which coerces the *option* in the specified *section*
A convenience method which coerces the *option* in the specified *section*
to a Boolean value. Note that the accepted values for the option are
to a Boolean value. Note that the accepted values for the option are
``"1"``, ``"yes"``, ``"true"``, and ``"on"``, which cause this method to
``"1"``, ``"yes"``, ``"true"``, and ``"on"``, which cause this method to
return ``True``, and ``"0"``, ``"no"``, ``"false"``, and ``"off"``, which
return ``True``, and ``"0"``, ``"no"``, ``"false"``, and ``"off"``, which
cause it to return ``False``. These string values are checked in
cause it to return ``False``. These string values are checked in a
a case-insensitive manner. Any other value will cause it to raise
case-insensitive manner. Any other value will cause it to raise
:exc:`ValueError`. See :meth:`get` for explanation of *vars* and *fallback*.
:exc:`ValueError`. See :meth:`get` for explanation of *vars* and
*fallback*.
.. method:: RawConfigParser.
items(section)
.. method::
items(section)
Return a list of ``(name, value)`` pairs for each option in the given
Return a list of ``(name, value)`` pairs for each option in the given
*section*.
*section*.
.. method:: RawConfigParser.
set(section, option, value)
.. method::
set(section, option, value)
If the given section exists, set the given option to the specified value;
If the given section exists, set the given option to the specified value;
otherwise raise :exc:`NoSectionError`. While it is possible to use
otherwise raise :exc:`NoSectionError`. While it is possible to use
:class:`RawConfigParser` (or :class:`ConfigParser` with *raw* parameters set
:class:`RawConfigParser` (or :class:`ConfigParser` with *raw* parameters
to true) for *internal* storage of non-string values, full functionality
set to true) for *internal* storage of non-string values, full
(including interpolation and output to files) can only be achieved using
functionality (including interpolation and output to files) can only be
string values.
achieved using
string values.
.. warning
::
.. note
::
This method lets users assign non-string values to keys internally. This
This method lets users assign non-string values to keys internally.
behaviour is unsupported and will cause errors when attempting to write
to
This behaviour is unsupported and will cause errors when attempting
to
a file or get it in non-raw mode. **Use the mapping protocol API** which does
write to a file or get it in non-raw mode. **Use the mapping protocol
not allow such assignments to take place.
API** which does
not allow such assignments to take place.
.. method:: RawConfigParser.
write(fileobject, space_around_delimiters=True)
.. method::
write(fileobject, space_around_delimiters=True)
Write a representation of the configuration to the specified
Write a representation of the configuration to the specified :term:`file
:term:`file object`, which must be opened in text mode (accepting strings).
object`, which must be opened in text mode (accepting strings). This
This representation can be parsed by a future :meth:`read` call.
If
representation can be parsed by a future :meth:`read` call.
If
``space_around_delimiters`` is ``True`` (the default), delimiters between
``space_around_delimiters`` is ``True`` (the default), delimiters between
keys and values are surrounded by spaces.
keys and values are surrounded by spaces.
.. method:: RawConfigParser.
remove_option(section, option)
.. method::
remove_option(section, option)
Remove the specified *option* from the specified *section*. If the section does
Remove the specified *option* from the specified *section*. If the
not exist, raise :exc:`NoSectionError`. If the option existed to be removed,
section does not exist, raise :exc:`NoSectionError`. If the option
return :const:`True`; otherwise return :const:`False`.
existed to be removed, return :const:`True`; otherwise return
:const:`False`.
.. method:: RawConfigParser.
remove_section(section)
.. method::
remove_section(section)
Remove the specified *section* from the configuration. If the section in fact
Remove the specified *section* from the configuration. If the section in
existed, return ``True``.
Otherwise return ``False``.
fact existed, return ``True``.
Otherwise return ``False``.
.. method:: RawConfigParser.
optionxform(option)
.. method::
optionxform(option)
Transforms the option name *option* as found in an input file or as passed in
Transforms the option name *option* as found in an input file or as passed
by client code to the form that should be used in the internal structures.
in by client code to the form that should be used in the internal
The default implementation returns a lower-case version of *option*;
structures. The default implementation returns a lower-case version of
subclasses may override this or client code can set an attribute of this nam
e
*option*; subclasses may override this or client code can set an attribut
e
on instances to affect this behavior.
of this name
on instances to affect this behavior.
You don't necessarily need to subclass a ConfigParser to use this method, you
You don't necessarily need to subclass a ConfigParser to use this method,
can also re-set it on an instance, to a function that takes a string
you
can also re-set it on an instance, to a function that takes a string
argument. Setting it to ``str``, for example, would make option names case
argument. Setting it to ``str``, for example, would make option names
sensitive::
case
sensitive::
cfgparser = ConfigParser()
cfgparser = ConfigParser()
...
...
cfgparser.optionxform = str
cfgparser.optionxform = str
Note that when reading configuration files, whitespace around the
Note that when reading configuration files, whitespace around the option
option
names are stripped before :meth:`optionxform` is called.
names are stripped before :meth:`optionxform` is called.
.. method:: RawConfigParser.
readfp(fp, filename=None)
.. method::
readfp(fp, filename=None)
.. deprecated:: 3.2
.. deprecated:: 3.2
Please use :meth:`read_file` instead.
Please use :meth:`read_file` instead.
...
@@ -933,8 +929,8 @@ ConfigParser Objects
...
@@ -933,8 +929,8 @@ ConfigParser Objects
--------------------
--------------------
.. warning::
.. warning::
Whenever you can, consider using :class:`SafeConfigParser` which
Whenever you can, consider using :class:`SafeConfigParser` which
adds
adds
validation and escaping for the interpolation.
validation and escaping for the interpolation.
The :class:`ConfigParser` class extends some methods of the
The :class:`ConfigParser` class extends some methods of the
:class:`RawConfigParser` interface, adding some optional arguments.
:class:`RawConfigParser` interface, adding some optional arguments.
...
@@ -966,54 +962,55 @@ The :class:`ConfigParser` class extends some methods of the
...
@@ -966,54 +962,55 @@ The :class:`ConfigParser` class extends some methods of the
*strict* and *empty_lines_in_values* were added.
*strict* and *empty_lines_in_values* were added.
.. method:: ConfigParser.
get(section, option, raw=False, [vars, fallback])
.. method::
get(section, option, raw=False, [vars, fallback])
Get an *option* value for the named *section*. If *vars* is provided, it
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),
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 a
nd
*section*, and in *DEFAULTSECT* in that order. If the key is not fou
nd
*fallback* is provided, it is used as a fallback value. ``None`` can be
and *fallback* is provided, it is used as a fallback value. ``None`` can
provided as a *fallback* value.
be
provided as a *fallback* value.
All the ``'%'`` interpolations are expanded in the return values, unless the
All the ``'%'`` interpolations are expanded in the return values, unless
*raw* argument is true. Values for interpolation keys are looked up in the
the *raw* argument is true. Values for interpolation keys are looked up
same manner as the option.
in the
same manner as the option.
.. versionchanged:: 3.2
.. versionchanged:: 3.2
Arguments *raw*, *vars* and *fallback* are keyword only to protect users
Arguments *raw*, *vars* and *fallback* are keyword only to protect
from trying to use the third argument as the *fallback* fallback
users
from trying to use the third argument as the *fallback* fallback
(especially when using the mapping protocol).
(especially when using the mapping protocol).
.. method:: ConfigParser.
getint(section, option, raw=False, [vars, fallback])
.. method::
getint(section, option, raw=False, [vars, fallback])
A convenience method which coerces the *option* in the specified *section* to
A convenience method which coerces the *option* in the specified *section*
an integer. See :meth:`get` for explanation of *raw*, *vars* and *fallback*.
to an integer. See :meth:`get` for explanation of *raw*, *vars* and
*fallback*.
.. method:: ConfigParser.
getfloat(section, option, raw=False, [vars, fallback])
.. method::
getfloat(section, option, raw=False, [vars, fallback])
A convenience method which coerces the *option* in the specified *section* to
A convenience method which coerces the *option* in the specified *section*
a floating point number. See :meth:`get` for explanation of *raw*, *vars*
to a floating point number. See :meth:`get` for explanation of *raw*,
and *fallback*.
*vars*
and *fallback*.
.. method:: ConfigParser.
getboolean(section, option, raw=False, [vars, fallback])
.. method::
getboolean(section, option, raw=False, [vars, fallback])
A convenience method which coerces the *option* in the specified *section*
A convenience method which coerces the *option* in the specified *section*
to a Boolean value. Note that the accepted values for the option are
to a Boolean value. Note that the accepted values for the option are
``"1"``, ``"yes"``, ``"true"``, and ``"on"``, which cause this method to
``"1"``, ``"yes"``, ``"true"``, and ``"on"``, which cause this method to
return ``True``, and ``"0"``, ``"no"``, ``"false"``, and ``"off"``, which
return ``True``, and ``"0"``, ``"no"``, ``"false"``, and ``"off"``, which
cause it to return ``False``. These string values are checked in
cause it to return ``False``. These string values are checked in a
a
case-insensitive manner. Any other value will cause it to raise
case-insensitive manner. Any other value will cause it to raise
:exc:`ValueError`. See :meth:`get` for explanation of *raw*, *vars* and
:exc:`ValueError`. See :meth:`get` for explanation of *raw*, *vars* and
*fallback*.
*fallback*.
.. method:: ConfigParser.
items(section, raw=False, vars=None)
.. method::
items(section, raw=False, vars=None)
Return a list of ``(name, value)`` pairs for each option in the given
Return a list of ``(name, value)`` pairs for each option in the given
*section*. Optional arguments have the same meaning as for the :meth:`get`
*section*. Optional arguments have the same meaning as for the
method.
:meth:`get`
method.
.. data:: MAX_INTERPOLATION_DEPTH
.. data:: MAX_INTERPOLATION_DEPTH
...
@@ -1021,6 +1018,7 @@ The :class:`ConfigParser` class extends some methods of the
...
@@ -1021,6 +1018,7 @@ The :class:`ConfigParser` class extends some methods of the
The maximum depth for recursive interpolation for :meth:`get` when the *raw*
The maximum depth for recursive interpolation for :meth:`get` when the *raw*
parameter is false. This is relevant only for the :class:`ConfigParser` class.
parameter is false. This is relevant only for the :class:`ConfigParser` class.
.. _safeconfigparser-objects:
.. _safeconfigparser-objects:
SafeConfigParser Objects
SafeConfigParser Objects
...
@@ -1046,10 +1044,10 @@ SafeConfigParser Objects
...
@@ -1046,10 +1044,10 @@ SafeConfigParser Objects
*empty_lines_in_values* were added.
*empty_lines_in_values* were added.
The :class:`SafeConfigParser` class implements the same extended interface as
The :class:`SafeConfigParser` class implements the same extended interface as
:class:`ConfigParser`, with the following addition:
:class:`ConfigParser`, with the following addition:
.. method:: SafeConfigParser.
set(section, option, value)
.. method::
set(section, option, value)
If the given section exists, set the given option to the specified value;
If the given section exists, set the given option to the specified value;
otherwise raise :exc:`NoSectionError`. *value* must be a string; if it is
otherwise raise :exc:`NoSectionError`. *value* must be a string; if it is
...
@@ -1109,19 +1107,20 @@ Exceptions
...
@@ -1109,19 +1107,20 @@ Exceptions
.. exception:: InterpolationMissingOptionError
.. exception:: InterpolationMissingOptionError
Exception raised when an option referenced from a value does not exist.
Subclass
Exception raised when an option referenced from a value does not exist.
of :exc:`InterpolationError`.
Subclass
of :exc:`InterpolationError`.
.. exception:: InterpolationSyntaxError
.. exception:: InterpolationSyntaxError
Exception raised when the source text into which substitutions are made does
not
Exception raised when the source text into which substitutions are made does
conform to the required syntax.
Subclass of :exc:`InterpolationError`.
not conform to the required syntax.
Subclass of :exc:`InterpolationError`.
.. exception:: MissingSectionHeaderError
.. exception:: MissingSectionHeaderError
Exception raised when attempting to parse a file which has no section headers.
Exception raised when attempting to parse a file which has no section
headers.
.. exception:: ParsingError
.. exception:: ParsingError
...
@@ -1132,6 +1131,9 @@ Exceptions
...
@@ -1132,6 +1131,9 @@ Exceptions
The ``filename`` attribute and :meth:`__init__` argument were renamed to
The ``filename`` attribute and :meth:`__init__` argument were renamed to
``source`` for consistency.
``source`` for consistency.
.. [customizable] Config parsers allow for very heavy customization. If you're
interested in changing the behaviour outlined by the footnote
.. rubric:: Footnotes
reference, consult the `Customizing Parser Behaviour`_ section.
.. [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.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment