gh-95065: Produce nicer deprecation messages in Argument Clinic (#107808)

This commit is contained in:
Erlend E. Aasland 2023-08-09 15:28:18 +02:00 committed by GitHub
parent 1b3f5f24af
commit 0a7f48b9a8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 211 additions and 18 deletions

View file

@ -928,7 +928,7 @@ class CLanguage(Language):
if first_pos:
preamble = f"Passing {first_pos+1} positional arguments to "
depr_message = preamble + (
f"{func.full_name}() is deprecated. Parameter {pstr} will "
f"{func.fulldisplayname}() is deprecated. Parameter {pstr} will "
f"become a keyword-only parameter in Python {major}.{minor}."
)
else:
@ -939,7 +939,7 @@ class CLanguage(Language):
f"argument{'s' if first_pos != 1 else ''} to "
)
depr_message = preamble + (
f"{func.full_name}() is deprecated. Parameters {pstr} will "
f"{func.fulldisplayname}() is deprecated. Parameters {pstr} will "
f"become keyword-only parameters in Python {major}.{minor}."
)
@ -1673,14 +1673,7 @@ class CLanguage(Language):
full_name = f.full_name
template_dict = {'full_name': full_name}
if new_or_init:
assert isinstance(f.cls, Class)
name = f.cls.name
else:
name = f.name
template_dict['name'] = name
template_dict['name'] = f.displayname
if f.c_basename:
c_basename = f.c_basename
@ -2678,6 +2671,21 @@ class Function:
self.self_converter: self_converter | None = None
self.__render_parameters__: list[Parameter] | None = None
@functools.cached_property
def displayname(self) -> str:
"""Pretty-printable name."""
if self.kind.new_or_init:
assert isinstance(self.cls, Class)
return self.cls.name
else:
return self.name
@functools.cached_property
def fulldisplayname(self) -> str:
if isinstance(self.module, Module):
return f"{self.module.name}.{self.displayname}"
return self.displayname
@property
def render_parameters(self) -> list[Parameter]:
if not self.__render_parameters__:
@ -5522,13 +5530,7 @@ class DSLParser:
self, f: Function, parameters: list[Parameter]
) -> str:
text, add, output = _text_accumulator()
if f.kind.new_or_init:
# classes get *just* the name of the class
# not __new__, not __init__, and not module.classname
assert f.cls
add(f.cls.name)
else:
add(f.name)
add(f.displayname)
if self.forced_text_signature:
add(self.forced_text_signature)
else: