Skip to content

gh-104683: Argument Clinic: Use CConverter.length_name where possible #107638

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

Merged
erlend-aasland merged 2 commits into from
Aug 4, 2023
Merged

gh-104683: Argument Clinic: Use CConverter.length_name where possible #107638

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce1066e
gh-104683: Argument Clinic: Use CConverter.length_name where possible
erlend-aasland Aug 4, 2023
6c37324
Address review: make it a cached property
erlend-aasland Aug 4, 2023
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
30 changes: 15 additions & 15 deletions Tools/clinic/clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2781,7 +2781,7 @@ class CConverter(metaclass=CConverterAutoRegister):
# Only used by the 'O!' format unit (and the "object" converter).
subclass_of: str | None = None

# Do we want an adjacent '_length' variable for this variable?
# See also the 'length_name' property.
# Only used by format units ending with '#'.
length = False

Expand Down Expand Up @@ -2875,12 +2875,12 @@ def _render_self(self, parameter: Parameter, data: CRenderData) -> None:
s = ("&" if self.impl_by_reference else "") + name
data.impl_arguments.append(s)
if self.length:
data.impl_arguments.append(self.length_name())
data.impl_arguments.append(self.length_name)

# impl_parameters
data.impl_parameters.append(self.simple_declaration(by_reference=self.impl_by_reference))
if self.length:
data.impl_parameters.append("Py_ssize_t " + self.length_name())
data.impl_parameters.append(f"Py_ssize_t {self.length_name}")

def _render_non_self(
self,
Expand Down Expand Up @@ -2939,6 +2939,7 @@ def render(self, parameter: Parameter, data: CRenderData) -> None:
self._render_self(parameter, data)
self._render_non_self(parameter, data)

@functools.cached_property
def length_name(self) -> str:
"""Computes the name of the associated "length" variable."""
assert self.length is not None
Expand All @@ -2962,7 +2963,7 @@ def parse_argument(self, args: list[str]) -> None:
args.append(s)

if self.length:
args.append("&" + self.length_name())
args.append(f"&{self.length_name}")

#
# All the functions after here are intended as extension points.
Expand Down Expand Up @@ -3007,9 +3008,8 @@ def declaration(self, *, in_parser: bool = False) -> str:
declaration.append(default)
declaration.append(";")
if self.length:
declaration.append('\nPy_ssize_t ')
declaration.append(self.length_name())
declaration.append(';')
declaration.append('\n')
declaration.append(f"Py_ssize_t {self.length_name};")
return "".join(declaration)

def initialize(self) -> str:
Expand Down Expand Up @@ -3688,29 +3688,29 @@ def parse_arg(self, argname: str, displayname: str) -> str | None:
_PyArg_BadArgument("{{name}}", {displayname}, "str", {argname});
goto exit;
}}}}
Py_ssize_t {paramname}_length;
{paramname} = PyUnicode_AsUTF8AndSize({argname}, &{paramname}_length);
Py_ssize_t {length_name};
{paramname} = PyUnicode_AsUTF8AndSize({argname}, &{length_name});
if ({paramname} == NULL) {{{{
goto exit;
}}}}
if (strlen({paramname}) != (size_t){paramname}_length) {{{{
if (strlen({paramname}) != (size_t){length_name}) {{{{
PyErr_SetString(PyExc_ValueError, "embedded null character");
goto exit;
}}}}
""".format(argname=argname, paramname=self.parser_name,
displayname=displayname)
displayname=displayname, length_name=self.length_name)
if self.format_unit == 'z':
return """
if ({argname} == Py_None) {{{{
{paramname} = NULL;
}}}}
else if (PyUnicode_Check({argname})) {{{{
Py_ssize_t {paramname}_length;
{paramname} = PyUnicode_AsUTF8AndSize({argname}, &{paramname}_length);
Py_ssize_t {length_name};
{paramname} = PyUnicode_AsUTF8AndSize({argname}, &{length_name});
if ({paramname} == NULL) {{{{
goto exit;
}}}}
if (strlen({paramname}) != (size_t){paramname}_length) {{{{
if (strlen({paramname}) != (size_t){length_name}) {{{{
PyErr_SetString(PyExc_ValueError, "embedded null character");
goto exit;
}}}}
Expand All @@ -3720,7 +3720,7 @@ def parse_arg(self, argname: str, displayname: str) -> str | None:
goto exit;
}}}}
""".format(argname=argname, paramname=self.parser_name,
displayname=displayname)
displayname=displayname, length_name=self.length_name)
return super().parse_arg(argname, displayname)

#
Expand Down