Skip to content

gh-106368: Add tests for permutation helpers in Argument Clinic #106407

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
erlend-aasland merged 1 commit into from
Jul 4, 2023
Merged

gh-106368: Add tests for permutation helpers in Argument Clinic #106407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
gh-106368: Add tests for permutation helpers in Argument Clinic 
Added new test class PermutationTests()
  • Loading branch information
@erlend-aasland
erlend-aasland committed Jul 4, 2023
commit 7ce02243ed7e02637ca2bced5c95a66937368541
106 changes: 106 additions & 0 deletions Lib/test/test_clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
4 changes: 2 additions & 2 deletions Tools/clinic/clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -518,7 +518,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)
Expand All @@ -533,7 +533,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)
Expand Down