temporalio.testing.ActivityEnvironment

Activity environment for testing activities.

This environment is used for running activity code that can access the functions in the temporalio.activity module. Use run to run an activity function or any function within an activity context.

Static Method default_info Get the default activity info used for testing.
Method __init__ Create an ActivityEnvironment for running activity code.
Method cancel Cancel the activity.
Method run Run the given callable in an activity context.
Method worker_shutdown Notify the activity that the worker is shutting down.
Instance Variable info The info that is returned from temporalio.activity.info function. To customize, use default_info with dataclasses.replace to modify fields.
Instance Variable metric_meter Metric meter set on the activity context. This must be set before run. Changes after the activity has started do not take effect. Default is noop.
Instance Variable on_heartbeat Function called on each heartbeat invocation by the activity.
Instance Variable payload_converter Payload converter set on the activity context. This must be set before run. Changes after the activity has started do not take effect.
Instance Variable _activities Undocumented
Instance Variable _cancellation_details Undocumented
Instance Variable _cancelled Undocumented
Instance Variable _client Undocumented
Instance Variable _worker_shutdown Undocumented

Get the default activity info used for testing.

Returns a new default Info instance that can be modified using dataclasses.replace before assigning to the info attribute.

Create an ActivityEnvironment for running activity code.

Cancel the activity.

This only has an effect on the first call.

Run the given callable in an activity context.

Parameters
fn:Callable[_Params, _Return]The function/callable to run.
*args:_Params.argsAll positional arguments to the callable.
**kwargs:_Params.kwargsAll keyword arguments to the callable.
Returns
_ReturnThe callable's result.

Notify the activity that the worker is shutting down.

This only has an effect on the first call.

Metric meter set on the activity context. This must be set before run. Changes after the activity has started do not take effect. Default is noop.

Function called on each heartbeat invocation by the activity.

Payload converter set on the activity context. This must be set before run. Changes after the activity has started do not take effect.