Skip to content

PoC @alias annotation #27

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

PoC @alias annotation #27

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
40 changes: 38 additions & 2 deletions Tools/clinic/clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1769,6 +1769,18 @@ def parser_body(
"cpp_endif" : cpp_endif,
"methoddef_ifndef" : methoddef_ifndef,
}
if f.alias:
# Duplicate the PyMethodDef define, and replace the
# 'methoddef_name' field with 'methoddef_alias'. During generation,
# 'methoddef_alias' will be swapped with f.alias (from @alias).
alias_def = methoddef_define
_, cname = f.alias
if cname:
alias_def = alias_def.replace("methoddef_name",
"methoddef_alias")
Comment on lines +1779 to +1780
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feels somewhat hacky, but I guess no more hacky than all the other times we're calling .replace() on templates in clinic.py :)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it is a bit hacky. We could add some asserts, to make sure the code breaks sooner than later if the prototype template changes.

alias_def = alias_def.replace("{name}", "{alias}")
d["methoddef_define"] += "\n"
d["methoddef_define"] += alias_def

# make sure we didn't forget to assign something,
# and wrap each non-empty value in \n's
Expand Down Expand Up @@ -1982,8 +1994,16 @@ def render_function(
data.impl_parameters.append("PyObject *value")
data.impl_arguments.append("value")
else:
template_dict['methoddef_name'] = f.c_basename.upper() + "_METHODDEF"
def methoddef_name(name: str) -> str:
return name.upper() + "_METHODDEF"

template_dict['methoddef_name'] = methoddef_name(f.c_basename)
template_dict['c_basename'] = f.c_basename
if f.alias:
alias, cname = f.alias
template_dict['alias'] = alias
if cname:
template_dict['methoddef_alias'] = methoddef_name(cname)

template_dict['docstring'] = self.docstring_for_c_string(f)

Expand Down Expand Up @@ -3046,6 +3066,7 @@ class Function:
docstring_only: bool = False
critical_section: bool = False
target_critical_section: list[str] = dc.field(default_factory=list)
alias: tuple[str, str | None] | None = None

def __post_init__(self) -> None:
self.parent = self.cls or self.module
Expand Down Expand Up @@ -5205,6 +5226,7 @@ class DSLParser:
critical_section: bool
target_critical_section: list[str]
from_version_re = re.compile(r'([*/]) +\[from +(.+)\]')
alias: tuple[str, str | None] | None = None

def __init__(self, clinic: Clinic) -> None:
self.clinic = clinic
Expand Down Expand Up @@ -5240,6 +5262,7 @@ def reset(self) -> None:
self.preserve_output = False
self.critical_section = False
self.target_critical_section = []
self.alias = None

def directive_version(self, required: str) -> None:
global version
Expand Down Expand Up @@ -5407,6 +5430,18 @@ def at_text_signature(self, text_signature: str) -> None:
fail("Called @text_signature twice!")
self.forced_text_signature = text_signature

def at_alias(self, alias: str, as_: str = "", cname: str = "") -> None:
if self.alias:
fail("Called @alias twice!")
if as_:
if as_ != "as":
fail("@alias: expected 'as' or no further arguments")
if not cname:
fail("@alias: 'as' must be followed by a name")
self.alias = alias, cname
else:
self.alias = alias, None

def parse(self, block: Block) -> None:
self.reset()
self.block = block
Expand Down Expand Up @@ -5628,7 +5663,8 @@ def state_modulename_name(self, line: str) -> None:
self.function = Function(name=function_name, full_name=full_name, module=module, cls=cls, c_basename=c_basename,
return_converter=return_converter, kind=self.kind, coexist=self.coexist,
critical_section=self.critical_section,
target_critical_section=self.target_critical_section)
target_critical_section=self.target_critical_section,
alias=self.alias)
self.block.signatures.append(self.function)

# insert a self converter automatically
Expand Down