Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

autodoc_typehints = 'descriptions' throws KeyError: 'module' #7850

Closed
LiterallyUniqueLogin opened this issue Jun 17, 2020 · 4 comments
Closed

autodoc_typehints = 'descriptions' throws KeyError: 'module' #7850

LiterallyUniqueLogin opened this issue Jun 17, 2020 · 4 comments
Labels
extensions:autodoc type:bug
Milestone
3.1.2

Comments

@LiterallyUniqueLogin
Copy link

Describe the bug
autodoc_typehints = 'description' does not work, results in KeyError: 'module'

To Reproduce

git clone https://github.com/gymreklab/TRTools .
git checkout 157a332b49f2be0b12c2d5ae38312d83a175a851
cd doc
# add the line
# autodoc_typehints = 'description'
# to conf.py
make clean && make html

Environment info

  • OS: Linux
  • Python version: 3.5.6
  • Sphinx version: 3.0.4
  • Sphinx extensions: sphinx.ext.autodoc, sphinx.ext.napoleon

Additional context
Full error message:

Exception occurred:
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/nodes.py", line 567, in __getitem__
    return self.attributes[key]
KeyError: 'module'
The full traceback has been saved in /tmp/sphinx-err-1kq4sywr.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
make: *** [html] Error 2

Log file

# Sphinx version: 3.0.4
# Python version: 3.5.6 (CPython)
# Docutils version: 0.14
# Jinja2 version: 2.11.2
# Last messages:
#   reading sources... [ 54%] source/qcSTR
#
#   reading sources... [ 58%] source/statSTR
#
#   reading sources... [ 62%] trtools.compareSTR
#
#   reading sources... [ 66%] trtools.dumpSTR
#
#   reading sources... [ 70%] trtools.dumpSTR.filters
#
# Loaded extensions:
#   sphinx.ext.autodoc.type_comment (3.0.4) from /storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/ext/autodoc/type_comment.py
#   sphinxcontrib.qthelp (1.0.3) from /storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinxcontrib/qthelp/__init__.py
#   sphinx.ext.napoleon (3.0.4) from /storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/ext/napoleon/__init__.py
#   sphinxcontrib.serializinghtml (1.1.4) from /storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinxcontrib/serializinghtml/__init__.py
#   sphinxcontrib.devhelp (1.0.2) from /storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinxcontrib/devhelp/__init__.py
#   sphinx.ext.autodoc (3.0.4) from /storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/ext/autodoc/__init__.py
#   sphinx.ext.mathjax (3.0.4) from /storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/ext/mathjax.py
#   sphinxcontrib.applehelp (1.0.2) from /storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinxcontrib/applehelp/__init__.py
#   sphinxcontrib.htmlhelp (1.0.3) from /storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinxcontrib/htmlhelp/__init__.py
#   alabaster (0.7.12) from /storage/conda/envs/trtools_dev/lib/python3.5/site-packages/alabaster/__init__.py
Traceback (most recent call last):
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/cmd/build.py", line 280, in build_main
    app.build(args.force_all, filenames)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/application.py", line 348, in build
    self.builder.build_update()
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/builders/__init__.py", line 299, in build_update
    len(to_build))
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/builders/__init__.py", line 311, in build
    updated_docnames = set(self.read())
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/builders/__init__.py", line 418, in read
    self._read_serial(docnames)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/builders/__init__.py", line 439, in _read_serial
    self.read_doc(docname)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/builders/__init__.py", line 479, in read_doc
    doctree = read_doc(self.app, self.env, self.env.doc2path(docname))
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/io.py", line 221, in read_doc
    pub.publish()
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/core.py", line 217, in publish
    self.settings)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/io.py", line 126, in read
    self.parse()
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/readers/__init__.py", line 78, in parse
    self.parser.parse(self.input, document)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/parsers.py", line 102, in parse
    self.statemachine.run(inputlines, document, inliner=self.inliner)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 171, in run
    input_source=document['source'])
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/statemachine.py", line 239, in run
    context, state, transitions)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/statemachine.py", line 460, in check_line
    return method(match, context, next_state)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 2753, in underline
    self.section(title, source, style, lineno - 1, messages)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 327, in section
    self.new_subsection(title, lineno, messages)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 395, in new_subsection
    node=section_node, match_titles=True)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 282, in nested_parse
    node=node, match_titles=match_titles)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 196, in run
    results = StateMachineWS.run(self, input_lines, input_offset)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/statemachine.py", line 239, in run
    context, state, transitions)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/statemachine.py", line 460, in check_line
    return method(match, context, next_state)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 2326, in explicit_markup
    nodelist, blank_finish = self.explicit_construct(match)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 2338, in explicit_construct
    return method(self, expmatch)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 2081, in directive
    directive_class, match, type_name, option_presets)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 2130, in run_directive
    result = directive_instance.run()
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/ext/autodoc/directive.py", line 157, in run
    result = parse_generated_content(self.state, params.result, documenter)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/ext/autodoc/directive.py", line 100, in parse_generated_content
    nested_parse_with_titles(state, content, node)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/util/nodes.py", line 339, in nested_parse_with_titles
    return state.nested_parse(content, 0, node, match_titles=1)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 282, in nested_parse
    node=node, match_titles=match_titles)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 196, in run
    results = StateMachineWS.run(self, input_lines, input_offset)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/statemachine.py", line 239, in run
    context, state, transitions)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/statemachine.py", line 460, in check_line
    return method(match, context, next_state)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 2328, in explicit_markup
    self.explicit_list(blank_finish)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 2358, in explicit_list
    match_titles=self.state_machine.match_titles)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 319, in nested_list_parse
    node=node, match_titles=match_titles)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 196, in run
    results = StateMachineWS.run(self, input_lines, input_offset)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/statemachine.py", line 239, in run
    context, state, transitions)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/statemachine.py", line 460, in check_line
    return method(match, context, next_state)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 2631, in explicit_markup
    nodelist, blank_finish = self.explicit_construct(match)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 2338, in explicit_construct
    return method(self, expmatch)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 2081, in directive
    directive_class, match, type_name, option_presets)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 2130, in run_directive
    result = directive_instance.run()
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/domains/__init__.py", line 285, in run
    return super().run()
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/directives/__init__.py", line 209, in run
    self.state.nested_parse(self.content, self.content_offset, contentnode)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 282, in nested_parse
    node=node, match_titles=match_titles)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 196, in run
    results = StateMachineWS.run(self, input_lines, input_offset)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/statemachine.py", line 239, in run
    context, state, transitions)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/statemachine.py", line 460, in check_line
    return method(match, context, next_state)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 2326, in explicit_markup
    nodelist, blank_finish = self.explicit_construct(match)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 2338, in explicit_construct
    return method(self, expmatch)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 2081, in directive
    directive_class, match, type_name, option_presets)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/parsers/rst/states.py", line 2130, in run_directive
    result = directive_instance.run()
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/domains/__init__.py", line 285, in run
    return super().run()
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/directives/__init__.py", line 212, in run
    self.domain, self.objtype, contentnode)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/application.py", line 445, in emit
    return self.events.emit(event, *args)
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/events.py", line 107, in emit
    results.append(listener.handler(self.app, *args))
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/sphinx/ext/autodoc/typehints.py", line 50, in merge_typehints
    if signature['module']:
  File "/storage/conda/envs/trtools_dev/lib/python3.5/site-packages/docutils/nodes.py", line 567, in __getitem__
    return self.attributes[key]
KeyError: 'module'
@LiterallyUniqueLogin LiterallyUniqueLogin changed the title <what happen when you do on which document project> autodoc_typehints = 'descriptions' throws KeyError: 'module' Jun 17, 2020
@LiterallyUniqueLogin
Copy link
Author

I happened to fix my problem - seems that this occurs when there are both attribute and py:attribute in the same class with the same name (that occurs because of an unrelated issue with napoleon). I can understand that's not a use case that needs to be supported, but the error thrown should help describe what's going wrong.

@tk0miya
Copy link
Member

tk0miya commented Jun 21, 2020

Note: reproduced with this dockerfile:

FROM python:3.7-slim

RUN apt update; apt install -y git make build-essential vim
RUN git clone https://github.com/gymreklab/TRTools
WORKDIR /TRTools
RUN git checkout 157a332b49f2be0b12c2d5ae38312d83a175a851
RUN apt install -y libz-dev
RUN pip install -e .
RUN pip install -r requirements.txt
WORKDIR /TRTools/doc
RUN pip install Sphinx==3.0.4
RUN echo "autodoc_typehints = 'description'" >> conf.py
RUN make html

@tk0miya
Copy link
Member

tk0miya commented Jun 21, 2020

It seems typo in here. The error is resolved when I replaced ; to :.
https://github.com/gymreklab/TRTools/blob/157a332b49f2be0b12c2d5ae38312d83a175a851/trtools/dumpSTR/filters.py#L596-L599

tk0miya added a commit to tk0miya/sphinx that referenced this issue Jun 21, 2020
@tk0miya
Fix sphinx-doc#7850: autodoc: KeyError is raised for invalid mark up
4fb66c3
@tk0miya tk0miya mentioned this issue Jun 21, 2020
Merged
@tk0miya
Copy link
Member

tk0miya commented Jun 21, 2020

I added error-handling for invalid mark-up on PR #7850.

@tk0miya tk0miya added this to the 3.1.2 milestone Jun 21, 2020
tk0miya added a commit to tk0miya/sphinx that referenced this issue Jun 25, 2020
@tk0miya
Fix sphinx-doc#7850: autodoc: KeyError is raised for invalid mark up
bcb1935
tk0miya added a commit to tk0miya/sphinx that referenced this issue Jun 25, 2020
@tk0miya
Fix sphinx-doc#7850: autodoc: KeyError is raised for invalid mark up
ef5f0ba
tk0miya added a commit to tk0miya/sphinx that referenced this issue Jun 26, 2020
@tk0miya
Fix sphinx-doc#7850: autodoc: KeyError is raised for invalid mark up
4e739b8
tk0miya added a commit that referenced this issue Jun 26, 2020
@tk0miya
Merge pull request #7859 from tk0miya/7850_KeyError_for_autodoc_typeh…
bfde3f3 
…ints_description

Fix #7850: autodoc: KeyError is raised for invalid mark up
@tk0miya tk0miya closed this as completed Jun 26, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 23, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
extensions:autodoc type:bug
Projects
None yet
Milestone
3.1.2
Development

No branches or pull requests
2 participants
@tk0miya @LiterallyUniqueLogin