autodoc: fix constructor signatures for classes derived from typing.Generic #8142
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
tk0miya
requested changes
Aug 21, 2020
| @@ -290,6 +290,35 @@ def foo3(self, d='\n'): | |||
| '(b, c=42, *d, **e)' | |||
|
|
|||
|
|
|||
| @pytest.mark.skipif(sys.version_info < (3, 5), reason='typing is available since python3.5.') | |||
| def test_autodoc_process_signature_typing_generic(app): | |||
There was a problem hiding this comment.
Could you rewrite testcase using do_autodoc()?
- Add a target class to
tests/roots/test-ext-autodoc/targets/ - Call
do_autodoc(). There are many examples in this file.
There was a problem hiding this comment.
Done. I added a new file because I did not feel it fit in any of the existing test files.
This test is currently failing because typing.Generic.__new__ clobbers the real signature.
When documenting classes derived from typing.Generic (essentially all classes in the typing module) the constructor signature would show an unhelpful (*args, **kwds). typing.Generic has a __new__ method which was picked up by sphinx. With this patch it is skipped and constructor signatures for generic classes are shown as they should.
jcarrano
force-pushed
the
typing-generic-signatures
branch
from
eddb6c3
to
740be7f
Compare
tk0miya
approved these changes
Oct 2, 2020
|
Merged. Thank you for your support! |
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.
Subject: take the constructor signature from init instead of new for classes derived from typing.Generic
Feature or Bugfix
Purpose
When documenting classes derived from
typing.Generic(essentially all classes in the typing module) the constructor signature would show an unhelpful(*args, **kwds).typing.Generic.__new__was being picked up by sphinx.ext.autodoc. With this patch it is skipped and constructor signatures for generic classes are taken from__init__.Detail
I copied the code that was used to skip callable metaclasses.