Skip to content

Fix parsing of *args and **kwargs #21

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

Merged
merged 1 commit into from
Apr 10, 2020
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
2 changes: 1 addition & 1 deletion src/pytkdocs/parsers/docstrings.py
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ def read_parameters_section(self, lines: List[str], start_index: int) -> Tuple[O
kind = None

try:
signature_param = self.signature.parameters[name] # type: ignore
signature_param = self.signature.parameters[name.lstrip("*")] # type: ignore
except (AttributeError, KeyError):
self.parsing_errors.append(f"{self.path}: No type annotation for parameter '{name}'")
else:
Expand Down
18 changes: 18 additions & 0 deletions tests/test_parsers/test_docstrings.py
Original file line number Diff line number Diff line change
Expand Up @@ -344,3 +344,21 @@ def f(p: str, q: str):
sections, errors = parse(inspect.getdoc(f), inspect.signature(f))
assert len(sections) == 2
assert not errors

def test_parse_args_kwargs(self):
def f(a, *args, **kwargs):
"""
Arguments:
a: a parameter.
*args: args parameters.
**kwargs: kwargs parameters.
"""
return 1

sections, errors = parse(inspect.getdoc(f), inspect.signature(f))
assert len(sections) == 1
expected_parameters = {"a": "a parameter.", "*args": "args parameters.", "**kwargs": "kwargs parameters."}
for param in sections[0].value:
assert param.name in expected_parameters
assert expected_parameters[param.name] == param.description
assert not errors