feat: support py typed #51
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds PEP 561 compliance to the zai-sdk package by introducing a py.typed marker file, enabling type checkers like mypy to recognize and use the package's inline type hints.
- Added an empty
py.typedmarker file in the package directory - Updated pyproject.toml to include the py.typed file in distribution
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/zai/py.typed | Empty marker file signaling PEP 561 compliance for type checkers |
| pyproject.toml | Added include directive to ensure py.typed is packaged in distributions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| authors = ["Z.ai"] | ||
| readme = "README.md" | ||
| packages = [{include = "zai", from = "src"}] | ||
| include = ["src/zai/py.typed"] |
There was a problem hiding this comment.
The include path is incorrect for Poetry's package configuration. Since packages = [{include = \"zai\", from = \"src\"}] is specified, the include path should be relative to the project root without the 'src/' prefix. Change to include = [\"zai/py.typed\"] or use the full path pattern \"src/zai/py.typed\" only if it's meant to be included from the project root (which would be redundant given the packages config). The correct approach is include = [\"zai/py.typed\"].
| include = ["src/zai/py.typed"] | |
| include = ["zai/py.typed"] |
Description
Thank you for opening a Pull Request!
Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
CONTRIBUTINGGuide.mvn clean testfrom the repository root)Fixes #<issue_number_goes_here>