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

autodoc: the signature of base function will be shown for decorated functions

Browse Source
This commit is contained in:
Takeshi KOMIYA 2020-07-05 03:08:27 +09:00
parent cc4534d12f
commit 9b74e6cd67
4 changed files with 11 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CHANGES
View File

@ -7,6 +7,9 @@ Dependencies
Incompatible changes Incompatible changes
-------------------- --------------------
* #7650: autodoc: the signature of base function will be shown for decorated
functions, not a signature of decorator
Deprecated Deprecated
---------- ----------
@ -23,6 +26,8 @@ Bugs fixed
is 'description' is 'description'
* #7812: autodoc: crashed if the target name matches to both an attribute and * #7812: autodoc: crashed if the target name matches to both an attribute and
module that are same name module that are same name
* #7650: autodoc: function signature becomes ``(*args, **kwargs)`` if the
function is decorated by generic decorator
* #7812: autosummary: generates broken stub files if the target code contains * #7812: autosummary: generates broken stub files if the target code contains
an attribute and module that are same name an attribute and module that are same name
* #7806: viewcode: Failed to resolve viewcode references on 3rd party builders * #7806: viewcode: Failed to resolve viewcode references on 3rd party builders

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

@ -1157,10 +1157,7 @@ class FunctionDocumenter(DocstringSignatureMixin, ModuleLevelDocumenter): # typ
try: try:
self.env.app.emit('autodoc-before-process-signature', self.object, False) self.env.app.emit('autodoc-before-process-signature', self.object, False)
if inspect.is_singledispatch_function(self.object): sig = inspect.signature(self.object, follow_wrapped=True)
sig = inspect.signature(self.object, follow_wrapped=True)
else:
sig = inspect.signature(self.object)
args = stringify_signature(sig, **kwargs) args = stringify_signature(sig, **kwargs)
except TypeError as exc: except TypeError as exc:
logger.warning(__("Failed to get a function signature for %s: %s"), logger.warning(__("Failed to get a function signature for %s: %s"),
@ -1740,13 +1737,8 @@ class MethodDocumenter(DocstringSignatureMixin, ClassLevelDocumenter): # type:
sig = inspect.signature(self.object, bound_method=False) sig = inspect.signature(self.object, bound_method=False)
else: else:
self.env.app.emit('autodoc-before-process-signature', self.object, True) self.env.app.emit('autodoc-before-process-signature', self.object, True)
sig = inspect.signature(self.object, bound_method=True,
meth = self.parent.__dict__.get(self.objpath[-1], None) follow_wrapped=True)
if meth and inspect.is_singledispatch_method(meth):
sig = inspect.signature(self.object, bound_method=True,
follow_wrapped=True)
else:
sig = inspect.signature(self.object, bound_method=True)
args = stringify_signature(sig, **kwargs) args = stringify_signature(sig, **kwargs)
except TypeError as exc: except TypeError as exc:
logger.warning(__("Failed to get a method signature for %s: %s"), logger.warning(__("Failed to get a method signature for %s: %s"),

4
tests/test_ext_autodoc.py
View File

@ -1267,7 +1267,7 @@ def test_automethod_for_decorated(app):
actual = do_autodoc(app, 'method', 'target.decorator.Bar.meth') actual = do_autodoc(app, 'method', 'target.decorator.Bar.meth')
assert list(actual) == [ assert list(actual) == [
'', '',
'.. py:method:: Bar.meth()', '.. py:method:: Bar.meth(name=None, age=None)',
' :module: target.decorator', ' :module: target.decorator',
'', '',
] ]
@ -1432,7 +1432,7 @@ def test_coroutine(app):
actual = do_autodoc(app, 'function', 'target.coroutine.sync_func') actual = do_autodoc(app, 'function', 'target.coroutine.sync_func')
assert list(actual) == [ assert list(actual) == [
'', '',
'.. py:function:: sync_func(*args, **kwargs)', '.. py:function:: sync_func()',
' :module: target.coroutine', ' :module: target.coroutine',
'', '',
] ]

2
tests/test_ext_autodoc_autofunction.py
View File

@ -98,7 +98,7 @@ def test_decorated(app):
actual = do_autodoc(app, 'function', 'target.decorator.foo') actual = do_autodoc(app, 'function', 'target.decorator.foo')
assert list(actual) == [ assert list(actual) == [
'', '',
'.. py:function:: foo()', '.. py:function:: foo(name=None, age=None)',
' :module: target.decorator', ' :module: target.decorator',
'', '',
] ]