gh-66449: Add support to unnamed sections in ConfigParser #2735

pslacerda · 2017-07-16T19:38:47Z

Add support to files that have key-value pairs before any section or no section at all. Unnamed sections are enabled when passing allow_unnamed_section=True to configparser.ConfigParser and are stored as an empty string.

Issue: ConfigParser does not handle files without sections #66449

the-knights-who-say-ni · 2017-07-16T19:38:49Z

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately we couldn't find an account corresponding to your GitHub username on bugs.python.org (b.p.o) to verify you have signed the CLA (this might be simply due to a missing "GitHub Name" entry in your b.p.o account settings). This is necessary for legal reasons before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

Thanks again to your contribution and we look forward to looking at it!

Lib/configparser.py

ottok · 2021-04-25T20:04:16Z

This PR closes https://bugs.python.org/issue22253 from 2014

While waiting for this change to land in Python, a huge amount of people seem to use these workarounds:

github-actions · 2022-02-20T00:09:52Z

This PR is stale because it has been open for 30 days with no activity.

ottok · 2022-02-20T00:35:13Z

This PR should be merged and not closed for being "stale".

MaxwellDupre

Both test cases were successful:
test_no_first_section (Lib.test.test_configparser.SectionlessTestCase) ... ok test_no_section (Lib.test.test_configparser.SectionlessTestCase) ... ok
SO examples work, but if you print the key you get DEFAULT and if you want to see the get() you need to use a blank key ''.

github-actions · 2022-03-25T00:08:59Z

This PR is stale because it has been open for 30 days with no activity.

ChristianSi · 2022-07-01T10:25:17Z

Why is this not merged yet? It would be great to have!

arhadthedev · 2022-07-01T10:44:43Z

@ChristianSi Probably because #2735 (review) is not addressed.

arhadthedev · 2022-07-01T10:51:04Z

This PR is stuck for five years, so cc @ambv as a configparser expert.

ChristianSi · 2022-08-02T09:46:29Z

Any news on this one?

github-actions · 2022-09-02T00:12:11Z

This PR is stale because it has been open for 30 days with no activity.

ChristianSi · 2022-09-20T07:58:12Z

@pslacerda It seems this PR got stalled because you didn't address the proposal to use a sentinel object instead of the empty string (as per your own suggestion).

Could you implement that change to get this moving again? Also, the branch would have be to rebased or main merged into it to get it up-to-date.

Would be great if we could finally get this completed!

ChristianSi · 2023-04-10T08:27:57Z

@arhadthedev Good to read from you. Could you maybe help us to get this finally merged into main?

github-actions · 2023-05-11T00:10:06Z

This PR is stale because it has been open for 30 days with no activity.

arhadthedev · 2023-05-13T08:56:24Z

I give up on this, but not without publicly naming and shaming @ambv for not doing his job as the apparent maintainer of this part of the standard library.

Even with big desire, nobody can merge any new feature until 3.12b1 is out. The release date is already urgently moved from the last Monday to May 22. From https://discuss.python.org/t/postponing-3-12-beta-1-feature-freeze/26406:

Considering how many accepted changes are still being worked on (PEPs 684, 687, 688, 695, 697 at least) and still being decided on by the SC (PEPs 649, 702 and 709), I’m planning to postpone feature freeze and beta 1 for 3.12 by two weeks, without changing the rest of the schedule.

For the record: the postponement is just for the changes already in flight. Please don’t try to squeeze in more features because we have two more weeks. (Bugfixes are fine, of course.)

Lib/configparser.py

github-actions · 2023-06-17T00:10:33Z

This PR is stale because it has been open for 30 days with no activity.

vadmium

As well clarifying whether headerless options should leak into other sections, maybe there should be tests and documentation for the behaviour of:

config.add_section(TOP_LEVEL)
config[TOP_LEVEL] = ...
Creating and retrieving TOP_LEVEL section when reading headerless section not enabled
Using TOP_LEVEL as a regular name, e.g. sorted(config.keys())

vadmium · 2024-03-24T02:27:02Z

Lib/configparser.py

@@ -68,6 +69,12 @@
        converter gets its corresponding get*() method on the parser object and
        section proxies.

+        When `allow_unnamed_section` is True (default: False), options
+        without section are accepted: the section for this is


options without a section?

vadmium · 2024-03-24T02:41:14Z

Lib/configparser.py

+        return "<TOP_LEVEL>"
+
+    def __eq__(self, other):
+        return repr(self) == repr(other)


Why did __eq__ get implemented? It makes more sense to me to keep the default inherited implementation. Doesn’t the class only get instantiated once anyway?

Won’t this make a valid section headed [<TOP_LEVEL>] match the headerless section in some cases?

vadmium · 2024-03-24T03:00:11Z

Misc/NEWS.d/next/Library/2022-09-22-07-33-00.bpo-22253.jdo4573.rst

@@ -0,0 +1,4 @@
+:class:`configparser.ConfigParser` now accepts unnamed sections before named
+ones, if configured to do so.


“accepts an unnamed section before named ones” might be clearer

vadmium · 2024-03-24T03:20:36Z

Lib/configparser.py

@@ -68,6 +69,12 @@
        converter gets its corresponding get*() method on the parser object and
        section proxies.

+        When `allow_unnamed_section` is True (default: False), options
+        without section are accepted: the section for this is
+        ``configparser.UNNAMED_SECTION``. In the file, they are placed before


configparser.TOP_LEVEL?

vadmium · 2024-03-24T03:22:19Z

Lib/configparser.py

@@ -18,7 +18,8 @@
             delimiters=('=', ':'), comment_prefixes=('#', ';'),
             inline_comment_prefixes=None, strict=True,
             empty_lines_in_values=True, default_section='DEFAULT',
-             interpolation=<unset>, converters=<unset>):
+             interpolation=<unset>, converters=<unset>,
+             allow_unnamed_section=False):


allow_unnamed_section not implemented

This seems ok.

Lib/configparser.py

hw-claudio · 2024-03-26T09:19:13Z

this feature would be very important to integrate. Is it available yet?
Note that a lot of the comments in the issue thread related to this are incorrect when they argue that this is not how INI files work.

The Windows INI files and the GetProfileString family of APIs have had this undocumented behavior forever, where an empty section is absolutely present and used by software.

See the following wine commits and bugs related to it:

wine-mirror/wine@be678a5
https://bugs.winehq.org/show_bug.cgi?id=8036
https://bugs.winehq.org/show_bug.cgi?id=18099

I would like to use ConfigParser, but currently cannot due to this missing feature, so I am open coding the config file parsing, which I would gladly avoid.

ChristianSi · 2024-03-26T16:43:20Z

@vadmium Thanks for your review!

@pslacerda Are you still around and willing to make the changes suggested in the review? They seem quite reasonable to me.

ChristianSi · 2024-03-26T16:45:01Z

@hw-claudio I alsolutely agree, it would be great to have!

~~Sadly it seems that it's a low-prio, or even a no-prio feature for Python's core developers 😢~~

pslacerda · 2024-03-26T20:59:45Z

I don't even remember the original motivation why I did this PR.

I failed to merge into this PR, so I did a new one.

#117273

pslacerda · 2024-03-26T22:52:46Z

Finally seems that we will get this code into main. Thank you @ChristianSi!

ChristianSi · 2024-03-29T09:55:08Z

@pslacerda Wow, that's wonderful news, thanks a lot for all your effort!

Co-authored-by: Furkan Onder <furkanonder@protonmail.com>

pslacerda · 2024-03-29T15:07:46Z

Thank you @ChristianSi and @jaraco, it finally got merged.

#117273

the-knights-who-say-ni added the CLA not signed label Jul 16, 2017

MichalCab reviewed Jul 16, 2017

View reviewed changes

Lib/configparser.py Outdated Show resolved Hide resolved

the-knights-who-say-ni added CLA signed and removed CLA not signed labels Jul 16, 2017

csabella reviewed Jul 18, 2017

View reviewed changes

Lib/configparser.py Outdated Show resolved Hide resolved

csabella reviewed Jul 18, 2017

View reviewed changes

Lib/configparser.py Outdated Show resolved Hide resolved

Mariatta added needs rebase and removed needs rebase labels Oct 9, 2017

brettcannon added the awaiting review label Feb 2, 2018

serhiy-storchaka added the type-feature A feature request or enhancement label Dec 8, 2018

github-actions bot added the stale Stale PR or inactive for long period of time. label Feb 20, 2022

github-actions bot removed the stale Stale PR or inactive for long period of time. label Feb 21, 2022

MaxwellDupre approved these changes Feb 22, 2022

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Feb 22, 2022

github-actions bot added the stale Stale PR or inactive for long period of time. label Mar 25, 2022

github-actions bot removed the stale Stale PR or inactive for long period of time. label Jul 2, 2022

ezio-melotti removed the CLA signed label Jul 13, 2022

github-actions bot added the stale Stale PR or inactive for long period of time. label Sep 2, 2022

github-actions bot added the stale Stale PR or inactive for long period of time. label Apr 9, 2023

Merge branch 'main' into fix-issue-issue22253

394b83f

github-actions bot removed the stale Stale PR or inactive for long period of time. label Apr 10, 2023

github-actions bot added the stale Stale PR or inactive for long period of time. label May 11, 2023

arhadthedev changed the title ~~bpo-22253: Add support to unnamed sections in ConfigParser~~ gh-66449: Add support to unnamed sections in ConfigParser May 11, 2023

Merge branch 'main' into fix-issue-issue22253

fa3f10b

github-actions bot removed the stale Stale PR or inactive for long period of time. label May 12, 2023

This comment was marked as abuse.

Sign in to view

furkanonder reviewed May 17, 2023

View reviewed changes

Lib/configparser.py Outdated Show resolved Hide resolved

github-actions bot added the stale Stale PR or inactive for long period of time. label Jun 17, 2023

furkanonder added stdlib Python modules in the Lib dir stale Stale PR or inactive for long period of time. and removed stale Stale PR or inactive for long period of time. labels Aug 6, 2023

Delgan mentioned this pull request Nov 4, 2023

Add support for "global" properties (before any section)? pyscaffold/configupdater#123

Open

vadmium reviewed Mar 24, 2024

View reviewed changes

github-actions bot removed the stale Stale PR or inactive for long period of time. label Mar 24, 2024

kernc mannequin mentioned this pull request May 11, 2023

ConfigParser does not handle files without sections #66449

Closed

Update Lib/configparser.py

fdb7081

Co-authored-by: Furkan Onder <furkanonder@protonmail.com>

pslacerda closed this Mar 29, 2024

		@@ -0,0 +1,4 @@
		:class:`configparser.ConfigParser` now accepts unnamed sections before named
		ones, if configured to do so.

Uh oh!

gh-66449: Add support to unnamed sections in ConfigParser #2735

gh-66449: Add support to unnamed sections in ConfigParser #2735

Uh oh!

Conversation

pslacerda commented Jul 16, 2017 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

the-knights-who-say-ni commented Jul 16, 2017

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ottok commented Apr 25, 2021

Uh oh!

github-actions bot commented Feb 20, 2022

Uh oh!

ottok commented Feb 20, 2022

Uh oh!

MaxwellDupre left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 25, 2022

Uh oh!

ChristianSi commented Jul 1, 2022

Uh oh!

arhadthedev commented Jul 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

arhadthedev commented Jul 1, 2022

Uh oh!

ChristianSi commented Aug 2, 2022

Uh oh!

github-actions bot commented Sep 2, 2022

Uh oh!

ChristianSi commented Sep 20, 2022

Uh oh!

ChristianSi commented Apr 10, 2023

Uh oh!

github-actions bot commented May 11, 2023

Uh oh!

This comment was marked as abuse.

arhadthedev commented May 13, 2023

Uh oh!

Uh oh!

github-actions bot commented Jun 17, 2023

Uh oh!

vadmium left a comment

Choose a reason for hiding this comment

Uh oh!

vadmium Mar 24, 2024

Choose a reason for hiding this comment

Uh oh!

vadmium Mar 24, 2024

Choose a reason for hiding this comment

Uh oh!

vadmium Mar 24, 2024

Choose a reason for hiding this comment

Uh oh!

vadmium Mar 24, 2024

Choose a reason for hiding this comment

Uh oh!

vadmium Mar 24, 2024

Choose a reason for hiding this comment

Uh oh!

pslacerda Mar 26, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hw-claudio commented Mar 26, 2024

Uh oh!

ChristianSi commented Mar 26, 2024

Uh oh!

ChristianSi commented Mar 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pslacerda commented Mar 26, 2024

Uh oh!

pslacerda commented Mar 26, 2024

Uh oh!

pslacerda commented Jul 16, 2017 •

edited by bedevere-bot

Loading

arhadthedev commented Jul 1, 2022 •

edited

Loading

ChristianSi commented Mar 26, 2024 •

edited

Loading