Fix rendering of nested type annotations with alias defined #9736
Conversation
This file contains hidden or 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
The current implementation replaces type annotations with a alias defined by the class TypeAliasForwardRef. This class is later again replaced by the type defined in the alias map. This commit fixes the problem that this second replacement does not happen if the aliased type is nested in another generic type (e.g. Iterator[aliased_type]). The new function goes recursivly through the nested types and replaces the internal class TypeAliasForwardRef again by the correct annotation.
cc9a185 to
d8c202f
Compare
|
I've been getting the error (side question: is it possible to tell autodoc to just completely not try to make type hints into cross-references?) |
asmeurer
added a commit
to asmeurer/array-api
that referenced
this pull request
Feb 8, 2022
8000
This makes Sphinx read the type hints directly. It also triggers a Sphinx bug that requires this Sphinx PR to fix sphinx-doc/sphinx#9736.
tk0miya
requested changes
Feb 11, 2022
| @@ -614,6 +614,17 @@ def _should_unwrap(subject: Callable) -> bool: | |||
| return False | |||
|
|
|||
|
|
|||
| def _fix_type_alias_forward_ref(annotation: Any) -> Any: | |||
There was a problem hiding this comment.
How about expand_type_alias_forward_ref() instead?
Additonally, it would be better to add a docstring to this.
|
|
||
| if hasattr(annotation, "__args__"): 8000 | ||
| new_args = tuple(_fix_type_alias_forward_ref(arg) for arg in annotation.__args__) | ||
| return annotation.copy_with(new_args) |
There was a problem hiding this comment.
Is this method available on python3.6 and 3.10?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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: Fix rendering of nested type annotations with alias defined
Feature or Bugfix
Purpose
Detail
The current implementation replaces type annotations with a alias defined by the class TypeAliasForwardRef. This class is later again replaced by the type defined in the alias map.
This commit fixes the problem that this second replacement does not happen if the aliased type is nested in another generic type (e.g. Iterator[aliased_type]). The new function goes recursivly through the nested types and replaces the internal class TypeAliasForwardRef again by the correct annotation.
Relates