diff options
| author | Jürgen Gmach <juergen.gmach@googlemail.com> | 2021-05-18 16:11:23 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-18 16:11:23 (GMT) |
| commit | 02ee8191263848f8c8999f72286148946b83e5c9 (patch) | |
| tree | 085154e904b82f135e48cb8b7a991d2115e22e53 | |
| parent | 115dea9e2602b96b63390f00cc880e90c433efa2 (diff) | |
| download | cpython-02ee8191263848f8c8999f72286148946b83e5c9.zip cpython-02ee8191263848f8c8999f72286148946b83e5c9.tar.gz cpython-02ee8191263848f8c8999f72286148946b83e5c9.tar.bz2 | |
bpo-41963: document that ConfigParser strips off comments (GH-26197)
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>
| -rw-r--r-- | Doc/library/configparser.rst | 7 | ||||
| -rw-r--r-- | Lib/configparser.py | 5 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/Documentation/2021-05-17-20-03-47.bpo-41963.eUz9_o.rst | 1 |
3 files changed, 12 insertions, 1 deletions
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst index 646e8a3..b0c2a2c 100644 --- a/Doc/library/configparser.rst +++ b/Doc/library/configparser.rst @@ -1153,6 +1153,13 @@ ConfigParser Objects *space_around_delimiters* is true, delimiters between 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) diff --git a/Lib/configparser.py b/Lib/configparser.py index 3b4cb5e..2f45e24 100644 --- a/Lib/configparser.py +++ b/Lib/configparser.py @@ -908,6 +908,9 @@ class RawConfigParser(MutableMapping): If `space_around_delimiters' is True (the default), delimiters 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: d = " {} ".format(self._delimiters[0]) @@ -1006,7 +1009,7 @@ class RawConfigParser(MutableMapping): Configuration files may include comments, prefixed by specific characters (`#' and `;' by default). Comments may appear on their own 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() cursect = None # None, or a dictionary diff --git a/Misc/NEWS.d/next/Documentation/2021-05-17-20-03-47.bpo-41963.eUz9_o.rst b/Misc/NEWS.d/next/Documentation/2021-05-17-20-03-47.bpo-41963.eUz9_o.rst new file mode 100644 index 0000000..b9fe722 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2021-05-17-20-03-47.bpo-41963.eUz9_o.rst @@ -0,0 +1 @@ +Document that ``ConfigParser`` strips off comments when reading configuration files.
\ No newline at end of file |