Improvements to enum

antonpirker · antonpirker · commit 90358ddfdbf5 · 2025-02-21T09:25:25.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2348,7 +2348,7 @@ By: @mgaligniana (#1773)
       await ctx['session'].aclose()
 
   async def main():
-      with sentry_sdk.start_transaction(name="testing_arq_tasks", source=TransactionSource.COMPONENT.value):
+      with sentry_sdk.start_transaction(name="testing_arq_tasks", source=TransactionSource.COMPONENT):
           redis = await create_pool(RedisSettings())
           for url in ('https://facebook.com', 'https://microsoft.com', 'https://github.com', "asdf"
                       ):
@@ -2434,7 +2434,7 @@ By: @mgaligniana (#1773)
           traces_sample_rate=1.0,
       )
 
-      with sentry_sdk.start_transaction(name="testing_huey_tasks", source=TransactionSource.COMPONENT.value):
+      with sentry_sdk.start_transaction(name="testing_huey_tasks", source=TransactionSource.COMPONENT):
           r = add_numbers(1, 2)
 
   if __name__ == "__main__":
diff --git a/sentry_sdk/integrations/aiohttp.py b/sentry_sdk/integrations/aiohttp.py
@@ -129,7 +129,7 @@ async def sentry_app_handle(self, request, *args, **kwargs):
                         # If this transaction name makes it to the UI, AIOHTTP's
                         # URL resolver did not find a route or died trying.
                         name="generic AIOHTTP request",
-                        source=TransactionSource.ROUTE.value,
+                        source=TransactionSource.ROUTE,
                         origin=AioHttpIntegration.origin,
                     )
                     with sentry_sdk.start_transaction(
diff --git a/sentry_sdk/integrations/arq.py b/sentry_sdk/integrations/arq.py
@@ -102,7 +102,7 @@ async def _sentry_run_job(self, job_id, score):
                 name="unknown arq task",
                 status="ok",
                 op=OP.QUEUE_TASK_ARQ,
-                source=TransactionSource.TASK.value,
+                source=TransactionSource.TASK,
                 origin=ArqIntegration.origin,
             )
 
diff --git a/sentry_sdk/integrations/asgi.py b/sentry_sdk/integrations/asgi.py
@@ -270,9 +270,9 @@ def event_processor(self, event, hint, asgi_scope):
         already_set = event["transaction"] != _DEFAULT_TRANSACTION_NAME and event[
             "transaction_info"
         ].get("source") in [
-            TransactionSource.COMPONENT.value,
-            TransactionSource.ROUTE.value,
-            TransactionSource.CUSTOM.value,
+            TransactionSource.COMPONENT,
+            TransactionSource.ROUTE,
+            TransactionSource.CUSTOM,
         ]
         if not already_set:
             name, source = self._get_transaction_name_and_source(
@@ -310,7 +310,7 @@ def _get_transaction_name_and_source(self, transaction_style, asgi_scope):
                 name = transaction_from_function(endpoint) or ""
             else:
                 name = _get_url(asgi_scope, "http" if ty == "http" else "ws", host=None)
-                source = TransactionSource.URL.value
+                source = TransactionSource.URL
 
         elif transaction_style == "url":
             # FastAPI includes the route object in the scope to let Sentry extract the
@@ -322,11 +322,11 @@ def _get_transaction_name_and_source(self, transaction_style, asgi_scope):
                     name = path
             else:
                 name = _get_url(asgi_scope, "http" if ty == "http" else "ws", host=None)
-                source = TransactionSource.URL.value
+                source = TransactionSource.URL
 
         if name is None:
             name = _DEFAULT_TRANSACTION_NAME
-            source = TransactionSource.ROUTE.value
+            source = TransactionSource.ROUTE
             return name, source
 
         return name, source
diff --git a/sentry_sdk/integrations/aws_lambda.py b/sentry_sdk/integrations/aws_lambda.py
@@ -153,7 +153,7 @@ def sentry_handler(aws_event, aws_context, *args, **kwargs):
                 headers,
                 op=OP.FUNCTION_AWS,
                 name=aws_context.function_name,
-                source=TransactionSource.COMPONENT.value,
+                source=TransactionSource.COMPONENT,
                 origin=AwsLambdaIntegration.origin,
             )
             with sentry_sdk.start_transaction(
diff --git a/sentry_sdk/integrations/celery/__init__.py b/sentry_sdk/integrations/celery/__init__.py
@@ -319,7 +319,7 @@ def _inner(*args, **kwargs):
                     headers,
                     op=OP.QUEUE_TASK_CELERY,
                     name="unknown celery task",
-                    source=TransactionSource.TASK.value,
+                    source=TransactionSource.TASK,
                     origin=CeleryIntegration.origin,
                 )
                 transaction.name = task.name
diff --git a/sentry_sdk/integrations/chalice.py b/sentry_sdk/integrations/chalice.py
@@ -67,7 +67,7 @@ def wrapped_view_function(**function_args):
                 configured_time = app.lambda_context.get_remaining_time_in_millis()
                 scope.set_transaction_name(
                     app.lambda_context.function_name,
-                    source=TransactionSource.COMPONENT.value,
+                    source=TransactionSource.COMPONENT,
                 )
 
                 scope.add_event_processor(
diff --git a/sentry_sdk/integrations/django/__init__.py b/sentry_sdk/integrations/django/__init__.py
@@ -398,7 +398,7 @@ def _set_transaction_name_and_source(scope, transaction_style, request):
 
         if transaction_name is None:
             transaction_name = request.path_info
-            source = TransactionSource.URL.value
+            source = TransactionSource.URL
         else:
             source = SOURCE_FOR_STYLE[transaction_style]
 
diff --git a/sentry_sdk/integrations/fastapi.py b/sentry_sdk/integrations/fastapi.py
@@ -61,7 +61,7 @@ def _set_transaction_name_and_source(scope, transaction_style, request):
 
     if not name:
         name = _DEFAULT_TRANSACTION_NAME
-        source = TransactionSource.ROUTE.value
+        source = TransactionSource.ROUTE
     else:
         source = SOURCE_FOR_STYLE[transaction_style]
 
diff --git a/sentry_sdk/integrations/gcp.py b/sentry_sdk/integrations/gcp.py
@@ -88,7 +88,7 @@ def sentry_func(functionhandler, gcp_event, *args, **kwargs):
                 headers,
                 op=OP.FUNCTION_GCP,
                 name=environ.get("FUNCTION_NAME", ""),
-                source=TransactionSource.COMPONENT.value,
+                source=TransactionSource.COMPONENT,
                 origin=GcpIntegration.origin,
             )
             sampling_context = {
diff --git a/sentry_sdk/integrations/grpc/aio/server.py b/sentry_sdk/integrations/grpc/aio/server.py
@@ -48,7 +48,7 @@ async def wrapped(request, context):
                     dict(context.invocation_metadata()),
                     op=OP.GRPC_SERVER,
                     name=name,
-                    source=TransactionSource.CUSTOM.value,
+                    source=TransactionSource.CUSTOM,
                     origin=SPAN_ORIGIN,
                 )
 
diff --git a/sentry_sdk/integrations/grpc/server.py b/sentry_sdk/integrations/grpc/server.py
@@ -42,7 +42,7 @@ def behavior(request, context):
                         metadata,
                         op=OP.GRPC_SERVER,
                         name=name,
-                        source=TransactionSource.CUSTOM.value,
+                        source=TransactionSource.CUSTOM,
                         origin=SPAN_ORIGIN,
                     )
 
diff --git a/sentry_sdk/integrations/huey.py b/sentry_sdk/integrations/huey.py
@@ -159,7 +159,7 @@ def _sentry_execute(self, task, timestamp=None):
                 sentry_headers or {},
                 name=task.name,
                 op=OP.QUEUE_TASK_HUEY,
-                source=TransactionSource.TASK.value,
+                source=TransactionSource.TASK,
                 origin=HueyIntegration.origin,
             )
             transaction.set_status(SPANSTATUS.OK)
diff --git a/sentry_sdk/integrations/litestar.py b/sentry_sdk/integrations/litestar.py
@@ -249,7 +249,7 @@ def event_processor(event, _):
 
             if not tx_name:
                 tx_name = _DEFAULT_TRANSACTION_NAME
-                tx_info = {"source": TransactionSource.ROUTE.value}
+                tx_info = {"source": TransactionSource.ROUTE}
 
             event.update(
                 {
diff --git a/sentry_sdk/integrations/ray.py b/sentry_sdk/integrations/ray.py
@@ -63,7 +63,7 @@ def _f(*f_args, _tracing=None, **f_kwargs):
                 op=OP.QUEUE_TASK_RAY,
                 name=qualname_from_function(f),
                 origin=RayIntegration.origin,
-                source=TransactionSource.TASK.value,
+                source=TransactionSource.TASK,
             )
 
             with sentry_sdk.start_transaction(transaction) as transaction:
diff --git a/sentry_sdk/integrations/rq.py b/sentry_sdk/integrations/rq.py
@@ -57,7 +57,7 @@ def sentry_patched_perform_job(self, job, *args, **kwargs):
                     job.meta.get("_sentry_trace_headers") or {},
                     op=OP.QUEUE_TASK_RQ,
                     name="unknown RQ task",
-                    source=TransactionSource.TASK.value,
+                    source=TransactionSource.TASK,
                     origin=RqIntegration.origin,
                 )
 
diff --git a/sentry_sdk/integrations/sanic.py b/sentry_sdk/integrations/sanic.py
@@ -192,7 +192,7 @@ async def _context_enter(request):
         op=OP.HTTP_SERVER,
         # Unless the request results in a 404 error, the name and source will get overwritten in _set_transaction
         name=request.path,
-        source=TransactionSource.URL.value,
+        source=TransactionSource.URL,
         origin=SanicIntegration.origin,
     )
     request.ctx._sentry_transaction = sentry_sdk.start_transaction(
@@ -230,7 +230,7 @@ async def _set_transaction(request, route, **_):
             scope = sentry_sdk.get_current_scope()
             route_name = route.name.replace(request.app.name, "").strip(".")
             scope.set_transaction_name(
-                route_name, source=TransactionSource.COMPONENT.value
+                route_name, source=TransactionSource.COMPONENT
             )
 
 
@@ -306,11 +306,11 @@ def _legacy_router_get(self, *args):
                     sanic_route = sanic_route[len(sanic_app_name) + 1 :]
 
                 scope.set_transaction_name(
-                    sanic_route, source=TransactionSource.COMPONENT.value
+                    sanic_route, source=TransactionSource.COMPONENT
                 )
             else:
                 scope.set_transaction_name(
-                    rv[0].__name__, source=TransactionSource.COMPONENT.value
+                    rv[0].__name__, source=TransactionSource.COMPONENT
                 )
 
     return rv
diff --git a/sentry_sdk/integrations/starlette.py b/sentry_sdk/integrations/starlette.py
@@ -713,7 +713,7 @@ def _set_transaction_name_and_source(scope, transaction_style, request):
 
     if name is None:
         name = _DEFAULT_TRANSACTION_NAME
-        source = TransactionSource.ROUTE.value
+        source = TransactionSource.ROUTE
 
     scope.set_transaction_name(name, source=source)
     logger.debug(
@@ -728,9 +728,9 @@ def _get_transaction_from_middleware(app, asgi_scope, integration):
 
     if integration.transaction_style == "endpoint":
         name = transaction_from_function(app.__class__)
-        source = TransactionSource.COMPONENT.value
+        source = TransactionSource.COMPONENT
     elif integration.transaction_style == "url":
         name = _transaction_name_from_router(asgi_scope)
-        source = TransactionSource.ROUTE.value
+        source = TransactionSource.ROUTE
 
     return name, source
diff --git a/sentry_sdk/integrations/starlite.py b/sentry_sdk/integrations/starlite.py
@@ -235,7 +235,7 @@ def event_processor(event, _):
 
             if not tx_name:
                 tx_name = _DEFAULT_TRANSACTION_NAME
-                tx_info = {"source": TransactionSource.ROUTE.value}
+                tx_info = {"source": TransactionSource.ROUTE}
 
             event.update(
                 {
diff --git a/sentry_sdk/integrations/strawberry.py b/sentry_sdk/integrations/strawberry.py
@@ -208,7 +208,7 @@ def on_operation(self):
         transaction = self.graphql_span.containing_transaction
         if transaction and self.execution_context.operation_name:
             transaction.name = self.execution_context.operation_name
-            transaction.source = TransactionSource.COMPONENT.value
+            transaction.source = TransactionSource.COMPONENT
             transaction.op = op
 
         self.graphql_span.finish()
diff --git a/sentry_sdk/integrations/tornado.py b/sentry_sdk/integrations/tornado.py
@@ -119,7 +119,7 @@ def _handle_request_impl(self):
             # sentry_urldispatcher_resolve is responsible for
             # setting a transaction name later.
             name="generic Tornado request",
-            source=TransactionSource.ROUTE.value,
+            source=TransactionSource.ROUTE,
             origin=TornadoIntegration.origin,
         )
 
@@ -157,7 +157,7 @@ def tornado_processor(event, hint):
         with capture_internal_exceptions():
             method = getattr(handler, handler.request.method.lower())
             event["transaction"] = transaction_from_function(method) or ""
-            event["transaction_info"] = {"source": TransactionSource.COMPONENT.value}
+            event["transaction_info"] = {"source": TransactionSource.COMPONENT}
 
         with capture_internal_exceptions():
             extractor = TornadoRequestExtractor(request)
diff --git a/sentry_sdk/integrations/wsgi.py b/sentry_sdk/integrations/wsgi.py
@@ -115,7 +115,7 @@ def __call__(self, environ, start_response):
                             environ,
                             op=OP.HTTP_SERVER,
                             name="generic WSGI request",
-                            source=TransactionSource.ROUTE.value,
+                            source=TransactionSource.ROUTE,
                             origin=self.span_origin,
                         )
 
diff --git a/sentry_sdk/metrics.py b/sentry_sdk/metrics.py
@@ -63,10 +63,10 @@
 
 GOOD_TRANSACTION_SOURCES = frozenset(
     [
-        TransactionSource.ROUTE.value,
-        TransactionSource.VIEW.value,
-        TransactionSource.COMPONENT.value,
-        TransactionSource.TASK.value,
+        TransactionSource.ROUTE,
+        TransactionSource.VIEW,
+        TransactionSource.COMPONENT,
+        TransactionSource.TASK,
     ]
 )
 
diff --git a/sentry_sdk/tracing.py b/sentry_sdk/tracing.py
@@ -131,30 +131,33 @@ class TransactionKwargs(SpanKwargs, total=False):
 
 # Transaction source
 # see https://develop.sentry.dev/sdk/event-payloads/transaction/#transaction-annotations
-class TransactionSource(Enum):
+class TransactionSource(str, Enum):
+    COMPONENT = "component"
     CUSTOM = "custom"
-    URL = "url"
     ROUTE = "route"
-    VIEW = "view"
-    COMPONENT = "component"
     TASK = "task"
+    URL = "url"
+    VIEW = "view"
+
+    def __str__(self):
+        return self.value
 
 
 # These are typically high cardinality and the server hates them
 LOW_QUALITY_TRANSACTION_SOURCES = [
-    TransactionSource.URL.value,
+    TransactionSource.URL,
 ]
 
 SOURCE_FOR_STYLE = {
-    "endpoint": TransactionSource.COMPONENT.value,
-    "function_name": TransactionSource.COMPONENT.value,
-    "handler_name": TransactionSource.COMPONENT.value,
-    "method_and_path_pattern": TransactionSource.ROUTE.value,
-    "path": TransactionSource.URL.value,
-    "route_name": TransactionSource.COMPONENT.value,
-    "route_pattern": TransactionSource.ROUTE.value,
-    "uri_template": TransactionSource.ROUTE.value,
-    "url": TransactionSource.ROUTE.value,
+    "endpoint": TransactionSource.COMPONENT,
+    "function_name": TransactionSource.COMPONENT,
+    "handler_name": TransactionSource.COMPONENT,
+    "method_and_path_pattern": TransactionSource.ROUTE,
+    "path": TransactionSource.URL,
+    "route_name": TransactionSource.COMPONENT,
+    "route_pattern": TransactionSource.ROUTE,
+    "uri_template": TransactionSource.ROUTE,
+    "url": TransactionSource.ROUTE,
 }
 
 
@@ -782,7 +785,7 @@ def __init__(  # type: ignore[misc]
         name="",  # type: str
         parent_sampled=None,  # type: Optional[bool]
         baggage=None,  # type: Optional[Baggage]
-        source=TransactionSource.CUSTOM.value,  # type: str
+        source=TransactionSource.CUSTOM,  # type: str
         **kwargs,  # type: Unpack[SpanKwargs]
     ):
         # type: (...) -> None
diff --git a/tests/integrations/asgi/test_asgi.py b/tests/integrations/asgi/test_asgi.py
@@ -131,7 +131,7 @@ async def app(scope, receive, send):
 def asgi3_custom_transaction_app():
     async def app(scope, receive, send):
         sentry_sdk.get_current_scope().set_transaction_name(
-            "foobar", source=TransactionSource.CUSTOM.value
+            "foobar", source=TransactionSource.CUSTOM
         )
         await send(
             {
diff --git a/tests/integrations/sanic/test_sanic.py b/tests/integrations/sanic/test_sanic.py
@@ -370,15 +370,15 @@ def __init__(
             url="/message",
             expected_status=200,
             expected_transaction_name="hi",
-            expected_source=TransactionSource.COMPONENT.value,
+            expected_source=TransactionSource.COMPONENT,
         ),
         TransactionTestConfig(
             # Transaction still recorded when we have an internal server error
             integration_args=(),
             url="/500",
             expected_status=500,
             expected_transaction_name="fivehundred",
-            expected_source=TransactionSource.COMPONENT.value,
+            expected_source=TransactionSource.COMPONENT,
         ),
         TransactionTestConfig(
             # By default, no transaction when we have a 404 error
@@ -393,7 +393,7 @@ def __init__(
             url="/404",
             expected_status=404,
             expected_transaction_name="/404",
-            expected_source=TransactionSource.URL.value,
+            expected_source=TransactionSource.URL,
         ),
         TransactionTestConfig(
             # Transaction can be suppressed for other HTTP statuses, too, by passing config to the integration
diff --git a/tests/test_metrics.py b/tests/test_metrics.py

Original file line number	Diff line number	Diff line change
`@@ -129,7 +129,7 @@ async def sentry_app_handle(self, request, args, *kwargs):`
`129`	`129`	`# If this transaction name makes it to the UI, AIOHTTP's`
`130`	`130`	`# URL resolver did not find a route or died trying.`
`131`	`131`	`name="generic AIOHTTP request",`
`132`		`- source=TransactionSource.ROUTE.value,`
	`132`	`+ source=TransactionSource.ROUTE,`
`133`	`133`	`origin=AioHttpIntegration.origin,`
`134`	`134`	`)`
`135`	`135`	`with sentry_sdk.start_transaction(`
Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ async def _sentry_run_job(self, job_id, score):`
`102`	`102`	`name="unknown arq task",`
`103`	`103`	`status="ok",`
`104`	`104`	`op=OP.QUEUE_TASK_ARQ,`
`105`		`- source=TransactionSource.TASK.value,`
	`105`	`+ source=TransactionSource.TASK,`
`106`	`106`	`origin=ArqIntegration.origin,`
`107`	`107`	`)`
`108`	`108`
Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,7 @@ def sentry_handler(aws_event, aws_context, args, *kwargs):`
`153`	`153`	`headers,`
`154`	`154`	`op=OP.FUNCTION_AWS,`
`155`	`155`	`name=aws_context.function_name,`
`156`		`- source=TransactionSource.COMPONENT.value,`
	`156`	`+ source=TransactionSource.COMPONENT,`
`157`	`157`	`origin=AwsLambdaIntegration.origin,`
`158`	`158`	`)`
`159`	`159`	`with sentry_sdk.start_transaction(`
Original file line number	Diff line number	Diff line change
`@@ -319,7 +319,7 @@ def _inner(args, *kwargs):`
`319`	`319`	`headers,`
`320`	`320`	`op=OP.QUEUE_TASK_CELERY,`
`321`	`321`	`name="unknown celery task",`
`322`		`- source=TransactionSource.TASK.value,`
	`322`	`+ source=TransactionSource.TASK,`
`323`	`323`	`origin=CeleryIntegration.origin,`
`324`	`324`	`)`
`325`	`325`	`transaction.name = task.name`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ def wrapped_view_function(**function_args):`
`67`	`67`	`configured_time = app.lambda_context.get_remaining_time_in_millis()`
`68`	`68`	`scope.set_transaction_name(`
`69`	`69`	`app.lambda_context.function_name,`
`70`		`- source=TransactionSource.COMPONENT.value,`
	`70`	`+ source=TransactionSource.COMPONENT,`
`71`	`71`	`)`
`72`	`72`
`73`	`73`	`scope.add_event_processor(`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ def sentry_func(functionhandler, gcp_event, args, *kwargs):`
`88`	`88`	`headers,`
`89`	`89`	`op=OP.FUNCTION_GCP,`
`90`	`90`	`name=environ.get("FUNCTION_NAME", ""),`
`91`		`- source=TransactionSource.COMPONENT.value,`
	`91`	`+ source=TransactionSource.COMPONENT,`
`92`	`92`	`origin=GcpIntegration.origin,`
`93`	`93`	`)`
`94`	`94`	`sampling_context = {`