IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fix unwanted * between varargs and keyword only args

Browse Source 
The * parameter must only be present when a holder for positional variable arguments is not present.
This commit is contained in:
Alex Grönholm 2016-04-09 17:35:32 +03:00
parent 174e61fdb2
commit 0beabaf4cf
3 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
sphinx/ext/autodoc.py
View File

@ -350,7 +350,9 @@ def formatargspec(function, args, varargs=None, varkw=None, defaults=None,
formatted.append('*' + format_arg_with_annotation(varargs)) formatted.append('*' + format_arg_with_annotation(varargs))
if kwonlyargs: if kwonlyargs:
formatted.append('*') if not varargs:
formatted.append('*')
for kwarg in kwonlyargs: for kwarg in kwonlyargs:
arg_fd = StringIO() arg_fd = StringIO()
arg_fd.write(format_arg_with_annotation(kwarg)) arg_fd.write(format_arg_with_annotation(kwarg))

11
tests/test_autodoc.py
View File

@ -1010,7 +1010,7 @@ def test_type_hints():
from sphinx.util.inspect import getargspec from sphinx.util.inspect import getargspec
try: try:
from typing_test_data import f0, f1, f2, f3, f4, f5, f6, f7, f8 from typing_test_data import f0, f1, f2, f3, f4, f5, f6, f7, f8, f9
except (ImportError, SyntaxError): except (ImportError, SyntaxError):
raise SkipTest('Cannot import Python code with function annotations') raise SkipTest('Cannot import Python code with function annotations')
@ -1037,12 +1037,15 @@ def test_type_hints():
# Keyword-only arguments # Keyword-only arguments
verify_arg_spec(f5, '(x: int, *, y: str, z: str) -> None') verify_arg_spec(f5, '(x: int, *, y: str, z: str) -> None')
# Keyword-only arguments with varargs
verify_arg_spec(f6, '(x: int, *args, y: str, z: str) -> None')
# Space around '=' for defaults # Space around '=' for defaults
verify_arg_spec(f6, '(x: int = None, y: dict = {}) -> None') verify_arg_spec(f7, '(x: int = None, y: dict = {}) -> None')
# Callable types # Callable types
verify_arg_spec(f7, '(x: typing.Callable[[int, str], int]) -> None') verify_arg_spec(f8, '(x: typing.Callable[[int, str], int]) -> None')
# Tuple types # Tuple types
verify_arg_spec(f8, '(x: typing.Tuple[int, str],' verify_arg_spec(f9, '(x: typing.Tuple[int, str],'
' y: typing.Tuple[int, ...]) -> None') ' y: typing.Tuple[int, ...]) -> None')

10
tests/typing_test_data.py
View File

@ -35,14 +35,18 @@ def f5(x: int, *, y: str, z: str) -> None:
pass pass
def f6(x: int = None, y: dict = {}) -> None: def f6(x: int, *args, y: str, z: str) -> None:
pass pass
def f7(x: Callable[[int, str], int]) -> None: def f7(x: int = None, y: dict = {}) -> None:
pass
def f8(x: Callable[[int, str], int]) -> None:
# See https://github.com/ambv/typehinting/issues/149 for Callable[..., int] # See https://github.com/ambv/typehinting/issues/149 for Callable[..., int]
pass pass
def f8(x: Tuple[int, str], y: Tuple[int, ...]) -> None: def f9(x: Tuple[int, str], y: Tuple[int, ...]) -> None:
pass pass