fix: add PEP 561 py.typed markers for type checker support #918
+47
−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
andres-ito-traversal
force-pushed
the
andres/add-type-stubs
branch
from
fb0116e to
6a581eb
Compare
andres-ito-traversal
changed the title
Contributor
Author
|
@rnorth Apologies richard for the random tag, but do you have any idea how authors will get notified of this PR? It's my first time contributing to this open-source library |
Add py.typed marker files to core and all module packages to indicate type information is available. This enables type checkers like Pyright and mypy to recognize and validate type hints in testcontainers packages. Resolves "Stub file not found" errors when running type checkers on code that imports testcontainers modules.
andres-ito-traversal
force-pushed
the
andres/add-type-stubs
branch
from
6a581eb to
468ede5
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #918 +/- ##
=======================================
Coverage 79.78% 79.78%
=======================================
Files 14 14
Lines 1182 1182
Branches 184 184
=======================================
Hits 943 943
Misses 197 197
Partials 42 42 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Summary
Adds
py.typedmarker files to all testcontainers packages to comply with PEP 561 and enable type checking support.Motivation
Without
py.typedmarkers, type checkers like Pyright and mypy report "Stub file not found" errors when importing testcontainers modules, even though the code has inline type annotations.Changes
py.typedmarker tocore/testcontainers/py.typedmarkers to all module packages undermodules/*/testcontainers/pyproject.tomlto ensurepy.typedfiles are included in distributionsTesting
Verified that type checkers no longer report missing stub file errors:
Impact
Github Issue=#305