mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-10 00:43:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 18

bpo-41963: document that ConfigParser strips off comments (GH-26197)

Browse source 
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Laura Gutierrez Funderburk <58710704+lgfunderburk@users.noreply.github.com>
This commit is contained in:
Jürgen Gmach 2021-05-18 18:11:23 +02:00 • committed by GitHub
parent 115dea9e26
commit 02ee819126
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
Doc/library/configparser.rst
View file

@ -1153,6 +1153,13 @@ ConfigParser Objects
*space_around_delimiters* is true, delimiters between *space_around_delimiters* is true, delimiters between
keys and values are surrounded by spaces. keys and values are surrounded by spaces.
.. note::
Comments in the original configuration file are not preserved when
writing the configuration back.
What is considered a comment, depends on the given values for
*comment_prefix* and *inline_comment_prefix*.
.. method:: remove_option(section, option) .. method:: remove_option(section, option)

5
Lib/configparser.py
View file

@ -908,6 +908,9 @@ class RawConfigParser(MutableMapping):
If `space_around_delimiters' is True (the default), delimiters If `space_around_delimiters' is True (the default), delimiters
between keys and values are surrounded by spaces. between keys and values are surrounded by spaces.
Please note that comments in the original configuration file are not
preserved when writing the configuration back.
""" """
if space_around_delimiters: if space_around_delimiters:
d = " {} ".format(self._delimiters[0]) d = " {} ".format(self._delimiters[0])
@ -1006,7 +1009,7 @@ class RawConfigParser(MutableMapping):
Configuration files may include comments, prefixed by specific Configuration files may include comments, prefixed by specific
characters (`#' and `;' by default). Comments may appear on their own characters (`#' and `;' by default). Comments may appear on their own
in an otherwise empty line or may be entered in lines holding values or in an otherwise empty line or may be entered in lines holding values or
section names. section names. Please note that comments get stripped off when reading configuration files.
""" """
elements_added = set() elements_added = set()
cursect = None # None, or a dictionary cursect = None # None, or a dictionary

1
Misc/NEWS.d/next/Documentation/2021-05-17-20-03-47.bpo-41963.eUz9_o.rst Normal file
View file

@ -0,0 +1 @@
Document that ``ConfigParser`` strips off comments when reading configuration files.