sentry-sdk 3.0.0a2__py2.py3-none-any.whl → 3.0.0a4__py2.py3-none-any.whl

sentry_sdk/api.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 import inspect
 from contextlib import contextmanager
 
@@ -20,21 +21,23 @@ from sentry_sdk.opentelemetry.scope import (
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from collections.abc import Mapping
-
-    from typing import Any
-    from typing import Dict
-    from typing import Optional
-    from typing import Callable
-    from typing import TypeVar
-    from typing import Union
-    from typing import Generator
-
-    import sentry_sdk
+    from typing import Any, Optional, Callable, TypeVar, Union, Generator
 
     T = TypeVar("T")
     F = TypeVar("F", bound=Callable[..., Any])
 
+    from collections.abc import Mapping
+    from sentry_sdk.client import BaseClient
+    from sentry_sdk.tracing import Span
+    from sentry_sdk._types import (
+        Event,
+        Hint,
+        LogLevelStr,
+        ExcInfo,
+        BreadcrumbHint,
+        Breadcrumb,
+    )
+
 
 # When changing this, update __all__ in __init__.py too
 __all__ = [
@@ -45,6 +48,7 @@ __all__ = [
     "capture_exception",
     "capture_message",
     "continue_trace",
+    "new_trace",
     "flush",
     "get_baggage",
     "get_client",
@@ -69,11 +73,13 @@ __all__ = [
     "monitor",
     "use_scope",
     "use_isolation_scope",
+    "start_session",
+    "end_session",
+    "set_transaction_name",
 ]
 
 
-def scopemethod(f):
-    # type: (F) -> F
+def scopemethod(f: F) -> F:
     f.__doc__ = "%s\n\n%s" % (
         "Alias for :py:meth:`sentry_sdk.Scope.%s`" % f.__name__,
         inspect.getdoc(getattr(Scope, f.__name__)),
@@ -81,8 +87,7 @@ def scopemethod(f):
     return f
 
 
-def clientmethod(f):
-    # type: (F) -> F
+def clientmethod(f: F) -> F:
     f.__doc__ = "%s\n\n%s" % (
         "Alias for :py:meth:`sentry_sdk.Client.%s`" % f.__name__,
         inspect.getdoc(getattr(Client, f.__name__)),
@@ -91,13 +96,11 @@ def clientmethod(f):
 
 
 @scopemethod
-def get_client():
-    # type: () -> sentry_sdk.client.BaseClient
+def get_client() -> BaseClient:
     return Scope.get_client()
 
 
-def is_initialized():
-    # type: () -> bool
+def is_initialized() -> bool:
     """
     .. versionadded:: 2.0.0
 
@@ -111,26 +114,22 @@ def is_initialized():
 
 
 @scopemethod
-def get_global_scope():
-    # type: () -> BaseScope
+def get_global_scope() -> BaseScope:
     return Scope.get_global_scope()
 
 
 @scopemethod
-def get_isolation_scope():
-    # type: () -> Scope
+def get_isolation_scope() -> Scope:
     return Scope.get_isolation_scope()
 
 
 @scopemethod
-def get_current_scope():
-    # type: () -> Scope
+def get_current_scope() -> Scope:
     return Scope.get_current_scope()
 
 
 @scopemethod
-def last_event_id():
-    # type: () -> Optional[str]
+def last_event_id() -> Optional[str]:
     """
     See :py:meth:`sentry_sdk.Scope.last_event_id` documentation regarding
     this method's limitations.
@@ -140,23 +139,21 @@ def last_event_id():
 
 @scopemethod
 def capture_event(
-    event,  # type: sentry_sdk._types.Event
-    hint=None,  # type: Optional[sentry_sdk._types.Hint]
-    scope=None,  # type: Optional[Any]
-    **scope_kwargs,  # type: Any
-):
-    # type: (...) -> Optional[str]
+    event: Event,
+    hint: Optional[Hint] = None,
+    scope: Optional[Any] = None,
+    **scope_kwargs: Any,
+) -> Optional[str]:
     return get_current_scope().capture_event(event, hint, scope=scope, **scope_kwargs)
 
 
 @scopemethod
 def capture_message(
-    message,  # type: str
-    level=None,  # type: Optional[sentry_sdk._types.LogLevelStr]
-    scope=None,  # type: Optional[Any]
-    **scope_kwargs,  # type: Any
-):
-    # type: (...) -> Optional[str]
+    message: str,
+    level: Optional[LogLevelStr] = None,
+    scope: Optional[Any] = None,
+    **scope_kwargs: Any,
+) -> Optional[str]:
     return get_current_scope().capture_message(
         message, level, scope=scope, **scope_kwargs
     )
@@ -164,23 +161,21 @@ def capture_message(
 
 @scopemethod
 def capture_exception(
-    error=None,  # type: Optional[Union[BaseException, sentry_sdk._types.ExcInfo]]
-    scope=None,  # type: Optional[Any]
-    **scope_kwargs,  # type: Any
-):
-    # type: (...) -> Optional[str]
+    error: Optional[Union[BaseException, ExcInfo]] = None,
+    scope: Optional[Any] = None,
+    **scope_kwargs: Any,
+) -> Optional[str]:
     return get_current_scope().capture_exception(error, scope=scope, **scope_kwargs)
 
 
 @scopemethod
 def add_attachment(
-    bytes=None,  # type: Union[None, bytes, Callable[[], bytes]]
-    filename=None,  # type: Optional[str]
-    path=None,  # type: Optional[str]
-    content_type=None,  # type: Optional[str]
-    add_to_transactions=False,  # type: bool
-):
-    # type: (...) -> None
+    bytes: Union[None, bytes, Callable[[], bytes]] = None,
+    filename: Optional[str] = None,
+    path: Optional[str] = None,
+    content_type: Optional[str] = None,
+    add_to_transactions: bool = False,
+) -> None:
     return get_isolation_scope().add_attachment(
         bytes, filename, path, content_type, add_to_transactions
     )
@@ -188,61 +183,52 @@ def add_attachment(
 
 @scopemethod
 def add_breadcrumb(
-    crumb=None,  # type: Optional[sentry_sdk._types.Breadcrumb]
-    hint=None,  # type: Optional[sentry_sdk._types.BreadcrumbHint]
-    **kwargs,  # type: Any
-):
-    # type: (...) -> None
+    crumb: Optional[Breadcrumb] = None,
+    hint: Optional[BreadcrumbHint] = None,
+    **kwargs: Any,
+) -> None:
     return get_isolation_scope().add_breadcrumb(crumb, hint, **kwargs)
 
 
 @scopemethod
-def set_tag(key, value):
-    # type: (str, Any) -> None
+def set_tag(key: str, value: Any) -> None:
     return get_isolation_scope().set_tag(key, value)
 
 
 @scopemethod
-def set_tags(tags):
-    # type: (Mapping[str, object]) -> None
+def set_tags(tags: Mapping[str, object]) -> None:
     return get_isolation_scope().set_tags(tags)
 
 
 @scopemethod
-def set_context(key, value):
-    # type: (str, Dict[str, Any]) -> None
+def set_context(key: str, value: dict[str, Any]) -> None:
     return get_isolation_scope().set_context(key, value)
 
 
 @scopemethod
-def set_extra(key, value):
-    # type: (str, Any) -> None
+def set_extra(key: str, value: Any) -> None:
     return get_isolation_scope().set_extra(key, value)
 
 
 @scopemethod
-def set_user(value):
-    # type: (Optional[Dict[str, Any]]) -> None
+def set_user(value: Optional[dict[str, Any]]) -> None:
     return get_isolation_scope().set_user(value)
 
 
 @scopemethod
-def set_level(value):
-    # type: (sentry_sdk._types.LogLevelStr) -> None
+def set_level(value: LogLevelStr) -> None:
     return get_isolation_scope().set_level(value)
 
 
 @clientmethod
 def flush(
-    timeout=None,  # type: Optional[float]
-    callback=None,  # type: Optional[Callable[[int, float], None]]
-):
-    # type: (...) -> None
+    timeout: Optional[float] = None,
+    callback: Optional[Callable[[int, float], None]] = None,
+) -> None:
     return get_client().flush(timeout=timeout, callback=callback)
 
 
-def start_span(**kwargs):
-    # type: (Any) -> sentry_sdk.tracing.Span
+def start_span(**kwargs: Any) -> Span:
     """
     Start and return a span.
 
@@ -258,11 +244,7 @@ def start_span(**kwargs):
     return get_current_scope().start_span(**kwargs)
 
 
-def start_transaction(
-    transaction=None,  # type: Optional[sentry_sdk.tracing.Span]
-    **kwargs,  # type: Any
-):
-    # type: (...) -> sentry_sdk.tracing.Span
+def start_transaction(transaction: Optional[Span] = None, **kwargs: Any) -> Span:
     """
     .. deprecated:: 3.0.0
         This function is deprecated and will be removed in a future release.
@@ -301,24 +283,21 @@ def start_transaction(
     )
 
 
-def get_current_span(scope=None):
-    # type: (Optional[Scope]) -> Optional[sentry_sdk.tracing.Span]
+def get_current_span(scope: Optional[Scope] = None) -> Optional[Span]:
     """
     Returns the currently active span if there is one running, otherwise `None`
     """
     return tracing_utils.get_current_span(scope)
 
 
-def get_traceparent():
-    # type: () -> Optional[str]
+def get_traceparent() -> Optional[str]:
     """
     Returns the traceparent either from the active span or from the scope.
     """
     return get_current_scope().get_traceparent()
 
 
-def get_baggage():
-    # type: () -> Optional[str]
+def get_baggage() -> Optional[str]:
     """
     Returns Baggage either from the active span or from the scope.
     """
@@ -330,10 +309,35 @@ def get_baggage():
 
 
 @contextmanager
-def continue_trace(environ_or_headers):
-    # type: (Dict[str, Any]) -> Generator[None, None, None]
+def continue_trace(environ_or_headers: dict[str, Any]) -> Generator[None, None, None]:
     """
     Sets the propagation context from environment or headers to continue an incoming trace.
     """
     with get_isolation_scope().continue_trace(environ_or_headers):
         yield
+
+
+@contextmanager
+def new_trace() -> Generator[None, None, None]:
+    """
+    Force creation of a new trace.
+    """
+    with get_isolation_scope().new_trace():
+        yield
+
+
+@scopemethod
+def start_session(
+    session_mode: str = "application",
+) -> None:
+    return get_isolation_scope().start_session(session_mode=session_mode)
+
+
+@scopemethod
+def end_session() -> None:
+    return get_isolation_scope().end_session()
+
+
+@scopemethod
+def set_transaction_name(name: str, source: Optional[str] = None) -> None:
+    return get_current_scope().set_transaction_name(name, source)

sentry_sdk/attachments.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 import os
 import mimetypes
 
@@ -31,13 +32,12 @@ class Attachment:
 
     def __init__(
         self,
-        bytes=None,  # type: Union[None, bytes, Callable[[], bytes]]
-        filename=None,  # type: Optional[str]
-        path=None,  # type: Optional[str]
-        content_type=None,  # type: Optional[str]
-        add_to_transactions=False,  # type: bool
-    ):
-        # type: (...) -> None
+        bytes: Union[None, bytes, Callable[[], bytes]] = None,
+        filename: Optional[str] = None,
+        path: Optional[str] = None,
+        content_type: Optional[str] = None,
+        add_to_transactions: bool = False,
+    ) -> None:
         if bytes is None and path is None:
             raise TypeError("path or raw bytes required for attachment")
         if filename is None and path is not None:
@@ -52,10 +52,9 @@ class Attachment:
         self.content_type = content_type
         self.add_to_transactions = add_to_transactions
 
-    def to_envelope_item(self):
-        # type: () -> Item
+    def to_envelope_item(self) -> Item:
         """Returns an envelope item for this attachment."""
-        payload = None  # type: Union[None, PayloadRef, bytes]
+        payload: Union[None, PayloadRef, bytes] = None
         if self.bytes is not None:
             if callable(self.bytes):
                 payload = self.bytes()
@@ -70,6 +69,5 @@ class Attachment:
             filename=self.filename,
         )
 
-    def __repr__(self):
-        # type: () -> str
+    def __repr__(self) -> str:
         return "<Attachment %r>" % (self.filename,)