Added missing type hint py.typed files. #403
Open
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
haxdds
reviewed
Nov 18, 2021
| @@ -35,6 +35,10 @@ | |||
| 'alpaca_trade_api', | |||
| 'alpaca_trade_api.polygon', | |||
| ], | |||
| package_data={ | |||
| 'alpaca_trade_api': ['py.typed'], | |||
| 'alpaca_trade_api.polygon': ['py.typed'], | |||
There was a problem hiding this comment.
Hi blane-Nelson, thanks for contributing!
Why have you added a py.typed file for alpaca_trade_api.polygon package? What is the purpose?
There was a problem hiding this comment.
This file lets utilities (like MyPy) know that the package is using the new typing library. The files doesn't need to contain anything, it just has to be present in the package's root folder. Refer to the PEP 561 - https://www.python.org/dev/peps/pep-0561/ on python.org for a full explanation.
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.
In order for utilities like MyPy to take advantage of the type hints in the package. There needs to be a py.typed file installed with the package and modules as per PEP 561