https://github.com/python/cpython/commit/f3d3663a47f82de5ddf384ea1497bd3b36…
commit: f3d3663a47f82de5ddf384ea1497bd3b36d795d7
branch: 3.12
author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com>
committer: iritkatriel <1055913+iritkatriel(a)users.noreply.github.com>
date: 2023-12-31T23:22:55Z
summary:
[3.12] gh-101578: [doc] mention that PyErr_GetRaisedException returns NULL when the error indicator is not set (GH-113369) (#113606)
gh-101578: [doc] mention that PyErr_GetRaisedException returns NULL when the error indicator is not set (GH-113369)
(cherry picked from commit 2849cbb53afc8c6a4465f1b3490c67c2455caf6f)
Co-authored-by: Irit Katriel <1055913+iritkatriel(a)users.noreply.github.com>
files:
M Doc/c-api/exceptions.rst
diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index d5119789a5f623..39408641c8a52e 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -427,7 +427,7 @@ Querying the error indicator
.. c:function:: PyObject *PyErr_GetRaisedException(void)
Return the exception currently being raised, clearing the error indicator at
- the same time.
+ the same time. Return ``NULL`` if the error indicator is not set.
This function is used by code that needs to catch exceptions,
or code that needs to save and restore the error indicator temporarily.
https://github.com/python/cpython/commit/2849cbb53afc8c6a4465f1b3490c67c245…
commit: 2849cbb53afc8c6a4465f1b3490c67c2455caf6f
branch: main
author: Irit Katriel <1055913+iritkatriel(a)users.noreply.github.com>
committer: iritkatriel <1055913+iritkatriel(a)users.noreply.github.com>
date: 2023-12-31T23:16:33Z
summary:
gh-101578: [doc] mention that PyErr_GetRaisedException returns NULL when the error indicator is not set (#113369)
files:
M Doc/c-api/exceptions.rst
diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index 284a9c71e420da..c7e3cd9463e5d7 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -440,7 +440,7 @@ Querying the error indicator
.. c:function:: PyObject *PyErr_GetRaisedException(void)
Return the exception currently being raised, clearing the error indicator at
- the same time.
+ the same time. Return ``NULL`` if the error indicator is not set.
This function is used by code that needs to catch exceptions,
or code that needs to save and restore the error indicator temporarily.
https://github.com/python/cpython/commit/51691133795814a3ac3bc84e938238eb0e…
commit: 51691133795814a3ac3bc84e938238eb0e720d8f
branch: 3.11
author: Hugo van Kemenade <hugovk(a)users.noreply.github.com>
committer: AlexWaygood <Alex.Waygood(a)Gmail.com>
date: 2023-12-31T18:18:49Z
summary:
[3.11] gh-101100: Fix Sphinx warnings in `library/configparser.rst` (GH-113598) (#113600)
(cherry picked from commit 30a6d79fb8bc1ef96600c290c016720103b74b2d)
Co-authored-by: Alex Waygood <Alex.Waygood(a)Gmail.com>
files:
M Doc/library/configparser.rst
M Doc/library/logging.config.rst
M Doc/tools/.nitignore
M Doc/whatsnew/2.0.rst
M Doc/whatsnew/2.4.rst
M Doc/whatsnew/2.7.rst
M Doc/whatsnew/3.11.rst
M Doc/whatsnew/3.2.rst
M Misc/NEWS.d/3.11.0a1.rst
M Misc/NEWS.d/3.11.0a6.rst
M Misc/NEWS.d/3.8.0a1.rst
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index 6a3bb93115dda7..f6e17908a7e29e 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -208,7 +208,7 @@ converters and customize the provided ones. [1]_
Fallback Values
---------------
-As with a dictionary, you can use a section's :meth:`get` method to
+As with a dictionary, you can use a section's :meth:`~ConfigParser.get` method to
provide fallback values:
.. doctest::
@@ -232,7 +232,7 @@ even if we specify a fallback:
>>> topsecret.get('CompressionLevel', '3')
'9'
-One more thing to be aware of is that the parser-level :meth:`get` method
+One more thing to be aware of is that the parser-level :meth:`~ConfigParser.get` method
provides a custom, more complex interface, maintained for backwards
compatibility. When using this method, a fallback value can be provided via
the ``fallback`` keyword-only argument:
@@ -481,7 +481,7 @@ historical background and it's very likely that you will want to customize some
of the features.
The most common way to change the way a specific config parser works is to use
-the :meth:`__init__` options:
+the :meth:`!__init__` options:
* *defaults*, default value: ``None``
@@ -491,7 +491,7 @@ the :meth:`__init__` options:
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.
+ :meth:`~ConfigParser.read_dict` before you read the actual file.
* *dict_type*, default value: :class:`dict`
@@ -635,8 +635,8 @@ the :meth:`__init__` options:
* *strict*, default value: ``True``
When set to ``True``, the parser will not allow for any section or option
- duplicates while reading from a single source (using :meth:`read_file`,
- :meth:`read_string` or :meth:`read_dict`). It is recommended to use strict
+ duplicates while reading from a single source (using :meth:`~ConfigParser.read_file`,
+ :meth:`~ConfigParser.read_string` or :meth:`~ConfigParser.read_dict`). It is recommended to use strict
parsers in new applications.
.. versionchanged:: 3.2
@@ -697,7 +697,7 @@ the :meth:`__init__` options:
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
- :meth:`getdecimal` on both the parser object and all section proxies. In
+ :meth:`!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)``.
@@ -1062,11 +1062,11 @@ ConfigParser Objects
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 :attr:`name` attribute, that is used for
+ not given and *f* has a :attr:`!name` attribute, that is used for
*source*; the default is ``'<???>'``.
.. versionadded:: 3.2
- Replaces :meth:`readfp`.
+ Replaces :meth:`!readfp`.
.. method:: read_string(string, source='<string>')
@@ -1236,7 +1236,7 @@ ConfigParser Objects
.. data:: MAX_INTERPOLATION_DEPTH
- The maximum depth for recursive interpolation for :meth:`get` when the *raw*
+ The maximum depth for recursive interpolation for :meth:`~configparser.ConfigParser.get` when the *raw*
parameter is false. This is relevant only when the default *interpolation*
is used.
@@ -1309,13 +1309,13 @@ Exceptions
.. exception:: DuplicateSectionError
- Exception raised if :meth:`add_section` is called with the name of a section
+ Exception raised if :meth:`~ConfigParser.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.
.. versionadded:: 3.2
Optional ``source`` and ``lineno`` attributes and arguments to
- :meth:`__init__` were added.
+ :meth:`!__init__` were added.
.. exception:: DuplicateOptionError
@@ -1368,7 +1368,7 @@ Exceptions
Exception raised when errors occur attempting to parse a file.
.. versionchanged:: 3.2
- The ``filename`` attribute and :meth:`__init__` argument were renamed to
+ The ``filename`` attribute and :meth:`!__init__` argument were renamed to
``source`` for consistency.
diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index 45aa67a2e49f62..7a9261c575a47c 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -93,8 +93,8 @@ in :mod:`logging` itself) and defining handlers which are declared either in
:param fname: A filename, or a file-like object, or an instance derived
from :class:`~configparser.RawConfigParser`. If a
- ``RawConfigParser``-derived instance is passed, it is used as
- is. Otherwise, a :class:`~configparser.Configparser` is
+ :class:`!RawConfigParser`-derived instance is passed, it is used as
+ is. Otherwise, a :class:`~configparser.ConfigParser` is
instantiated, and the configuration read by it from the
object passed in ``fname``. If that has a :meth:`readline`
method, it is assumed to be a file-like object and read using
@@ -103,7 +103,7 @@ in :mod:`logging` itself) and defining handlers which are declared either in
:meth:`~configparser.ConfigParser.read`.
- :param defaults: Defaults to be passed to the ConfigParser can be specified
+ :param defaults: Defaults to be passed to the :class:`!ConfigParser` can be specified
in this argument.
:param disable_existing_loggers: If specified as ``False``, loggers which
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index c14fb6e9f9a81c..5f7409df2c86c2 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -33,7 +33,6 @@ Doc/library/asyncio-task.rst
Doc/library/bdb.rst
Doc/library/collections.rst
Doc/library/concurrent.futures.rst
-Doc/library/configparser.rst
Doc/library/copy.rst
Doc/library/csv.rst
Doc/library/ctypes.rst
diff --git a/Doc/whatsnew/2.0.rst b/Doc/whatsnew/2.0.rst
index fe7efe8ca01ccd..c0552e4947e3f1 100644
--- a/Doc/whatsnew/2.0.rst
+++ b/Doc/whatsnew/2.0.rst
@@ -1030,7 +1030,7 @@ Module changes
Lots of improvements and bugfixes were made to Python's extensive standard
library; some of the affected modules include :mod:`readline`,
-:mod:`ConfigParser`, :mod:`cgi`, :mod:`calendar`, :mod:`posix`, :mod:`readline`,
+:mod:`ConfigParser <configparser>`, :mod:`cgi`, :mod:`calendar`, :mod:`posix`, :mod:`readline`,
:mod:`xmllib`, :mod:`aifc`, :mod:`chunk, wave`, :mod:`random`, :mod:`shelve`,
and :mod:`nntplib`. Consult the CVS logs for the exact patch-by-patch details.
diff --git a/Doc/whatsnew/2.4.rst b/Doc/whatsnew/2.4.rst
index 1d455294910509..7236be8a58d6cb 100644
--- a/Doc/whatsnew/2.4.rst
+++ b/Doc/whatsnew/2.4.rst
@@ -1052,9 +1052,9 @@ complete list of changes, or look through the CVS logs for all the details.
advantage of :class:`collections.deque` for improved performance. (Contributed
by Raymond Hettinger.)
-* The :mod:`ConfigParser` classes have been enhanced slightly. The :meth:`read`
+* The :mod:`ConfigParser <configparser>` classes have been enhanced slightly. The :meth:`~configparser.ConfigParser.read`
method now returns a list of the files that were successfully parsed, and the
- :meth:`set` method raises :exc:`TypeError` if passed a *value* argument that
+ :meth:`~configparser.ConfigParser.set` method raises :exc:`TypeError` if passed a *value* argument that
isn't a string. (Contributed by John Belmonte and David Goodger.)
* The :mod:`curses` module now supports the ncurses extension
diff --git a/Doc/whatsnew/2.7.rst b/Doc/whatsnew/2.7.rst
index 2c057fb71759cb..020dd41399812a 100644
--- a/Doc/whatsnew/2.7.rst
+++ b/Doc/whatsnew/2.7.rst
@@ -287,7 +287,7 @@ remains O(1).
The standard library now supports use of ordered dictionaries in several
modules.
-* The :mod:`ConfigParser` module uses them by default, meaning that
+* The :mod:`ConfigParser <configparser>` module uses them by default, meaning that
configuration files can now be read, modified, and then written back
in their original order.
@@ -1134,7 +1134,7 @@ changes, or look through the Subversion logs for all the details.
another type that isn't a :class:`Mapping`.
(Fixed by Daniel Stutzbach; :issue:`8729`.)
-* Constructors for the parsing classes in the :mod:`ConfigParser` module now
+* Constructors for the parsing classes in the :mod:`ConfigParser <configparser>` module now
take an *allow_no_value* parameter, defaulting to false; if true,
options without values will be allowed. For example::
diff --git a/Doc/whatsnew/3.11.rst b/Doc/whatsnew/3.11.rst
index 1698c206b87704..104d9894601d60 100644
--- a/Doc/whatsnew/3.11.rst
+++ b/Doc/whatsnew/3.11.rst
@@ -1773,7 +1773,7 @@ Standard Library
* the :class:`!configparser.SafeConfigParser` class
* the :attr:`!configparser.ParsingError.filename` property
- * the :meth:`configparser.RawConfigParser.readfp` method
+ * the :meth:`!configparser.RawConfigParser.readfp` method
(Contributed by Hugo van Kemenade in :issue:`45173`.)
diff --git a/Doc/whatsnew/3.2.rst b/Doc/whatsnew/3.2.rst
index ef99b3d75e1924..75f4eec1d05e52 100644
--- a/Doc/whatsnew/3.2.rst
+++ b/Doc/whatsnew/3.2.rst
@@ -183,7 +183,7 @@ PEP 391: Dictionary Based Configuration for Logging
The :mod:`logging` module provided two kinds of configuration, one style with
function calls for each option or another style driven by an external file saved
-in a :mod:`ConfigParser` format. Those options did not provide the flexibility
+in a :mod:`configparser` format. Those options did not provide the flexibility
to create configurations from JSON or YAML files, nor did they support
incremental configuration, which is needed for specifying logger options from a
command line.
@@ -2132,7 +2132,7 @@ configparser
The :mod:`configparser` module was modified to improve usability and
predictability of the default parser and its supported INI syntax. The old
-:class:`ConfigParser` class was removed in favor of :class:`SafeConfigParser`
+:class:`!ConfigParser` class was removed in favor of :class:`!SafeConfigParser`
which has in turn been renamed to :class:`~configparser.ConfigParser`. Support
for inline comments is now turned off by default and section or option
duplicates are not allowed in a single configuration source.
@@ -2412,7 +2412,7 @@ when one operand is much larger than the other (patch by Andress Bennetts in
(:issue:`1569291` by Alexander Belopolsky). The :class:`BaseHTTPRequestHandler`
has more efficient buffering (:issue:`3709` by Andrew Schaaf). The
:func:`operator.attrgetter` function has been sped-up (:issue:`10160` by
-Christos Georgiou). And :class:`ConfigParser` loads multi-line arguments a bit
+Christos Georgiou). And :class:`~configparser.ConfigParser` loads multi-line arguments a bit
faster (:issue:`7113` by Łukasz Langa).
@@ -2612,8 +2612,8 @@ This section lists previously described changes and other bugfixes that may
require changes to your code:
* The :mod:`configparser` module has a number of clean-ups. The major change is
- to replace the old :class:`ConfigParser` class with long-standing preferred
- alternative :class:`SafeConfigParser`. In addition there are a number of
+ to replace the old :class:`!ConfigParser` class with long-standing preferred
+ alternative :class:`!SafeConfigParser`. In addition there are a number of
smaller incompatibilities:
* The interpolation syntax is now validated on
diff --git a/Misc/NEWS.d/3.11.0a1.rst b/Misc/NEWS.d/3.11.0a1.rst
index 38f1e15f5b1087..ff57266aadea38 100644
--- a/Misc/NEWS.d/3.11.0a1.rst
+++ b/Misc/NEWS.d/3.11.0a1.rst
@@ -1642,9 +1642,9 @@ interval specified with nanosecond precision.
.. nonce: UptGAn
.. section: Library
-Remove from the :mod:`configparser` module: the :class:`SafeConfigParser`
-class, the :attr:`filename` property of the :class:`ParsingError` class, the
-:meth:`readfp` method of the :class:`ConfigParser` class, deprecated since
+Remove from the :mod:`configparser` module: the :class:`!SafeConfigParser`
+class, the :attr:`!filename` property of the :class:`~configparser.ParsingError` class, the
+:meth:`!readfp` method of the :class:`~configparser.ConfigParser` class, deprecated since
Python 3.2.
Patch by Hugo van Kemenade.
diff --git a/Misc/NEWS.d/3.11.0a6.rst b/Misc/NEWS.d/3.11.0a6.rst
index 52055b3fafd485..974d025c631a45 100644
--- a/Misc/NEWS.d/3.11.0a6.rst
+++ b/Misc/NEWS.d/3.11.0a6.rst
@@ -941,7 +941,7 @@ uvloop library.
Make the :class:`configparser.ConfigParser` constructor raise
:exc:`TypeError` if the ``interpolation`` parameter is not of type
-:class:`configparser.Interpolation`
+:class:`!configparser.Interpolation`
..
diff --git a/Misc/NEWS.d/3.8.0a1.rst b/Misc/NEWS.d/3.8.0a1.rst
index 104e6649f24120..78587a68379c0c 100644
--- a/Misc/NEWS.d/3.8.0a1.rst
+++ b/Misc/NEWS.d/3.8.0a1.rst
@@ -5044,8 +5044,8 @@ functionality.
.. nonce: C_K-J9
.. section: Library
-`ConfigParser.items()` was fixed so that key-value pairs passed in via
-`vars` are not included in the resulting output.
+``ConfigParser.items()`` was fixed so that key-value pairs passed in via
+:func:`vars` are not included in the resulting output.
..
https://github.com/python/cpython/commit/a8011d5eb0f2bc9f27d00f0db609023297…
commit: a8011d5eb0f2bc9f27d00f0db6090232976c0eac
branch: 3.12
author: Hugo van Kemenade <hugovk(a)users.noreply.github.com>
committer: AlexWaygood <Alex.Waygood(a)Gmail.com>
date: 2023-12-31T18:17:33Z
summary:
[3.12] gh-101100: Fix Sphinx warnings in `library/configparser.rst` (GH-113598) (#113599)
(cherry picked from commit 30a6d79fb8bc1ef96600c290c016720103b74b2d)
Co-authored-by: Alex Waygood <Alex.Waygood(a)Gmail.com>
files:
M Doc/library/configparser.rst
M Doc/library/logging.config.rst
M Doc/tools/.nitignore
M Doc/whatsnew/2.0.rst
M Doc/whatsnew/2.4.rst
M Doc/whatsnew/2.7.rst
M Doc/whatsnew/3.11.rst
M Doc/whatsnew/3.2.rst
M Misc/NEWS.d/3.11.0a1.rst
M Misc/NEWS.d/3.11.0a6.rst
M Misc/NEWS.d/3.8.0a1.rst
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index 4d0dad20287a90..0031737853e7b4 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -208,7 +208,7 @@ converters and customize the provided ones. [1]_
Fallback Values
---------------
-As with a dictionary, you can use a section's :meth:`get` method to
+As with a dictionary, you can use a section's :meth:`~ConfigParser.get` method to
provide fallback values:
.. doctest::
@@ -232,7 +232,7 @@ even if we specify a fallback:
>>> topsecret.get('CompressionLevel', '3')
'9'
-One more thing to be aware of is that the parser-level :meth:`get` method
+One more thing to be aware of is that the parser-level :meth:`~ConfigParser.get` method
provides a custom, more complex interface, maintained for backwards
compatibility. When using this method, a fallback value can be provided via
the ``fallback`` keyword-only argument:
@@ -481,7 +481,7 @@ historical background and it's very likely that you will want to customize some
of the features.
The most common way to change the way a specific config parser works is to use
-the :meth:`__init__` options:
+the :meth:`!__init__` options:
* *defaults*, default value: ``None``
@@ -491,7 +491,7 @@ the :meth:`__init__` options:
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.
+ :meth:`~ConfigParser.read_dict` before you read the actual file.
* *dict_type*, default value: :class:`dict`
@@ -635,8 +635,8 @@ the :meth:`__init__` options:
* *strict*, default value: ``True``
When set to ``True``, the parser will not allow for any section or option
- duplicates while reading from a single source (using :meth:`read_file`,
- :meth:`read_string` or :meth:`read_dict`). It is recommended to use strict
+ duplicates while reading from a single source (using :meth:`~ConfigParser.read_file`,
+ :meth:`~ConfigParser.read_string` or :meth:`~ConfigParser.read_dict`). It is recommended to use strict
parsers in new applications.
.. versionchanged:: 3.2
@@ -697,7 +697,7 @@ the :meth:`__init__` options:
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
- :meth:`getdecimal` on both the parser object and all section proxies. In
+ :meth:`!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)``.
@@ -1062,11 +1062,11 @@ ConfigParser Objects
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 :attr:`name` attribute, that is used for
+ not given and *f* has a :attr:`!name` attribute, that is used for
*source*; the default is ``'<???>'``.
.. versionadded:: 3.2
- Replaces :meth:`readfp`.
+ Replaces :meth:`!readfp`.
.. method:: read_string(string, source='<string>')
@@ -1214,7 +1214,7 @@ ConfigParser Objects
.. data:: MAX_INTERPOLATION_DEPTH
- The maximum depth for recursive interpolation for :meth:`get` when the *raw*
+ The maximum depth for recursive interpolation for :meth:`~configparser.ConfigParser.get` when the *raw*
parameter is false. This is relevant only when the default *interpolation*
is used.
@@ -1287,13 +1287,13 @@ Exceptions
.. exception:: DuplicateSectionError
- Exception raised if :meth:`add_section` is called with the name of a section
+ Exception raised if :meth:`~ConfigParser.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.
.. versionadded:: 3.2
Optional ``source`` and ``lineno`` attributes and arguments to
- :meth:`__init__` were added.
+ :meth:`!__init__` were added.
.. exception:: DuplicateOptionError
@@ -1345,9 +1345,9 @@ Exceptions
Exception raised when errors occur attempting to parse a file.
-.. versionchanged:: 3.12
- The ``filename`` attribute and :meth:`__init__` constructor argument were
- removed. They have been available using the name ``source`` since 3.2.
+ .. versionchanged:: 3.12
+ The ``filename`` attribute and :meth:`!__init__` constructor argument were
+ removed. They have been available using the name ``source`` since 3.2.
.. rubric:: Footnotes
diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index 1c0ea22deac957..e1ecd3513078fe 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -93,8 +93,8 @@ in :mod:`logging` itself) and defining handlers which are declared either in
:param fname: A filename, or a file-like object, or an instance derived
from :class:`~configparser.RawConfigParser`. If a
- ``RawConfigParser``-derived instance is passed, it is used as
- is. Otherwise, a :class:`~configparser.Configparser` is
+ :class:`!RawConfigParser`-derived instance is passed, it is used as
+ is. Otherwise, a :class:`~configparser.ConfigParser` is
instantiated, and the configuration read by it from the
object passed in ``fname``. If that has a :meth:`readline`
method, it is assumed to be a file-like object and read using
@@ -103,7 +103,7 @@ in :mod:`logging` itself) and defining handlers which are declared either in
:meth:`~configparser.ConfigParser.read`.
- :param defaults: Defaults to be passed to the ConfigParser can be specified
+ :param defaults: Defaults to be passed to the :class:`!ConfigParser` can be specified
in this argument.
:param disable_existing_loggers: If specified as ``False``, loggers which
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index 0d91e09cc7d6cd..c0f8aee64aed7c 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -39,7 +39,6 @@ Doc/library/cgi.rst
Doc/library/chunk.rst
Doc/library/collections.rst
Doc/library/concurrent.futures.rst
-Doc/library/configparser.rst
Doc/library/copy.rst
Doc/library/csv.rst
Doc/library/datetime.rst
diff --git a/Doc/whatsnew/2.0.rst b/Doc/whatsnew/2.0.rst
index aa03d85f75d2f5..3effa74179b34b 100644
--- a/Doc/whatsnew/2.0.rst
+++ b/Doc/whatsnew/2.0.rst
@@ -1030,7 +1030,7 @@ Module changes
Lots of improvements and bugfixes were made to Python's extensive standard
library; some of the affected modules include :mod:`readline`,
-:mod:`ConfigParser`, :mod:`cgi`, :mod:`calendar`, :mod:`posix`, :mod:`readline`,
+:mod:`ConfigParser <configparser>`, :mod:`cgi`, :mod:`calendar`, :mod:`posix`, :mod:`readline`,
:mod:`xmllib`, :mod:`aifc`, :mod:`chunk, wave`, :mod:`random`, :mod:`shelve`,
and :mod:`nntplib`. Consult the CVS logs for the exact patch-by-patch details.
diff --git a/Doc/whatsnew/2.4.rst b/Doc/whatsnew/2.4.rst
index 1d455294910509..7236be8a58d6cb 100644
--- a/Doc/whatsnew/2.4.rst
+++ b/Doc/whatsnew/2.4.rst
@@ -1052,9 +1052,9 @@ complete list of changes, or look through the CVS logs for all the details.
advantage of :class:`collections.deque` for improved performance. (Contributed
by Raymond Hettinger.)
-* The :mod:`ConfigParser` classes have been enhanced slightly. The :meth:`read`
+* The :mod:`ConfigParser <configparser>` classes have been enhanced slightly. The :meth:`~configparser.ConfigParser.read`
method now returns a list of the files that were successfully parsed, and the
- :meth:`set` method raises :exc:`TypeError` if passed a *value* argument that
+ :meth:`~configparser.ConfigParser.set` method raises :exc:`TypeError` if passed a *value* argument that
isn't a string. (Contributed by John Belmonte and David Goodger.)
* The :mod:`curses` module now supports the ncurses extension
diff --git a/Doc/whatsnew/2.7.rst b/Doc/whatsnew/2.7.rst
index b01cd5e52ffa9d..220c531d341aa0 100644
--- a/Doc/whatsnew/2.7.rst
+++ b/Doc/whatsnew/2.7.rst
@@ -287,7 +287,7 @@ remains O(1).
The standard library now supports use of ordered dictionaries in several
modules.
-* The :mod:`ConfigParser` module uses them by default, meaning that
+* The :mod:`ConfigParser <configparser>` module uses them by default, meaning that
configuration files can now be read, modified, and then written back
in their original order.
@@ -1134,7 +1134,7 @@ changes, or look through the Subversion logs for all the details.
another type that isn't a :class:`Mapping`.
(Fixed by Daniel Stutzbach; :issue:`8729`.)
-* Constructors for the parsing classes in the :mod:`ConfigParser` module now
+* Constructors for the parsing classes in the :mod:`ConfigParser <configparser>` module now
take an *allow_no_value* parameter, defaulting to false; if true,
options without values will be allowed. For example::
diff --git a/Doc/whatsnew/3.11.rst b/Doc/whatsnew/3.11.rst
index a8c412e79a79f6..b0695d31fb36ab 100644
--- a/Doc/whatsnew/3.11.rst
+++ b/Doc/whatsnew/3.11.rst
@@ -1773,7 +1773,7 @@ Standard Library
* the :class:`!configparser.SafeConfigParser` class
* the :attr:`!configparser.ParsingError.filename` property
- * the :meth:`configparser.RawConfigParser.readfp` method
+ * the :meth:`!configparser.RawConfigParser.readfp` method
(Contributed by Hugo van Kemenade in :issue:`45173`.)
diff --git a/Doc/whatsnew/3.2.rst b/Doc/whatsnew/3.2.rst
index 230f0d3e629680..449fa5a438bfc2 100644
--- a/Doc/whatsnew/3.2.rst
+++ b/Doc/whatsnew/3.2.rst
@@ -183,7 +183,7 @@ PEP 391: Dictionary Based Configuration for Logging
The :mod:`logging` module provided two kinds of configuration, one style with
function calls for each option or another style driven by an external file saved
-in a :mod:`ConfigParser` format. Those options did not provide the flexibility
+in a :mod:`configparser` format. Those options did not provide the flexibility
to create configurations from JSON or YAML files, nor did they support
incremental configuration, which is needed for specifying logger options from a
command line.
@@ -2134,7 +2134,7 @@ configparser
The :mod:`configparser` module was modified to improve usability and
predictability of the default parser and its supported INI syntax. The old
-:class:`ConfigParser` class was removed in favor of :class:`SafeConfigParser`
+:class:`!ConfigParser` class was removed in favor of :class:`!SafeConfigParser`
which has in turn been renamed to :class:`~configparser.ConfigParser`. Support
for inline comments is now turned off by default and section or option
duplicates are not allowed in a single configuration source.
@@ -2414,7 +2414,7 @@ when one operand is much larger than the other (patch by Andress Bennetts in
(:issue:`1569291` by Alexander Belopolsky). The :class:`BaseHTTPRequestHandler`
has more efficient buffering (:issue:`3709` by Andrew Schaaf). The
:func:`operator.attrgetter` function has been sped-up (:issue:`10160` by
-Christos Georgiou). And :class:`ConfigParser` loads multi-line arguments a bit
+Christos Georgiou). And :class:`~configparser.ConfigParser` loads multi-line arguments a bit
faster (:issue:`7113` by Łukasz Langa).
@@ -2614,8 +2614,8 @@ This section lists previously described changes and other bugfixes that may
require changes to your code:
* The :mod:`configparser` module has a number of clean-ups. The major change is
- to replace the old :class:`ConfigParser` class with long-standing preferred
- alternative :class:`SafeConfigParser`. In addition there are a number of
+ to replace the old :class:`!ConfigParser` class with long-standing preferred
+ alternative :class:`!SafeConfigParser`. In addition there are a number of
smaller incompatibilities:
* The interpolation syntax is now validated on
diff --git a/Misc/NEWS.d/3.11.0a1.rst b/Misc/NEWS.d/3.11.0a1.rst
index d30acb3e064076..6c9eb34064efad 100644
--- a/Misc/NEWS.d/3.11.0a1.rst
+++ b/Misc/NEWS.d/3.11.0a1.rst
@@ -1642,9 +1642,9 @@ interval specified with nanosecond precision.
.. nonce: UptGAn
.. section: Library
-Remove from the :mod:`configparser` module: the :class:`SafeConfigParser`
-class, the :attr:`filename` property of the :class:`ParsingError` class, the
-:meth:`readfp` method of the :class:`ConfigParser` class, deprecated since
+Remove from the :mod:`configparser` module: the :class:`!SafeConfigParser`
+class, the :attr:`!filename` property of the :class:`~configparser.ParsingError` class, the
+:meth:`!readfp` method of the :class:`~configparser.ConfigParser` class, deprecated since
Python 3.2.
Patch by Hugo van Kemenade.
diff --git a/Misc/NEWS.d/3.11.0a6.rst b/Misc/NEWS.d/3.11.0a6.rst
index 52055b3fafd485..974d025c631a45 100644
--- a/Misc/NEWS.d/3.11.0a6.rst
+++ b/Misc/NEWS.d/3.11.0a6.rst
@@ -941,7 +941,7 @@ uvloop library.
Make the :class:`configparser.ConfigParser` constructor raise
:exc:`TypeError` if the ``interpolation`` parameter is not of type
-:class:`configparser.Interpolation`
+:class:`!configparser.Interpolation`
..
diff --git a/Misc/NEWS.d/3.8.0a1.rst b/Misc/NEWS.d/3.8.0a1.rst
index 4a5467a8bbd510..2f5f7b6edef3f2 100644
--- a/Misc/NEWS.d/3.8.0a1.rst
+++ b/Misc/NEWS.d/3.8.0a1.rst
@@ -5044,8 +5044,8 @@ functionality.
.. nonce: C_K-J9
.. section: Library
-`ConfigParser.items()` was fixed so that key-value pairs passed in via
-`vars` are not included in the resulting output.
+``ConfigParser.items()`` was fixed so that key-value pairs passed in via
+:func:`vars` are not included in the resulting output.
..
https://github.com/python/cpython/commit/30a6d79fb8bc1ef96600c290c016720103…
commit: 30a6d79fb8bc1ef96600c290c016720103b74b2d
branch: main
author: Hugo van Kemenade <hugovk(a)users.noreply.github.com>
committer: hugovk <hugovk(a)users.noreply.github.com>
date: 2023-12-31T10:57:33-07:00
summary:
gh-101100: Fix Sphinx warnings in `library/configparser.rst` (#113598)
Co-authored-by: Alex Waygood <Alex.Waygood(a)Gmail.com>
files:
M Doc/library/configparser.rst
M Doc/library/logging.config.rst
M Doc/tools/.nitignore
M Doc/whatsnew/2.0.rst
M Doc/whatsnew/2.4.rst
M Doc/whatsnew/2.7.rst
M Doc/whatsnew/3.11.rst
M Doc/whatsnew/3.2.rst
M Misc/NEWS.d/3.11.0a1.rst
M Misc/NEWS.d/3.11.0a6.rst
M Misc/NEWS.d/3.8.0a1.rst
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index 4d0dad20287a90..0031737853e7b4 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -208,7 +208,7 @@ converters and customize the provided ones. [1]_
Fallback Values
---------------
-As with a dictionary, you can use a section's :meth:`get` method to
+As with a dictionary, you can use a section's :meth:`~ConfigParser.get` method to
provide fallback values:
.. doctest::
@@ -232,7 +232,7 @@ even if we specify a fallback:
>>> topsecret.get('CompressionLevel', '3')
'9'
-One more thing to be aware of is that the parser-level :meth:`get` method
+One more thing to be aware of is that the parser-level :meth:`~ConfigParser.get` method
provides a custom, more complex interface, maintained for backwards
compatibility. When using this method, a fallback value can be provided via
the ``fallback`` keyword-only argument:
@@ -481,7 +481,7 @@ historical background and it's very likely that you will want to customize some
of the features.
The most common way to change the way a specific config parser works is to use
-the :meth:`__init__` options:
+the :meth:`!__init__` options:
* *defaults*, default value: ``None``
@@ -491,7 +491,7 @@ the :meth:`__init__` options:
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.
+ :meth:`~ConfigParser.read_dict` before you read the actual file.
* *dict_type*, default value: :class:`dict`
@@ -635,8 +635,8 @@ the :meth:`__init__` options:
* *strict*, default value: ``True``
When set to ``True``, the parser will not allow for any section or option
- duplicates while reading from a single source (using :meth:`read_file`,
- :meth:`read_string` or :meth:`read_dict`). It is recommended to use strict
+ duplicates while reading from a single source (using :meth:`~ConfigParser.read_file`,
+ :meth:`~ConfigParser.read_string` or :meth:`~ConfigParser.read_dict`). It is recommended to use strict
parsers in new applications.
.. versionchanged:: 3.2
@@ -697,7 +697,7 @@ the :meth:`__init__` options:
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
- :meth:`getdecimal` on both the parser object and all section proxies. In
+ :meth:`!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)``.
@@ -1062,11 +1062,11 @@ ConfigParser Objects
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 :attr:`name` attribute, that is used for
+ not given and *f* has a :attr:`!name` attribute, that is used for
*source*; the default is ``'<???>'``.
.. versionadded:: 3.2
- Replaces :meth:`readfp`.
+ Replaces :meth:`!readfp`.
.. method:: read_string(string, source='<string>')
@@ -1214,7 +1214,7 @@ ConfigParser Objects
.. data:: MAX_INTERPOLATION_DEPTH
- The maximum depth for recursive interpolation for :meth:`get` when the *raw*
+ The maximum depth for recursive interpolation for :meth:`~configparser.ConfigParser.get` when the *raw*
parameter is false. This is relevant only when the default *interpolation*
is used.
@@ -1287,13 +1287,13 @@ Exceptions
.. exception:: DuplicateSectionError
- Exception raised if :meth:`add_section` is called with the name of a section
+ Exception raised if :meth:`~ConfigParser.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.
.. versionadded:: 3.2
Optional ``source`` and ``lineno`` attributes and arguments to
- :meth:`__init__` were added.
+ :meth:`!__init__` were added.
.. exception:: DuplicateOptionError
@@ -1345,9 +1345,9 @@ Exceptions
Exception raised when errors occur attempting to parse a file.
-.. versionchanged:: 3.12
- The ``filename`` attribute and :meth:`__init__` constructor argument were
- removed. They have been available using the name ``source`` since 3.2.
+ .. versionchanged:: 3.12
+ The ``filename`` attribute and :meth:`!__init__` constructor argument were
+ removed. They have been available using the name ``source`` since 3.2.
.. rubric:: Footnotes
diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index 85a53e6aa7a78b..85a68cb11ee22c 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -93,8 +93,8 @@ in :mod:`logging` itself) and defining handlers which are declared either in
:param fname: A filename, or a file-like object, or an instance derived
from :class:`~configparser.RawConfigParser`. If a
- ``RawConfigParser``-derived instance is passed, it is used as
- is. Otherwise, a :class:`~configparser.Configparser` is
+ :class:`!RawConfigParser`-derived instance is passed, it is used as
+ is. Otherwise, a :class:`~configparser.ConfigParser` is
instantiated, and the configuration read by it from the
object passed in ``fname``. If that has a :meth:`readline`
method, it is assumed to be a file-like object and read using
@@ -103,7 +103,7 @@ in :mod:`logging` itself) and defining handlers which are declared either in
:meth:`~configparser.ConfigParser.read`.
- :param defaults: Defaults to be passed to the ConfigParser can be specified
+ :param defaults: Defaults to be passed to the :class:`!ConfigParser` can be specified
in this argument.
:param disable_existing_loggers: If specified as ``False``, loggers which
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index ab6baf819de97a..05df332fa7c9a8 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -33,7 +33,6 @@ Doc/library/asyncio-task.rst
Doc/library/bdb.rst
Doc/library/collections.rst
Doc/library/concurrent.futures.rst
-Doc/library/configparser.rst
Doc/library/csv.rst
Doc/library/datetime.rst
Doc/library/dbm.rst
diff --git a/Doc/whatsnew/2.0.rst b/Doc/whatsnew/2.0.rst
index 6d6e51006d5bd8..b0e495b0651789 100644
--- a/Doc/whatsnew/2.0.rst
+++ b/Doc/whatsnew/2.0.rst
@@ -1030,7 +1030,7 @@ Module changes
Lots of improvements and bugfixes were made to Python's extensive standard
library; some of the affected modules include :mod:`readline`,
-:mod:`ConfigParser`, :mod:`!cgi`, :mod:`calendar`, :mod:`posix`, :mod:`readline`,
+:mod:`ConfigParser <configparser>`, :mod:`!cgi`, :mod:`calendar`, :mod:`posix`, :mod:`readline`,
:mod:`xmllib`, :mod:`!aifc`, :mod:`!chunk`, :mod:`wave`, :mod:`random`, :mod:`shelve`,
and :mod:`!nntplib`. Consult the CVS logs for the exact patch-by-patch details.
diff --git a/Doc/whatsnew/2.4.rst b/Doc/whatsnew/2.4.rst
index bc748dd44f5f8e..6df59dd245ff55 100644
--- a/Doc/whatsnew/2.4.rst
+++ b/Doc/whatsnew/2.4.rst
@@ -1052,9 +1052,9 @@ complete list of changes, or look through the CVS logs for all the details.
advantage of :class:`collections.deque` for improved performance. (Contributed
by Raymond Hettinger.)
-* The :mod:`ConfigParser` classes have been enhanced slightly. The :meth:`read`
+* The :mod:`ConfigParser <configparser>` classes have been enhanced slightly. The :meth:`~configparser.ConfigParser.read`
method now returns a list of the files that were successfully parsed, and the
- :meth:`set` method raises :exc:`TypeError` if passed a *value* argument that
+ :meth:`~configparser.ConfigParser.set` method raises :exc:`TypeError` if passed a *value* argument that
isn't a string. (Contributed by John Belmonte and David Goodger.)
* The :mod:`curses` module now supports the ncurses extension
diff --git a/Doc/whatsnew/2.7.rst b/Doc/whatsnew/2.7.rst
index 5af700bd5d3506..81fe132d50e1f1 100644
--- a/Doc/whatsnew/2.7.rst
+++ b/Doc/whatsnew/2.7.rst
@@ -287,7 +287,7 @@ remains O(1).
The standard library now supports use of ordered dictionaries in several
modules.
-* The :mod:`ConfigParser` module uses them by default, meaning that
+* The :mod:`ConfigParser <configparser>` module uses them by default, meaning that
configuration files can now be read, modified, and then written back
in their original order.
@@ -1134,7 +1134,7 @@ changes, or look through the Subversion logs for all the details.
another type that isn't a :class:`Mapping`.
(Fixed by Daniel Stutzbach; :issue:`8729`.)
-* Constructors for the parsing classes in the :mod:`ConfigParser` module now
+* Constructors for the parsing classes in the :mod:`ConfigParser <configparser>` module now
take an *allow_no_value* parameter, defaulting to false; if true,
options without values will be allowed. For example::
diff --git a/Doc/whatsnew/3.11.rst b/Doc/whatsnew/3.11.rst
index 8db133b90a7a4b..cae5a26bae1148 100644
--- a/Doc/whatsnew/3.11.rst
+++ b/Doc/whatsnew/3.11.rst
@@ -1773,7 +1773,7 @@ Standard Library
* the :class:`!configparser.SafeConfigParser` class
* the :attr:`!configparser.ParsingError.filename` property
- * the :meth:`configparser.RawConfigParser.readfp` method
+ * the :meth:`!configparser.RawConfigParser.readfp` method
(Contributed by Hugo van Kemenade in :issue:`45173`.)
diff --git a/Doc/whatsnew/3.2.rst b/Doc/whatsnew/3.2.rst
index 5ef76968e9d86b..aad196478dd38b 100644
--- a/Doc/whatsnew/3.2.rst
+++ b/Doc/whatsnew/3.2.rst
@@ -183,7 +183,7 @@ PEP 391: Dictionary Based Configuration for Logging
The :mod:`logging` module provided two kinds of configuration, one style with
function calls for each option or another style driven by an external file saved
-in a :mod:`ConfigParser` format. Those options did not provide the flexibility
+in a :mod:`configparser` format. Those options did not provide the flexibility
to create configurations from JSON or YAML files, nor did they support
incremental configuration, which is needed for specifying logger options from a
command line.
@@ -2134,7 +2134,7 @@ configparser
The :mod:`configparser` module was modified to improve usability and
predictability of the default parser and its supported INI syntax. The old
-:class:`ConfigParser` class was removed in favor of :class:`SafeConfigParser`
+:class:`!ConfigParser` class was removed in favor of :class:`!SafeConfigParser`
which has in turn been renamed to :class:`~configparser.ConfigParser`. Support
for inline comments is now turned off by default and section or option
duplicates are not allowed in a single configuration source.
@@ -2414,7 +2414,7 @@ when one operand is much larger than the other (patch by Andress Bennetts in
(:issue:`1569291` by Alexander Belopolsky). The :class:`BaseHTTPRequestHandler`
has more efficient buffering (:issue:`3709` by Andrew Schaaf). The
:func:`operator.attrgetter` function has been sped-up (:issue:`10160` by
-Christos Georgiou). And :class:`ConfigParser` loads multi-line arguments a bit
+Christos Georgiou). And :class:`~configparser.ConfigParser` loads multi-line arguments a bit
faster (:issue:`7113` by Łukasz Langa).
@@ -2614,8 +2614,8 @@ This section lists previously described changes and other bugfixes that may
require changes to your code:
* The :mod:`configparser` module has a number of clean-ups. The major change is
- to replace the old :class:`ConfigParser` class with long-standing preferred
- alternative :class:`SafeConfigParser`. In addition there are a number of
+ to replace the old :class:`!ConfigParser` class with long-standing preferred
+ alternative :class:`!SafeConfigParser`. In addition there are a number of
smaller incompatibilities:
* The interpolation syntax is now validated on
diff --git a/Misc/NEWS.d/3.11.0a1.rst b/Misc/NEWS.d/3.11.0a1.rst
index 26c44b6c1af0ed..1c96c0760a57b2 100644
--- a/Misc/NEWS.d/3.11.0a1.rst
+++ b/Misc/NEWS.d/3.11.0a1.rst
@@ -1642,9 +1642,9 @@ interval specified with nanosecond precision.
.. nonce: UptGAn
.. section: Library
-Remove from the :mod:`configparser` module: the :class:`SafeConfigParser`
-class, the :attr:`filename` property of the :class:`ParsingError` class, the
-:meth:`readfp` method of the :class:`ConfigParser` class, deprecated since
+Remove from the :mod:`configparser` module: the :class:`!SafeConfigParser`
+class, the :attr:`!filename` property of the :class:`~configparser.ParsingError` class, the
+:meth:`!readfp` method of the :class:`~configparser.ConfigParser` class, deprecated since
Python 3.2.
Patch by Hugo van Kemenade.
diff --git a/Misc/NEWS.d/3.11.0a6.rst b/Misc/NEWS.d/3.11.0a6.rst
index 52055b3fafd485..974d025c631a45 100644
--- a/Misc/NEWS.d/3.11.0a6.rst
+++ b/Misc/NEWS.d/3.11.0a6.rst
@@ -941,7 +941,7 @@ uvloop library.
Make the :class:`configparser.ConfigParser` constructor raise
:exc:`TypeError` if the ``interpolation`` parameter is not of type
-:class:`configparser.Interpolation`
+:class:`!configparser.Interpolation`
..
diff --git a/Misc/NEWS.d/3.8.0a1.rst b/Misc/NEWS.d/3.8.0a1.rst
index 2b9dbd5d63a87e..99f408661d9f69 100644
--- a/Misc/NEWS.d/3.8.0a1.rst
+++ b/Misc/NEWS.d/3.8.0a1.rst
@@ -5044,8 +5044,8 @@ functionality.
.. nonce: C_K-J9
.. section: Library
-`ConfigParser.items()` was fixed so that key-value pairs passed in via
-`vars` are not included in the resulting output.
+``ConfigParser.items()`` was fixed so that key-value pairs passed in via
+:func:`vars` are not included in the resulting output.
..
https://github.com/python/cpython/commit/02912125b45f62ec66bba440a98bfa80af…
commit: 02912125b45f62ec66bba440a98bfa80af95a8d9
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com>
committer: hugovk <hugovk(a)users.noreply.github.com>
date: 2023-12-30T23:24:39Z
summary:
[3.11] Update ConfigParser docs defining valid section name (GH-110506) (#113590)
Co-authored-by: Delgan <4193924+Delgan(a)users.noreply.github.com>
files:
M Doc/library/configparser.rst
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index 3f15b20fb4871c..6a3bb93115dda7 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -271,7 +271,7 @@ 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
may be treated as parts of multiline values or ignored.
-By default, a valid section name can be any string that does not contain '\\n' or ']'.
+By default, a valid section name can be any string that does not contain '\\n'.
To change this, see :attr:`ConfigParser.SECTCRE`.
Configuration files may include comments, prefixed by specific
https://github.com/python/cpython/commit/9a2dadf689c0885e4dce4e20de6c2bf603…
commit: 9a2dadf689c0885e4dce4e20de6c2bf60389eede
branch: 3.12
author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com>
committer: hugovk <hugovk(a)users.noreply.github.com>
date: 2023-12-30T23:24:32Z
summary:
[3.12] Update ConfigParser docs defining valid section name (GH-110506) (#113589)
Co-authored-by: Delgan <4193924+Delgan(a)users.noreply.github.com>
files:
M Doc/library/configparser.rst
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index 12eee47613d186..4d0dad20287a90 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -271,7 +271,7 @@ 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
may be treated as parts of multiline values or ignored.
-By default, a valid section name can be any string that does not contain '\\n' or ']'.
+By default, a valid section name can be any string that does not contain '\\n'.
To change this, see :attr:`ConfigParser.SECTCRE`.
Configuration files may include comments, prefixed by specific
https://github.com/python/cpython/commit/471aa752415029c508693fa7971076f514…
commit: 471aa752415029c508693fa7971076f5148022a6
branch: main
author: Delgan <4193924+Delgan(a)users.noreply.github.com>
committer: hugovk <hugovk(a)users.noreply.github.com>
date: 2023-12-30T16:18:06-07:00
summary:
Update ConfigParser docs defining valid section name (#110506)
files:
M Doc/library/configparser.rst
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index 12eee47613d186..4d0dad20287a90 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -271,7 +271,7 @@ 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
may be treated as parts of multiline values or ignored.
-By default, a valid section name can be any string that does not contain '\\n' or ']'.
+By default, a valid section name can be any string that does not contain '\\n'.
To change this, see :attr:`ConfigParser.SECTCRE`.
Configuration files may include comments, prefixed by specific
https://github.com/python/cpython/commit/206dc9a82e7f6209392561128b7b1660aa…
commit: 206dc9a82e7f6209392561128b7b1660aa33d6a1
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com>
committer: ronaldoussoren <ronaldoussoren(a)mac.com>
date: 2023-12-30T18:10:11+01:00
summary:
[3.11] gh-89414: Document that SIGCLD is not available on macOS (GH-113580) (#113586)
gh-89414: Document that SIGCLD is not available on macOS (GH-113580)
Document that SIGCLD is not available on macOS
(cherry picked from commit f48a1bcb2914addee971814fd014e4d8075ea6a9)
Co-authored-by: Ronald Oussoren <ronaldoussoren(a)mac.com>
files:
M Doc/library/signal.rst
diff --git a/Doc/library/signal.rst b/Doc/library/signal.rst
index 7ee5ece8859825..85a073aad233ac 100644
--- a/Doc/library/signal.rst
+++ b/Doc/library/signal.rst
@@ -157,6 +157,8 @@ The variables defined in the :mod:`signal` module are:
Alias to :data:`SIGCHLD`.
+ .. availability:: not macOS.
+
.. data:: SIGCONT
Continue the process if it is currently stopped
https://github.com/python/cpython/commit/c4eaae1864e40e504fe94a07ab6cf8bd1e…
commit: c4eaae1864e40e504fe94a07ab6cf8bd1e4ed2db
branch: 3.12
author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com>
committer: ronaldoussoren <ronaldoussoren(a)mac.com>
date: 2023-12-30T18:09:50+01:00
summary:
[3.12] gh-89414: Document that SIGCLD is not available on macOS (GH-113580) (#113585)
gh-89414: Document that SIGCLD is not available on macOS (GH-113580)
Document that SIGCLD is not available on macOS
(cherry picked from commit f48a1bcb2914addee971814fd014e4d8075ea6a9)
Co-authored-by: Ronald Oussoren <ronaldoussoren(a)mac.com>
files:
M Doc/library/signal.rst
diff --git a/Doc/library/signal.rst b/Doc/library/signal.rst
index 7ee5ece8859825..85a073aad233ac 100644
--- a/Doc/library/signal.rst
+++ b/Doc/library/signal.rst
@@ -157,6 +157,8 @@ The variables defined in the :mod:`signal` module are:
Alias to :data:`SIGCHLD`.
+ .. availability:: not macOS.
+
.. data:: SIGCONT
Continue the process if it is currently stopped
