Skip to content

bpo-46607: Add DeprecationWarning to LegacyInterpolation #30927

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gpshead merged 2 commits into from
Apr 5, 2022
Merged

bpo-46607: Add DeprecationWarning to LegacyInterpolation #30927

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2aa86b8
bpo-46607: Add DeprecationWarning for LegacyInterpolation, deprecated…
hugovk Feb 2, 2022
25296e1
Merge branch 'main' into issue45173-deprecate-LegacyInterpolation
hugovk Feb 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
bpo-46607: Add DeprecationWarning for LegacyInterpolation, deprecated… 
… in docs since 3.2
  • Loading branch information
@hugovk
hugovk committed Feb 3, 2022
commit 2aa86b80ebbbd2e0e7af316560ce18cbc39ec1b0
5 changes: 5 additions & 0 deletions Doc/whatsnew/3.11.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,6 +473,11 @@ Deprecated

(Contributed by Hugo van Kemenade in :issue:`45173`.)

* :class:`configparser.LegacyInterpolation` has been deprecated in the docstring
since Python 3.2. It now emits a :exc:`DeprecationWarning` and will be removed
in Python 3.13. Use :class:`configparser.BasicInterpolation` or
:class:`configparser.ExtendedInterpolation instead.
(Contributed by Hugo van Kemenade in :issue:`46607`.)

Removed
=======
Expand Down
9 changes: 9 additions & 0 deletions Lib/configparser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -525,6 +525,15 @@ class LegacyInterpolation(Interpolation):

_KEYCRE = re.compile(r"%\(([^)]*)\)s|.")

def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
warnings.warn(
"LegacyInterpolation has been deprecated since Python 3.2 "
"and will be removed from the configparser module in Python 3.13. "
"Use BasicInterpolation or ExtendedInterpolation instead.",
DeprecationWarning, stacklevel=2
)

def before_get(self, parser, section, option, value, vars):
rawval = value
depth = MAX_INTERPOLATION_DEPTH
Expand Down
8 changes: 8 additions & 0 deletions Lib/test/test_configparser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1658,6 +1658,14 @@ def test_safeconfigparser_deprecation(self):
for warning in w:
self.assertTrue(warning.category is DeprecationWarning)

def test_legacyinterpolation_deprecation(self):
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("always", DeprecationWarning)
configparser.LegacyInterpolation()
self.assertGreaterEqual(len(w), 1)
for warning in w:
self.assertIs(warning.category, DeprecationWarning)

def test_sectionproxy_repr(self):
parser = configparser.ConfigParser()
parser.read_string("""
Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Library/2022-01-26-18-30-34.bpo-46607.xnhT4a.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Add :exc:`DeprecationWarning` to :class:`LegacyInterpolation`, deprecated in
the docstring since Python 3.2. Will be removed in Python 3.13. Use
:class:`BasicInterpolation` or :class:`ExtendedInterpolation` instead.