updated type hints for getters and setters (#1106)

This commit is contained in:
Alan Isaac
2022-05-28 20:32:14 -04:00
committed by GitHub
parent f7409b8b98
commit 100ecfeb08
10 changed files with 17 additions and 15 deletions

View File

@ -6,7 +6,7 @@ on:
- 'release/*' - 'release/*'
pull_request: pull_request:
env: env:
CORE_REPO_SHA: e4494ea9cdd420390a36f6e6bbd9f15cd29873e9 CORE_REPO_SHA: cad776a2031c84fb3c3a1af90ee2a939f3394b9a
jobs: jobs:
build: build:

View File

@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed ### Fixed
- `opentelemetry-instrumentation-grpc` narrow protobuf dependency to exclude protobuf >= 4 - `opentelemetry-instrumentation-grpc` narrow protobuf dependency to exclude protobuf >= 4
([1109](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1109)) ([1109](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1109))
- cleanup type hints for textmap `Getter` and `Setter` classes
([1106](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1106))
## [1.12.0rc1-0.31b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.12.0rc1-0.31b0) - 2022-05-17 ## [1.12.0rc1-0.31b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.12.0rc1-0.31b0) - 2022-05-17

View File

@ -40,7 +40,7 @@ class DatadogFormat(TextMapPropagator):
self, self,
carrier: CarrierT, carrier: CarrierT,
context: typing.Optional[Context] = None, context: typing.Optional[Context] = None,
getter: Getter = default_getter, getter: Getter[CarrierT] = default_getter,
) -> Context: ) -> Context:
if context is None: if context is None:
context = Context() context = Context()
@ -88,7 +88,7 @@ class DatadogFormat(TextMapPropagator):
self, self,
carrier: CarrierT, carrier: CarrierT,
context: typing.Optional[Context] = None, context: typing.Optional[Context] = None,
setter: Setter = default_setter, setter: Setter[CarrierT] = default_setter,
) -> None: ) -> None:
span = get_current_span(context) span = get_current_span(context)
span_context = span.get_span_context() span_context = span.get_span_context()

View File

@ -180,7 +180,7 @@ _ClientRequestHookT = typing.Optional[typing.Callable[[Span, dict], None]]
_ClientResponseHookT = typing.Optional[typing.Callable[[Span, dict], None]] _ClientResponseHookT = typing.Optional[typing.Callable[[Span, dict], None]]
class ASGIGetter(Getter): class ASGIGetter(Getter[dict]):
def get( def get(
self, carrier: dict, key: str self, carrier: dict, key: str
) -> typing.Optional[typing.List[str]]: ) -> typing.Optional[typing.List[str]]:
@ -216,7 +216,7 @@ class ASGIGetter(Getter):
asgi_getter = ASGIGetter() asgi_getter = ASGIGetter()
class ASGISetter(Setter): class ASGISetter(Setter[dict]):
def set( def set(
self, carrier: dict, key: str, value: str self, carrier: dict, key: str, value: str
) -> None: # pylint: disable=no-self-use ) -> None: # pylint: disable=no-self-use

View File

@ -59,7 +59,7 @@ _OPENTELEMETRY_ATTRIBUTE_IDENTIFIER: str = "otel."
_OTEL_IDENTIFIER_LENGTH = len(_OPENTELEMETRY_ATTRIBUTE_IDENTIFIER) _OTEL_IDENTIFIER_LENGTH = len(_OPENTELEMETRY_ATTRIBUTE_IDENTIFIER)
class Boto3SQSGetter(Getter): class Boto3SQSGetter(Getter[CarrierT]):
def get(self, carrier: CarrierT, key: str) -> Optional[List[str]]: def get(self, carrier: CarrierT, key: str) -> Optional[List[str]]:
value = carrier.get(f"{_OPENTELEMETRY_ATTRIBUTE_IDENTIFIER}{key}", {}) value = carrier.get(f"{_OPENTELEMETRY_ATTRIBUTE_IDENTIFIER}{key}", {})
if not value: if not value:
@ -75,7 +75,7 @@ class Boto3SQSGetter(Getter):
] ]
class Boto3SQSSetter(Setter): class Boto3SQSSetter(Setter[CarrierT]):
def set(self, carrier: CarrierT, key: str, value: str) -> None: def set(self, carrier: CarrierT, key: str, value: str) -> None:
# This is a limitation defined by AWS for SQS MessageAttributes size # This is a limitation defined by AWS for SQS MessageAttributes size
if len(carrier.items()) < 10: if len(carrier.items()) < 10:

View File

@ -91,7 +91,7 @@ ProduceHookT = Optional[Callable[[Span, List, Dict], None]]
ConsumeHookT = Optional[Callable[[Span, ABCRecord, List, Dict], None]] ConsumeHookT = Optional[Callable[[Span, ABCRecord, List, Dict], None]]
class KafkaContextGetter(textmap.Getter): class KafkaContextGetter(textmap.Getter[textmap.CarrierT]):
def get(self, carrier: textmap.CarrierT, key: str) -> Optional[List[str]]: def get(self, carrier: textmap.CarrierT, key: str) -> Optional[List[str]]:
if carrier is None: if carrier is None:
return None return None
@ -108,7 +108,7 @@ class KafkaContextGetter(textmap.Getter):
return [key for (key, value) in carrier] return [key for (key, value) in carrier]
class KafkaContextSetter(textmap.Setter): class KafkaContextSetter(textmap.Setter[textmap.CarrierT]):
def set(self, carrier: textmap.CarrierT, key: str, value: str) -> None: def set(self, carrier: textmap.CarrierT, key: str, value: str) -> None:
if carrier is None or key is None: if carrier is None or key is None:
return return

View File

@ -17,7 +17,7 @@ from opentelemetry.trace.span import Span
_LOG = getLogger(__name__) _LOG = getLogger(__name__)
class _PikaGetter(Getter): # type: ignore class _PikaGetter(Getter[CarrierT]): # type: ignore
def get(self, carrier: CarrierT, key: str) -> Optional[List[str]]: def get(self, carrier: CarrierT, key: str) -> Optional[List[str]]:
value = carrier.get(key, None) value = carrier.get(key, None)
if value is None: if value is None:

View File

@ -182,7 +182,7 @@ _CARRIER_KEY_PREFIX = "HTTP_"
_CARRIER_KEY_PREFIX_LEN = len(_CARRIER_KEY_PREFIX) _CARRIER_KEY_PREFIX_LEN = len(_CARRIER_KEY_PREFIX)
class WSGIGetter(Getter): class WSGIGetter(Getter[dict]):
def get( def get(
self, carrier: dict, key: str self, carrier: dict, key: str
) -> typing.Optional[typing.List[str]]: ) -> typing.Optional[typing.List[str]]:

View File

@ -113,7 +113,7 @@ class AwsXRayPropagator(TextMapPropagator):
self, self,
carrier: CarrierT, carrier: CarrierT,
context: typing.Optional[Context] = None, context: typing.Optional[Context] = None,
getter: Getter = default_getter, getter: Getter[CarrierT] = default_getter,
) -> Context: ) -> Context:
if context is None: if context is None:
context = Context() context = Context()
@ -275,7 +275,7 @@ class AwsXRayPropagator(TextMapPropagator):
self, self,
carrier: CarrierT, carrier: CarrierT,
context: typing.Optional[Context] = None, context: typing.Optional[Context] = None,
setter: Setter = default_setter, setter: Setter[CarrierT] = default_setter,
) -> None: ) -> None:
span = trace.get_current_span(context=context) span = trace.get_current_span(context=context)

View File

@ -53,7 +53,7 @@ class OTTracePropagator(TextMapPropagator):
self, self,
carrier: CarrierT, carrier: CarrierT,
context: Optional[Context] = None, context: Optional[Context] = None,
getter: Getter = default_getter, getter: Getter[CarrierT] = default_getter,
) -> Context: ) -> Context:
if context is None: if context is None:
context = Context() context = Context()
@ -112,7 +112,7 @@ class OTTracePropagator(TextMapPropagator):
self, self,
carrier: CarrierT, carrier: CarrierT,
context: Optional[Context] = None, context: Optional[Context] = None,
setter: Setter = default_setter, setter: Setter[CarrierT] = default_setter,
) -> None: ) -> None:
span_context = get_current_span(context).get_span_context() span_context = get_current_span(context).get_span_context()