gh-116957: configparser: Do post-process values after DuplicateOptionError #116958

drothlis · 2024-03-18T14:29:02Z

If you catch DuplicateOptionError / DuplicateSectionError when reading a config file (the intention is to skip invalid config files) and then attempt to use the ConfigParser instance, any values it had read successfully so far, were stored as a list instead of string! Later get calls would raise "AttributeError: 'list' object has no attribute 'find'" from somewhere deep in the interpolation code.

Fixes #116957.

Issue: configparser.DuplicateOptionError leaves ConfigParser instance in bad state #116957

…OptionError If you catch DuplicateOptionError / DuplicateSectionError when reading a config file (the intention is to skip invalid config files) and then attempt to use the ConfigParser instance, any values it *had* read successfully so far, were stored as a list instead of string! Later `get` calls would raise "AttributeError: 'list' object has no attribute 'find'" from somewhere deep in the interpolation code.

drothlis · 2024-03-18T14:29:54Z

This diff is best viewed with "ignore whitespace changes".

drothlis · 2024-03-18T14:30:12Z

Without this fix, the new test fails like this:

======================================================================
ERROR: test_get_after_duplicate_option_error (__main__.ConfigParserTestCaseExtendedInterpolation.test_get_after_duplicate_option_error)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/drothlis/work/python/cpython/Lib/test/test_configparser.py", line 662, in test_get_after_duplicate_option_error
    self.assertEqual(cf.get('Foo', 'x'), '1')
                     ~~~~~~^^^^^^^^^^^^
  File "/home/drothlis/work/python/cpython/Lib/configparser.py", line 743, in get
    return self._interpolation.before_get(self, section, option, value,
           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
                                          d)
                                          ^^
  File "/home/drothlis/work/python/cpython/Lib/configparser.py", line 441, in before_get
    self._interpolate_some(parser, option, L, value, section, defaults, 1)
    ~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/drothlis/work/python/cpython/Lib/configparser.py", line 458, in _interpolate_some
    p = rest.find("$")
        ^^^^^^^^^
AttributeError: 'list' object has no attribute 'find'

======================================================================
FAIL: test_get_after_duplicate_option_error (__main__.StrictTestCase.test_get_after_duplicate_option_error)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/drothlis/work/python/cpython/Lib/test/test_configparser.py", line 662, in test_get_after_duplicate_option_error
    self.assertEqual(cf.get('Foo', 'x'), '1')
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: ['1'] != '1'

serhiy-storchaka

LGTM.

miss-islington-app · 2024-03-19T09:59:26Z

Thanks @drothlis for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

miss-islington-app · 2024-03-19T09:59:26Z

Thanks @drothlis for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington-app · 2024-03-19T09:59:30Z

Sorry, @drothlis and @serhiy-storchaka, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker b1bc37597f0d36084c4dcb15977fe6d4b9322cd4 3.11

miss-islington-app · 2024-03-19T09:59:47Z

Sorry, @drothlis and @serhiy-storchaka, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker b1bc37597f0d36084c4dcb15977fe6d4b9322cd4 3.12

…plicateOptionError (pythonGH-116958) If you catch DuplicateOptionError / DuplicateSectionError when reading a config file (the intention is to skip invalid config files) and then attempt to use the ConfigParser instance, any values it *had* read successfully so far, were stored as a list instead of string! Later `get` calls would raise "AttributeError: 'list' object has no attribute 'find'" from somewhere deep in the interpolation code. (cherry picked from commit b1bc375) Co-authored-by: David Röthlisberger <david@rothlis.net>

bedevere-app · 2024-03-19T15:25:29Z

GH-117012 is a backport of this pull request to the 3.11 branch.

…plicateOptionError (pythonGH-116958) If you catch DuplicateOptionError / DuplicateSectionError when reading a config file (the intention is to skip invalid config files) and then attempt to use the ConfigParser instance, any values it *had* read successfully so far, were stored as a list instead of string! Later `get` calls would raise "AttributeError: 'list' object has no attribute 'find'" from somewhere deep in the interpolation code. (cherry picked from commit b1bc375) Co-authored-by: David Röthlisberger <david@rothlis.net>

bedevere-app · 2024-03-19T15:28:56Z

GH-117013 is a backport of this pull request to the 3.12 branch.

…eOptionError (GH-116958) (GH-117013) If you catch DuplicateOptionError / DuplicateSectionError when reading a config file (the intention is to skip invalid config files) and then attempt to use the ConfigParser instance, any values it *had* read successfully so far, were stored as a list instead of string! Later `get` calls would raise "AttributeError: 'list' object has no attribute 'find'" from somewhere deep in the interpolation code. (cherry picked from commit b1bc375)

…eOptionError (GH-116958) (GH-117012) If you catch DuplicateOptionError / DuplicateSectionError when reading a config file (the intention is to skip invalid config files) and then attempt to use the ConfigParser instance, any values it *had* read successfully so far, were stored as a list instead of string! Later `get` calls would raise "AttributeError: 'list' object has no attribute 'find'" from somewhere deep in the interpolation code. (cherry picked from commit b1bc375)

…OptionError (pythonGH-116958) If you catch DuplicateOptionError / DuplicateSectionError when reading a config file (the intention is to skip invalid config files) and then attempt to use the ConfigParser instance, any values it *had* read successfully so far, were stored as a list instead of string! Later `get` calls would raise "AttributeError: 'list' object has no attribute 'find'" from somewhere deep in the interpolation code.

drothlis requested a review from jaraco as a code owner March 18, 2024 14:29

bedevere-app bot added the awaiting review label Mar 18, 2024

bedevere-app bot mentioned this pull request Mar 18, 2024

configparser.DuplicateOptionError leaves ConfigParser instance in bad state #116957

Closed

pythongh-116957: Add NEWS blurb

78b91b7

serhiy-storchaka self-requested a review March 19, 2024 09:19

serhiy-storchaka approved these changes Mar 19, 2024

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting review labels Mar 19, 2024

serhiy-storchaka added needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes and removed needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Mar 19, 2024

serhiy-storchaka merged commit b1bc375 into python:main Mar 19, 2024
39 checks passed

bedevere-app bot removed the awaiting merge label Mar 19, 2024

serhiy-storchaka added needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Mar 19, 2024

miss-islington-app bot assigned serhiy-storchaka Mar 19, 2024

drothlis deleted the fix-gh-116957 branch March 19, 2024 15:16

bedevere-app bot removed the needs backport to 3.11 only security fixes label Mar 19, 2024

bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Mar 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-116957: configparser: Do post-process values after DuplicateOptionError #116958

gh-116957: configparser: Do post-process values after DuplicateOptionError #116958

drothlis commented Mar 18, 2024 •

edited by bedevere-app bot

Loading

drothlis commented Mar 18, 2024

drothlis commented Mar 18, 2024

serhiy-storchaka left a comment

miss-islington-app bot commented Mar 19, 2024

miss-islington-app bot commented Mar 19, 2024

miss-islington-app bot commented Mar 19, 2024

miss-islington-app bot commented Mar 19, 2024

bedevere-app bot commented Mar 19, 2024

bedevere-app bot commented Mar 19, 2024

gh-116957: configparser: Do post-process values after DuplicateOptionError #116958

gh-116957: configparser: Do post-process values after DuplicateOptionError #116958

Conversation

drothlis commented Mar 18, 2024 • edited by bedevere-app bot Loading

drothlis commented Mar 18, 2024

drothlis commented Mar 18, 2024

serhiy-storchaka left a comment

Choose a reason for hiding this comment

miss-islington-app bot commented Mar 19, 2024

miss-islington-app bot commented Mar 19, 2024

miss-islington-app bot commented Mar 19, 2024

miss-islington-app bot commented Mar 19, 2024

bedevere-app bot commented Mar 19, 2024

bedevere-app bot commented Mar 19, 2024

drothlis commented Mar 18, 2024 •

edited by bedevere-app bot

Loading