Skip to content
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.

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

gh-113317: Change how Argument Clinic lists converters #116853

Merged
merged 8 commits into from Mar 27, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions Lib/test/test_clinic.py
Expand Up @@ -2657,6 +2657,7 @@ def test_cli_converters(self):
float()
int()
long()
object()
Py_ssize_t()
size_t()
unsigned_int()
Expand Down
65 changes: 39 additions & 26 deletions Tools/clinic/clinic.py
Expand Up @@ -1988,13 +1988,30 @@ def parse_file(
libclinic.write_file(output, cooked)


def create_parser_namespace() -> dict[str, Any]:
erlend-aasland marked this conversation as resolved.
Show resolved Hide resolved
ns = dict(
CConverter=CConverter,
CReturnConverter=CReturnConverter,
buffer=buffer,
robuffer=robuffer,
rwbuffer=rwbuffer,
unspecified=unspecified,
)
for name, converter in converters.items():
ns[f'{name}_converter'] = converter
for name, return_converter in return_converters.items():
ns[f'{name}_return_converter'] = return_converter
return ns
vstinner marked this conversation as resolved.
Show resolved Hide resolved


class PythonParser:
def __init__(self, clinic: Clinic) -> None:
pass
self.namespace = create_parser_namespace()

def parse(self, block: Block) -> None:
ns = dict(self.namespace)
erlend-aasland marked this conversation as resolved.
Show resolved Hide resolved
with contextlib.redirect_stdout(io.StringIO()) as s:
exec(block.input)
exec(block.input, ns)
block.output = s.getvalue()


Expand Down Expand Up @@ -4984,25 +5001,22 @@ def run_clinic(parser: argparse.ArgumentParser, ns: argparse.Namespace) -> None:
parser.error(
"can't specify --converters and a filename at the same time"
)
converters: list[tuple[str, str]] = []
return_converters: list[tuple[str, str]] = []
ignored = set("""
add_c_converter
add_c_return_converter
add_default_legacy_c_converter
add_legacy_c_converter
""".strip().split())
module = globals()
for name in module:
for suffix, ids in (
("_return_converter", return_converters),
("_converter", converters),
):
if name in ignored:
continue
if name.endswith(suffix):
ids.append((name, name.removesuffix(suffix)))
break
converter_list: list[tuple[str, str, Any]] = []
return_converter_list: list[tuple[str, str, Any]] = []
vstinner marked this conversation as resolved.
Show resolved Hide resolved

for name, converter in converters.items():
converter_list.append((
f'{name}_converter',
erlend-aasland marked this conversation as resolved.
Show resolved Hide resolved
name,
converter,
))
for name, return_converter in return_converters.items():
return_converter_list.append((
f'{name}_return_converter',
name,
return_converter
))

print()

print("Legacy converters:")
Expand All @@ -5012,15 +5026,14 @@ def run_clinic(parser: argparse.ArgumentParser, ns: argparse.Namespace) -> None:
print()

for title, attribute, ids in (
("Converters", 'converter_init', converters),
("Return converters", 'return_converter_init', return_converters),
("Converters", 'converter_init', converter_list),
("Return converters", 'return_converter_init', return_converter_list),
):
print(title + ":")
longest = -1
for name, short_name in ids:
for name, short_name, converter in ids:
longest = max(longest, len(short_name))
for name, short_name in sorted(ids, key=lambda x: x[1].lower()):
cls = module[name]
for name, short_name, cls in sorted(ids, key=lambda x: x[1].lower()):
callable = getattr(cls, attribute, None)
if not callable:
continue
Expand Down