style(fsm): format Propagators

Added type annotations to the binary, HTTP and text propagators and used ruff (vscode) to:
- Black-compatible code formatting.
- fix all auto-fixable violations, like unused imports.
- isort-compatible import sorting.

Signed-off-by: Paulo Vital

Author: pvital

src/instana/propagators/binary_propagator.py

@@ -2,11 +2,13 @@
 # (c) Copyright Instana Inc. 2020
 
 
-from instana.log import logger
-from instana.propagators.base_propagator import BasePropagator
+from typing import Optional
 
 from opentelemetry.trace.span import format_span_id
 
+from instana.log import logger
+from instana.propagators.base_propagator import BasePropagator, CarrierT
+from instana.span_context import SpanContext
 from instana.util.ids import define_server_timing
 
 
@@ -17,17 +19,22 @@ class BinaryPropagator(BasePropagator):
     """
 
     # ByteArray variations from base class
-    HEADER_KEY_T = b'x-instana-t'
-    HEADER_KEY_S = b'x-instana-s'
-    HEADER_KEY_L = b'x-instana-l'
-    HEADER_SERVER_TIMING = b'server-timing'
-    HEADER_KEY_TRACEPARENT = b'traceparent'
-    HEADER_KEY_TRACESTATE = b'tracestate'
+    HEADER_KEY_T = b"x-instana-t"
+    HEADER_KEY_S = b"x-instana-s"
+    HEADER_KEY_L = b"x-instana-l"
+    HEADER_SERVER_TIMING = b"server-timing"
+    HEADER_KEY_TRACEPARENT = b"traceparent"
+    HEADER_KEY_TRACESTATE = b"tracestate"
 
-    def __init__(self):
+    def __init__(self) -> None:
         super(BinaryPropagator, self).__init__()
 
-    def inject(self, span_context, carrier, disable_w3c_trace_context=True):
+    def inject(
+        self,
+        span_context: SpanContext,
+        carrier: CarrierT,
+        disable_w3c_trace_context: bool = True,
+    ) -> Optional[CarrierT]:
         try:
             trace_id = format_span_id(span_context.trace_id).encode()
             span_id = format_span_id(span_context.span_id).encode()
@@ -37,21 +44,23 @@ def inject(self, span_context, carrier, disable_w3c_trace_context=True):
             if disable_w3c_trace_context:
                 traceparent, tracestate = [None] * 2
             else:
-                traceparent, tracestate = self._get_participating_trace_context(span_context)
+                traceparent, tracestate = self._get_participating_trace_context(
+                    span_context
+                )
                 try:
-                    traceparent = str.encode(traceparent)
-                    tracestate = str.encode(tracestate)
+                    traceparent = str.encode(traceparent)  # type: ignore[arg-type]
+                    tracestate = str.encode(tracestate)  # type: ignore[arg-type]
                 except Exception:
                     traceparent, tracestate = [None] * 2
 
             if isinstance(carrier, dict) or hasattr(carrier, "__dict__"):
                 if traceparent and tracestate:
-                    carrier[self.HEADER_KEY_TRACEPARENT] = traceparent
-                    carrier[self.HEADER_KEY_TRACESTATE] = tracestate
-                carrier[self.HEADER_KEY_T] = trace_id
-                carrier[self.HEADER_KEY_S] = span_id
-                carrier[self.HEADER_KEY_L] = level
-                carrier[self.HEADER_SERVER_TIMING] = server_timing
+                    carrier[self.HEADER_KEY_TRACEPARENT] = traceparent  # type: ignore[index]
+                    carrier[self.HEADER_KEY_TRACESTATE] = tracestate  # type: ignore[index]
+                carrier[self.HEADER_KEY_T] = trace_id  # type: ignore[index]
+                carrier[self.HEADER_KEY_S] = span_id  # type: ignore[index]
+                carrier[self.HEADER_KEY_L] = level  # type: ignore[index]
+                carrier[self.HEADER_SERVER_TIMING] = server_timing  # type: ignore[index]
             elif isinstance(carrier, list):
                 if traceparent and tracestate:
                     carrier.append((self.HEADER_KEY_TRACEPARENT, traceparent))
@@ -62,13 +71,17 @@ def inject(self, span_context, carrier, disable_w3c_trace_context=True):
                 carrier.append((self.HEADER_SERVER_TIMING, server_timing))
             elif isinstance(carrier, tuple):
                 if traceparent and tracestate:
-                    carrier = carrier.__add__(((self.HEADER_KEY_TRACEPARENT, traceparent),))
-                    carrier = carrier.__add__(((self.HEADER_KEY_TRACESTATE, tracestate),))
+                    carrier = carrier.__add__(
+                        ((self.HEADER_KEY_TRACEPARENT, traceparent),)
+                    )
+                    carrier = carrier.__add__(
+                        ((self.HEADER_KEY_TRACESTATE, tracestate),)
+                    )
                 carrier = carrier.__add__(((self.HEADER_KEY_T, trace_id),))
                 carrier = carrier.__add__(((self.HEADER_KEY_S, span_id),))
                 carrier = carrier.__add__(((self.HEADER_KEY_L, level),))
                 carrier = carrier.__add__(((self.HEADER_SERVER_TIMING, server_timing),))
-            elif hasattr(carrier, '__setitem__'):
+            elif hasattr(carrier, "__setitem__"):
                 if traceparent and tracestate:
                     carrier.__setitem__(self.HEADER_KEY_TRACEPARENT, traceparent)
                     carrier.__setitem__(self.HEADER_KEY_TRACESTATE, tracestate)
@@ -82,5 +95,3 @@ def inject(self, span_context, carrier, disable_w3c_trace_context=True):
             return carrier
         except Exception:
             logger.debug("inject error:", exc_info=True)
-
-

src/instana/propagators/http_propagator.py

@@ -2,12 +2,15 @@
 # (c) Copyright Instana Inc. 2020
 
 
+from typing import Any
+
+from opentelemetry.trace.span import format_span_id
+
 from instana.log import logger
-from instana.propagators.base_propagator import BasePropagator
-from instana.util.ids import define_server_timing, hex_id_limited
+from instana.propagators.base_propagator import BasePropagator, CarrierT
 from instana.span_context import SpanContext
+from instana.util.ids import define_server_timing, hex_id_limited
 
-from opentelemetry.trace.span import format_span_id
 
 class HTTPPropagator(BasePropagator):
     """
@@ -17,17 +20,24 @@ class HTTPPropagator(BasePropagator):
     The character set should be restricted to HTTP compatible.
     """
 
-    def __init__(self):
+    def __init__(self) -> None:
         super(HTTPPropagator, self).__init__()
 
-    def inject(self, span_context, carrier, disable_w3c_trace_context=False):
+    def inject(
+        self,
+        span_context: SpanContext,
+        carrier: CarrierT,
+        disable_w3c_trace_context: bool = False,
+    ) -> None:
         trace_id = span_context.trace_id
         span_id = span_context.span_id
         dictionary_carrier = self.extract_headers_dict(carrier)
         if dictionary_carrier:
             # Suppression `level` made in the child context or in the parent context
             # has priority over any non-suppressed `level` setting
-            child_level = int(self.extract_instana_headers(dictionary_carrier)[2] or "1")
+            child_level = int(
+                self.extract_instana_headers(dictionary_carrier)[2] or "1"
+            )
             new_level = min(child_level, span_context.level)
 
             if new_level != span_context.level:
@@ -46,21 +56,23 @@ def inject(self, span_context, carrier, disable_w3c_trace_context=False):
                     correlation_type=span_context.correlation_type,
                     correlation_id=span_context.correlation_id,
                     traceparent=span_context.traceparent,
-                    tracestate=span_context.tracestate
+                    tracestate=span_context.tracestate,
                 )
 
         serializable_level = str(span_context.level)
 
         if disable_w3c_trace_context:
             traceparent, tracestate = [None] * 2
         else:
-            traceparent, tracestate = self._get_participating_trace_context(span_context)
+            traceparent, tracestate = self._get_participating_trace_context(
+                span_context
+            )
 
-        def inject_key_value(carrier, key, value):
+        def inject_key_value(carrier: CarrierT, key: str, value: Any) -> None:
             if isinstance(carrier, list):
                 carrier.append((key, value))
-            elif isinstance(carrier, dict) or '__setitem__' in dir(carrier):
-                carrier[key] = value
+            elif isinstance(carrier, dict) or "__setitem__" in dir(carrier):
+                carrier[key] = value  # type: ignore[index]
             else:
                 raise Exception("Unsupported carrier type", type(carrier))
 

src/instana/propagators/text_propagator.py

@@ -2,11 +2,13 @@
 # (c) Copyright Instana Inc. 2020
 
 
-from instana.log import logger
-from instana.propagators.base_propagator import BasePropagator
+from typing import Optional
 
 from opentelemetry.trace.span import format_span_id
 
+from instana.log import logger
+from instana.propagators.base_propagator import BasePropagator, CarrierT
+from instana.span_context import SpanContext
 from instana.util.ids import define_server_timing
 
 
@@ -18,17 +20,22 @@ class TextPropagator(BasePropagator):
     The character set is unrestricted.
     """
 
-    def inject(self, span_context, carrier, disable_w3c_trace_context=True):
+    def inject(
+        self,
+        span_context: SpanContext,
+        carrier: CarrierT,
+        disable_w3c_trace_context: bool = True,
+    ) -> Optional[CarrierT]:
         try:
             trace_id = format_span_id(span_context.trace_id)
             span_id = format_span_id(span_context.span_id)
             server_timing = define_server_timing(span_context.trace_id).encode()
 
             if isinstance(carrier, dict) or hasattr(carrier, "__dict__"):
-                carrier[self.LC_HEADER_KEY_T] = trace_id
-                carrier[self.LC_HEADER_KEY_S] = span_id
-                carrier[self.LC_HEADER_KEY_L] = "1"
-                carrier[self.LC_HEADER_KEY_SERVER_TIMING] = server_timing
+                carrier[self.LC_HEADER_KEY_T] = trace_id  # type: ignore[index]
+                carrier[self.LC_HEADER_KEY_S] = span_id  # type: ignore[index]
+                carrier[self.LC_HEADER_KEY_L] = "1"  # type: ignore[index]
+                carrier[self.LC_HEADER_KEY_SERVER_TIMING] = server_timing  # type: ignore[index]
             elif isinstance(carrier, list):
                 carrier.append((self.LC_HEADER_KEY_T, trace_id))
                 carrier.append((self.LC_HEADER_KEY_S, span_id))
@@ -38,8 +45,10 @@ def inject(self, span_context, carrier, disable_w3c_trace_context=True):
                 carrier = carrier.__add__(((self.LC_HEADER_KEY_T, trace_id),))
                 carrier = carrier.__add__(((self.LC_HEADER_KEY_S, span_id),))
                 carrier = carrier.__add__(((self.LC_HEADER_KEY_L, "1"),))
-                carrier = carrier.__add__(((self.LC_HEADER_KEY_SERVER_TIMING, server_timing),))
-            elif hasattr(carrier, '__setitem__'):
+                carrier = carrier.__add__(
+                    ((self.LC_HEADER_KEY_SERVER_TIMING, server_timing),)
+                )
+            elif hasattr(carrier, "__setitem__"):
                 carrier.__setitem__(self.LC_HEADER_KEY_T, trace_id)
                 carrier.__setitem__(self.LC_HEADER_KEY_S, span_id)
                 carrier.__setitem__(self.LC_HEADER_KEY_L, "1")