Add py.typed #991
Merged
Add py.typed #991
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
|
@LukasVik this PR adds a single empty file. Is that intended? |
|
@umarcor Yes this is correct. The file just needs to exist as a marker, its content does not matter. https://peps.python.org/pep-0561/#packaging-type-information |
|
Nice! Please, add a news fragment and we can have this merged. |
@umarcor Done! Thank you! |
So that code that uses VUnit can be type checked with mypy against VUnit's type hints.
|
I reworded it, is better now. |
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.
So that code that uses VUnit can be type checked with mypy against VUnit's type hints.
See here for background: https://peps.python.org/pep-0561/
I verified that the file is included in the PyPI releases by running "python3 setup sdist" and checking that it was present in "vunit/py.typed" in the release zip.