Fix typing WIP

Author: sl0thentr0py

MIGRATION_GUIDE.md

@@ -14,6 +14,7 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
 - You can no longer change the sampled status of a span with `span.sampled = False` after starting it.
 - The `Span()` constructor does not accept a `hub` parameter anymore.
 - `Span.finish()` does not accept a `hub` parameter anymore.
+- `Span.finish()` no longer returns the `event_id` if the event is sent to sentry.
 - The `Profile()` constructor does not accept a `hub` parameter anymore.
 - A `Profile` object does not have a `.hub` property anymore.
 - `sentry_sdk.continue_trace` no longer returns a `Transaction` and is now a context manager.
@@ -146,6 +147,7 @@ Looking to upgrade from Sentry SDK 2.x to 3.x? Here's a comprehensive list of wh
 - `continue_from_headers`, `continue_from_environ` and `from_traceparent` have been removed, please use top-level API `sentry_sdk.continue_trace` instead.
 - `PropagationContext` constructor no longer takes a `dynamic_sampling_context` but takes a `baggage` object instead.
 - `ThreadingIntegration` no longer takes the `propagate_hub` argument.
+- `Baggage.populate_from_transaction` has been removed.
 
 ### Deprecated
 

sentry_sdk/integrations/opentelemetry/integration.py

@@ -59,10 +59,10 @@ def _patch_readable_span():
     def sentry_patched_readable_span(self):
         # type: (Span) -> ReadableSpan
         readable_span = old_readable_span(self)
-        readable_span._sentry_meta = getattr(self, "_sentry_meta", {})
+        readable_span._sentry_meta = getattr(self, "_sentry_meta", {})  # type: ignore[attr-defined]
         return readable_span
 
-    Span._readable_span = sentry_patched_readable_span
+    Span._readable_span = sentry_patched_readable_span  # type: ignore[method-assign]
 
 
 def _setup_sentry_tracing():

sentry_sdk/integrations/opentelemetry/utils.py

@@ -18,8 +18,12 @@
 import sentry_sdk
 from sentry_sdk.utils import Dsn
 from sentry_sdk.consts import SPANSTATUS, OP, SPANDATA
-from sentry_sdk.tracing import get_span_status_from_http_code, DEFAULT_SPAN_ORIGIN
-from sentry_sdk.tracing_utils import Baggage, LOW_QUALITY_TRANSACTION_SOURCES
+from sentry_sdk.tracing import (
+    get_span_status_from_http_code,
+    DEFAULT_SPAN_ORIGIN,
+    LOW_QUALITY_TRANSACTION_SOURCES,
+)
+from sentry_sdk.tracing_utils import Baggage
 from sentry_sdk.integrations.opentelemetry.consts import SentrySpanAttribute
 
 from sentry_sdk._types import TYPE_CHECKING

sentry_sdk/tracing.py

@@ -266,7 +266,7 @@ def finish(
         scope=None,  # type: Optional[sentry_sdk.Scope]
         end_timestamp=None,  # type: Optional[Union[float, datetime]]
     ):
-        # type: (...) -> Optional[str]
+        # type: (...) -> None
         pass
 
     def set_measurement(self, name, value, unit=""):
@@ -375,7 +375,9 @@ def __init__(
                     self.set_status(status)
 
     def __eq__(self, other):
-        # type: (Span) -> bool
+        # type: (object) -> bool
+        if not isinstance(other, Span):
+            return False
         return self._otel_span == other._otel_span
 
     def __repr__(self):
@@ -526,7 +528,6 @@ def sample_rate(self):
         sample_rate = self._otel_span.get_span_context().trace_state.get(
             TRACESTATE_SAMPLE_RATE_KEY
         )
-        sample_rate = cast("Optional[str]", sample_rate)
         return float(sample_rate) if sample_rate is not None else None
 
     @property
@@ -668,18 +669,24 @@ def set_data(self, key, value):
 
     def get_attribute(self, name):
         # type: (str) -> Optional[Any]
-        if not isinstance(self._otel_span, ReadableSpan):
+        if (
+            not isinstance(self._otel_span, ReadableSpan)
+            or not self._otel_span.attributes
+        ):
             return None
         return self._otel_span.attributes.get(name)
 
     def set_attribute(self, key, value):
         # type: (str, Any) -> None
+        # otel doesn't support None as values, preferring to not set the key
+        # at all instead
         if value is None:
-            # otel doesn't support None as values, preferring to not set the key
-            # at all instead
+            return
+        serialized_value = _serialize_span_attribute(value)
+        if serialized_value is None:
             return
 
-        self._otel_span.set_attribute(key, _serialize_span_attribute(value))
+        self._otel_span.set_attribute(key, serialized_value)
 
     @property
     def status(self):
@@ -690,7 +697,7 @@ def status(self):
         Sentry `SPANSTATUS` it can not be guaranteed that the status
         set in `set_status()` will be the same as the one returned here.
         """
-        if not hasattr(self._otel_span, "status"):
+        if not isinstance(self._otel_span, ReadableSpan):
             return None
 
         if self._otel_span.status.status_code == StatusCode.UNSET:
@@ -740,10 +747,10 @@ def set_http_status(self, http_status):
 
     def is_success(self):
         # type: () -> bool
-        return self._otel_span.status.code == StatusCode.OK
+        return self.status == SPANSTATUS.OK
 
     def finish(self, end_timestamp=None):
-        # type: (Optional[Union[float, datetime]]) -> Optional[str]
+        # type: (Optional[Union[float, datetime]]) -> None
         if end_timestamp is not None:
             from sentry_sdk.integrations.opentelemetry.utils import (
                 convert_to_otel_timestamp,

sentry_sdk/tracing_utils.py

@@ -525,52 +525,6 @@ def from_options(cls, scope):
 
         return Baggage(sentry_items, third_party_items, mutable)
 
-    @classmethod
-    def populate_from_transaction(cls, transaction):
-        # type: (sentry_sdk.tracing.Transaction) -> Baggage
-        """
-        Populate fresh baggage entry with sentry_items and make it immutable
-        if this is the head SDK which originates traces.
-        """
-        client = sentry_sdk.get_client()
-        sentry_items = {}  # type: Dict[str, str]
-
-        if not client.is_active():
-            return Baggage(sentry_items)
-
-        options = client.options or {}
-
-        sentry_items["trace_id"] = transaction.trace_id
-
-        if options.get("environment"):
-            sentry_items["environment"] = options["environment"]
-
-        if options.get("release"):
-            sentry_items["release"] = options["release"]
-
-        if options.get("dsn"):
-            sentry_items["public_key"] = Dsn(options["dsn"]).public_key
-
-        if (
-            transaction.name
-            and transaction.source not in LOW_QUALITY_TRANSACTION_SOURCES
-        ):
-            sentry_items["transaction"] = transaction.name
-
-        if transaction.sample_rate is not None:
-            sentry_items["sample_rate"] = str(transaction.sample_rate)
-
-        if transaction.sampled is not None:
-            sentry_items["sampled"] = "true" if transaction.sampled else "false"
-
-        # there's an existing baggage but it was mutable,
-        # which is why we are creating this new baggage.
-        # However, if by chance the user put some sentry items in there, give them precedence.
-        if transaction._baggage and transaction._baggage.sentry_items:
-            sentry_items.update(transaction._baggage.sentry_items)
-
-        return Baggage(sentry_items, mutable=False)
-
     def freeze(self):
         # type: () -> None
         self.mutable = False
@@ -722,6 +676,5 @@ def get_current_span(scope=None):
 # Circular imports
 from sentry_sdk.tracing import (
     BAGGAGE_HEADER_NAME,
-    LOW_QUALITY_TRANSACTION_SOURCES,
     SENTRY_TRACE_HEADER_NAME,
 )

sentry_sdk/transport.py

@@ -23,7 +23,7 @@
 from sentry_sdk.worker import BackgroundWorker
 from sentry_sdk.envelope import Envelope, Item, PayloadRef
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, cast
 
 if TYPE_CHECKING:
     from typing import Any
@@ -179,6 +179,7 @@ def _parse_rate_limits(header, now=None):
 
             retry_after = now + timedelta(seconds=int(retry_after_val))
             for category in categories and categories.split(";") or (None,):
+                category = cast("Optional[EventDataCategory]", category)
                 yield category, retry_after
         except (LookupError, ValueError):
             continue