Fix return type annotation of _parse_trace_id_header in Jaeger propagator#5440
Open
Eason09053360 wants to merge 2 commits into
Open
Conversation
…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.
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.Type of change
How Has This Been Tested?
propagator/opentelemetry-propagator-jaegertests cover the extraction behavior.Does This PR Require a Contrib Repo Change?
Checklist: