Skip to content

Commit

Permalink
pythongh-104683: Argument Clinic: Params now render their own docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
erlend-aasland committed Aug 8, 2023
1 parent 7350738 commit b36eda9
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 18 deletions.
12 changes: 10 additions & 2 deletions Lib/test/test_clinic.py
Original file line number Diff line number Diff line change
Expand Up @@ -834,8 +834,8 @@ def expect_failure(self, block, err, *, filename=None, lineno=None):

def checkDocstring(self, fn, expected):
self.assertTrue(hasattr(fn, "docstring"))
self.assertEqual(fn.docstring.strip(),
dedent(expected).strip())
self.assertEqual(dedent(expected).strip(),
fn.docstring.strip())

def test_trivial(self):
parser = DSLParser(_make_clinic())
Expand Down Expand Up @@ -999,8 +999,12 @@ def test_function_docstring(self):
path: str
Path to be examined
Ensure that multiple lines are indented correctly.
Perform a stat system call on the given path.
Ensure that multiple lines are indented correctly.
Ensure that multiple lines are indented correctly.
""")
self.checkDocstring(function, """
stat($module, /, path)
Expand All @@ -1010,6 +1014,10 @@ def test_function_docstring(self):
path
Path to be examined
Ensure that multiple lines are indented correctly.
Ensure that multiple lines are indented correctly.
Ensure that multiple lines are indented correctly.
""")

def test_docstring_trailing_whitespace(self):
Expand Down
29 changes: 13 additions & 16 deletions Tools/clinic/clinic.py
Original file line number Diff line number Diff line change
Expand Up @@ -2775,6 +2775,15 @@ def get_displayname(self, i: int) -> str:
else:
return f'"argument {i}"'

def render_docstring(self) -> str:
if not self.docstring:
return ""
add, out = text_accumulator()
add(f" {self.name}\n")
for line in self.docstring.split("\n"):
add(f" {line}\n")
return out().rstrip()


CConverterClassT = TypeVar("CConverterClassT", bound=type["CConverter"])

Expand Down Expand Up @@ -5681,22 +5690,10 @@ def add_parameter(text: str) -> None:
@staticmethod
def format_docstring_parameters(params: list[Parameter]) -> str:
"""Create substitution text for {parameters}"""
text, add, output = _text_accumulator()
spacer_line = False
for param in params:
docstring = param.docstring.strip()
if not docstring:
continue
if spacer_line:
add('\n')
else:
spacer_line = True
add(" ")
add(param.name)
add('\n')
stripped = rstrip_lines(docstring)
add(textwrap.indent(stripped, " "))
if text:
add, output = text_accumulator()
docstrings = [p.render_docstring() for p in params if p.docstring]
for docstring in docstrings:
add(docstring)
add('\n')
return output()

Expand Down

0 comments on commit b36eda9

Please sign in to comment.