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: Argument Clinic: move C/Py identifier helpers into libclinic #115520

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 4 additions & 29 deletions Tools/clinic/clinic.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,31 +138,6 @@ def fail(
warn_or_fail(*args, filename=filename, line_number=line_number, fail=True)


is_legal_c_identifier = re.compile('^[A-Za-z_][A-Za-z0-9_]*$').match

def is_legal_py_identifier(s: str) -> bool:
return all(is_legal_c_identifier(field) for field in s.split('.'))

# identifiers that are okay in Python but aren't a good idea in C.
# so if they're used Argument Clinic will add "_value" to the end
# of the name in C.
c_keywords = set("""
asm auto break case char const continue default do double
else enum extern float for goto if inline int long
register return short signed sizeof static struct switch
typedef typeof union unsigned void volatile while
""".strip().split())

def ensure_legal_c_identifier(s: str) -> str:
# for now, just complain if what we're given isn't legal
if not is_legal_c_identifier(s):
fail("Illegal C identifier:", s)
# but if we picked a C keyword, pick something else
if s in c_keywords:
return s + "_value"
return s


class CRenderData:
def __init__(self) -> None:

Expand Down Expand Up @@ -2954,7 +2929,7 @@ def __init__(self,
unused: bool = False,
**kwargs: Any
) -> None:
self.name = ensure_legal_c_identifier(name)
self.name = libclinic.ensure_legal_c_identifier(name)
self.py_name = py_name
self.unused = unused
self.includes: list[Include] = []
Expand Down Expand Up @@ -5083,9 +5058,9 @@ def parse_function_names(self, line: str) -> FunctionNames:
if fields[-1] == '__new__':
fields.pop()
c_basename = "_".join(fields)
if not is_legal_py_identifier(full_name):
if not libclinic.is_legal_py_identifier(full_name):
fail(f"Illegal function name: {full_name!r}")
if not is_legal_c_identifier(c_basename):
if not libclinic.is_legal_c_identifier(c_basename):
fail(f"Illegal C basename: {c_basename!r}")
names = FunctionNames(full_name=full_name, c_basename=c_basename)
self.normalize_function_kind(names.full_name)
Expand Down Expand Up @@ -5207,7 +5182,7 @@ def state_modulename_name(self, line: str) -> None:
before, equals, existing = line.rpartition('=')
if equals:
existing = existing.strip()
if is_legal_py_identifier(existing):
if libclinic.is_legal_py_identifier(existing):
# we're cloning!
names = self.parse_function_names(before)
return self.parse_cloned_function(names, existing)
Expand Down
10 changes: 10 additions & 0 deletions Tools/clinic/libclinic/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@
wrap_declarations,
wrapped_c_string_literal,
)
from .identifiers import (
ensure_legal_c_identifier,
is_legal_c_identifier,
is_legal_py_identifier,
)
from .utils import (
FormatCounterFormatter,
compute_checksum,
Expand All @@ -41,6 +46,11 @@
"wrap_declarations",
"wrapped_c_string_literal",

# Identifier helpers
"ensure_legal_c_identifier",
"is_legal_c_identifier",
"is_legal_py_identifier",

# Utility functions
"FormatCounterFormatter",
"compute_checksum",
Expand Down
31 changes: 31 additions & 0 deletions Tools/clinic/libclinic/identifiers.py
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@AlexWaygood: interested in painting the name for this new bikeshed? 🎨 🚲

Copy link
Contributor Author

Choose a reason for hiding this comment

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

identifiers.py it is! 🖌️

Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import re
from .errors import ClinicError


is_legal_c_identifier = re.compile("^[A-Za-z_][A-Za-z0-9_]*$").match


def is_legal_py_identifier(identifier: str) -> bool:
return all(is_legal_c_identifier(field) for field in identifier.split("."))


# Identifiers that are okay in Python but aren't a good idea in C.
# So if they're used Argument Clinic will add "_value" to the end
# of the name in C.
_c_keywords = frozenset("""
asm auto break case char const continue default do double
else enum extern float for goto if inline int long
register return short signed sizeof static struct switch
typedef typeof union unsigned void volatile while
""".strip().split()
)


def ensure_legal_c_identifier(identifier: str) -> str:
# For now, just complain if what we're given isn't legal.
if not is_legal_c_identifier(identifier):
raise ClinicError(f"Illegal C identifier: {identifier}")
# But if we picked a C keyword, pick something else.
if identifier in _c_keywords:
return identifier + "_value"
return identifier
Loading