[Python-checkins] [3.12] gh-106368: Add tests for permutation helpers in Argument Clinic (GH-106407) (#106409)
erlend-aasland
webhook-mailer at python.org
Tue Jul 4 08:17:09 EDT 2023
https://github.com/python/cpython/commit/fda297031bba7c4e46b5959ebaa9c48ca11bb5f4
commit: fda297031bba7c4e46b5959ebaa9c48ca11bb5f4
branch: 3.12
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: erlend-aasland <erlend.aasland at protonmail.com>
date: 2023-07-04T14:17:05+02:00
summary:
[3.12] gh-106368: Add tests for permutation helpers in Argument Clinic (GH-106407) (#106409)
Added new test class PermutationTests()
(cherry picked from commit 8f6df5e9cbc3a1689601714192aa6ecbb23e1927)
Co-authored-by: Erlend E. Aasland <erlend at python.org>
files:
M Lib/test/test_clinic.py
M Tools/clinic/clinic.py
diff --git a/Lib/test/test_clinic.py b/Lib/test/test_clinic.py
index 03754d0bf123b..544e7323e4f60 100644
--- a/Lib/test/test_clinic.py
+++ b/Lib/test/test_clinic.py
@@ -1586,5 +1586,111 @@ def test_cloned_func_with_converter_exception_message(self):
self.assertEqual(func(), name)
+class PermutationTests(unittest.TestCase):
+ """Test permutation support functions."""
+
+ def test_permute_left_option_groups(self):
+ expected = (
+ (),
+ (3,),
+ (2, 3),
+ (1, 2, 3),
+ )
+ data = list(zip([1, 2, 3])) # Generate a list of 1-tuples.
+ actual = tuple(clinic.permute_left_option_groups(data))
+ self.assertEqual(actual, expected)
+
+ def test_permute_right_option_groups(self):
+ expected = (
+ (),
+ (1,),
+ (1, 2),
+ (1, 2, 3),
+ )
+ data = list(zip([1, 2, 3])) # Generate a list of 1-tuples.
+ actual = tuple(clinic.permute_right_option_groups(data))
+ self.assertEqual(actual, expected)
+
+ def test_permute_optional_groups(self):
+ empty = {
+ "left": (), "required": (), "right": (),
+ "expected": ((),),
+ }
+ noleft1 = {
+ "left": (), "required": ("b",), "right": ("c",),
+ "expected": (
+ ("b",),
+ ("b", "c"),
+ ),
+ }
+ noleft2 = {
+ "left": (), "required": ("b", "c",), "right": ("d",),
+ "expected": (
+ ("b", "c"),
+ ("b", "c", "d"),
+ ),
+ }
+ noleft3 = {
+ "left": (), "required": ("b", "c",), "right": ("d", "e"),
+ "expected": (
+ ("b", "c"),
+ ("b", "c", "d"),
+ ("b", "c", "d", "e"),
+ ),
+ }
+ noright1 = {
+ "left": ("a",), "required": ("b",), "right": (),
+ "expected": (
+ ("b",),
+ ("a", "b"),
+ ),
+ }
+ noright2 = {
+ "left": ("a",), "required": ("b", "c"), "right": (),
+ "expected": (
+ ("b", "c"),
+ ("a", "b", "c"),
+ ),
+ }
+ noright3 = {
+ "left": ("a", "b"), "required": ("c",), "right": (),
+ "expected": (
+ ("c",),
+ ("b", "c"),
+ ("a", "b", "c"),
+ ),
+ }
+ leftandright1 = {
+ "left": ("a",), "required": ("b",), "right": ("c",),
+ "expected": (
+ ("b",),
+ ("a", "b"), # Prefer left.
+ ("a", "b", "c"),
+ ),
+ }
+ leftandright2 = {
+ "left": ("a", "b"), "required": ("c", "d"), "right": ("e", "f"),
+ "expected": (
+ ("c", "d"),
+ ("b", "c", "d"), # Prefer left.
+ ("a", "b", "c", "d"), # Prefer left.
+ ("a", "b", "c", "d", "e"),
+ ("a", "b", "c", "d", "e", "f"),
+ ),
+ }
+ dataset = (
+ empty,
+ noleft1, noleft2, noleft3,
+ noright1, noright2, noright3,
+ leftandright1, leftandright2,
+ )
+ for params in dataset:
+ with self.subTest(**params):
+ left, required, right, expected = params.values()
+ permutations = clinic.permute_optional_groups(left, required, right)
+ actual = tuple(permutations)
+ self.assertEqual(actual, expected)
+
+
if __name__ == "__main__":
unittest.main()
diff --git a/Tools/clinic/clinic.py b/Tools/clinic/clinic.py
index d67479c7f8ab8..fa6c1392e1f09 100755
--- a/Tools/clinic/clinic.py
+++ b/Tools/clinic/clinic.py
@@ -509,7 +509,7 @@ class PythonLanguage(Language):
def permute_left_option_groups(l):
"""
- Given [1, 2, 3], should yield:
+ Given [(1,), (2,), (3,)], should yield:
()
(3,)
(2, 3)
@@ -524,7 +524,7 @@ def permute_left_option_groups(l):
def permute_right_option_groups(l):
"""
- Given [1, 2, 3], should yield:
+ Given [(1,), (2,), (3,)], should yield:
()
(1,)
(1, 2)
More information about the Python-checkins
mailing list