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

remove the syntax checks from the escape method and update the tests

Browse Source
This commit is contained in:
Keewis
2020-08-05 19:22:43 +02:00
parent e79cd79cd2
commit 849d3c18a7
2 changed files with 12 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
sphinx/ext/napoleon/docstring.py
View File

@@ -1090,45 +1090,9 @@ class NumpyDocstring(GoogleDocstring):
func = super()._escape_args_and_kwargs
if ", " in name:
args, kwargs, *rest = name.split(", ")
def check_args(s):
return s[:1] == "*" and len([c for c in s if c == "*"]) == 1
def check_kwargs(s):
return s[:2] == "**" and len([c for c in s if c == "*"]) == 2
is_args = check_args(args)
is_kwargs = check_kwargs(kwargs)
location = self._get_location()
if (not is_args and check_args(kwargs)) and (not is_kwargs and check_kwargs(args)):
logger.warning(
__("wrong order of *args and **kwargs: %s"),
name,
location=location,
)
elif (is_args or is_kwargs) and not (is_args and is_kwargs):
name_ = args if is_args else kwargs
other = "*args" if not is_args else "**kwargs"
logger.warning(
__("can only combine parameters of form %s with %s: %s"),
name_,
other,
name,
location=location,
)
elif is_args and is_kwargs and rest:
logger.warning(
__("cannot combine %s and %s with more parameters: %s"),
args,
kwargs,
name,
location=location,
)
return ", ".join([func(args), func(kwargs)])
return func(name)
return ", ".join(func(param) for param in name.split(", "))
else:
return func(name)
def _consume_field(self, parse_type: bool = True, prefer_type: bool = False
) -> Tuple[str, str, List[str]]:

31
tests/test_ext_napoleon_docstring.py
View File

@@ -2238,28 +2238,15 @@ class TestNumpyDocstring:
_token_type(token)
@pytest.mark.parametrize(
["spec", "pattern"],
("name", "expected"),
(
pytest.param("*args, *kwargs", ".+: can only combine parameters of form", id="two args"),
pytest.param("**args, **kwargs", ".+: can only combine parameters of form", id="two kwargs"),
pytest.param(
"*args, **kwargs, other_parameter",
".+: cannot combine .+ and .+ with more parameters",
id="more parameters",
),
pytest.param("**kwargs, *args", r".+: wrong order of .+ and .+", id="swapped parameters"),
)
("x, y, z", "x, y, z"),
("*args, **kwargs", r"\*args, \*\*kwargs"),
("*x, **y", r"\*x, \*\*y"),
),
)
def test_invalid_combined_args_and_kwargs(self, spec, pattern, app, warning):
docstring = dedent(
"""\
Parameters
----------
{}
variable args list and arbitrary keyword arguments
"""
).format(spec)
config = Config()
def test_escape_args_and_kwargs(self, name, expected):
numpy_docstring = NumpyDocstring("")
actual = numpy_docstring._escape_args_and_kwargs(name)
with warns(warning, match=pattern):
str(NumpyDocstring(docstring, config, app, "method"))
assert actual == expected