feat: Add py.typed marker file for proper typing support #44
Reference in New Issue
Block a user
Delete Branch "feature/add-py-typed-support"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
py.typedmarker file to jambo package directory to signal typing support to static type checkersBackground
This addresses the missing
py.typedfile that prevents static type checkers from recognizing the library's type annotations. Without this marker file, type checkers treat the package as untyped even though it contains comprehensive type hints.Changes
jambo/py.typedmarker fileTest plan
🤖 Generated with Claude Code
lol i thought it may have required more configuration
I want to be upfront—I haven’t verified how MyPy handles static analysis for this repository yet. I’ll make some improvements to the internal typing before merging this for better use of all mypy users.
And i've been thinking and statically checking a pydantic class created with this package would be kinda awkward, you'd probably would have to declare the class as
type[object]orAnyto avoid some checking...i tested it and it worked good with mypy. it's also for usage of functions: JSONSchema TypedDict for the input, for example.
And the result is not awkward, it produces a BaseModel, which is important to know for several libraries.
Codecov Report
✅ All modified and coverable lines are covered by tests.
📢 Thoughts on this report? Let us know!
If you’ve tested it, I’ll go ahead and merge. The release containing this code will include additional fixes and internal improvements I’m planning, and therefore might take some time to be released.