temporalio.worker

package documentation
(source)

Worker for processing Temporal workflows and/or activities.

Package workflow_sandbox Sandbox for Temporal workflows.
Module _activity Activity worker.
Module _command_aware_visitor Visitor that sets command context during payload traversal.
Module _interceptor Worker interceptor.
Module _nexus Nexus worker
Module _plugin Undocumented
Module _replayer Replayer.
Module _tuning No module docstring; 0/1 variable, 0/1 type alias, 0/1 constant, 0/1 function, 1/2 class documented
Module _worker Worker for processing Temporal workflows and/or activities.
Module _workflow Workflow worker.
Module _workflow_instance Workflow worker runner and instance.

From __init__.py:

Class ActivityInboundInterceptor Inbound interceptor to wrap outbound creation and activity execution.
Class ActivityOutboundInterceptor Outbound interceptor to wrap calls made from within activities.
Class ActivitySlotInfo Info about an activity task slot usage.
Class ContinueAsNewInput Input for WorkflowOutboundInterceptor.continue_as_new.
Class CustomSlotSupplier This class can be implemented to provide custom slot supplier behavior.
Class ExecuteActivityInput Input for ActivityInboundInterceptor.execute_activity.
Class ExecuteWorkflowInput Input for WorkflowInboundInterceptor.execute_workflow.
Class FixedSizeSlotSupplier A fixed-size slot supplier that will never issue more than a fixed number of slots.
Class HandleQueryInput Input for WorkflowInboundInterceptor.handle_query.
Class HandleSignalInput Input for WorkflowInboundInterceptor.handle_signal.
Class HandleUpdateInput Input for WorkflowInboundInterceptor.handle_update_validator and WorkflowInboundInterceptor.handle_update_handler.
Class Interceptor Interceptor for workers.
Class LocalActivitySlotInfo Info about a local activity task slot usage.
Class NexusSlotInfo Info about a nexus task slot usage.
Class Plugin Base class for worker plugins that can intercept and modify worker behavior.
Class PollerBehaviorAutoscaling A poller behavior that will automatically scale the number of pollers based on feedback from the server. A slot must be available before beginning polling.
Class PollerBehaviorSimpleMaximum A poller behavior that will attempt to poll as long as a slot is available, up to the provided maximum. Cannot be less than two for workflow tasks, or one for other tasks.
Class Replayer Replayer to replay workflows from history.
Class ReplayerConfig TypedDict of config originally passed to Replayer.
Class ResourceBasedSlotConfig Options for a specific slot type being used with a ResourceBasedSlotSupplier.
Class ResourceBasedSlotSupplier A slot supplier that will dynamically adjust the number of slots based on resource usage.
Class ResourceBasedTunerConfig Options for a ResourceBasedTuner or a ResourceBasedSlotSupplier.
Class SharedHeartbeatSender Base class for a heartbeat sender that is picklable for use in another process.
Class SharedStateManager Base class for a shared state manager providing cross-process-safe primitives for use by activity executors.
Class SignalChildWorkflowInput Input for WorkflowOutboundInterceptor.signal_child_workflow.
Class SignalExternalWorkflowInput Input for WorkflowOutboundInterceptor.signal_external_workflow.
Class SlotMarkUsedContext Context for marking a slot used from a CustomSlotSupplier.
Class SlotPermit A permit to use a slot for a workflow/activity/local activity task.
Class SlotReleaseContext Context for releasing a slot from a CustomSlotSupplier.
Class SlotReserveContext Context for reserving a slot from a CustomSlotSupplier.
Class StartActivityInput Input for WorkflowOutboundInterceptor.start_activity.
Class StartChildWorkflowInput Input for WorkflowOutboundInterceptor.start_child_workflow.
Class StartLocalActivityInput Input for WorkflowOutboundInterceptor.start_local_activity.
Class StartNexusOperationInput Input for WorkflowOutboundInterceptor.start_nexus_operation.
Class UnsandboxedWorkflowRunner Workflow runner that does not do any sandboxing.
Class Worker Worker to process workflows and/or activities.
Class WorkerConfig TypedDict of config originally passed to Worker.
Class WorkerDeploymentConfig Options for configuring the Worker Versioning feature.
Class WorkerDeploymentVersion Represents the version of a specific worker deployment.
Class WorkerTuner WorkerTuners allow for the dynamic customization of some aspects of worker configuration
Class WorkflowInboundInterceptor Inbound interceptor to wrap outbound creation, workflow execution, and signal/query handling.
Class WorkflowInstance Instance of a workflow that can handle activations.
Class WorkflowInstanceDetails Immutable details for creating a workflow instance.
Class WorkflowInterceptorClassInput Input for Interceptor.workflow_interceptor_class.
Class WorkflowOutboundInterceptor Outbound interceptor to wrap calls made from within workflows.
Class WorkflowReplayResult Single workflow replay result.
Class WorkflowReplayResults Results of replaying multiple workflows.
Class WorkflowRunner Abstract runner for workflows that creates workflow instances to run.
Class WorkflowSlotInfo Info about a workflow task slot usage.
Type Alias PollerBehavior Undocumented
Type Alias SlotInfo Undocumented