Browse Source

chore(sdk): Add types to `bind_organization_context` (#51644)

This adds types to the `bind_organization_context` function, which we use to add org data to the SDK scope. It also changes the type of the `orgs` parameter in `bind_ambiguous_org_context` (which was already typed), to allow for an `RpcOrganization` sequence to be passed.
Katie Byers 1 year ago
parent
commit
50e6ce1dfb
1 changed files with 6 additions and 2 deletions
  1. 6 2
      src/sentry/utils/sdk.py

+ 6 - 2
src/sentry/utils/sdk.py

@@ -28,6 +28,8 @@ from sentry.utils.rust import RustInfoIntegration
 # Can't import models in utils because utils should be the bottom of the food chain
 # Can't import models in utils because utils should be the bottom of the food chain
 if TYPE_CHECKING:
 if TYPE_CHECKING:
     from sentry.models.organization import Organization
     from sentry.models.organization import Organization
+    from sentry.services.hybrid_cloud.organization import RpcOrganization
+
 
 
 logger = logging.getLogger(__name__)
 logger = logging.getLogger(__name__)
 
 
@@ -595,7 +597,7 @@ def capture_exception_with_scope_check(
     return sentry_sdk.capture_exception(error, scope=extra_scope)
     return sentry_sdk.capture_exception(error, scope=extra_scope)
 
 
 
 
-def bind_organization_context(organization):
+def bind_organization_context(organization: Organization | RpcOrganization) -> None:
     # Callable to bind additional context for the Sentry SDK
     # Callable to bind additional context for the Sentry SDK
     helper = settings.SENTRY_ORGANIZATION_CONTEXT_HELPER
     helper = settings.SENTRY_ORGANIZATION_CONTEXT_HELPER
 
 
@@ -619,7 +621,9 @@ def bind_organization_context(organization):
                 )
                 )
 
 
 
 
-def bind_ambiguous_org_context(orgs: Sequence[Organization], source: str | None = None) -> None:
+def bind_ambiguous_org_context(
+    orgs: Sequence[Organization | RpcOrganization], source: str | None = None
+) -> None:
     """
     """
     Add org context information to the scope in the case where the current org might be one of a
     Add org context information to the scope in the case where the current org might be one of a
     number of known orgs (for example, if we've attempted to derive the current org from an
     number of known orgs (for example, if we've attempted to derive the current org from an