Make all relevant types public (#4315)

antonpirker · web-flow · commit d1819c7786de · 2025-04-22T09:17:55.000Z
Make types that users can use when configuring the SDK public. Accompaniyng docs update: getsentry/sentry-docs#13437 Fixes #4127
diff --git a/sentry_sdk/_types.py b/sentry_sdk/_types.py
@@ -220,7 +220,9 @@ class SDKInfo(TypedDict):
         tuple[None, None, None],
     ]
 
+    # TODO: Make a proper type definition for this (PRs welcome!)
     Hint = Dict[str, Any]
+
     Log = TypedDict(
         "Log",
         {
@@ -233,9 +235,13 @@ class SDKInfo(TypedDict):
         },
     )
 
+    # TODO: Make a proper type definition for this (PRs welcome!)
     Breadcrumb = Dict[str, Any]
+
+    # TODO: Make a proper type definition for this (PRs welcome!)
     BreadcrumbHint = Dict[str, Any]
 
+    # TODO: Make a proper type definition for this (PRs welcome!)
     SamplingContext = Dict[str, Any]
 
     EventProcessor = Callable[[Event, Hint], Optional[Event]]
diff --git a/sentry_sdk/types.py b/sentry_sdk/types.py
@@ -11,15 +11,39 @@
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from sentry_sdk._types import Event, EventDataCategory, Hint, Log
+    # Re-export types to make them available in the public API
+    from sentry_sdk._types import (
+        Breadcrumb,
+        BreadcrumbHint,
+        Event,
+        EventDataCategory,
+        Hint,
+        Log,
+        MonitorConfig,
+        SamplingContext,
+    )
 else:
     from typing import Any
 
     # The lines below allow the types to be imported from outside `if TYPE_CHECKING`
     # guards. The types in this module are only intended to be used for type hints.
+    Breadcrumb = Any
+    BreadcrumbHint = Any
     Event = Any
     EventDataCategory = Any
     Hint = Any
     Log = Any
+    MonitorConfig = Any
+    SamplingContext = Any
 
-__all__ = ("Event", "EventDataCategory", "Hint", "Log")
+
+__all__ = (
+    "Breadcrumb",
+    "BreadcrumbHint",
+    "Event",
+    "EventDataCategory",
+    "Hint",
+    "Log",
+    "MonitorConfig",
+    "SamplingContext",
+)

Original file line number	Diff line number	Diff line change
`@@ -220,7 +220,9 @@ class SDKInfo(TypedDict):`
`220`	`220`	`tuple[None, None, None],`
`221`	`221`	`]`
`222`	`222`
	`223`	`+ # TODO: Make a proper type definition for this (PRs welcome!)`
`223`	`224`	`Hint = Dict[str, Any]`
	`225`	`+`
`224`	`226`	`Log = TypedDict(`
`225`	`227`	`"Log",`
`226`	`228`	`{`
`@@ -233,9 +235,13 @@ class SDKInfo(TypedDict):`
`233`	`235`	`},`
`234`	`236`	`)`
`235`	`237`
	`238`	`+ # TODO: Make a proper type definition for this (PRs welcome!)`
`236`	`239`	`Breadcrumb = Dict[str, Any]`
	`240`	`+`
	`241`	`+ # TODO: Make a proper type definition for this (PRs welcome!)`
`237`	`242`	`BreadcrumbHint = Dict[str, Any]`
`238`	`243`
	`244`	`+ # TODO: Make a proper type definition for this (PRs welcome!)`
`239`	`245`	`SamplingContext = Dict[str, Any]`
`240`	`246`
`241`	`247`	`EventProcessor = Callable[[Event, Hint], Optional[Event]]`