feat: add py.typed marker for type checking#1868
Merged
Conversation
Add PEP 561 compliant py.typed marker file to enable type checkers like mypy to recognize instructor as a typed package, resolving import-untyped errors. Fixes #1798 Generated with Claude Code Co-Authored-By: Claude <[email protected]>
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ❌ Deployment failed View logs |
instructor | 553bffc | Oct 27 2025, 07:21 PM |
Contributor
There was a problem hiding this comment.
Important
Looks good to me! 👍
Reviewed everything up to 553bffc in 29 seconds. Click for details.
- Reviewed
3lines of code in1files - Skipped
0files when reviewing. - Skipped posting
1draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. instructor/py.typed:1
- Draft comment:
The empty py.typed marker is correctly added to the package root per PEP 561 requirements. This change successfully resolves issue #1798. - Reason this comment was not posted:
Confidence changes required:0%<= threshold85%None
Workflow ID: wflow_id0JCFRF3rhimGaR
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
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
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 PEP 561 compliant py.typed marker file to the instructor package. This enables type checkers like mypy to recognize instructor as a typed package and prevents
import-untypederrors.Changes
instructor/py.typedmarker file per PEP 561 specificationTest Plan
Fixes #1798
Generated with Claude Code
Important
Adds
py.typedmarker file toinstructorpackage for type checking support.py.typedmarker file toinstructorpackage, enabling type checkers to recognize it as a typed package.hatchlingincludespy.typedautomatically.This description was created by
for 553bffc. You can customize this summary. It will automatically update as commits are pushed.