Skip to content

Event 'autodoc-process-docstring' threw an exception (exception: unhashable type: 'ParamSpecArgs') #318

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
Closed
spacemanspiff2007 opened this issue Jan 26, 2023 · 0 comments · Fixed by #319
Closed

Event 'autodoc-process-docstring' threw an exception (exception: unhashable type: 'ParamSpecArgs') #318

spacemanspiff2007 opened this issue Jan 26, 2023 · 0 comments · Fixed by #319

Comments

@spacemanspiff2007
Copy link
Contributor

Autodoc 1.21.8 fails for a ParamSpec

HINT_CB_P = ParamSpec('HINT_CB_P')
HINT_CB: TypeAlias = Callable[HINT_CB_P, Any]


class MyClass):
    def func(self, callback: HINT_CB, *args: HINT_CB_P.args, **kwargs: HINT_CB_P.kwargs):
        pass

Error:

    if annotation in _TYPES_DICT:
TypeError: unhashable type: 'ParamSpecArgs'

sphinx-autodoc-typehints/src/sphinx_autodoc_typehints/__init__.py

Line 39 in d9c4a06

if annotation in _TYPES_DICT:

@spacemanspiff2007 spacemanspiff2007 mentioned this issue Jan 26, 2023
Merged
hoodmane pushed a commit that referenced this issue Jan 27, 2023
@spacemanspiff2007
FIX TypeError: unhashable type (#319)
d181c2d 
Fixes #318. The access to `_TYPES_DICT` should be wrapped in a try block so that
if the type is unhashable the error can be caught and discarded.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

FIX TypeError: unhashable type spacemanspiff2007/sphinx-autodoc-typehints
1 participant
@spacemanspiff2007