sdk-python API reference

400 public APIs from sdk-python (temporalio/sdk-python) — 179 classes, 31 functions, 190 methods. Signatures extracted by static analysis of the actual source.

Repository: temporalio/sdk-python

Kind	Count
Classes	179
Functions	31
Methods	190

API list

classtemporalio.activity.ActivityCancellationDetails

Provides the reasons for the activity's cancellation.

classtemporalio.activity.Info

Information about the running activity.

methodtemporalio.activity.Info.in_workflow() -> bool

Was this activity started by a workflow?

functemporalio.activity.client() -> Client

Return a Temporal Client for use in the current activity.

functemporalio.activity.heartbeat(*details:Any) -> None

Send a heartbeat for the current activity.

functemporalio.activity.in_activity() -> bool

Whether the current code is inside an activity.

functemporalio.activity.info() -> Info

Current activity's info.

functemporalio.activity.is_worker_shutdown() -> bool

Whether shutdown has been invoked on the worker.

functemporalio.activity.metric_meter() -> temporalio.common.MetricMeter

Get the metric meter for the current activity.

methodtemporalio.api.cloud.cloudservice.v1.service_pb2_grpc.CloudServiceServicer.CreateUser(request, context)

Create a user

methodtemporalio.api.cloud.cloudservice.v1.service_pb2_grpc.CloudServiceServicer.DeleteUser(request, context)

Delete a user

methodtemporalio.api.cloud.cloudservice.v1.service_pb2_grpc.CloudServiceServicer.GetApiKey(request, context)

Get an API key

methodtemporalio.api.cloud.cloudservice.v1.service_pb2_grpc.CloudServiceServicer.GetAuditLogs(request, context)

Get audit logs

methodtemporalio.api.cloud.cloudservice.v1.service_pb2_grpc.CloudServiceServicer.GetNamespace(request, context)

Get a namespace

methodtemporalio.api.cloud.cloudservice.v1.service_pb2_grpc.CloudServiceServicer.GetRegion(request, context)

Get a region

methodtemporalio.api.cloud.cloudservice.v1.service_pb2_grpc.CloudServiceServicer.GetRegions(request, context)

Get all regions

methodtemporalio.api.cloud.cloudservice.v1.service_pb2_grpc.CloudServiceServicer.GetUser(request, context)

Get a user

methodtemporalio.api.cloud.cloudservice.v1.service_pb2_grpc.CloudServiceServicer.GetUserGroup(request, context)

Get a user group

methodtemporalio.api.cloud.cloudservice.v1.service_pb2_grpc.CloudServiceServicer.UpdateUser(request, context)

Update a user

methodtemporalio.api.workflowservice.v1.service_pb2_grpc.WorkflowServiceServicer.GetWorkerTaskReachability(request, context)

Deprecated.

classtemporalio.bridge._visitor.PayloadVisitor

A visitor for payloads.

methodtemporalio.bridge._visitor.PayloadVisitor.visit(fs:VisitorFunctions, root:Any) -> None

Visits the given root message with the given function.

classtemporalio.bridge._visitor_functions.VisitorFunctions

Functions invoked by generated payload visitors.

methodtemporalio.bridge._visitor_functions.VisitorFunctions.drain_since(_checkpoint:int) -> None

Wait for visits scheduled after ``checkpoint`` to finish.

methodtemporalio.bridge._visitor_functions.VisitorFunctions.visit_payload(payload:Payload) -> None

Visit a single payload.

methodtemporalio.bridge._visitor_functions.VisitorFunctions.visit_payloads(payloads:PayloadSequence) -> None

Visit a sequence of payloads together.

methodtemporalio.bridge._visitor_functions.VisitorFunctions.visit_system_nexus_envelope(_payload:Payload) -> None

Visit a recognized system Nexus envelope payload.

classtemporalio.bridge.client.Client

RPC client using SDK Core.

method

temporalio.bridge.client.Client.call(*service:str, *rpc:str, *req:google.protobuf.message.Message, *resp_type:type[ProtoMessage], *retry:bool, *metadata:Mapping[str, str | bytes], *timeout:timedelta | None) -> ProtoMessage

Make RPC call using SDK Core.

methodtemporalio.bridge.client.Client.connect(runtime:temporalio.bridge.runtime.Runtime, config:ClientConfig) -> Client

Establish connection with server.

methodtemporalio.bridge.client.Client.update_api_key(api_key:str | None) -> None

Update underlying API key on Core client.

methodtemporalio.bridge.client.Client.update_metadata(metadata:Mapping[str, str | bytes]) -> None

Update underlying metadata on Core client.

classtemporalio.bridge.client.ClientTlsConfig

Python representation of the Rust struct for configuring TLS.

classtemporalio.bridge.client.RpcCall

Python representation of the Rust struct for an RPC call.

classtemporalio.bridge.metric.MetricAttributes

Metric attributes using SDK Core.

method

temporalio.bridge.metric.MetricAttributes.with_additional_attributes(new_attrs:Mapping[str, str | int | float | bool]) -> MetricAttributes

Create new attributes with new attributes appended.

classtemporalio.bridge.metric.MetricCounter

Metric counter using SDK Core.

methodtemporalio.bridge.metric.MetricCounter.add(value:int, attrs:MetricAttributes) -> None

Add value to counter.

classtemporalio.bridge.metric.MetricGauge

Metric gauge using SDK Core.

methodtemporalio.bridge.metric.MetricGauge.set(value:int, attrs:MetricAttributes) -> None

Set value on gauge.

classtemporalio.bridge.metric.MetricGaugeFloat

Metric gauge using SDK Core.

methodtemporalio.bridge.metric.MetricGaugeFloat.set(value:float, attrs:MetricAttributes) -> None

Set value on gauge.

classtemporalio.bridge.metric.MetricHistogram

Metric histogram using SDK Core.

methodtemporalio.bridge.metric.MetricHistogram.record(value:int, attrs:MetricAttributes) -> None

Record value on histogram.

classtemporalio.bridge.metric.MetricHistogramDuration

Metric histogram using SDK Core.

methodtemporalio.bridge.metric.MetricHistogramDuration.record(value_ms:int, attrs:MetricAttributes) -> None

Record value on histogram.

classtemporalio.bridge.metric.MetricHistogramFloat

Metric histogram using SDK Core.

methodtemporalio.bridge.metric.MetricHistogramFloat.record(value:float, attrs:MetricAttributes) -> None

Record value on histogram.

classtemporalio.bridge.metric.MetricMeter

Metric meter using SDK Core.

methodtemporalio.bridge.metric.MetricMeter.create(runtime:temporalio.bridge.runtime.Runtime) -> MetricMeter | None

Create optional metric meter.

methodtemporalio.bridge.metric.MetricMeter.default_attributes() -> MetricAttributes

Default attributes for the metric meter.

classtemporalio.bridge.runtime.BufferedLogEntry

A buffered log entry.

methodtemporalio.bridge.runtime.BufferedLogEntry.fields() -> dict[str, Any]

Additional log entry fields.

methodtemporalio.bridge.runtime.BufferedLogEntry.level() -> int

Python log level, with trace as 9.

methodtemporalio.bridge.runtime.BufferedLogEntry.message() -> str

Log message.

methodtemporalio.bridge.runtime.BufferedLogEntry.target() -> str

Target category for the log entry.

methodtemporalio.bridge.runtime.BufferedLogEntry.time() -> float

Time as from ``time.time`` since Unix epoch.

classtemporalio.bridge.runtime.MetricsConfig

Python representation of the Rust struct for metrics config.

classtemporalio.bridge.runtime.Runtime

Runtime for SDK Core.

methodtemporalio.bridge.runtime.Runtime.retrieve_buffered_metrics(durations_as_seconds:bool) -> Sequence[Any]

Get buffered metrics.

methodtemporalio.bridge.runtime.Runtime.write_test_debug_log(message:str, extra_data:str) -> None

Write a test core log at DEBUG level.

methodtemporalio.bridge.runtime.Runtime.write_test_info_log(message:str, extra_data:str) -> None

Write a test core log at INFO level.

classtemporalio.bridge.services_generated.CloudService

RPC calls for the CloudService.

classtemporalio.bridge.services_generated.HealthService

RPC calls for the HealthService.

classtemporalio.bridge.services_generated.OperatorService

RPC calls for the OperatorService.

classtemporalio.bridge.services_generated.TestService

RPC calls for the TestService.

classtemporalio.bridge.services_generated.WorkflowService

RPC calls for the WorkflowService.

classtemporalio.bridge.testing.EphemeralServer

Python representation of a Rust ephemeral server.

methodtemporalio.bridge.testing.EphemeralServer.has_test_service() -> bool

Whether this server supports the test service.

methodtemporalio.bridge.testing.EphemeralServer.shutdown() -> None

Shutdown this server.

method

temporalio.bridge.testing.EphemeralServer.start_dev_server(runtime:temporalio.bridge.runtime.Runtime, config:DevServerConfig) -> EphemeralServer

Start a dev server instance.

method

temporalio.bridge.testing.EphemeralServer.start_test_server(runtime:temporalio.bridge.runtime.Runtime, config:TestServerConfig) -> EphemeralServer

Start a test server instance.

methodtemporalio.bridge.testing.EphemeralServer.target() -> str

Frontend address.

classtemporalio.bridge.worker.Worker

SDK Core worker.

methodtemporalio.bridge.worker.Worker.complete_activity_task(comp:temporalio.bridge.proto.ActivityTaskCompletion) -> None

Complete an activity task.

methodtemporalio.bridge.worker.Worker.complete_nexus_task(comp:temporalio.bridge.proto.nexus.NexusTaskCompletion) -> None

Complete a nexus task.

method

temporalio.bridge.worker.Worker.complete_workflow_activation(comp:temporalio.bridge.proto.workflow_completion.WorkflowActivationCompletion) -> None

Complete a workflow activation.

methodtemporalio.bridge.worker.Worker.create(client:temporalio.bridge.client.Client, config:WorkerConfig) -> Worker

Create a bridge worker from a bridge client.

methodtemporalio.bridge.worker.Worker.finalize_shutdown() -> None

Finalize the worker.

method

temporalio.bridge.worker.Worker.for_replay(runtime:temporalio.bridge.runtime.Runtime, config:WorkerConfig) -> tuple[Worker, temporalio.bridge.temporal_sdk_bridge.HistoryPusher]

Create a bridge replay worker.

methodtemporalio.bridge.worker.Worker.initiate_shutdown() -> None

Start shutdown of the worker.

methodtemporalio.bridge.worker.Worker.poll_activity_task() -> temporalio.bridge.proto.activity_task.ActivityTask

Poll for an activity task.

methodtemporalio.bridge.worker.Worker.poll_nexus_task() -> temporalio.bridge.proto.nexus.NexusTask

Poll for a nexus task.

method

temporalio.bridge.worker.Worker.poll_workflow_activation() -> temporalio.bridge.proto.workflow_activation.WorkflowActivation

Poll for a workflow activation.

methodtemporalio.bridge.worker.Worker.record_activity_heartbeat(comp:temporalio.bridge.proto.ActivityHeartbeat) -> None

Record an activity heartbeat.

methodtemporalio.bridge.worker.Worker.replace_client(client:temporalio.bridge.client.Client) -> None

Replace the worker client.

methodtemporalio.bridge.worker.Worker.request_workflow_eviction(run_id:str) -> None

Request a workflow be evicted.

methodtemporalio.bridge.worker.Worker.validate() -> temporalio.bridge.proto.NamespaceInfo

Validate the bridge worker.

methodtemporalio.client._activity.ActivityExecutionAsyncIterator.fetch_next_page(*page_size:int | None=None) -> None

Fetch the next page of results.

methodtemporalio.client._activity.ActivityExecutionAsyncIterator.next_page_token() -> bytes | None

Token for the next page request if any.

classtemporalio.client._activity.ActivityExecutionStatus

Status of an activity execution.

classtemporalio.client._activity.AsyncActivityIDReference

Reference to an async activity by its qualified ID.

classtemporalio.client._client.Client

Client for accessing Temporal.

methodtemporalio.client._client.Client.api_key() -> str | None

API key for every call made by this client.

methodtemporalio.client._client.Client.config(*active_config:bool=False) -> ClientConfig

Config, as a dictionary, used to create this client.

method

temporalio.client._client.Client.count_workflows(query:str | None=None, rpc_metadata:Mapping[str, str | bytes]={}, rpc_timeout:timedelta | None=None) -> WorkflowExecutionCount

Count workflows.

methodtemporalio.client._client.Client.data_converter() -> temporalio.converter.DataConverter

Data converter used by this client.

methodtemporalio.client._client.Client.get_schedule_handle(id:str) -> ScheduleHandle

Get a schedule handle for the given ID.

methodtemporalio.client._client.Client.identity() -> str

Identity used in calls by this client.

method

temporalio.client._client.Client.list_schedules(query:str | None=None, *page_size:int=1000, *next_page_token:bytes | None=None, *rpc_metadata:Mapping[str, str | bytes]={}, *rpc_timeout:timedelta | None=None) -> ScheduleAsyncIterator

List schedules.

method

temporalio.client._client.Client.list_workflows(query:str | None=None, *limit:int | None=None, *page_size:int=1000, *next_page_token:bytes | None=None, *rpc_metadata:Mapping[str, str | bytes]={}, *rpc_timeout:timedelta | None=None) -> WorkflowExecutionAsyncIterator

List workflows.

methodtemporalio.client._client.Client.namespace() -> str

Namespace used in calls by this client.

methodtemporalio.client._client.Client.operator_service() -> temporalio.service.OperatorService

Raw gRPC operator service client.

methodtemporalio.client._client.Client.rpc_metadata() -> Mapping[str, str | bytes]

Headers for every call made by this client.

methodtemporalio.client._client.Client.service_client() -> temporalio.service.ServiceClient

Raw gRPC service client.

methodtemporalio.client._client.Client.workflow_service() -> temporalio.service.WorkflowService

Raw gRPC workflow service client.

classtemporalio.client._cloud.CloudOperationsClient

Client for accessing Temporal Cloud Operations API.

methodtemporalio.client._cloud.CloudOperationsClient.api_key() -> str | None

API key for every call made by this client.

methodtemporalio.client._cloud.CloudOperationsClient.cloud_service() -> temporalio.service.CloudService

Raw gRPC cloud service client.

methodtemporalio.client._cloud.CloudOperationsClient.identity() -> str

Identity used in calls by this client.

methodtemporalio.client._cloud.CloudOperationsClient.service_client() -> temporalio.service.ServiceClient

Raw gRPC service client.

classtemporalio.client._exceptions.ActivityFailureError

Error that occurs when an activity is unsuccessful.

methodtemporalio.client._exceptions.ActivityFailureError.cause() -> BaseException

Cause of the activity failure.

classtemporalio.client._exceptions.ScheduleAlreadyRunningError

Error when a schedule is already running.

classtemporalio.client._exceptions.WorkflowFailureError

Error that occurs when a workflow is unsuccessful.

methodtemporalio.client._exceptions.WorkflowFailureError.cause() -> BaseException

Cause of the workflow failure.

classtemporalio.client._exceptions.WorkflowQueryFailedError

Error that occurs when a query fails.

methodtemporalio.client._exceptions.WorkflowQueryFailedError.message() -> str

Get query failed message.

classtemporalio.client._exceptions.WorkflowQueryRejectedError

Error that occurs when a query was rejected.

classtemporalio.client._exceptions.WorkflowUpdateFailedError

Error that occurs when an update fails.

methodtemporalio.client._exceptions.WorkflowUpdateFailedError.cause() -> BaseException

Cause of the update failure.

classtemporalio.client._interceptor.DeleteScheduleInput

Input for :py:meth:`OutboundInterceptor.delete_schedule`.

classtemporalio.client._interceptor.Interceptor

Interceptor for clients.

methodtemporalio.client._interceptor.Interceptor.intercept_client(next:OutboundInterceptor) -> OutboundInterceptor

Method called for intercepting a client.

classtemporalio.client._interceptor.ListSchedulesInput

Input for :py:meth:`OutboundInterceptor.list_schedules`.

classtemporalio.client._interceptor.ListWorkflowsInput

Input for :py:meth:`OutboundInterceptor.list_workflows`.

classtemporalio.client._interceptor.OutboundInterceptor

OutboundInterceptor for intercepting client calls.

methodtemporalio.client._interceptor.OutboundInterceptor.pause_schedule(input:PauseScheduleInput) -> None

Called for every :py:meth:`ScheduleHandle.pause` call.

methodtemporalio.client._interceptor.OutboundInterceptor.query_workflow(input:QueryWorkflowInput) -> Any

Called for every :py:meth:`WorkflowHandle.query` call.

classtemporalio.client._interceptor.PauseScheduleInput

Input for :py:meth:`OutboundInterceptor.pause_schedule`.

classtemporalio.client._nexus.NexusClient

Client for starting standalone Nexus operations.

classtemporalio.client._nexus.NexusOperationExecutionCancellationInfo

Cancellation information for a Nexus Operation.

methodtemporalio.client._nexus.NexusOperationHandle.endpoint() -> str

Endpoint name.

methodtemporalio.client._nexus.NexusOperationHandle.operation_id() -> str

ID of the operation.

method

temporalio.client._nexus.NexusOperationHandle.result(*rpc_metadata:Mapping[str, str | bytes]={}, *rpc_timeout:timedelta | None=None) -> ReturnType

Wait for result of the Nexus operation.

methodtemporalio.client._nexus.NexusOperationHandle.run_id() -> str | None

Run ID of the operation.

methodtemporalio.client._nexus.NexusOperationHandle.service() -> str

Service name.

methodtemporalio.client._plugin.Plugin.name() -> str

Get the name of this plugin.

classtemporalio.client._schedule.Schedule

A schedule for periodically running an action.

classtemporalio.client._schedule.ScheduleAction

Base class for an action a schedule can take.

classtemporalio.client._schedule.ScheduleActionExecution

Base class for an action execution.

classtemporalio.client._schedule.ScheduleActionExecutionStartWorkflow

Execution of a scheduled workflow start.

classtemporalio.client._schedule.ScheduleActionResult

Information about when an action took place.

classtemporalio.client._schedule.ScheduleActionStartWorkflow

Schedule action to start a workflow.

classtemporalio.client._schedule.ScheduleDescription

Description of a schedule.

classtemporalio.client._schedule.ScheduleHandle

Handle for interacting with a schedule.

method

temporalio.client._schedule.ScheduleHandle.delete(*rpc_metadata:Mapping[str, str | bytes]={}, *rpc_timeout:timedelta | None=None) -> None

Delete this schedule.

method

temporalio.client._schedule.ScheduleHandle.describe(*rpc_metadata:Mapping[str, str | bytes]={}, *rpc_timeout:timedelta | None=None) -> ScheduleDescription

Fetch this schedule's description.

method

temporalio.client._schedule.ScheduleHandle.pause(*note:str | None=None, *rpc_metadata:Mapping[str, str | bytes]={}, *rpc_timeout:timedelta | None=None) -> None

Pause the schedule and set a note.

method

temporalio.client._schedule.ScheduleHandle.unpause(*note:str | None=None, *rpc_metadata:Mapping[str, str | bytes]={}, *rpc_timeout:timedelta | None=None) -> None

Unpause the schedule and set a note.

classtemporalio.client._schedule.ScheduleInfo

Information about a schedule.

classtemporalio.client._schedule.ScheduleIntervalSpec

Specification for scheduling on an interval.

classtemporalio.client._schedule.ScheduleListAction

Base class for an action a listed schedule can take.

classtemporalio.client._schedule.ScheduleListActionStartWorkflow

Action to start a workflow on a listed schedule.

classtemporalio.client._schedule.ScheduleListDescription

Description of a listed schedule.

classtemporalio.client._schedule.ScheduleListInfo

Information about a listed schedule.

classtemporalio.client._schedule.ScheduleListSchedule

Details for a listed schedule.

classtemporalio.client._schedule.ScheduleListState

State of a listed schedule.

classtemporalio.client._schedule.SchedulePolicy

Policies of a schedule.

classtemporalio.client._schedule.ScheduleRange

Inclusive range for a schedule match value.

classtemporalio.client._schedule.ScheduleSpec

Specification of the times scheduled actions may occur.

classtemporalio.client._schedule.ScheduleState

State of a schedule.

classtemporalio.client._workflow.WorkflowExecution

Info for a single workflow execution run.

methodtemporalio.client._workflow.WorkflowExecution.data_converter() -> temporalio.converter.DataConverter

Data converter for the workflow.

classtemporalio.client._workflow.WorkflowExecutionDescription

Description for a single workflow execution run.

classtemporalio.client._workflow.WorkflowExecutionStatus

Status of a workflow execution.

classtemporalio.client._workflow.WorkflowHandle

Handle for interacting with a workflow.

method

temporalio.client._workflow.WorkflowHandle.cancel(*reason:str='', *rpc_metadata:Mapping[str, str | bytes]={}, *rpc_timeout:timedelta | None=None) -> None

Cancel the workflow.

method

temporalio.client._workflow.WorkflowHandle.describe(*rpc_metadata:Mapping[str, str | bytes]={}, *rpc_timeout:timedelta | None=None) -> WorkflowExecutionDescription

Get workflow details.

method

temporalio.client._workflow.WorkflowHandle.get_update_handle(id:str, *workflow_run_id:str | None=None, *result_type:type | None=None) -> WorkflowUpdateHandle[Any]

Get a handle for an update.

methodtemporalio.client._workflow.WorkflowHandle.id() -> str

ID of the workflow.

method

temporalio.client._workflow.WorkflowHandle.result(*follow_runs:bool=True, *rpc_metadata:Mapping[str, str | bytes]={}, *rpc_timeout:timedelta | None=None) -> ReturnType

Wait for result of the workflow.

method

temporalio.client._workflow.WorkflowHandle.terminate(*reason:str | None=None, *rpc_metadata:Mapping[str, str | bytes]={}, *rpc_timeout:timedelta | None=None, *args:Any) -> None

Terminate the workflow.

classtemporalio.client._workflow.WorkflowHistory

A workflow's ID and immutable history.

methodtemporalio.client._workflow.WorkflowHistory.run_id() -> str

Run ID extracted from the first event.

methodtemporalio.client._workflow.WorkflowHistory.to_json() -> str

Convert this history to JSON.

methodtemporalio.client._workflow.WorkflowHistory.to_json_dict() -> dict[str, Any]

Convert this history to JSON-compatible dict.

classtemporalio.client._workflow.WorkflowHistoryEventFilterType

Type of history events to get for a workflow.

classtemporalio.client._workflow.WorkflowUpdateHandle

Handle for a workflow update execution request.

methodtemporalio.client._workflow.WorkflowUpdateHandle.id() -> str

ID of this Update request.

methodtemporalio.client._workflow.WorkflowUpdateHandle.workflow_id() -> str

The ID of the Workflow targeted by this Update.

classtemporalio.common.ActivityIDConflictPolicy

How already-running activity IDs are handled on start.

classtemporalio.common.ActivityIDReusePolicy

How already-closed activity IDs are handled on start.

classtemporalio.common.HeaderCodecBehavior

Different ways to handle header encoding

classtemporalio.common.MetricCommon

Base for all metrics.

methodtemporalio.common.MetricCommon.description() -> str | None

Description for the metric if any.

methodtemporalio.common.MetricCommon.name() -> str

Name for the metric.

methodtemporalio.common.MetricCommon.unit() -> str | None

Unit for the metric if any.

classtemporalio.common.MetricCounter

Counter metric created by a metric meter.

methodtemporalio.common.MetricCounter.add(value:int, additional_attributes:MetricAttributes | None=None) -> None

Add a value to the counter.

classtemporalio.common.MetricGauge

Gauge metric created by a metric meter.

methodtemporalio.common.MetricGauge.set(value:int, additional_attributes:MetricAttributes | None=None) -> None

Set a value on the gauge.

classtemporalio.common.MetricGaugeFloat

Gauge metric created by a metric meter.

methodtemporalio.common.MetricGaugeFloat.set(value:float, additional_attributes:MetricAttributes | None=None) -> None

Set a value on the gauge.

classtemporalio.common.MetricHistogram

Histogram metric created by a metric meter.

methodtemporalio.common.MetricHistogram.record(value:int, additional_attributes:MetricAttributes | None=None) -> None

Record a value on the histogram.

classtemporalio.common.MetricHistogramFloat

Histogram metric created by a metric meter.

methodtemporalio.common.MetricHistogramFloat.record(value:float, additional_attributes:MetricAttributes | None=None) -> None

Record a value on the histogram.

classtemporalio.common.MetricHistogramTimedelta

Histogram metric created by a metric meter.

method

temporalio.common.MetricHistogramTimedelta.record(value:timedelta, additional_attributes:MetricAttributes | None=None) -> None

Record a value on the histogram.

classtemporalio.common.MetricMeter

Metric meter for recording metrics.

method

temporalio.common.MetricMeter.create_counter(name:str, description:str | None=None, unit:str | None=None) -> MetricCounter

Create a counter metric for adding values.

methodtemporalio.common.MetricMeter.create_gauge(name:str, description:str | None=None, unit:str | None=None) -> MetricGauge

Create a gauge metric for setting values.

method

temporalio.common.MetricMeter.create_gauge_float(name:str, description:str | None=None, unit:str | None=None) -> MetricGaugeFloat

Create a gauge metric for setting values.

method

temporalio.common.MetricMeter.create_histogram(name:str, description:str | None=None, unit:str | None=None) -> MetricHistogram

Create a histogram metric for recording values.

classtemporalio.common.NexusOperationCancellationState

State of a Nexus operation cancellation.

classtemporalio.common.NexusOperationExecutionStatus

Status of a standalone Nexus operation execution.

classtemporalio.common.QueryRejectCondition

Whether a query should be rejected in certain conditions.

classtemporalio.common.RawValue

Representation of an unconverted, raw payload.

classtemporalio.common.RetryPolicy

Options for retrying workflows and activities.

methodtemporalio.common.RetryPolicy.apply_to_proto(proto:temporalio.api.common.v1.RetryPolicy) -> None

Apply the fields in this policy to the given proto object.

methodtemporalio.common.RetryPolicy.from_proto(proto:temporalio.api.common.v1.RetryPolicy) -> RetryPolicy

Create a retry policy from the proto object.

classtemporalio.common.SearchAttributeIndexedValueType

Server index type of a search attribute.

classtemporalio.common.SearchAttributeKey

Typed search attribute key representation.

methodtemporalio.common.SearchAttributeKey.for_bool(name:str) -> SearchAttributeKey[bool]

Create a 'Bool' search attribute type.

methodtemporalio.common.SearchAttributeKey.for_datetime(name:str) -> SearchAttributeKey[datetime]

Create a 'Datetime' search attribute type.

methodtemporalio.common.SearchAttributeKey.for_float(name:str) -> SearchAttributeKey[float]

Create a 'Double' search attribute type.

methodtemporalio.common.SearchAttributeKey.for_int(name:str) -> SearchAttributeKey[int]

Create an 'Int' search attribute type.

methodtemporalio.common.SearchAttributeKey.for_keyword(name:str) -> SearchAttributeKey[str]

Create a 'Keyword' search attribute type.

methodtemporalio.common.SearchAttributeKey.for_keyword_list(name:str) -> SearchAttributeKey[Sequence[str]]

Create a 'KeywordList' search attribute type.

methodtemporalio.common.SearchAttributeKey.for_text(name:str) -> SearchAttributeKey[str]

Create a 'Text' search attribute type.

methodtemporalio.common.SearchAttributeKey.indexed_value_type() -> SearchAttributeIndexedValueType

Get the server index typed of the key

methodtemporalio.common.SearchAttributeKey.name() -> str

Get the name of the key.

methodtemporalio.common.SearchAttributeKey.value_type() -> type[SearchAttributeValueType]

Get the Python type of value for the key.

classtemporalio.common.SearchAttributeUpdate

Representation of a search attribute update.

methodtemporalio.common.SearchAttributeUpdate.key() -> SearchAttributeKey[SearchAttributeValueType]

Key that is being set.

classtemporalio.common.TypedSearchAttributes

Collection of typed search attributes.

classtemporalio.common.WorkerDeploymentVersion

Represents the version of a specific worker deployment.

classtemporalio.common.WorkflowIDReusePolicy

How already-in-use workflow IDs are handled on start.

functemporalio.contrib.aws.lambda_worker._defaults.apply_lambda_worker_defaults(config:WorkerConfig) -> None

Apply Lambda-appropriate defaults to worker config.

func

temporalio.contrib.aws.lambda_worker._run_worker.run_worker(version:WorkerDeploymentVersion, configure:ConfigureCallback) -> Callable[[Any, Any], None]

Create a Temporal worker Lambda handler.

classtemporalio.contrib.aws.lambda_worker.otel.OtelOptions

Options for :py:func:`apply_defaults`.

classtemporalio.contrib.aws.s3driver._client.S3StorageDriverClient

Abstract base class for S3 object operations.

methodtemporalio.contrib.aws.s3driver._client.S3StorageDriverClient.put_object(*bucket:str, *key:str, *data:bytes) -> None

Upload *data* to the given S3 *bucket* and *key*.

classtemporalio.contrib.google_adk_agents._mcp.TemporalMcpToolSet

Temporal-aware MCP toolset implementation.

classtemporalio.contrib.google_adk_agents._model.StreamingInvokeInput

Input for :func:`invoke_model_streaming`.

functemporalio.contrib.google_adk_agents._model.invoke_model(llm_request:LlmRequest) -> list[LlmResponse]

Activity that invokes an LLM model.

functemporalio.contrib.google_adk_agents._model.invoke_model_streaming(input:StreamingInvokeInput) -> list[LlmResponse]

Streaming-aware model activity.

classtemporalio.contrib.google_adk_agents._plugin.GoogleAdkPlugin

A Temporal Worker Plugin configured for ADK.

functemporalio.contrib.langgraph._activity.clear_store_warning(run_id:str) -> None

Drop the store-warning dedupe entry for a workflow run.

functemporalio.contrib.langgraph._langgraph_config.strip_runnable_config(config:RunnableConfig | None) -> RunnableConfig

Return a serializable subset of a RunnableConfig.

classtemporalio.contrib.langgraph._plugin.LangGraphPlugin

LangGraph plugin for Temporal SDK.

func

temporalio.contrib.langgraph._plugin.entrypoint(name:str, cache:dict[str, Any] | None=None) -> Pregel[Any, Any, Any, Any]

Retrieve a registered entrypoint by name.

functemporalio.contrib.langgraph._plugin.graph(name:str, cache:dict[str, Any] | None=None) -> StateGraph[Any, Any, Any, Any]

Retrieve a registered graph by name.

functemporalio.contrib.langgraph._task_cache.cache_lookup(key:str) -> tuple[bool, Any]

Return (True, value) if cached, (False, None) otherwise.

functemporalio.contrib.langgraph._task_cache.cache_put(key:str, value:Any) -> None

Store a value in the task result cache.

functemporalio.contrib.langgraph._task_cache.set_task_cache(cache:dict[str, Any] | None) -> None

Set the task result cache for the current context.

functemporalio.contrib.langgraph._task_cache.task_id(func:Any) -> str

Return the fully-qualified module.qualname for a function.

classtemporalio.contrib.langsmith._plugin.LangSmithPlugin

LangSmith tracing plugin for Temporal SDK.

classtemporalio.contrib.openai_agents._invoke_model_activity.ActivityModelInput

Input for the invoke_model_activity activity.

functemporalio.contrib.openai_agents._mcp.StatefulMCPServerProvider.heartbeat_every(delay:float, *details:Any) -> None

Heartbeat every so often while not cancelled

classtemporalio.contrib.openai_agents._openai_runner.TemporalOpenAIRunner

Temporal Runner for OpenAI agents.

classtemporalio.contrib.openai_agents._temporal_openai_agents.OpenAIPayloadConverter

PayloadConverter for OpenAI agents.

classtemporalio.contrib.openai_agents.sandbox._temporal_activity_models.CreateSessionArgs

Arguments for create session activity.

classtemporalio.contrib.openai_agents.sandbox._temporal_activity_models.ExecArgs

Arguments for exec activity.

classtemporalio.contrib.openai_agents.sandbox._temporal_activity_models.ExecResult

Result of an exec activity.

classtemporalio.contrib.openai_agents.sandbox._temporal_activity_models.PersistWorkspaceResult

Result of a persist workspace activity.

classtemporalio.contrib.openai_agents.sandbox._temporal_activity_models.PtyExecStartArgs

Arguments for PTY exec start activity.

classtemporalio.contrib.openai_agents.sandbox._temporal_activity_models.PtyExecUpdateResult

Result of a PTY exec activity.

classtemporalio.contrib.openai_agents.sandbox._temporal_activity_models.PtyWriteStdinArgs

Arguments for PTY write stdin activity.

classtemporalio.contrib.openai_agents.sandbox._temporal_activity_models.ReadArgs

Arguments for read activity.

classtemporalio.contrib.openai_agents.sandbox._temporal_activity_models.ReadResult

Result of a read activity.

classtemporalio.contrib.openai_agents.sandbox._temporal_activity_models.ResumeSessionArgs

Arguments for resume session activity.

classtemporalio.contrib.openai_agents.sandbox._temporal_activity_models.RunningArgs

Arguments for running check activity.

classtemporalio.contrib.openai_agents.sandbox._temporal_activity_models.RunningResult

Result of a running check activity.

classtemporalio.contrib.openai_agents.sandbox._temporal_activity_models.StartArgs

Arguments for start activity.

classtemporalio.contrib.openai_agents.sandbox._temporal_activity_models.StopArgs

Arguments for stop activity.

classtemporalio.contrib.openai_agents.sandbox._temporal_activity_models.WriteArgs

Arguments for write activity.

classtemporalio.contrib.openai_agents.testing.ResponseBuilders

Builders for creating model responses for testing.

methodtemporalio.contrib.openai_agents.testing.ResponseBuilders.model_response(output:TResponseOutputItem) -> ModelResponse

Create a ModelResponse with the given output.

methodtemporalio.contrib.openai_agents.testing.ResponseBuilders.output_message(text:str) -> ModelResponse

Create a ModelResponse with an output message.

methodtemporalio.contrib.openai_agents.testing.ResponseBuilders.response_output_message(text:str) -> ResponseOutputMessage

Create a ResponseOutputMessage with text content.

methodtemporalio.contrib.openai_agents.testing.ResponseBuilders.tool_call(arguments:str, name:str) -> ModelResponse

Create a ModelResponse with a function tool call.

classtemporalio.contrib.openai_agents.testing.TestModel

Test model for use mocking model responses.

classtemporalio.contrib.opentelemetry._interceptor.TracingWorkflowInboundInterceptor

Tracing interceptor for workflow calls.

classtemporalio.contrib.opentelemetry._plugin.OpenTelemetryPlugin

OpenTelemetry plugin for Temporal SDK.

func

temporalio.contrib.opentelemetry.workflow.completed_span(name:str, *attributes:opentelemetry.util.types.Attributes=None, *exception:Exception | None=None) -> None

Create and end an OpenTelemetry span.

classtemporalio.contrib.pydantic.PydanticJSONPlainPayloadConverter

Pydantic JSON payload converter.

methodtemporalio.contrib.pydantic.PydanticJSONPlainPayloadConverter.encoding() -> str

See base class.

method

temporalio.contrib.pydantic.PydanticJSONPlainPayloadConverter.from_payload(payload:temporalio.api.common.v1.Payload, type_hint:type | None=None) -> Any

See base class.

method

temporalio.contrib.pydantic.PydanticJSONPlainPayloadConverter.to_payload(value:Any) -> temporalio.api.common.v1.Payload | None

See base class.

classtemporalio.contrib.pydantic.ToJsonOptions

Options for converting to JSON with pydantic.

classtemporalio.contrib.strands._plugin.StrandsPlugin

Temporal Worker plugin for the Strands Agents SDK.

classtemporalio.contrib.workflow_streams._types.PollInput

Update payload: request to poll for new items.

classtemporalio.contrib.workflow_streams._types.PollResult

Update response: items matching the poll request.

classtemporalio.contrib.workflow_streams._types.PublishEntry

A single entry to publish via signal (wire type).

classtemporalio.contrib.workflow_streams._types.PublishInput

Signal payload: batch of entries to publish.

classtemporalio.contrib.workflow_streams._types.PublisherState

Per-publisher dedup state.

classtemporalio.contrib.workflow_streams._types.WorkflowStreamItem

A single item in the workflow stream's log.

functemporalio.converter._data_converter.default() -> DataConverter

Default data converter.

classtemporalio.converter._extstore.ExternalStorage

Configuration for external storage behavior.

classtemporalio.converter._extstore.StorageWarning

Warning for external storage issues.

classtemporalio.converter._failure_converter.DefaultFailureConverter

Default failure converter.

method

temporalio.converter._failure_converter.DefaultFailureConverter.from_failure(failure:temporalio.api.failure.v1.Failure, payload_converter:PayloadConverter) -> BaseException

See base class.

method

temporalio.converter._failure_converter.DefaultFailureConverter.to_failure(exception:BaseException, payload_converter:PayloadConverter, failure:temporalio.api.failure.v1.Failure) -> None

See base class.

classtemporalio.converter._failure_converter.FailureConverter

Base failure converter to/from errors.

classtemporalio.converter._payload_codec.PayloadCodec

Codec for encoding/decoding to/from bytes.

method

temporalio.converter._payload_codec.PayloadCodec.decode(payloads:Sequence[temporalio.api.common.v1.Payload]) -> list[temporalio.api.common.v1.Payload]

Decode the given payloads.

methodtemporalio.converter._payload_codec.PayloadCodec.decode_failure(failure:temporalio.api.failure.v1.Failure) -> None

Decode payloads of a failure.

method

temporalio.converter._payload_codec.PayloadCodec.encode(payloads:Sequence[temporalio.api.common.v1.Payload]) -> list[temporalio.api.common.v1.Payload]

Encode the given payloads.

methodtemporalio.converter._payload_codec.PayloadCodec.encode_failure(failure:temporalio.api.failure.v1.Failure) -> None

Encode payloads of a failure.

classtemporalio.converter._payload_converter.AdvancedJSONEncoder

Advanced JSON encoder.

methodtemporalio.converter._payload_converter.AdvancedJSONEncoder.default(o:Any) -> Any

Override JSON encoding default.

func

temporalio.converter._payload_converter.value_to_type(hint:type, value:Any, custom_converters:Sequence[JSONTypeConverter]=[]) -> Any

Convert a given value to the given type hint.

func

temporalio.converter._search_attributes.decode_search_attributes(api:temporalio.api.common.v1.SearchAttributes) -> temporalio.common.SearchAttributes

Decode API search attributes to values.

classtemporalio.converter._serialization_context.ActivitySerializationContext

Serialization context for activities.

classtemporalio.converter._serialization_context.SerializationContext

Base serialization context.

classtemporalio.converter._serialization_context.WorkflowSerializationContext

Serialization context for workflows.

methodtemporalio.envconfig.ClientConfig.from_dict(d:Mapping[str, Mapping[str, Any]]) -> Self

Create a ClientConfig from a dictionary.

classtemporalio.envconfig.ClientConfigProfile

Represents a client configuration profile.

methodtemporalio.envconfig.ClientConfigProfile.from_dict(d:ClientConfigProfileDict) -> Self

Create a ClientConfigProfile from a dictionary.

classtemporalio.envconfig.ClientConfigTLSDict

Dictionary representation of TLS config for TOML.

classtemporalio.exceptions.ActivityError

Error raised on activity failure.

methodtemporalio.exceptions.ActivityError.activity_id() -> str

Activity ID for this error.

methodtemporalio.exceptions.ActivityError.activity_type() -> str

Activity type for this error.

methodtemporalio.exceptions.ActivityError.identity() -> str

Identity for this error.

methodtemporalio.exceptions.ActivityError.retry_state() -> RetryState | None

Retry state for this error.

methodtemporalio.exceptions.ActivityError.scheduled_event_id() -> int

Scheduled event ID for this error.

methodtemporalio.exceptions.ActivityError.started_event_id() -> int

Started event ID for this error.

classtemporalio.exceptions.ApplicationError

Error raised during workflow/activity execution.

methodtemporalio.exceptions.ApplicationError.category() -> ApplicationErrorCategory

Severity category of the application error

methodtemporalio.exceptions.ApplicationError.details() -> Sequence[Any]

User-defined details on the error.

methodtemporalio.exceptions.ApplicationError.next_retry_delay() -> timedelta | None

Delay before the next activity retry attempt.

methodtemporalio.exceptions.ApplicationError.type() -> str | None

General error type.

classtemporalio.exceptions.ApplicationErrorCategory

Severity category for your application error.

classtemporalio.exceptions.CancelledError

Error raised on workflow/activity cancellation.

methodtemporalio.exceptions.CancelledError.details() -> Sequence[Any]

User-defined details on the error.

classtemporalio.exceptions.ChildWorkflowError

Error raised on child workflow failure.

methodtemporalio.exceptions.ChildWorkflowError.initiated_event_id() -> int

Initiated event ID for this error.

methodtemporalio.exceptions.ChildWorkflowError.namespace() -> str

Namespace for this error.

methodtemporalio.exceptions.ChildWorkflowError.retry_state() -> RetryState | None

Retry state for this error.

methodtemporalio.exceptions.ChildWorkflowError.run_id() -> str

Run ID for this error.

methodtemporalio.exceptions.ChildWorkflowError.started_event_id() -> int

Started event ID for this error.

methodtemporalio.exceptions.ChildWorkflowError.workflow_id() -> str

Workflow ID for this error.

methodtemporalio.exceptions.ChildWorkflowError.workflow_type() -> str

Workflow type for this error.

classtemporalio.exceptions.FailureError

Base for runtime failures during workflow/activity execution.

methodtemporalio.exceptions.FailureError.failure() -> temporalio.api.failure.v1.Failure | None

Underlying protobuf failure object.

methodtemporalio.exceptions.FailureError.message() -> str

Message.

methodtemporalio.exceptions.NexusOperationError.endpoint() -> str

The endpoint name for the failed operation.

methodtemporalio.exceptions.NexusOperationError.operation() -> str

The name of the failed operation.

methodtemporalio.exceptions.NexusOperationError.service() -> str

The service name for the failed operation.

classtemporalio.exceptions.RetryState

Current retry state of the workflow/activity during error.

classtemporalio.exceptions.ServerError

Error originating in the Temporal server.

methodtemporalio.exceptions.ServerError.non_retryable() -> bool

Whether this error is non-retryable.

classtemporalio.exceptions.TemporalError

Base for all Temporal exceptions.

methodtemporalio.exceptions.TemporalError.cause() -> BaseException | None

Cause of the exception.

classtemporalio.exceptions.TerminatedError

Error raised on workflow cancellation.

methodtemporalio.exceptions.TerminatedError.details() -> Sequence[Any]

User-defined details on the error.

classtemporalio.exceptions.TimeoutError

Error raised on workflow/activity timeout.

methodtemporalio.exceptions.TimeoutError.type() -> TimeoutType | None

Type of timeout error.

classtemporalio.exceptions.TimeoutType

Type of timeout for :py:class:`TimeoutError`.

func

temporalio.nexus._link_conversion.activity_link_to_nexus_link(activity:temporalio.api.common.v1.Link.Activity) -> nexusrpc.Link

Convert an Activity link into a nexusrpc link.

func

temporalio.nexus._link_conversion.workflow_to_nexus_link(workflow:temporalio.api.common.v1.Link.Workflow) -> nexusrpc.Link

Convert a Workflow link into a nexusrpc link.

classtemporalio.nexus._operation_context.Info

Information about the running Nexus operation.

classtemporalio.nexus._operation_context.WorkflowRunOperationContext

Context received by a workflow run operation.

methodtemporalio.nexus._operation_context.WorkflowRunOperationContext.metric_meter() -> temporalio.common.MetricMeter

The metric meter

functemporalio.nexus._operation_context.in_operation() -> bool

Whether the current code is inside a Nexus operation.

functemporalio.nexus._operation_context.info() -> Info

Get the current Nexus operation information.

functemporalio.nexus._operation_context.is_worker_shutdown() -> bool

Whether shutdown has been invoked on the worker.

classtemporalio.nexus._temporal_client.TemporalNexusClient

Nexus-aware wrapper around a Temporal Client.

methodtemporalio.nexus._temporal_client.TemporalNexusClient.client() -> temporalio.client.Client

The underlying Temporal Client ..

classtemporalio.nexus._temporal_client.TemporalOperationResult

Unified result: sync value or async token.

classtemporalio.nexus._token.OperationToken

Serializable token identifying a Nexus operation target.

methodtemporalio.nexus._token.OperationToken.encode() -> str

Convert handle to a base64url-encoded token string.

classtemporalio.nexus._token.OperationTokenType

Type discriminator for Nexus operation tokens.

classtemporalio.nexus._token.WorkflowHandle

A handle to a workflow that is backing a Nexus operation.

methodtemporalio.nexus._token.WorkflowHandle.to_token() -> str

Convert handle to a base64url-encoded token string.

functemporalio.nexus._util.get_callable_name(fn:Callable[..., Any]) -> str

Return the name of a callable object.

functemporalio.nexus._util.is_async_callable(obj:Any) -> bool

Return True if ``obj`` is an async callable.

functemporalio.nexus.system.is_system_endpoint(endpoint:str) -> bool

Return whether a Nexus endpoint is the Temporal system endpoint.

classtemporalio.nexus.system.workflow_service.models.SignalWithStartWorkflowRequest

classtemporalio.nexus.system.workflow_service.service.WorkflowService

classtemporalio.runtime.BufferedMetric

A metric for a buffered update.

methodtemporalio.runtime.BufferedMetric.description() -> str | None

Get the description of the metric if any.

methodtemporalio.runtime.BufferedMetric.kind() -> BufferedMetricKind

Get the metric kind.

methodtemporalio.runtime.BufferedMetric.name() -> str

Get the name of the metric.

methodtemporalio.runtime.BufferedMetric.unit() -> str | None

Get the unit of the metric if any.

classtemporalio.runtime.BufferedMetricUpdate

A single metric value update.

methodtemporalio.runtime.BufferedMetricUpdate.attributes() -> temporalio.common.MetricAttributes

Attributes for the update.

methodtemporalio.runtime.BufferedMetricUpdate.metric() -> BufferedMetric

Metric being updated.

methodtemporalio.runtime.BufferedMetricUpdate.value() -> int | float

Value for the update.

classtemporalio.runtime.LogForwardingConfig

Configuration for log forwarding from Core.

classtemporalio.runtime.LoggingConfig

Configuration for runtime logging.

classtemporalio.runtime.MetricBufferDurationFormat

How durations are represented for metrics buffers.

classtemporalio.runtime.OpenTelemetryConfig

Configuration for OpenTelemetry collector.

classtemporalio.runtime.OpenTelemetryMetricTemporality

Temporality for OpenTelemetry metrics.

classtemporalio.runtime.PrometheusConfig

Configuration for Prometheus metrics endpoint.

classtemporalio.runtime.Runtime

Runtime for Temporal Python SDK.

methodtemporalio.runtime.Runtime.default() -> Runtime

Get the default runtime, creating if not already created.

methodtemporalio.runtime.Runtime.metric_meter() -> temporalio.common.MetricMeter

Metric meter for this runtime.

methodtemporalio.runtime.Runtime.set_default(runtime:Runtime, *error_if_already_set:bool=True) -> None

Set the default runtime to the given runtime.

classtemporalio.runtime.TelemetryConfig

Configuration for Core telemetry.

classtemporalio.runtime.TelemetryFilter

Filter for telemetry use.

methodtemporalio.runtime.TelemetryFilter.formatted() -> str

Return a formatted form of this filter.

classtemporalio.service.CloudService

Client to the Temporal server's cloud service.

classtemporalio.service.ConnectConfig

Config for connecting to the server.

classtemporalio.service.DnsLoadBalancingConfig

DNS load balancing configuration for client connections.

classtemporalio.service.GrpcCompression

Transport-level gRPC compression mode.

classtemporalio.service.HealthService

Client to the Temporal server's health service.

classtemporalio.service.KeepAliveConfig

Keep-alive configuration for client connections.

About this data

These signatures were extracted from the public source of temporalio/sdk-python using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries