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

Exception _WorkflowBeingEvictedError

Module _workflow_instance

Classes

HandlerExecution
Attributes
- id
- name
- unfinished_policy
_ActivityHandle
Methods
- __init__
- cancel
- _apply_cancel_command
- _apply_schedule_command
- _resolve_backoff
- _resolve_failure
- _resolve_success
Attributes
- _input
- _instance
- _result_fut
- _seq
- _started
_ChildWorkflowHandle
Methods
- __init__
- signal
- _apply_cancel_command
- _apply_start_command
- _resolve_failure
- _resolve_start_success
- _resolve_success
Attributes
- first_execution_run_id
- id
- _first_execution_run_id
- _input
- _instance
- _result_fut
- _seq
- _start_fut
_ExternalWorkflowHandle
Methods
- __init__
- cancel
- signal
Attributes
- id
- run_id
- _id
- _instance
- _run_id
_ReplaySafeMetricCommon
Methods
- __init__
- with_additional_attributes
Attributes
- description
- name
- unit
- _underlying
_ReplaySafeMetricCounter
Methods
- add
Inherited Methods
- __init__
- with_additional_attributes
Inherited Attributes
- description
- name
- unit
- _underlying
_ReplaySafeMetricGauge
Methods
- set
Inherited Methods
- __init__
- with_additional_attributes
Inherited Attributes
- description
- name
- unit
- _underlying
_ReplaySafeMetricGaugeFloat
Methods
- set
Inherited Methods
- __init__
- with_additional_attributes
Inherited Attributes
- description
- name
- unit
- _underlying
_ReplaySafeMetricHistogram
Methods
- record
Inherited Methods
- __init__
- with_additional_attributes
Inherited Attributes
- description
- name
- unit
- _underlying
_ReplaySafeMetricHistogramFloat
Methods
- record
Inherited Methods
- __init__
- with_additional_attributes
Inherited Attributes
- description
- name
- unit
- _underlying
_ReplaySafeMetricHistogramTimedelta
Methods
- record
Inherited Methods
- __init__
- with_additional_attributes
Inherited Attributes
- description
- name
- unit
- _underlying
_ReplaySafeMetricMeter
Methods
- __init__
- create_counter
- create_gauge
- create_gauge_float
- create_histogram
- create_histogram_float
- create_histogram_timedelta
- with_additional_attributes
Attributes
- _underlying
Inherited Attributes
- noop
_TimerHandle
Methods
- __init__
- _apply_cancel_command
- _apply_start_command
Attributes
- _options
- _seq
_TimerOptions
Attributes
- user_metadata
_WorkflowExternFunctions
Attributes
- __temporal_get_metric_meter
_WorkflowInboundImpl
Methods
- __init__
- execute_workflow
- handle_query
- handle_signal
- handle_update_handler
- handle_update_validator
- init
Attributes
- _instance
- _outbound
_WorkflowInstanceImpl
Methods
- __init__
- activate
- call_at
- call_exception_handler
- call_later
- call_soon
- create_future
- create_task
- default_exception_handler
- get_debug
- get_exception_handler
- get_thread_id
- set_exception_handler
- time
- workflow_all_handlers_finished
- workflow_continue_as_new
- workflow_extern_functions
- workflow_get_current_build_id
- workflow_get_current_details
- workflow_get_current_history_length
- workflow_get_current_history_size
- workflow_get_external_workflow_handle
- workflow_get_query_handler
- workflow_get_signal_handler
- workflow_get_update_handler
- workflow_get_update_validator
- workflow_info
- workflow_is_continue_as_new_suggested
- workflow_is_replaying
- workflow_memo
- workflow_memo_value
- workflow_metric_meter
- workflow_patch
- workflow_payload_converter
- workflow_random
- workflow_set_current_details
- workflow_set_query_handler
- workflow_set_signal_handler
- workflow_set_update_handler
- workflow_sleep
- workflow_start_activity
- workflow_start_child_workflow
- workflow_start_local_activity
- workflow_time_ns
- workflow_upsert_search_attributes
- workflow_wait_condition
- _add_command
- _apply
- _apply_cancel_workflow
- _apply_do_update
- _apply_fire_timer
- _apply_initialize_workflow
- _apply_notify_has_patch
- _apply_query_workflow
- _apply_remove_from_cache
- _apply_resolve_activity
- _apply_resolve_child_workflow_execution
- _apply_resolve_child_workflow_execution_start
- _apply_resolve_request_cancel_external_workflow
- _apply_resolve_signal_external_workflow
- _apply_signal_workflow
- _apply_update_random_seed
- _as_read_only
- _assert_not_read_only
- _cancel_external_workflow
- _check_condition
- _convert_payloads
- _enhanced_stack_trace
- _instantiate_workflow_object
- _is_workflow_failure_exception
- _make_workflow_input
- _next_seq
- _outbound_continue_as_new
- _outbound_schedule_activity
- _outbound_signal_child_workflow
- _outbound_signal_external_workflow
- _outbound_start_child_workflow
- _process_handler_args
- _process_signal_job
- _register_task
- _run_once
- _run_top_level_workflow_function
- _set_workflow_failure
- _signal_external_workflow
- _stack_trace
- _temporal_workflow_metadata
- _timer_handle_cancelled
- _timer_impl
- _warn_if_unfinished_handlers
Inherited Methods
- current
- maybe_current
- set_on_loop
Attributes
- _buffered_signals
- _cancel_requested
- _conditions
- _continue_as_new_suggested
- _curr_seqs
- _current_activation_error
- _current_build_id
- _current_completion
- _current_details
- _current_history_length
- _current_history_size
- _current_thread_id
- _defn
- _deleting
- _disable_eager_activity_execution
- _exception_handler
- _extern_functions
- _failure_converter
- _handled_signals_seq
- _in_progress_signals
- _in_progress_updates
- _inbound
- _info
- _is_replaying
- _memo
- _metric_meter
- _object
- _outbound
- _patches_memoized
- _patches_notified
- _payload_converter
- _pending_activities
- _pending_child_workflows
- _pending_external_cancels
- _pending_external_signals
- _pending_timers
- _primary_task
- _queries
- _random
- _read_only
- _ready
- _signals
- _tasks
- _time_ns
- _updates
- _worker_level_failure_exception_types
- _workflow_input
Inherited Attributes
- logger_details
- _logger_details
_WorkflowOutboundImpl
Methods
- __init__
- continue_as_new
- info
- signal_child_workflow
- signal_external_workflow
- start_activity
- start_child_workflow
- start_local_activity
Attributes
- _instance
_ActivityDoBackoffError
Methods
- __init__
Attributes
- backoff
_ContinueAsNewError
Methods
- __init__
- _apply_command
Attributes
- _input
- _instance
_WorkflowBeingEvictedError

Functions

_encode_search_attributes
_make_unfinished_signal_handler_message
_make_unfinished_update_handler_message

Variables

LOG_IGNORE_DURING_DELETE
logger
_MetricType
_T
_Context
_ExceptionHandler
_TimerOptionsCtxVar

`temporalio.worker._workflow_instance._WorkflowBeingEvictedError`

exception documentation

class _WorkflowBeingEvictedError(BaseException): (source)

View In Hierarchy

Undocumented

API Documentation for Temporal Python, generated by pydoctor 23.4.1 at 2024-12-20 18:11:49.