fix: remove runtime assignment of type aliases to Any.
#2378
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
This PR replaces this pattern:
```py
from typing import TYPE_CHECKING, Any
if TYPE_CHECKING:
from typing_extensions import TypeAlias
from litestar import Thing
ThingAlias: TypeAlias = Thing
else:
ThingAlias: TypeAlias = Any
```
My best guess is that this pattern was some workaround for circular dependencies before we introduced `__future__.annotations`.
I believe these changes will be beneficial as:
- the current pattern is non-standard (at least in my experience)
- the current pattern causes the types to be documented as `Any` in the API docs.
Open
4 tasks
|
Type API docs improve somewhat:
However, its just treating it as a string constant and using docstring for |
sobolevn
approved these changes
Sep 28, 2023
De-stringizes type aliases where possible by importing components from typing at runtime.
|
Kudos, SonarCloud Quality Gate passed! |
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/2378 |
JacobCoffee
approved these changes
Sep 29, 2023
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.
This PR replaces this pattern:
My best guess is that this pattern was some workaround for circular dependencies before we introduced
__future__.annotations.I believe these changes will be beneficial as:
Anyin the API docs.Example of current API docs for alias types:
Pull Request Checklist
Description
Close Issue(s)