Add py.typed marker #465
Merged
Add py.typed marker #465
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
|
|
ahangsu
approved these changes
Jul 22, 2022
michaeldiamant
approved these changes
Jul 22, 2022
There was a problem hiding this comment.
@jasonpaulos Matches how the docs recommend configuration. Thanks for considering the use case - makes a lot of sense to add in!
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.
Currently we use mypy internally to type check our code, but unfortunately any packages that import PyTeal are not able to take advantage of our code's types when they use mypy.
The reason is the
pytealpackage must declare to mypy that we actually use types. More info can be found here, but for our purposes the answer is to simply add apy.typedfile to our package.I've verified this actually works and allows dependent packages to do proper type checking with our code as well.