Skip to content

Commit 100ecfe

Browse files
authored
updated type hints for getters and setters (#1106)
1 parent f7409b8 commit 100ecfe

File tree

10 files changed

+17
-15
lines changed
  • .github/workflows
  • exporter/opentelemetry-exporter-datadog/src/opentelemetry/exporter/datadog
  • instrumentation
    • opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi
    • opentelemetry-instrumentation-boto3sqs/src/opentelemetry/instrumentation/boto3sqs
    • opentelemetry-instrumentation-kafka-python/src/opentelemetry/instrumentation/kafka
    • opentelemetry-instrumentation-pika/src/opentelemetry/instrumentation/pika
    • opentelemetry-instrumentation-wsgi/src/opentelemetry/instrumentation/wsgi
  • propagator
    • opentelemetry-propagator-aws-xray/src/opentelemetry/propagators/aws
    • opentelemetry-propagator-ot-trace/src/opentelemetry/propagators/ot_trace

10 files changed

+17
-15
lines changed

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ on:
66
- 'release/*'
77
pull_request:
88
env:
9-
CORE_REPO_SHA: e4494ea9cdd420390a36f6e6bbd9f15cd29873e9
9+
CORE_REPO_SHA: cad776a2031c84fb3c3a1af90ee2a939f3394b9a
1010

1111
jobs:
1212
build:

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010
### Fixed
1111
- `opentelemetry-instrumentation-grpc` narrow protobuf dependency to exclude protobuf >= 4
1212
([1109](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1109))
13+
- cleanup type hints for textmap `Getter` and `Setter` classes
14+
([1106](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1106))
1315

1416
## [1.12.0rc1-0.31b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.12.0rc1-0.31b0) - 2022-05-17
1517

exporter/opentelemetry-exporter-datadog/src/opentelemetry/exporter/datadog/propagator.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ def extract(
4040
self,
4141
carrier: CarrierT,
4242
context: typing.Optional[Context] = None,
43-
getter: Getter = default_getter,
43+
getter: Getter[CarrierT] = default_getter,
4444
) -> Context:
4545
if context is None:
4646
context = Context()
@@ -88,7 +88,7 @@ def inject(
8888
self,
8989
carrier: CarrierT,
9090
context: typing.Optional[Context] = None,
91-
setter: Setter = default_setter,
91+
setter: Setter[CarrierT] = default_setter,
9292
) -> None:
9393
span = get_current_span(context)
9494
span_context = span.get_span_context()

instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ def client_response_hook(span: Span, message: dict):
180180
_ClientResponseHookT = typing.Optional[typing.Callable[[Span, dict], None]]
181181

182182

183-
class ASGIGetter(Getter):
183+
class ASGIGetter(Getter[dict]):
184184
def get(
185185
self, carrier: dict, key: str
186186
) -> typing.Optional[typing.List[str]]:
@@ -216,7 +216,7 @@ def keys(self, carrier: dict) -> typing.List[str]:
216216
asgi_getter = ASGIGetter()
217217

218218

219-
class ASGISetter(Setter):
219+
class ASGISetter(Setter[dict]):
220220
def set(
221221
self, carrier: dict, key: str, value: str
222222
) -> None: # pylint: disable=no-self-use

instrumentation/opentelemetry-instrumentation-boto3sqs/src/opentelemetry/instrumentation/boto3sqs/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
_OTEL_IDENTIFIER_LENGTH = len(_OPENTELEMETRY_ATTRIBUTE_IDENTIFIER)
6060

6161

62-
class Boto3SQSGetter(Getter):
62+
class Boto3SQSGetter(Getter[CarrierT]):
6363
def get(self, carrier: CarrierT, key: str) -> Optional[List[str]]:
6464
value = carrier.get(f"{_OPENTELEMETRY_ATTRIBUTE_IDENTIFIER}{key}", {})
6565
if not value:
@@ -75,7 +75,7 @@ def keys(self, carrier: CarrierT) -> List[str]:
7575
]
7676

7777

78-
class Boto3SQSSetter(Setter):
78+
class Boto3SQSSetter(Setter[CarrierT]):
7979
def set(self, carrier: CarrierT, key: str, value: str) -> None:
8080
# This is a limitation defined by AWS for SQS MessageAttributes size
8181
if len(carrier.items()) < 10:

instrumentation/opentelemetry-instrumentation-kafka-python/src/opentelemetry/instrumentation/kafka/utils.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ def extract_send_partition(instance, args, kwargs):
9191
ConsumeHookT = Optional[Callable[[Span, ABCRecord, List, Dict], None]]
9292

9393

94-
class KafkaContextGetter(textmap.Getter):
94+
class KafkaContextGetter(textmap.Getter[textmap.CarrierT]):
9595
def get(self, carrier: textmap.CarrierT, key: str) -> Optional[List[str]]:
9696
if carrier is None:
9797
return None
@@ -108,7 +108,7 @@ def keys(self, carrier: textmap.CarrierT) -> List[str]:
108108
return [key for (key, value) in carrier]
109109

110110

111-
class KafkaContextSetter(textmap.Setter):
111+
class KafkaContextSetter(textmap.Setter[textmap.CarrierT]):
112112
def set(self, carrier: textmap.CarrierT, key: str, value: str) -> None:
113113
if carrier is None or key is None:
114114
return

instrumentation/opentelemetry-instrumentation-pika/src/opentelemetry/instrumentation/pika/utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
_LOG = getLogger(__name__)
1818

1919

20-
class _PikaGetter(Getter): # type: ignore
20+
class _PikaGetter(Getter[CarrierT]): # type: ignore
2121
def get(self, carrier: CarrierT, key: str) -> Optional[List[str]]:
2222
value = carrier.get(key, None)
2323
if value is None:

instrumentation/opentelemetry-instrumentation-wsgi/src/opentelemetry/instrumentation/wsgi/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ def response_hook(span: Span, environ: WSGIEnvironment, status: str, response_he
182182
_CARRIER_KEY_PREFIX_LEN = len(_CARRIER_KEY_PREFIX)
183183

184184

185-
class WSGIGetter(Getter):
185+
class WSGIGetter(Getter[dict]):
186186
def get(
187187
self, carrier: dict, key: str
188188
) -> typing.Optional[typing.List[str]]:

propagator/opentelemetry-propagator-aws-xray/src/opentelemetry/propagators/aws/aws_xray_propagator.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ def extract(
113113
self,
114114
carrier: CarrierT,
115115
context: typing.Optional[Context] = None,
116-
getter: Getter = default_getter,
116+
getter: Getter[CarrierT] = default_getter,
117117
) -> Context:
118118
if context is None:
119119
context = Context()
@@ -275,7 +275,7 @@ def inject(
275275
self,
276276
carrier: CarrierT,
277277
context: typing.Optional[Context] = None,
278-
setter: Setter = default_setter,
278+
setter: Setter[CarrierT] = default_setter,
279279
) -> None:
280280
span = trace.get_current_span(context=context)
281281

propagator/opentelemetry-propagator-ot-trace/src/opentelemetry/propagators/ot_trace/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ def extract(
5353
self,
5454
carrier: CarrierT,
5555
context: Optional[Context] = None,
56-
getter: Getter = default_getter,
56+
getter: Getter[CarrierT] = default_getter,
5757
) -> Context:
5858
if context is None:
5959
context = Context()
@@ -112,7 +112,7 @@ def inject(
112112
self,
113113
carrier: CarrierT,
114114
context: Optional[Context] = None,
115-
setter: Setter = default_setter,
115+
setter: Setter[CarrierT] = default_setter,
116116
) -> None:
117117

118118
span_context = get_current_span(context).get_span_context()

0 commit comments

Comments
 (0)