Support attributes and type aliases #18
Merged
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
While it is very difficult to statically detect a type alias [1] such as `x = str`, explicit ones are easier to detect. This change makes sure that `x: TypeAlias = str` and `type x = str` are collected as importable type annotations. [1] https://docs.python.org/3/library/typing.html#type-aliases
Type information in docstrings is not yet taken into account. Instead, `typing.Any` is used as a fallback.
lagru
changed the title
as well as proper handling in context of stubs. In stubs, the value should basically always be omitted from attributes except for a few exceptions.
Type information in docstrings is not yet taken into account. Instead, `typing.Any` is used as a fallback.
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.
For now, docstub relies on static analysis only. Therefore, it is very difficult to differentiate a type alias such as
x = strfrom a regular assignment statement. However, explicit ones are easier to detect and they should be preserved as is (closes #17).This PR introduces support for several things:
Collect explicit type aliases during static analysis. Make sure that
x: TypeAlias = strandtype x = strare collected as importable type annotations .Fallback to
typing.Anyfor all un-annotated attributes except in type aliases.Replace right side of assignments with
...except in type aliases.Expand assignment statements with multiple targets on the left side, with multiple annotated ones. E.g.
x, y = (3, 4)tox: Any = ...; y: Any = ....