diff options
| -rw-r--r-- | CHANGES | 2 | ||||
| -rw-r--r-- | sphinx/pycode/parser.py | 4 | ||||
| -rw-r--r-- | tests/test_pycode.py | 15 |
3 files changed, 21 insertions, 0 deletions
@@ -41,6 +41,8 @@ Bugs fixed * #9883: autodoc: doccomment for the alias to mocked object was ignored * #9908: autodoc: debug message is shown on building document using NewTypes with Python 3.10 +* #9968: autodoc: instance variables are not shown if __init__ method has + position-only-arguments * #9947: i18n: topic directive having a bullet list can't be translatable * #9878: mathjax: MathJax configuration is placed after loading MathJax itself * #9857: Generated RFC links use outdated base url diff --git a/sphinx/pycode/parser.py b/sphinx/pycode/parser.py index cad9a6e71..6b566c4c4 100644 --- a/sphinx/pycode/parser.py +++ b/sphinx/pycode/parser.py @@ -312,6 +312,10 @@ class VariableCommentPicker(ast.NodeVisitor): """Returns the name of the first argument if in a function.""" if self.current_function and self.current_function.args.args: return self.current_function.args.args[0] + elif (self.current_function and + getattr(self.current_function.args, 'posonlyargs', None)): + # for py38+ + return self.current_function.args.posonlyargs[0] # type: ignore else: return None diff --git a/tests/test_pycode.py b/tests/test_pycode.py index bbcc42a52..e0e0fdb11 100644 --- a/tests/test_pycode.py +++ b/tests/test_pycode.py @@ -191,3 +191,18 @@ def test_ModuleAnalyzer_find_attr_docs(): 'Qux': 15, 'Qux.attr1': 16, 'Qux.attr2': 17} + + +@pytest.mark.skipif(sys.version_info < (3, 8), + reason='posonlyargs are available since python3.8.') +def test_ModuleAnalyzer_find_attr_docs_for_posonlyargs_method(): + code = ('class Foo(object):\n' + ' def __init__(self, /):\n' + ' self.attr = None #: attribute comment\n') + analyzer = ModuleAnalyzer.for_string(code, 'module') + docs = analyzer.find_attr_docs() + assert set(docs) == {('Foo', 'attr')} + assert docs[('Foo', 'attr')] == ['attribute comment', ''] + assert analyzer.tagorder == {'Foo': 0, + 'Foo.__init__': 1, + 'Foo.attr': 2} |