Skip to content

feat(fastapi): add py.typed marker#4685

Open
tamird wants to merge 1 commit into
open-telemetry:mainfrom
tamird:opentelemetry-instrumentation-fastapi-pep561
Open

feat(fastapi): add py.typed marker#4685
tamird wants to merge 1 commit into
open-telemetry:mainfrom
tamird:opentelemetry-instrumentation-fastapi-pep561

Conversation

@tamird

@tamird tamird commented Jun 11, 2026

Copy link
Copy Markdown

Add the PEP 561 marker to the FastAPI instrumentation package so downstream type checkers consume its inline annotations.

Place the marker alongside the import package so Hatch includes it in both wheel and source distributions.

This is a non-breaking typing metadata change and does not require a core repository change.

PEP 561 requires this marker inside the distributed package to indicate
that downstream users may consume its inline type annotations.
@tamird tamird force-pushed the opentelemetry-instrumentation-fastapi-pep561 branch from 228b36d to 5a17adf Compare June 11, 2026 02:57
@tamird tamird marked this pull request as ready for review June 11, 2026 02:57
@tamird tamird requested a review from a team as a code owner June 11, 2026 02:57
@tamird tamird changed the title fastapi: add py.typed marker feat(fastapi): add py.typed marker Jun 21, 2026
@tamird

tamird commented Jun 21, 2026

Copy link
Copy Markdown
Author

@xrmx could you please take a look?

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

This PR has been automatically marked as stale because it has not had any activity for 14 days. It will be closed if no further activity occurs within 14 days of this comment.
If you're still working on this, please add a comment or push new commits.

@github-actions github-actions Bot added the Stale label Jul 6, 2026
@tamird

tamird commented Jul 6, 2026

Copy link
Copy Markdown
Author

@xrmx ping.

@github-actions github-actions Bot removed the Stale label Jul 7, 2026
@tammy-baylis-swi tammy-baylis-swi moved this to Easy to review / merge / close in Python PR digest Jul 9, 2026
@tammy-baylis-swi

Copy link
Copy Markdown
Contributor

Thanks for this @tamird ! Please could you clarify a bit more on what this does, and maybe why this instrumentation library in particular?

@tamird

tamird commented Jul 9, 2026

Copy link
Copy Markdown
Author

@tammy-baylis-swi it does what's on the tin. Why this one? Because it's the one I ran into and needed.

@xrmx

xrmx commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

@tammy-baylis-swi it does what's on the tin. Why this one? Because it's the one I ran into and needed.

The fastapi instrumentation is not typechecked atm so am not sure what would be the outcome if your typechecker can look inside it.

@tamird

tamird commented Jul 10, 2026

Copy link
Copy Markdown
Author

I don't know if it's type-checked in your CI, but it does have type annotations.

@xrmx

xrmx commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

I don't know if it's type-checked in your CI, but it does have type annotations.

Yeah I mean that the type annotations may not be correct if they are not typechecked.

@tamird

tamird commented Jul 10, 2026

Copy link
Copy Markdown
Author

I don't know if it's type-checked in your CI, but it does have type annotations.

Yeah I mean that the type annotations may not be correct if they are not typechecked.

Would you be more comfortable if this PR also added type checking?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Easy to review / merge / close

Development

Successfully merging this pull request may close these issues.

3 participants