Add py.typed for PEP 561 compliance #913
Open
+1
−0
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
mohamadghaffari
force-pushed
the
add-py-typed
branch
from
dc2dd8d to
76d4393
Compare
This adds a py.typed marker file to the google.adk package and updates the Flit configuration in pyproject.toml to include it in the distribution. This ensures the package is PEP 561 compliant and allows static type checkers (like mypy and pyright) to recognize that the package supports type hints.
mohamadghaffari
force-pushed
the
add-py-typed
branch
from
76d4393 to
80858dc
Compare
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.
Summary
This PR adds a
py.typedmarker file to thegoogle.adkpackage and updates thepyproject.tomlto include it in the Flit build.This change ensures the package is PEP 561 compliant, allowing tools like
mypy,pyright, andpytypeto recognize and use the type hints provided in the source.Changes
src/google/adk/py.typed(empty file)[tool.flit.module]to includepy.typedin the buildTesting Plan
Built the package locally using:
uv buildInstalled the .whl locally using:
uv pip install dist/google_adk-<version>.whlVerified the presence of py.typed in the installed package:
Verified that both mypy and pyright detect and use the type hints correctly.
Fixes #914
CLA
☑️ I have signed the Google Contributor License Agreement