gh-125542: Deprecate prefix_chars in ArgumentParser.add_argument_group() (GH-125563)

This commit is contained in:
Savannah Ostrowski 2024-10-17 02:11:47 -07:00 committed by GitHub
parent 624be8699a
commit 7b04496e5c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 52 additions and 2 deletions

View file

@ -2893,6 +2893,31 @@ class TestPositionalsGroups(TestCase):
result = parser.parse_args('1 2 3 4'.split())
self.assertEqual(expected, result)
class TestGroupConstructor(TestCase):
def test_group_prefix_chars(self):
parser = ErrorRaisingArgumentParser()
msg = (
"The use of the undocumented 'prefix_chars' parameter in "
"ArgumentParser.add_argument_group() is deprecated."
)
with self.assertWarns(DeprecationWarning) as cm:
parser.add_argument_group(prefix_chars='-+')
self.assertEqual(msg, str(cm.warning))
self.assertEqual(cm.filename, __file__)
def test_group_prefix_chars_default(self):
# "default" isn't quite the right word here, but it's the same as
# the parser's default prefix so it's a good test
parser = ErrorRaisingArgumentParser()
msg = (
"The use of the undocumented 'prefix_chars' parameter in "
"ArgumentParser.add_argument_group() is deprecated."
)
with self.assertWarns(DeprecationWarning) as cm:
parser.add_argument_group(prefix_chars='-')
self.assertEqual(msg, str(cm.warning))
self.assertEqual(cm.filename, __file__)
# ===================
# Parent parser tests
# ===================