Fix return type annotation of _parse_trace_id_header in Jaeger propagator#5440
Open
Eason09053360 wants to merge 3 commits into
Open
Conversation
Eason09053360
added a commit
to Eason09053360/opentelemetry-python
that referenced
this pull request
Jul 19, 2026
Eason09053360
marked this pull request as ready for review
July 19, 2026 13:57
…ator The function returns a 3-tuple (trace_id, span_id, flags) on every code path and callers unpack three values, but the annotation declared tuple[int] (a one-element tuple), which misleads type checkers.
Eason09053360
force-pushed
the
fix-jaeger-parse-trace-id-header-annotation
branch
from
July 24, 2026 01:00
75f22c1 to
9fcea30
Compare
Contributor
|
Change looks good, any chance you can fix all the typing issue in the package so we can enable typechecking? Your PR already fixes half of them. Add the following and then |
Parameterize Getter/Setter with CarrierT to match the base class signatures, guard against None baggage values before unquoting, type header values as str instead of the unbound CarrierT, and make _int_from_hex_str return int | None with explicit fallbacks at the call sites. Add the package to the pyright include list.
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.
Description
_parse_trace_id_headerin the Jaeger propagator is annotated as returningtuple[int](a tuple of exactly one element), but every return path yields a 3-tuple(trace_id, span_id, flags)and the caller unpacks three values. This misleads type checkers.This PR fixes the annotation to
tuple[int, int, int]. Annotation-only change, no runtime impact._extract_baggage— Add complete type annotationType of change
How Has This Been Tested?
Annotation-only change; existing
propagator/opentelemetry-propagator-jaegertests cover the extraction behavior.tox -e typecheck
Does This PR Require a Contrib Repo Change?
Checklist: