Fix #8084: autodoc: KeyError is raised on documenting a broken attribute #8085
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ken attribute ``typing.get_type_hints()`` raises KeyError when a class having invalid __module__ was given. This handles the exception not to crash on build documents.
|
I'm seeing a similar issue in sphinx/util/inspect.py at line 468, when processing a package that uses wxPython. It attempts to use 'sip' as the module key and get_type_hints raises a KeyError, crashing as described above. Is this part of the same issue, or should I file a new report? |
|
@efahl Please file a new issue please. It seems latest Sphinx catches all kinds of exceptions at that location. So I feel strange that you got KeyError. I need to know about the error in detail (stacktrace, versions, extensions and so on). |
|
Oops... I wrongly merged this into 3.x branch. I cherry-picked this to 3.2.x branch manually now. |
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this pull request
Aug 10, 2020
… an attribute Until Python 3.5.2, typing.get_type_hints() raises AttributeError if given object does not have `__code__` attribute. This handles the exception not to crash building documents. refs: python/cpython@991d14f
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this pull request
Aug 10, 2020
… an attribute Until Python 3.5.2, typing.get_type_hints() raises AttributeError if given object does not have `__code__` attribute. This handles the exception not to crash building documents. Note: The AttributeError was fixed at 3.5.3 refs: python/cpython@991d14f
altendky
added a commit
to altendky/sphinx-autodoc-typehints
that referenced
this pull request
Aug 16, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature or Bugfix
Purpose
typing.get_type_hints()raises KeyError when a class having invalidmodule was given. This handles the exception not to crash on build
documents.