Skip to content

Python: fix(core): ensure proper section spacing and argument grouping in build_layered_docstring #8691

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

Closed
Manohar Paturi (ManoharPaturi) wants to merge 1 commit into from
+19 −1
Closed

Python: fix(core): ensure proper section spacing and argument grouping in build_layered_docstring #8691

Show file tree
Hide file tree
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
14 changes: 13 additions & 1 deletion python/packages/core/agent_framework/_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,23 @@ def build_layered_docstring(
insert_index = _find_next_section_index(lines, args_index + 1)
else:
insert_index = _find_next_section_index(lines, 0)
lines[insert_index:insert_index] = ["", "Keyword Args:", *formatted_keyword_arg_lines]
insertion: list[str] = []
if insert_index > 0 and lines[insert_index - 1] != "":
insertion.append("")
insertion.append("Keyword Args:")
insertion.extend(formatted_keyword_arg_lines)
if insert_index < len(lines) and lines[insert_index] != "":
insertion.append("")
lines[insert_index:insert_index] = insertion
return "\n".join(lines).rstrip()

insert_index = _find_next_section_index(lines, keyword_args_index + 1)
while insert_index > keyword_args_index + 1 and lines[insert_index - 1] == "":
insert_index -= 1
lines[insert_index:insert_index] = formatted_keyword_arg_lines
after_index = insert_index + len(formatted_keyword_arg_lines)
if after_index < len(lines) and lines[after_index] != "":
lines.insert(after_index, "")
return "\n".join(lines).rstrip()


Expand Down
6 changes: 6 additions & 0 deletions python/packages/core/tests/core/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,10 @@ def test_build_appends_to_existing_keyword_args_section() -> None:
kw_index = next(i for i, line in enumerate(lines) if line == "Keyword Args:")
ret_index = next(i for i, line in enumerate(lines) if line == "Returns:")
retries_index = next(i for i, line in enumerate(lines) if "retries:" in line)
timeout_index = next(i for i, line in enumerate(lines) if "timeout:" in line)
assert kw_index < retries_index < ret_index
assert retries_index == timeout_index + 1
assert lines[ret_index - 1] == ""


def test_build_inserts_keyword_args_after_args_section() -> None:
Expand All @@ -102,6 +105,9 @@ def test_build_inserts_keyword_args_after_args_section() -> None:
kw_index = next(i for i, line in enumerate(lines) if line == "Keyword Args:")
ret_index = next(i for i, line in enumerate(lines) if line == "Returns:")
assert args_index < kw_index < ret_index
assert lines[kw_index - 1] == ""
assert lines[kw_index - 2] != ""
assert lines[ret_index - 1] == ""


def test_build_inserts_keyword_args_in_docstring_with_no_sections() -> None:
Expand Down
Loading