Temporal Python API Documentation Modules Classes Names

search in docstrings

For more information on the search, visit the help page.

Module _plugin

Classes

_RootPlugin
Methods
- configure_replayer
- configure_worker
- init_worker_plugin
- run_replayer
- run_worker
Inherited Methods
- name

Package worker

Modules

workflow_sandbox
Modules
- _importer
- _in_sandbox
- _restrictions
- _runner
Classes
_activity
Classes
Functions
Variables
- logger
- _multiprocess_heartbeat_complete
_interceptor
_nexus
Classes
- _DummyPayloadSerializer
- _NexusWorker
Functions
- _exception_to_handler_error
Variables
- _TEMPORAL_FAILURE_PROTO_TYPE
_plugin
Classes
- _RootPlugin
_replayer
Variables
- logger
_tuning
Classes
- _BridgeSlotSupplierWrapper
- _CompositeTuner
Functions
- _to_bridge_slot_supplier
Variables
- SlotSupplier
- logger
- _DEFAULT_RESOURCE_ACTIVITY_MAX
_worker
Classes
- _ShutdownRequested
Functions
Variables
- logger
- _default_build_id
_workflow
Classes
- _RunningWorkflow
- _WorkflowWorker
- _DeadlockError
- _InterruptDeadlockError
Variables
- LOG_PROTOS
- logger
_workflow_instance
Classes
- HandlerExecution
- _ActivityHandle
- _ChildWorkflowHandle
- _ExternalWorkflowHandle
- _NexusOperationHandle
- _ReplaySafeMetricCommon
- _ReplaySafeMetricCounter
- _ReplaySafeMetricGauge
- _ReplaySafeMetricGaugeFloat
- _ReplaySafeMetricHistogram
- _ReplaySafeMetricHistogramFloat
- _ReplaySafeMetricHistogramTimedelta
- _ReplaySafeMetricMeter
- _TimerHandle
- _TimerOptions
- _WorkflowExternFunctions
- _WorkflowInboundImpl
- _WorkflowInstanceImpl
- _WorkflowLogicFlag
- _WorkflowOutboundImpl
- _ActivityDoBackoffError
- _ContinueAsNewError
- _WorkflowBeingEvictedError
Functions
Variables
- LOG_IGNORE_DURING_DELETE
- logger
- _MetricType
- _T
- _Context
- _ExceptionHandler
- _TimerOptionsCtxVar

Classes

ActivityInboundInterceptor
Methods
- __init__
- execute_activity
- init
Attributes
- next
ActivityOutboundInterceptor
Methods
- __init__
- heartbeat
- info
Attributes
- next
ActivitySlotInfo
Attributes
- activity_type
ContinueAsNewInput
Attributes
- arg_types
- args
- headers
- memo
- retry_policy
- run_timeout
- search_attributes
- task_queue
- task_timeout
- versioning_intent
- workflow
CustomSlotSupplier
Methods
- mark_slot_used
- release_slot
- reserve_slot
- try_reserve_slot
ExecuteActivityInput
Attributes
- args
- executor
- fn
- headers
ExecuteWorkflowInput
Attributes
- args
- headers
- run_fn
- type
FixedSizeSlotSupplier
Attributes
- num_slots
HandleQueryInput
Attributes
- args
- headers
- id
- query
HandleSignalInput
Attributes
- args
- headers
- signal
HandleUpdateInput
Attributes
- args
- headers
- id
- update
Interceptor
Methods
- intercept_activity
- workflow_interceptor_class
LocalActivitySlotInfo
Attributes
- activity_type
Plugin
Methods
- configure_replayer
- configure_worker
- init_worker_plugin
- name
- run_replayer
- run_worker
PollerBehaviorAutoscaling
Methods
- _to_bridge
Attributes
- initial
- maximum
- minimum
PollerBehaviorSimpleMaximum
Methods
- _to_bridge
Attributes
- maximum
Replayer
Methods
- __init__
- config
- replay_workflow
- replay_workflows
- workflow_replay_iterator
- _workflow_replay_iterator
Attributes
- _config
- _plugin
ReplayerConfig
Attributes
- build_id
- data_converter
- debug_mode
- disable_safe_workflow_eviction
- header_codec_behavior
- identity
- interceptors
- namespace
- runtime
- unsandboxed_workflow_runner
- workflow_failure_exception_types
- workflow_runner
- workflow_task_executor
- workflows
ResourceBasedSlotConfig
Attributes
- maximum_slots
- minimum_slots
- ramp_throttle
ResourceBasedSlotSupplier
Attributes
- slot_config
- tuner_config
ResourceBasedTunerConfig
Attributes
- target_cpu_usage
- target_memory_usage
SharedHeartbeatSender
Methods
- send_heartbeat
SharedStateManager
Methods
- create_from_multiprocessing
- new_event
- register_heartbeater
- unregister_heartbeater
SignalChildWorkflowInput
Attributes
- args
- child_workflow_id
- headers
- signal
SignalExternalWorkflowInput
Attributes
- args
- headers
- namespace
- signal
- workflow_id
- workflow_run_id
SlotMarkUsedContext
Attributes
- permit
- slot_info
SlotPermit
SlotReleaseContext
Attributes
- permit
- slot_info
SlotReserveContext
Attributes
- is_sticky
- slot_type
- task_queue
- worker_build_id
- worker_deployment_version
- worker_identity
StartActivityInput
Attributes
- activity
- activity_id
- arg_types
- args
- cancellation_type
- disable_eager_execution
- headers
- heartbeat_timeout
- priority
- ret_type
- retry_policy
- schedule_to_close_timeout
- schedule_to_start_timeout
- start_to_close_timeout
- summary
- task_queue
- versioning_intent
StartChildWorkflowInput
Attributes
- arg_types
- args
- cancellation_type
- cron_schedule
- execution_timeout
- headers
- id
- id_reuse_policy
- memo
- parent_close_policy
- priority
- ret_type
- retry_policy
- run_timeout
- search_attributes
- static_details
- static_summary
- task_queue
- task_timeout
- versioning_intent
- workflow
StartLocalActivityInput
Attributes
- activity
- activity_id
- arg_types
- args
- cancellation_type
- headers
- local_retry_threshold
- ret_type
- retry_policy
- schedule_to_close_timeout
- schedule_to_start_timeout
- start_to_close_timeout
StartNexusOperationInput
Methods
- __post_init__
Attributes
- endpoint
- headers
- input
- operation
- schedule_to_close_timeout
- service
- output_type
- operation_name
UnsandboxedWorkflowRunner
Methods
- create_instance
- prepare_workflow
Inherited Methods
- set_worker_level_failure_exception_types
Worker
Methods
- __aenter__
- __aexit__
- __init__
- client.setter
- config
- run
- shutdown
- _init_from_config
- _run
Attributes
- client
- is_running
- is_shutdown
- task_queue
- _activity_worker
- _async_context_inner_task
- _async_context_run_exception
- _async_context_run_task
- _bridge_worker
- _config
- _nexus_worker
- _plugin
- _runtime
- _shutdown_complete_event
- _shutdown_event
- _started
- _workflow_worker
WorkerConfig
Attributes
- activities
- activity_executor
- activity_task_poller_behavior
- build_id
- client
- debug_mode
- default_heartbeat_throttle_interval
- deployment_config
- disable_eager_activity_execution
- disable_safe_workflow_eviction
- graceful_shutdown_timeout
- identity
- interceptors
- max_activities_per_second
- max_cached_workflows
- max_concurrent_activities
- max_concurrent_activity_task_polls
- max_concurrent_local_activities
- max_concurrent_workflow_task_polls
- max_concurrent_workflow_tasks
- max_heartbeat_throttle_interval
- max_task_queue_activities_per_second
- nexus_service_handlers
- nexus_task_executor
- nexus_task_poller_behavior
- no_remote_activities
- nonsticky_to_sticky_poll_ratio
- on_fatal_error
- shared_state_manager
- sticky_queue_schedule_to_start_timeout
- task_queue
- tuner
- unsandboxed_workflow_runner
- use_worker_versioning
- workflow_failure_exception_types
- workflow_runner
- workflow_task_executor
- workflow_task_poller_behavior
- workflows
WorkerDeploymentConfig
Methods
- _to_bridge_worker_deployment_options
Attributes
- use_worker_versioning
- version
WorkerDeploymentVersion
Methods
- from_canonical_string
- to_canonical_string
- _to_proto
Attributes
- build_id
- deployment_name
WorkerTuner
Methods
WorkflowInboundInterceptor
Methods
- __init__
- execute_workflow
- handle_query
- handle_signal
- handle_update_handler
- handle_update_validator
- init
Attributes
- next
WorkflowInstance
Methods
- activate
- get_thread_id
WorkflowInstanceDetails
Attributes
- defn
- disable_eager_activity_execution
- extern_functions
- failure_converter_class
- info
- interceptor_classes
- payload_converter_class
- randomness_seed
- worker_level_failure_exception_types
WorkflowInterceptorClassInput
Attributes
- unsafe_extern_functions
WorkflowOutboundInterceptor
Methods
- __init__
- continue_as_new
- info
- signal_child_workflow
- signal_external_workflow
- start_activity
- start_child_workflow
- start_local_activity
- start_nexus_operation
Attributes
- next
WorkflowReplayResult
Attributes
- history
- replay_failure
WorkflowReplayResults
Attributes
- replay_failures
WorkflowRunner
Methods
WorkflowSlotInfo
Attributes
- is_sticky
- workflow_type

Variables

PollerBehavior
SlotInfo

`temporalio.worker._plugin`

module documentation

(source)

Undocumented

Class _RootPlugin Undocumented

API Documentation for Temporal Python, generated by pydoctor 24.11.2 at 2025-08-07 00:21:50.