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

check that we can only combine *args with **kwargs and vice versa

Browse Source
This commit is contained in:
Keewis 2020-06-08 14:19:03 +02:00
parent d5f552685c
commit 95ec45b562
1 changed files with 28 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -18,13 +18,16 @@ from typing import Any, Callable, Dict, List, Tuple, Union
from sphinx.application import Sphinx from sphinx.application import Sphinx
from sphinx.config import Config as SphinxConfig from sphinx.config import Config as SphinxConfig
from sphinx.ext.napoleon.iterators import modify_iter from sphinx.ext.napoleon.iterators import modify_iter
from sphinx.locale import _ from sphinx.locale import _, __
from sphinx.util import logging
if False: if False:
# For type annotation # For type annotation
from typing import Type # for python3.5.1 from typing import Type # for python3.5.1
logger = logging.getLogger(__name__)
_directive_regex = re.compile(r'\.\. \S+::') _directive_regex = re.compile(r'\.\. \S+::')
_google_section_regex = re.compile(r'^(\s|\w)+:\s*$') _google_section_regex = re.compile(r'^(\s|\w)+:\s*$')
_google_typed_arg_regex = re.compile(r'\s*(.+?)\s*\(\s*(.*[^\s]+)\s*\)') _google_typed_arg_regex = re.compile(r'\s*(.+?)\s*\(\s*(.*[^\s]+)\s*\)')
@ -880,8 +883,30 @@ class NumpyDocstring(GoogleDocstring):
func = super()._escape_args_and_kwargs func = super()._escape_args_and_kwargs
if ", " in name: if ", " in name:
parts = name.split(", ") args, kwargs, *rest = name.split(", ")
return ", ".join(func(part) for part in parts)
is_args = args[:1] == "*" and len([c for c in args if c == "*"]) == 1
is_kwargs = kwargs[:2] == "**" and len([c for c in kwargs if c == "*"]) == 2
if 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=None,
)
elif is_args and is_kwargs and rest:
logger.warning(
__("cannot combine %s and %s with more parameters: %s"),
args,
kwargs,
name,
location=None,
)
return ", ".join([func(args), func(kwargs)])
return func(name) return func(name)