8000 gh-117431: Argument Clinic: copy forced text signature when cloning by erlend-aasland · Pull Request #117591 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-117431: Argument Clinic: copy forced text signature when cloning #117591

New issue 8000

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
merged 6 commits into from
Apr 10, 2024
Merged

gh-117431: Argument Clinic: copy forced text signature when cloning #117591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5bafa02
Argument Clinic: copy forced text signature when cloning
erlend-aasland Apr 6, 2024
fd9f706
Add test
erlend-aasland Apr 6, 2024
86f7b4a
@text_signature when cloning does not make sense
erlend-aasland Apr 6, 2024
2d193aa
Clean up
erlend-aasland Apr 6, 2024
0a25324
Pull in main
erlend-aasland Apr 9, 2024
ae0fa89
More tests
erlend-aasland Apr 9, 2024
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
57 changes: 56 additions & 1 deletion Lib/test/test_clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from functools import partial
from test import support, test_tools
from test.support import os_helper
from test.support.os_helper import TESTFN, unlink
from test.support.os_helper import TESTFN, unlink, rmtree
from textwrap import dedent
from unittest import TestCase
import inspect
Expand Down Expand Up @@ -662,6 +662,61 @@ class C "void *" ""
err = "Illegal C basename: '.illegal.'"
self.expect_failure(block, err, lineno=7)

def test_cloned_fo 8000 rced_text_signature(self):
block = dedent("""
/*[clinic input]
@text_signature "($module, a[, b])"
src
a: object
param a
b: object = NULL
/

docstring
[clinic start generated code]*/

/*[clinic input]
dst = src
[clinic start generated code]*/
""")
self.clinic.parse(block)
self.addCleanup(rmtree, "clinic")
funcs = self.clinic.functions
self.assertEqual(len(funcs), 2)

src_docstring_lines = funcs[0].docstring.split("\n")
dst_docstring_lines = funcs[1].docstring.split("\n")

# Signatures are copied.
self.assertEqual(src_docstring_lines[0], "src($module, a[, b])")
self.assertEqual(dst_docstring_lines[0], "dst($module, a[, b])")

# Param docstrings are copied.
self.assertIn(" param a", src_docstring_lines)
self.assertIn(" param a", dst_docstring_lines)

# Docstrings are not copied.
self.assertIn("docstring", src_docstring_lines)
self.assertNotIn("docstring", dst_docstring_lines)

def test_cloned_forced_text_signature_illegal(self):
block = """
/*[clinic input]
@text_signature "($module, a[, b])"
src
a: object
b: object = NULL
/
[clinic start generated code]*/

/*[clinic input]
@text_signature "($module, a_override[, b])"
dst = src
[clinic start generated code]*/
"""
err = "Cannot use @text_signature when cloning a function"
self.expect_failure(block, err, lineno=11)


class ParseFileUnitTest(TestCase):
def expect_parsing_failure(
Expand Down
10 changes: 5 additions & 5 deletions Objects/clinic/unicodeobject.c.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 8 additions & 4 deletions Tools/clinic/libclinic/dsl_parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -666,6 +666,8 @@ def state_modulename_name(self, line: str) -> None:
if equals:
existing = existing.strip()
if libclinic.is_legal_py_identifier(existing):
if self.forced_text_signature:
fail("Cannot use @text_signature when cloning a function")
# we're cloning!
names = self.parse_function_names(before)
return self.parse_cloned_function(names, existing)
Expand All @@ -689,7 +691,8 @@ def state_modulename_name(self, line: str) -> None:
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,
forced_text_signature=self.forced_text_signature
)
self.add_function(func)

Expand Down Expand Up @@ -1324,13 +1327,14 @@ def state_function_docstring(self, line: str) -> None:

self.docstring_append(self.function, line)

@staticmethod
def format_docstring_signature(
self, f: Function, parameters: list[Parameter]
f: Function, parameters: list[Parameter]
) -> str:
lines = []
lines.append(f.displayname)
if self.forced_text_signature:
lines.append(self.forced_text_signature)
if f.forced_text_signature:
lines.append(f.forced_text_signature)
elif f.kind in {GETTER, SETTER}:
# @getter and @setter do not need signatures like a method or a function.
return ''
Expand Down
1 change: 1 addition & 0 deletions Tools/clinic/libclinic/function.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ class Function:
# functions with optional groups because we can't represent
# those accurately with inspect.Signature in 3.4.
docstring_only: bool = False
forced_text_signature: str | None = None
critical_section: bool = False
target_critical_section: list[str] = dc.field(default_factory=list)

Expand Down
0