feat(packaging): publish optax with py.typed marker - #1750
Closed
erensh27 wants to merge 1 commit into
Closed
Conversation
optax is almost fully annotated, so tools like mypy benefit from declaring the package as typed. Adds the empty py.typed marker (flit ships all files in the package dir) and the 'Typing :: Typed' classifier so PEP 561 consumers do not treat every optax import as untyped.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Implements #1388: publish optax with a
py.typedmarker so PEP 561-compliant type checkers (mypy default, pyright, etc.) treatimport optaxas typed instead of falling back toAny.optax/py.typed(empty marker; the flit backend ships all files inside the module directory, so no package-data config change is needed).Typing :: Typedtrove classifier that packaging ecosystems show in metadata.No behavior change; builds reproduce the same sdist/wheel plus the marker.