renamed methods

Author: daniel-sanche

google/cloud/bigtable/data/_async/metrics_interceptor.py

@@ -37,15 +37,15 @@
 __CROSS_SYNC_OUTPUT__ = "google.cloud.bigtable.data._sync_autogen.metrics_interceptor"
 
 
-def _with_operation_from_metadata(func):
+def _with_active_operation(func):
     """
-    Decorator for interceptor methods to extract the active operation
-    from metadata and pass it to the decorated function.
+    Decorator for interceptor methods to extract the active operation associated with the
+    in-scope contextvars, and pass it to the decorated function.
     """
 
     @wraps(func)
     def wrapper(self, continuation, client_call_details, request):
-        operation: "ActiveOperationMetric" | None = ActiveOperationMetric.get_active()
+        operation: "ActiveOperationMetric" | None = ActiveOperationMetric.from_context()
 
         if operation:
             # start a new attempt if not started
@@ -97,7 +97,7 @@ class AsyncBigtableMetricsInterceptor(
     """
 
     @CrossSync.convert
-    @_with_operation_from_metadata
+    @_with_active_operation
     async def intercept_unary_unary(
         self, operation, continuation, client_call_details, request
     ):
@@ -120,7 +120,7 @@ async def intercept_unary_unary(
                 operation.add_response_metadata(metadata)
 
     @CrossSync.convert
-    @_with_operation_from_metadata
+    @_with_active_operation
     async def intercept_unary_stream(
         self, operation, continuation, client_call_details, request
     ):

google/cloud/bigtable/data/_metrics/data_model.py

@@ -177,7 +177,13 @@ class ActiveOperationMetric:
     ] = contextvars.ContextVar("active_operation_context")
 
     @classmethod
-    def get_active(cls):
+    def from_context(cls) -> ActiveOperationMetric | None:
+        """
+        Reads the active operation saved to contextvars
+
+        This is meant to be called by grpc interceptor to grab a reference to
+        the active attempt reference at the start of an rpc
+        """
         return cls._active_operation_context.get(None)
 
     @property
@@ -193,6 +199,9 @@ def state(self) -> OperationState:
             return OperationState.ACTIVE_ATTEMPT
 
     def __post_init__(self):
+        """
+        Save new instances to contextvars on init
+        """
         self._active_operation_context.set(self)
 
     def start(self) -> None:
@@ -205,6 +214,7 @@ def start(self) -> None:
         if self.state != OperationState.CREATED:
             return self._handle_error(INVALID_STATE_ERROR.format("start", self.state))
         self.start_time_ns = time.monotonic_ns()
+        # set as active operation in contextvars
         self._active_operation_context.set(self)
 
     def start_attempt(self) -> ActiveAttemptMetric | None:
@@ -220,6 +230,7 @@ def start_attempt(self) -> ActiveAttemptMetric | None:
             return self._handle_error(
                 INVALID_STATE_ERROR.format("start_attempt", self.state)
             )
+        # set as active operation in contextvars
         self._active_operation_context.set(self)
 
         try:

google/cloud/bigtable/data/_sync_autogen/metrics_interceptor.py

@@ -26,13 +26,13 @@
 from grpc import UnaryStreamClientInterceptor
 
 
-def _with_operation_from_metadata(func):
-    """Decorator for interceptor methods to extract the active operation
-    from metadata and pass it to the decorated function."""
+def _with_active_operation(func):
+    """Decorator for interceptor methods to extract the active operation associated with the
+    in-scope contextvars, and pass it to the decorated function."""
 
     @wraps(func)
     def wrapper(self, continuation, client_call_details, request):
-        operation: "ActiveOperationMetric" | None = ActiveOperationMetric.get_active()
+        operation: "ActiveOperationMetric" | None = ActiveOperationMetric.from_context()
         if operation:
             if (
                 operation.state == OperationState.CREATED
@@ -63,7 +63,7 @@ class BigtableMetricsInterceptor(
     An async gRPC interceptor to add client metadata and print server metadata.
     """
 
-    @_with_operation_from_metadata
+    @_with_active_operation
     def intercept_unary_unary(
         self, operation, continuation, client_call_details, request
     ):
@@ -83,7 +83,7 @@ def intercept_unary_unary(
             if metadata is not None:
                 operation.add_response_metadata(metadata)
 
-    @_with_operation_from_metadata
+    @_with_active_operation
     def intercept_unary_stream(
         self, operation, continuation, client_call_details, request
     ):