Skip to content

gh-115077: Make some Argument Clinic error messages more helpful #115078

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

Closed
erlend-aasland wants to merge 11 commits into from
Closed

gh-115077: Make some Argument Clinic error messages more helpful #115078

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
771b535
gh-115077: Make some Argument Clinic error messages more helpful
erlend-aasland Feb 6, 2024
87fb158
mypy
erlend-aasland Feb 6, 2024
5ae4953
Update Tools/clinic/clinic.py
erlend-aasland Feb 6, 2024
140e6a4
Tweak `at_classmethod` and `at_staticmethod`
sobolevn Feb 6, 2024
53b2e04
Pull in main
erlend-aasland Feb 7, 2024
94e082e
Improve str_converter unsupported combination of args error message
erlend-aasland Feb 7, 2024
adf494d
no backslash in f-string
erlend-aasland Feb 7, 2024
f29facd
Show kind for `__new__`
sobolevn Feb 10, 2024
2ba1cbd
Fix CI
sobolevn Feb 10, 2024
b0277b2
Pull in main
erlend-aasland Mar 2, 2024
b3cb52a
Merge in changes from PR
erlend-aasland Mar 2, 2024
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
Prev Previous commit
Next Next commit
Improve str_converter unsupported combination of args error message
  • Loading branch information
@erlend-aasland
erlend-aasland committed Feb 7, 2024
commit 94e082e45be8c354833980402badc9d5eabc900e
9 changes: 9 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 @@ -2028,6 +2028,15 @@ def test_legacy_converters_non_string_constant_annotation(self):
with self.subTest(block=block):
self.expect_failure(block, err, lineno=2)

def test_str_converter_invalid_format_unit(self):
block = """
module foo
foo.bar
a: str(encoding='foo', zeroes=True, accept={})
"""
err = "unsupported combination of str converter arguments"
self.expect_failure(block, err, lineno=2)

def test_other_bizarre_things_in_annotations_fail(self):
err = "Annotations must be either a name, a function call, or a string"
dataset = (
Expand Down
26 changes: 21 additions & 5 deletions Tools/clinic/clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4043,14 +4043,27 @@ class buffer: pass
class rwbuffer: pass
class robuffer: pass

StrConverterKeyType = tuple[frozenset[type[object]], bool, bool]
@dc.dataclass
class StrConverterKey:
accept: frozenset[type[object]]
encoding: bool
zeroes: bool

def __hash__(self) -> int:
return hash((self.accept, self.encoding, self.zeroes))

def __str__(self) -> str:
accept = "{" + ", ".join([tp.__name__ for tp in self.accept]) + "}"
encoding = 'encodingname' if self.encoding else None
zeroes = self.zeroes
return f"{accept=!r}, {encoding=!r}, {zeroes=!r}"

def str_converter_key(
types: TypeSet, encoding: bool | str | None, zeroes: bool
) -> StrConverterKeyType:
return (frozenset(types), bool(encoding), bool(zeroes))
) -> StrConverterKey:
return StrConverterKey(frozenset(types), bool(encoding), bool(zeroes))

str_converter_argument_map: dict[StrConverterKeyType, str] = {}
str_converter_argument_map: dict[StrConverterKey, str] = {}

class str_converter(CConverter):
type = 'const char *'
Expand All @@ -4068,7 +4081,10 @@ def converter_init(
key = str_converter_key(accept, encoding, zeroes)
format_unit = str_converter_argument_map.get(key)
if not format_unit:
fail("str_converter: illegal combination of arguments", key)
fail("unsupported combination of str converter arguments: "
f"{accept=!r}, {encoding=!r}, {zeroes=!r}; "
"allowed combinations are:\n\n"
f"{'\n'.join([str(k) for k in str_converter_argument_map.keys()])}")

self.format_unit = format_unit
self.length = bool(zeroes)
Expand Down