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 |
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 |
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 |
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 |
Function called on each heartbeat invocation by the activity. |
| Instance Variable | payload |
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 |
Undocumented |
| Instance Variable | _cancelled |
Undocumented |
| Instance Variable | _client |
Undocumented |
| Instance Variable | _worker |
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[ | The function/callable to run. |
*args:_Params.args | All positional arguments to the callable. |
**kwargs:_Params.kwargs | All keyword arguments to the callable. |
| Returns | |
_Return | The 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.