https://github.com/python/cpython/commit/fc2178117538c161471711073887f34bcd464cc1
commit: fc2178117538c161471711073887f34bcd464cc1
branch: main
author: Timon Viola <44016238+timonvi...@users.noreply.github.com>
committer: ambv <luk...@langa.pl>
date: 2024-07-13T12:47:05Z
summary:
gh-96765: Update ConfigParser.read() docs with multi-file read example (#121664)
Co-authored-by: Łukasz Langa <luk...@langa.pl>
files:
M Doc/library/configparser.rst
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index e84fb513e45267..6fae03cd5c96fd 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -147,23 +147,28 @@ case-insensitive and stored in lowercase [1]_.
It is possible to read several configurations into a single
:class:`ConfigParser`, where the most recently added configuration has the
highest priority. Any conflicting keys are taken from the more recent
-configuration while the previously existing keys are retained.
+configuration while the previously existing keys are retained. The example
+below reads in an ``override.ini`` file, which will override any conflicting
+keys from the ``example.ini`` file.
+
+.. code-block:: ini
+
+ [DEFAULT]
+ ServerAliveInterval = -1
.. doctest::
- >>> another_config = configparser.ConfigParser()
- >>> another_config.read('example.ini')
- ['example.ini']
- >>> another_config['topsecret.server.example']['Port']
- '50022'
- >>> another_config.read_string("[topsecret.server.example]\nPort=48484")
- >>> another_config['topsecret.server.example']['Port']
- '48484'
- >>> another_config.read_dict({"topsecret.server.example": {"Port": 21212}})
- >>> another_config['topsecret.server.example']['Port']
- '21212'
- >>> another_config['topsecret.server.example']['ForwardX11']
- 'no'
+ >>> config_override = configparser.ConfigParser()
+ >>> config_override['DEFAULT'] = {'ServerAliveInterval': '-1'}
+ >>> with open('override.ini', 'w') as configfile:
+ ... config_override.write(configfile)
+ ...
+ >>> config_override = configparser.ConfigParser()
+ >>> config_override.read(['example.ini', 'override.ini'])
+ ['example.ini', 'override.ini']
+ >>> print(config_override.get('DEFAULT', 'ServerAliveInterval'))
+ -1
+
This behaviour is equivalent to a :meth:`ConfigParser.read` call with several
files passed to the *filenames* parameter.
@@ -984,6 +989,31 @@ ConfigParser Objects
converter gets its own corresponding :meth:`!get*()` method on the parser
object and section proxies.
+ It is possible to read several configurations into a single
+ :class:`ConfigParser`, where the most recently added configuration has the
+ highest priority. Any conflicting keys are taken from the more recent
+ configuration while the previously existing keys are retained. The example
+ below reads in an ``override.ini`` file, which will override any conflicting
+ keys from the ``example.ini`` file.
+
+ .. code-block:: ini
+
+ [DEFAULT]
+ ServerAliveInterval = -1
+
+ .. doctest::
+
+ >>> config_override = configparser.ConfigParser()
+ >>> config_override['DEFAULT'] = {'ServerAliveInterval': '-1'}
+ >>> with open('override.ini', 'w') as configfile:
+ ... config_override.write(configfile)
+ ...
+ >>> config_override = configparser.ConfigParser()
+ >>> config_override.read(['example.ini', 'override.ini'])
+ ['example.ini', 'override.ini']
+ >>> print(config_override.get('DEFAULT', 'ServerAliveInterval'))
+ -1
+
.. versionchanged:: 3.1
The default *dict_type* is :class:`collections.OrderedDict`.
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
