linting and cleanup

Author: THardy98

temporalio/activity.py

@@ -140,14 +140,16 @@ def _logger_details(self) -> Mapping[str, Any]:
 
 @dataclass
 class ActivityCancellationDetails:
+    """Provides the reasons for the activity's cancellation"""
+
     not_found: bool = False
     cancelled: bool = False
     paused: bool = False
     timed_out: bool = False
     worker_shutdown: bool = False
 
     @staticmethod
-    def fromProto(
+    def _fromProto(
         proto: temporalio.bridge.proto.activity_task.ActivityCancellationDetails,
     ) -> ActivityCancellationDetails:
         return ActivityCancellationDetails(

temporalio/client.py

@@ -6248,7 +6248,6 @@ async def heartbeat_async_activity(
                 metadata=input.rpc_metadata,
                 timeout=input.rpc_timeout,
             )
-            # TODO(thomas): modify activity context (if applicable to async activities)
             if resp_by_id.cancel_requested or resp_by_id.activity_paused:
                 raise AsyncActivityCancelledError()
 
@@ -6264,7 +6263,6 @@ async def heartbeat_async_activity(
                 metadata=input.rpc_metadata,
                 timeout=input.rpc_timeout,
             )
-            # TODO(thomas): modify activity context (if applicable to async activities)
             if resp.cancel_requested or resp.activity_paused:
                 raise AsyncActivityCancelledError()
 

temporalio/testing/_activity.py

@@ -74,6 +74,7 @@ def __init__(self) -> None:
         self._cancelled = False
         self._worker_shutdown = False
         self._activities: Set[_Activity] = set()
+        self.cancellation_details = None
 
     def cancel(self) -> None:
         """Cancel the activity.
@@ -154,6 +155,7 @@ def __init__(
             else self.cancel_thread_raiser.shielded,
             payload_converter_class_or_instance=env.payload_converter,
             runtime_metric_meter=env.metric_meter,
+            cancellation_details=lambda: env.cancellation_details,
         )
         self.task: Optional[asyncio.Task] = None
 

temporalio/worker/_activity.py

@@ -215,7 +215,7 @@ def _cancel(
             return
         logger.debug("Cancelling activity %s, reason: %s", task_token, cancel.reason)
         activity.cancellation_details = (
-            temporalio.activity.ActivityCancellationDetails.fromProto(cancel.details)
+            temporalio.activity.ActivityCancellationDetails._fromProto(cancel.details)
         )
         activity.cancel(cancelled_by_request=True)
 
@@ -751,7 +751,9 @@ def _execute_sync_activity(
         temporalio.converter.PayloadConverter,
     ],
     runtime_metric_meter: Optional[temporalio.common.MetricMeter],
-    cancellation_details: Callable[[], Optional[temporalio.activity.ActivityCancellationDetails]],
+    cancellation_details: Callable[
+        [], Optional[temporalio.activity.ActivityCancellationDetails]
+    ],
     fn: Callable[..., Any],
     *args: Any,
 ) -> Any:
@@ -783,7 +785,7 @@ def _execute_sync_activity(
             else cancel_thread_raiser.shielded,
             payload_converter_class_or_instance=payload_converter_class_or_instance,
             runtime_metric_meter=runtime_metric_meter,
-            cancellation_details=cancellation_details
+            cancellation_details=cancellation_details,
         )
     )
     return fn(*args)

tests/worker/test_workflow.py

@@ -7384,6 +7384,7 @@ async def heartbeat_activity() -> (
         except (CancelledError, asyncio.CancelledError):
             return activity.cancellation_details()
 
+
 @activity.defn
 def sync_heartbeat_activity() -> (
     Optional[temporalio.activity.ActivityCancellationDetails]
@@ -7395,6 +7396,7 @@ def sync_heartbeat_activity() -> (
         except (CancelledError, asyncio.CancelledError):
             return activity.cancellation_details()
 
+
 @workflow.defn
 class ActivityHeartbeatWorkflow:
     @workflow.run
@@ -7452,7 +7454,7 @@ async def check_paused() -> bool:
             task_queue=str(uuid.uuid4()),
             workflows=[ActivityHeartbeatWorkflow],
             activities=[heartbeat_activity, sync_heartbeat_activity],
-            activity_executor=executor
+            activity_executor=executor,
         ) as worker:
             test_activity_id = f"heartbeat-activity-{uuid.uuid4()}"
 
@@ -7483,5 +7485,9 @@ async def check_paused() -> bool:
 
             # Assert workflow returned "Paused"
             result = await handle.result()
-            assert result[0] == temporalio.activity.ActivityCancellationDetails(paused=True)
-            assert result[1] == temporalio.activity.ActivityCancellationDetails(paused=True)
+            assert result[0] == temporalio.activity.ActivityCancellationDetails(
+                paused=True
+            )
+            assert result[1] == temporalio.activity.ActivityCancellationDetails(
+                paused=True
+            )