Temporal Python API Documentation Modules Classes Names

search in docstrings

Search bar offers the following options:

Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: +foo bar -baz
Wildcards. The below example searches for documents with words beginning with “foo”: foo*
Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: +qname:twisted.mail.* +search
Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.
Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: foo~1

Results provided by Lunr.js

Module _interceptor

Package worker

Modules

workflow_sandbox
Modules
- _importer
- _in_sandbox
- _restrictions
- _runner
Classes
_activity
Classes
Functions
Variables
- logger
- _multiprocess_heartbeat_complete
_interceptor
_replayer
Variables
- logger
_worker
Classes
- _ShutdownRequested
Functions
- load_default_build_id
- _get_module_code
Variables
- logger
- _default_build_id
_workflow
Classes
- _WorkflowWorker
Variables
- LOG_PROTOS
- logger
_workflow_instance
Classes
Functions
- _encode_search_attributes
Variables
- LOG_IGNORE_DURING_DELETE
- logger
- _MetricType
- _T
- _Context
- _ExceptionHandler

Classes

ActivityInboundInterceptor
Methods
- __init__
- execute_activity
- init
Attributes
- next
ActivityOutboundInterceptor
Methods
- __init__
- heartbeat
- info
Attributes
- next
ContinueAsNewInput
Attributes
- arg_types
- args
- headers
- memo
- retry_policy
- run_timeout
- search_attributes
- task_queue
- task_timeout
- versioning_intent
- workflow
ExecuteActivityInput
Attributes
- args
- executor
- fn
- headers
ExecuteWorkflowInput
Attributes
- args
- headers
- run_fn
- type
HandleQueryInput
Attributes
- args
- headers
- id
- query
HandleSignalInput
Attributes
- args
- headers
- signal
HandleUpdateInput
Attributes
- args
- headers
- id
- update
Interceptor
Methods
- intercept_activity
- workflow_interceptor_class
Replayer
Methods
- __init__
- config
- replay_workflow
- replay_workflows
- workflow_replay_iterator
Attributes
- _config
ReplayerConfig
Attributes
- build_id
- data_converter
- debug_mode
- disable_safe_workflow_eviction
- identity
- interceptors
- namespace
- runtime
- unsandboxed_workflow_runner
- workflow_runner
- workflow_task_executor
- workflows
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
StartActivityInput
Attributes
- activity
- activity_id
- arg_types
- args
- cancellation_type
- disable_eager_execution
- headers
- heartbeat_timeout
- ret_type
- retry_policy
- schedule_to_close_timeout
- schedule_to_start_timeout
- start_to_close_timeout
- task_queue
- versioning_intent
StartChildWorkflowInput
Attributes
- arg_types
- args
- cancellation_type
- cron_schedule
- execution_timeout
- headers
- id
- id_reuse_policy
- memo
- parent_close_policy
- ret_type
- retry_policy
- run_timeout
- search_attributes
- 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
UnsandboxedWorkflowRunner
Methods
- create_instance
- prepare_workflow
Worker
Methods
- __aenter__
- __aexit__
- __init__
- config
- run
- shutdown
Attributes
- is_running
- is_shutdown
- task_queue
- _activity_worker
- _async_context_inner_task
- _async_context_run_exception
- _async_context_run_task
- _bridge_worker
- _config
- _shutdown_complete_event
- _shutdown_event
- _started
- _workflow_worker
WorkerConfig
Attributes
- activities
- activity_executor
- build_id
- client
- debug_mode
- default_heartbeat_throttle_interval
- 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
- no_remote_activities
- nonsticky_to_sticky_poll_ratio
- on_fatal_error
- shared_state_manager
- sticky_queue_schedule_to_start_timeout
- task_queue
- unsandboxed_workflow_runner
- use_worker_versioning
- workflow_runner
- workflow_task_executor
- workflows
WorkflowInboundInterceptor
Methods
- __init__
- execute_workflow
- handle_query
- handle_signal
- handle_update_handler
- handle_update_validator
- init
Attributes
- next
WorkflowInstance
Methods
- activate
WorkflowInstanceDetails
Attributes
- defn
- disable_eager_activity_execution
- extern_functions
- failure_converter_class
- info
- interceptor_classes
- payload_converter_class
- randomness_seed
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
Attributes
- next
WorkflowReplayResult
Attributes
- history
- replay_failure
WorkflowReplayResults
Attributes
- replay_failures
WorkflowRunner
Methods
- create_instance
- prepare_workflow

`temporalio.worker._interceptor`

module documentation

(source)

Worker interceptor.

API Documentation for Temporal Python, generated by pydoctor 23.4.1 at 2024-04-19 12:56:52.