Issue 10499: Modular interpolation in configparser
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index df7a1de..6822176 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -17,11 +17,10 @@
single: ini file
single: Windows ini file
-This module provides the classes :class:`RawConfigParser` and
-:class:`SafeConfigParser`. They implement a basic configuration
-language which provides a structure similar to what's found in Microsoft
-Windows INI files. You can use this to write Python programs which can be
-customized by end users easily.
+This module provides the :class:`SafeConfigParser` class which implements
+a basic configuration language which provides a structure similar to what's
+found in Microsoft Windows INI files. You can use this to write Python
+programs which can be customized by end users easily.
.. note::
@@ -34,6 +33,10 @@
Support for a creating Unix shell-like mini-languages which can be used
as an alternate format for application configuration files.
+ Module :mod:`json`
+ The json module implements a subset of JavaScript syntax which can also
+ be used for this purpose.
+
Quick Start
-----------
@@ -43,17 +46,17 @@
.. code-block:: ini
[DEFAULT]
- ServerAliveInterval = 45
- Compression = yes
- CompressionLevel = 9
- ForwardX11 = yes
+ ServerAliveInterval = 45
+ Compression = yes
+ CompressionLevel = 9
+ ForwardX11 = yes
[bitbucket.org]
- User = hg
+ User = hg
[topsecret.server.com]
- Port = 50022
- ForwardX11 = no
+ Port = 50022
+ ForwardX11 = no
The structure of INI files is described `in the following section
<#supported-ini-file-structure>`_. Essentially, the file
@@ -64,7 +67,7 @@
.. doctest::
>>> import configparser
- >>> config = configparser.RawConfigParser()
+ >>> config = configparser.SafeConfigParser()
>>> config['DEFAULT'] = {'ServerAliveInterval': '45',
... 'Compression': 'yes',
... 'CompressionLevel': '9'}
@@ -89,7 +92,7 @@
.. doctest::
>>> import configparser
- >>> config = configparser.RawConfigParser()
+ >>> config = configparser.SafeConfigParser()
>>> config.sections()
[]
>>> config.read('example.ini')
@@ -233,23 +236,26 @@
compatibility, by default only ``;`` starts an inline comment, while
``#`` does not [1]_.
-On top of the core functionality, :class:`SafeConfigParser` supports
-interpolation. This means values can contain format strings which refer to
-other values in the same section, or values in a special ``DEFAULT`` section
-[1]_. Additional defaults can be provided on initialization.
-
For example:
.. code-block:: ini
- [Paths]
- home_dir: /Users
- my_dir: %(home_dir)s/lumberjack
- my_pictures: %(my_dir)s/Pictures
+ [Simple Values]
+ key: value
+ spaces in keys: allowed
+ spaces in values: allowed as well
+ 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
+ I sleep all night and I work all day
[No Values]
key_without_value
@@ -262,28 +268,92 @@
multiline ;comment
value! ;comment
- [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?
+ [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?
-In the example above, :class:`SafeConfigParser` would resolve ``%(home_dir)s``
-to the value of ``home_dir`` (``/Users`` in this case). ``%(my_dir)s`` in
-effect would resolve to ``/Users/lumberjack``. All interpolations are done on
-demand so keys used in the chain of references do not have to be specified in
-any specific order in the configuration file.
-:class:`RawConfigParser` would simply return ``%(my_dir)s/Pictures`` as the
-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
-manner by both parsers.
+Interpolation of values
+-----------------------
+On top of the core functionality, :class:`SafeConfigParser` supports
+interpolation. This means values can be preprocessed before returning them
+from ``get()`` calls.
+
+.. class:: BasicInterpolation()
+
+ The default implementation used by :class:`SafeConfigParser`. It enables
+ values to contain format strings which refer to other values in the same
+ section, or values in the special default section [1]_. Additional default
+ values can be provided on initialization.
+
+ For example:
+
+ .. code-block:: ini
+
+ [Paths]
+ home_dir: /Users
+ my_dir: %(home_dir)s/lumberjack
+ my_pictures: %(my_dir)s/Pictures
+
+
+ In the example above, :class:`SafeConfigParser` with *interpolation* set to
+ ``BasicInterpolation()`` would resolve ``%(home_dir)s`` to the value of
+ ``home_dir`` (``/Users`` in this case). ``%(my_dir)s`` in effect would
+ resolve to ``/Users/lumberjack``. All interpolations are done on demand so
+ keys used in the chain of references do not have to be specified in any
+ specific order in the configuration file.
+
+ With ``interpolation`` set to ``None``, the parser would simply return
+ ``%(my_dir)s/Pictures`` as the value of ``my_pictures`` and
+ ``%(home_dir)s/lumberjack`` as the value of ``my_dir``.
+
+.. class:: ExtendedInterpolation()
+
+ An alternative handler for interpolation which implements a more advanced
+ syntax, used for instance in ``zc.buildout``. Extended interpolation is
+ using ``${section:option}`` to denote a value from a foreign section.
+ Interpolation can span multiple levels. For convenience, if the ``section:``
+ part is omitted, interpolation defaults to the current section (and possibly
+ the default values from the special section).
+
+ For example, the configuration specified above with basic interpolation,
+ would look like this with extended interpolation:
+
+ .. code-block:: ini
+
+ [Paths]
+ home_dir: /Users
+ my_dir: ${home_dir}/lumberjack
+ my_pictures: ${my_dir}/Pictures
+
+ Values from other sections can be fetched as well:
+
+ .. code-block:: ini
+
+ [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}
Mapping Protocol Access
-----------------------
@@ -350,9 +420,9 @@
* *defaults*, default value: ``None``
This option accepts a dictionary of key-value pairs which will be initially
- put in the ``DEFAULTSECT``. This makes for an elegant way to support concise
- configuration files that don't specify values which are the same as the
- documented default.
+ put in the ``DEFAULT`` section. This makes for an elegant way to support
+ concise configuration files that don't specify values which are the same as
+ the documented default.
Hint: if you want to specify default values for a specific section, use
:meth:`read_dict` before you read the actual file.
@@ -374,7 +444,7 @@
.. doctest::
- >>> parser = configparser.RawConfigParser()
+ >>> parser = configparser.SafeConfigParser()
>>> parser.read_dict({'section1': {'key1': 'value1',
... 'key2': 'value2',
... 'key3': 'value3'},
@@ -395,7 +465,7 @@
.. doctest::
>>> from collections import OrderedDict
- >>> parser = configparser.RawConfigParser()
+ >>> parser = configparser.SafeConfigParser()
>>> parser.read_dict(
... OrderedDict((
... ('s1',
@@ -441,7 +511,7 @@
... skip-bdb
... skip-innodb # we don't need ACID today
... """
- >>> config = configparser.RawConfigParser(allow_no_value=True)
+ >>> config = configparser.SafeConfigParser(allow_no_value=True)
>>> config.read_string(sample_config)
>>> # Settings with values are treated as before:
@@ -464,7 +534,7 @@
This means values (but not keys) can contain the delimiters.
See also the *space_around_delimiters* argument to
- :meth:`RawConfigParser.write`.
+ :meth:`SafeConfigParser.write`.
* *comment_prefixes*, default value: ``_COMPATIBLE`` (``'#'`` valid on empty
lines, ``';'`` valid also on non-empty lines)
@@ -512,6 +582,31 @@
will make empty lines split keys every time. In the example above, it would
produce two keys, ``key`` and ``this``.
+* *default_section*, default value: ``configparser.DEFAULTSECT`` (that is:
+ ``"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 <#interpolation-of-values>`_.
+
+ .. note:: :class:`RawConfigParser` is using ``None`` by default and
+ :class:`ConfigParser` is using ``configparser.BrokenInterpolation``.
+
More advanced customization may be achieved by overriding default values of
these parser attributes. The defaults are defined on the classes, so they
@@ -527,7 +622,7 @@
.. doctest::
- >>> custom = configparser.RawConfigParser()
+ >>> custom = configparser.SafeConfigParser()
>>> custom['section1'] = {'funky': 'nope'}
>>> custom['section1'].getboolean('funky')
Traceback (most recent call last):
@@ -557,7 +652,7 @@
... [Section2]
... AnotherKey = Value
... """
- >>> typical = configparser.RawConfigParser()
+ >>> typical = configparser.SafeConfigParser()
>>> typical.read_string(config)
>>> list(typical['Section1'].keys())
['key']
@@ -623,8 +718,7 @@
if config.getboolean('Section1', 'bool'):
print(config.get('Section1', 'foo'))
-To get interpolation, use :class:`SafeConfigParser` or, if
-you absolutely have to, a :class:`ConfigParser`::
+To get interpolation, use :class:`SafeConfigParser`::
import configparser
@@ -672,14 +766,14 @@
print(config.get('Section1', 'foo')) # -> "Life is hard!"
-.. _rawconfigparser-objects:
+.. _safeconfigparser-objects:
-RawConfigParser Objects
------------------------
+SafeConfigParser Objects
+------------------------
-.. class:: RawConfigParser(defaults=None, dict_type=collections.OrderedDict, allow_no_value=False, delimiters=('=', ':'), comment_prefixes=_COMPATIBLE, strict=False, empty_lines_in_values=True)
+.. class:: SafeConfigParser(defaults=None, dict_type=collections.OrderedDict, allow_no_value=False, delimiters=('=', ':'), comment_prefixes=_COMPATIBLE, strict=False, empty_lines_in_values=True, default_section=configparser.DEFAULTSECT, interpolation=BasicInterpolation())
- The basic configuration parser. When *defaults* is given, it is initialized
+ 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.
@@ -698,16 +792,33 @@
(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 presented for these is ``None``.
+ values are accepted; the value held for these is ``None`` and they are
+ serialized without the trailing delimiter.
- This class does not support the magical interpolation behavior.
+ 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 <#interpolation-of-values>`_.
+
+ All option names used in interpolation will be passed through the
+ :meth:`optionxform` method just like any other option name reference. For
+ example, using the default implementation of :meth:`optionxform` (which
+ converts option names to lower case), the values ``foo %(bar)s`` and ``foo
+ %(BAR)s`` are equivalent.
.. versionchanged:: 3.1
The default *dict_type* is :class:`collections.OrderedDict`.
.. versionchanged:: 3.2
- *allow_no_value*, *delimiters*, *comment_prefixes*, *strict* and
- *empty_lines_in_values* were added.
+ *allow_no_value*, *delimiters*, *comment_prefixes*, *strict*,
+ *empty_lines_in_values*, *default_section* and *interpolation* were
+ added.
.. method:: defaults()
@@ -717,22 +828,21 @@
.. method:: sections()
- Return a list of the sections available; ``DEFAULT`` is not included in
- the list.
+ Return a list of the sections available; the *default section* is not
+ included in the list.
.. method:: add_section(section)
Add a section named *section* to the instance. If a section by the given
- name already exists, :exc:`DuplicateSectionError` is raised. If the name
- ``DEFAULT`` (or any of it's case-insensitive variants) is passed,
- :exc:`ValueError` is raised.
+ name already exists, :exc:`DuplicateSectionError` is raised. If the
+ *default section* name is passed, :exc:`ValueError` is raised.
.. method:: has_section(section)
- Indicates whether the named section is present in the configuration. The
- ``DEFAULT`` section is not acknowledged.
+ Indicates whether the named *section* is present in the configuration.
+ The *default section* is not acknowledged.
.. method:: options(section)
@@ -742,7 +852,7 @@
.. 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`.
@@ -750,19 +860,20 @@
Attempt to read and parse a list of filenames, returning a list of
filenames which were successfully parsed. If *filenames* is a string, 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 a list 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 list will be read.
- If none of the named files exist, the :class:`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
- :meth:`read_file` before calling :meth:`read` for any optional files::
+ 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 a list 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 list will be
+ read. If none of the named files exist, the :class:`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 :meth:`read_file` before calling :meth:`read` for any
+ optional files::
import configparser, os
- config = configparser.ConfigParser()
+ config = configparser.SafeConfigParser()
config.read_file(open('defaults.cfg'))
config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')],
encoding='cp1250')
@@ -810,154 +921,6 @@
.. versionadded:: 3.2
- .. method:: get(section, option, [vars, 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.
-
- .. versionchanged:: 3.2
- Arguments *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).
-
-
- .. method:: getint(section, option, [vars, fallback])
-
- A convenience method which coerces the *option* in the specified *section*
- to an integer. See :meth:`get` for explanation of *vars* and *fallback*.
-
-
- .. method:: getfloat(section, option, [vars, fallback])
-
- A convenience method which coerces the *option* in the specified *section*
- to a floating point number. See :meth:`get` for explanation of *vars* and
- *fallback*.
-
-
- .. method:: getboolean(section, option, [vars, 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
- :exc:`ValueError`. See :meth:`get` for explanation of *vars* and
- *fallback*.
-
-
- .. method:: items(section)
-
- Return a list of *name*, *value* pairs for each option in the given
- *section*.
-
-
- .. method:: set(section, option, value)
-
- If the given section exists, set the given option to the specified value;
- otherwise raise :exc:`NoSectionError`. While it is possible to use
- :class:`RawConfigParser` (or :class:`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.
-
- .. note::
-
- 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.
-
-
- .. method:: write(fileobject, space_around_delimiters=True)
-
- Write a representation of the configuration to the specified :term:`file
- object`, which must be opened in text mode (accepting strings). This
- representation can be parsed by a future :meth:`read` call. If
- *space_around_delimiters* is true, delimiters between
- keys and values are surrounded by spaces.
-
-
- .. method:: remove_option(section, option)
-
- Remove the specified *option* from the specified *section*. If the
- section does not exist, raise :exc:`NoSectionError`. If the option
- existed to be removed, return :const:`True`; otherwise return
- :const:`False`.
-
-
- .. method:: remove_section(section)
-
- Remove the specified *section* from the configuration. If the section in
- fact existed, return ``True``. Otherwise return ``False``.
-
-
- .. method:: 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 :meth:`optionxform` is called.
-
-
- .. method:: readfp(fp, filename=None)
-
- .. deprecated:: 3.2
- Use :meth:`read_file` instead.
-
-
-.. _configparser-objects:
-
-ConfigParser Objects
---------------------
-
-.. warning::
- Whenever you can, consider using :class:`SafeConfigParser` which adds
- validation and escaping for the interpolation.
-
-The :class:`ConfigParser` class extends some methods of the
-:class:`RawConfigParser` interface, adding some optional arguments.
-
-.. class:: ConfigParser(defaults=None, dict_type=collections.OrderedDict, allow_no_value=False, delimiters=('=', ':'), comment_prefixes=_COMPATIBLE, strict=False, empty_lines_in_values=True)
-
- Derived class of :class:`RawConfigParser` that implements the magical
- interpolation feature and adds optional arguments to the :meth:`get` and
- :meth:`items` methods.
-
- :class:`SafeConfigParser` is generally recommended over this class if you
- need interpolation.
-
- The values in *defaults* must be appropriate for the ``%()s`` string
- interpolation.
-
- All option names used in interpolation will be passed through the
- :meth:`optionxform` method just like any other option name reference. For
- example, using the default implementation of :meth:`optionxform` (which
- converts option names to lower case), the values ``foo %(bar)s`` and ``foo
- %(BAR)s`` are equivalent.
-
- .. versionchanged:: 3.1
- The default *dict_type* is :class:`collections.OrderedDict`.
-
- .. versionchanged:: 3.2
- *allow_no_value*, *delimiters*, *comment_prefixes*,
- *strict* and *empty_lines_in_values* were added.
-
.. method:: get(section, option, raw=False, [vars, fallback])
@@ -1010,40 +973,6 @@
:meth:`get` method.
-.. data:: MAX_INTERPOLATION_DEPTH
-
- The maximum depth for recursive interpolation for :meth:`get` when the *raw*
- parameter is false. This is relevant only for the :class:`ConfigParser` class.
-
-
-.. _safeconfigparser-objects:
-
-SafeConfigParser Objects
-------------------------
-
-.. class:: SafeConfigParser(defaults=None, dict_type=collections.OrderedDict, allow_no_value=False, delimiters=('=', ':'), comment_prefixes=_COMPATIBLE, strict=False, empty_lines_in_values=True)
-
- Derived class of :class:`ConfigParser` that implements a variant of the
- magical interpolation feature. This implementation is more predictable as
- it validates the interpolation syntax used within a configuration file.
- This class also enables escaping the interpolation character (a key can have
- ``%`` as part of the value by specifying ``%%`` in the file).
-
- Applications that don't require interpolation should use
- :class:`RawConfigParser`, otherwise :class:`SafeConfigParser` is the best
- option.
-
- .. versionchanged:: 3.1
- The default *dict_type* is :class:`collections.OrderedDict`.
-
- .. versionchanged:: 3.2
- *allow_no_value*, *delimiters*, *comment_prefixes*, *strict* and
- *empty_lines_in_values* were added.
-
-
- The :class:`SafeConfigParser` class implements the same extended interface
- as :class:`ConfigParser`, with the following addition:
-
.. method:: set(section, option, value)
If the given section exists, set the given option to the specified value;
@@ -1051,6 +980,112 @@
:exc:`TypeError` is raised.
+ .. method:: write(fileobject, space_around_delimiters=True)
+
+ Write a representation of the configuration to the specified :term:`file
+ object`, which must be opened in text mode (accepting strings). This
+ representation can be parsed by a future :meth:`read` call. If
+ *space_around_delimiters* is true, delimiters between
+ keys and values are surrounded by spaces.
+
+
+ .. method:: remove_option(section, option)
+
+ Remove the specified *option* from the specified *section*. If the
+ section does not exist, raise :exc:`NoSectionError`. If the option
+ existed to be removed, return :const:`True`; otherwise return
+ :const:`False`.
+
+
+ .. method:: remove_section(section)
+
+ Remove the specified *section* from the configuration. If the section in
+ fact existed, return ``True``. Otherwise return ``False``.
+
+
+ .. method:: 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 :meth:`optionxform` is called.
+
+
+ .. method:: readfp(fp, filename=None)
+
+ .. deprecated:: 3.2
+ Use :meth:`read_file` instead.
+
+
+.. data:: MAX_INTERPOLATION_DEPTH
+
+ The maximum depth for recursive interpolation for :meth:`get` when the *raw*
+ parameter is false. This is relevant only when the default *interpolation*
+ is used.
+
+
+.. _rawconfigparser-objects:
+
+RawConfigParser Objects
+-----------------------
+
+.. class:: RawConfigParser(defaults=None, dict_type=collections.OrderedDict, allow_no_value=False, delimiters=('=', ':'), comment_prefixes=_COMPATIBLE, strict=False, empty_lines_in_values=True, default_section=configaparser.DEFAULTSECT, interpolation=None)
+
+ Legacy variant of the :class:`SafeConfigParser` with interpolation disabled
+ by default and an unsafe ``set`` method.
+
+ .. note::
+ Consider using :class:`SafeConfigParser` instead which checks types of
+ the values to be stored internally. If you don't want interpolation, you
+ can use ``SafeConfigParser(interpolation=None)``.
+
+
+ .. method:: set(section, option, value)
+
+ If the given section exists, set the given option to the specified value;
+ otherwise raise :exc:`NoSectionError`. While it is possible to use
+ :class:`RawConfigParser` (or :class:`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.
+
+
+.. _configparser-objects:
+
+ConfigParser Objects
+--------------------
+
+.. class:: ConfigParser(defaults=None, dict_type=collections.OrderedDict, allow_no_value=False, delimiters=('=', ':'), comment_prefixes=_COMPATIBLE, strict=False, empty_lines_in_values=True, default_section=configparser.DEFAULTSECT, interpolation=BrokenInterpolation())
+
+ .. deprecated:: 3.2
+ Whenever you can, consider using :class:`SafeConfigParser`. The
+ :class:`ConfigParser` provides the same functionality but its
+ implementation is less predictable. It does not validate the
+ interpolation syntax used within a configuration file. It also does not
+ enable escaping the interpolation character (when using
+ :class:`SafeConfigParser`, a key can have ``%`` as part of the value by
+ specifying ``%%`` in the file). On top of that, this class doesn't ensure
+ whether values passed to the parser object are strings which may lead to
+ inconsistent internal state.
+
+
Exceptions
----------
diff --git a/Doc/library/fileformats.rst b/Doc/library/fileformats.rst
index 980d4f5..e9c2e1f 100644
--- a/Doc/library/fileformats.rst
+++ b/Doc/library/fileformats.rst
@@ -5,7 +5,7 @@
************
The modules described in this chapter parse various miscellaneous file formats
-that aren't markup languages or are related to e-mail.
+that aren't markup languages and are not related to e-mail.
.. toctree::