Skip to content

feat: add py.typed marker for type checking#1868

Merged
jxnl merged 1 commit intomainfrom
feat/investigate-issues
Oct 27, 2025
Merged

feat: add py.typed marker for type checking#1868
jxnl merged 1 commit intomainfrom
feat/investigate-issues

Conversation

@jxnl
Copy link
Copy Markdown
Collaborator

@jxnl jxnl commented Oct 27, 2025

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-untyped errors.

Changes

  • Added empty instructor/py.typed marker file per PEP 561 specification

Test Plan

  • Verify file is created in correct location
  • Verify no other changes needed (hatchling includes py.typed automatically)

Fixes #1798

Generated with Claude Code


Important

Adds py.typed marker file to instructor package for type checking support.

  • Behavior:
    • Adds py.typed marker file to instructor package, enabling type checkers to recognize it as a typed package.
  • Misc:
    • No additional changes needed as hatchling includes py.typed automatically.

This description was created by Ellipsis for 553bffc. You can customize this summary. It will automatically update as commits are pushed.

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]>
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Oct 27, 2025

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
❌ Deployment failed
View logs
instructor 553bffc Oct 27 2025, 07:21 PM

@jxnl jxnl merged commit ecb50aa into main Oct 27, 2025
4 of 13 checks passed
@jxnl jxnl deleted the feat/investigate-issues branch October 27, 2025 19:17
Copy link
Copy Markdown
Contributor

@ellipsis-dev ellipsis-dev Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Important

Looks good to me! 👍

Reviewed everything up to 553bffc in 29 seconds. Click for details.
  • Reviewed 3 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 draft 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% <= threshold 85% None

Workflow ID: wflow_id0JCFRF3rhimGaR

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

@github-actions github-actions Bot added enhancement New feature or request python Pull requests that update python code size:XS This PR changes 0-9 lines, ignoring generated files. labels Oct 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request python Pull requests that update python code size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add py.typed marker for type checking

1 participant