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 #4969: autodoc: constructor method should not have return annotation

Browse Source
This commit is contained in:
Takeshi KOMIYA
2018-05-14 23:35:52 +09:00
parent b22cdccd9a
commit b2abab1c45
4 changed files with 17 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@@ -27,6 +27,7 @@ Bugs fixed
(escaped) line breaks are present. (escaped) line breaks are present.
* C++, properly use ``desc_addname`` nodes for prefixes of names. * C++, properly use ``desc_addname`` nodes for prefixes of names.
* #4915, #4916: links on search page are broken when using dirhtml builder * #4915, #4916: links on search page are broken when using dirhtml builder
* #4969: autodoc: constructor method should not have return annotation
Testing Testing
-------- --------

8
sphinx/ext/autodoc/__init__.py
View File

@@ -1035,9 +1035,11 @@ class FunctionDocumenter(DocstringSignatureMixin, ModuleLevelDocumenter): # typ
# typing) we try to use the constructor signature as function # typing) we try to use the constructor signature as function
# signature without the first argument. # signature without the first argument.
try: try:
args = Signature(self.object.__new__, bound_method=True).format_args() sig = Signature(self.object.__new__, bound_method=True, has_retval=False)
args = sig.format_args()
except TypeError: except TypeError:
args = Signature(self.object.__init__, bound_method=True).format_args() sig = Signature(self.object.__init__, bound_method=True, has_retval=False)
args = sig.format_args()
# escape backslashes for reST # escape backslashes for reST
args = args.replace('\\', '\\\\') args = args.replace('\\', '\\\\')
@@ -1090,7 +1092,7 @@ class ClassDocumenter(DocstringSignatureMixin, ModuleLevelDocumenter): # type:
not(inspect.ismethod(initmeth) or inspect.isfunction(initmeth)): not(inspect.ismethod(initmeth) or inspect.isfunction(initmeth)):
return None return None
try: try:
return Signature(initmeth, bound_method=True).format_args() return Signature(initmeth, bound_method=True, has_retval=False).format_args()
except TypeError: except TypeError:
# still not possible: happens e.g. for old-style classes # still not possible: happens e.g. for old-style classes
# with __init__ in C # with __init__ in C

10
sphinx/util/inspect.py
View File

@@ -298,8 +298,8 @@ class Signature(object):
its return annotation. its return annotation.
""" """
def __init__(self, subject, bound_method=False): def __init__(self, subject, bound_method=False, has_retval=True):
# type: (Callable, bool) -> None # type: (Callable, bool, bool) -> None
# check subject is not a built-in class (ex. int, str) # check subject is not a built-in class (ex. int, str)
if (isinstance(subject, type) and if (isinstance(subject, type) and
is_builtin_class_method(subject, "__new__") and is_builtin_class_method(subject, "__new__") and
@@ -307,6 +307,7 @@ class Signature(object):
raise TypeError("can't compute signature for built-in type {}".format(subject)) raise TypeError("can't compute signature for built-in type {}".format(subject))
self.subject = subject self.subject = subject
self.has_retval = has_retval
self.partialmethod_with_noargs = False self.partialmethod_with_noargs = False
if PY3: if PY3:
@@ -375,7 +376,10 @@ class Signature(object):
def return_annotation(self): def return_annotation(self):
# type: () -> Any # type: () -> Any
if PY3 and self.signature: if PY3 and self.signature:
return self.signature.return_annotation if self.has_retval:
return self.signature.return_annotation
else:
return inspect.Parameter.empty
else: else:
return None return None

4
tests/test_util_inspect.py
View File

@@ -280,6 +280,10 @@ def test_Signature_annotations():
sig = inspect.Signature(f11).format_args() sig = inspect.Signature(f11).format_args()
assert sig == '(x: CustomAnnotation, y: 123) -> None' assert sig == '(x: CustomAnnotation, y: 123) -> None'
# has_retval=False
sig = inspect.Signature(f11, has_retval=False).format_args()
assert sig == '(x: CustomAnnotation, y: 123)'
def test_safe_getattr_with_default(): def test_safe_getattr_with_default():
class Foo(object): class Foo(object):