temporalio.common

module documentation
(source)

Common code used in the Temporal SDK.

Class AutoUpgradeVersioningOverride The workflow will auto-upgrade to the current deployment version on the next workflow task.
Class MetricCommon Base for all metrics.
Class MetricCounter Counter metric created by a metric meter.
Class MetricGauge Gauge metric created by a metric meter.
Class MetricGaugeFloat Gauge metric created by a metric meter.
Class MetricHistogram Histogram metric created by a metric meter.
Class MetricHistogramFloat Histogram metric created by a metric meter.
Class MetricHistogramTimedelta Histogram metric created by a metric meter.
Class MetricMeter Metric meter for recording metrics.
Class PinnedVersioningOverride Workflow will be pinned to a specific deployment version.
Class Priority Priority contains metadata that controls relative ordering of task processing when tasks are backlogged in a queue. Initially, Priority will be used in activity and workflow task queues, which are typically where backlogs exist.
Class QueryRejectCondition Whether a query should be rejected in certain conditions.
Class RawValue Representation of an unconverted, raw payload.
Class RetryPolicy Options for retrying workflows and activities.
Class SearchAttributeIndexedValueType Server index type of a search attribute.
Class SearchAttributeKey Typed search attribute key representation.
Class SearchAttributePair A named tuple representing a key/value search attribute pair.
Class SearchAttributeUpdate Representation of a search attribute update.
Class TypedSearchAttributes Collection of typed search attributes.
Class VersioningBehavior Specifies when a workflow might move from a worker of one Build Id to another.
Class VersioningOverride Represents the override of a worker's versioning behavior for a workflow execution.
Class WorkflowIDConflictPolicy How already-running workflows of the same ID are handled on start.
Class WorkflowIDReusePolicy How already-in-use workflow IDs are handled on start.
Type Variable SearchAttributeValueType Undocumented
Type Alias MetricAttributes Undocumented
Type Alias SearchAttributes Undocumented
Type Alias SearchAttributeValue Undocumented
Type Alias SearchAttributeValues Undocumented
Class _NoopMetric Undocumented
Class _NoopMetricCounter Undocumented
Class _NoopMetricGauge Undocumented
Class _NoopMetricGaugeFloat Undocumented
Class _NoopMetricHistogram Undocumented
Class _NoopMetricHistogramFloat Undocumented
Class _NoopMetricHistogramTimedelta Undocumented
Class _NoopMetricMeter Undocumented
Class _SearchAttributeKey Undocumented
Class _SearchAttributeUpdate Undocumented
Function _apply_headers Undocumented
Function _arg_or_args Undocumented
Function _type_hints_from_func Extracts the type hints from the function.
Function _warn_on_deprecated_search_attributes Undocumented
Variable _arg_unset Undocumented
Variable _non_user_defined_callables Undocumented
SearchAttributeValueType = (source)

Undocumented

Value
TypeVar('SearchAttributeValueType',
        str,
        int,
        float,
        bool,
        datetime,
        Sequence[str])
MetricAttributes: TypeAlias = (source)

Undocumented

Value
Mapping[str, str | int | float | bool]
SearchAttributes: TypeAlias = (source)

Undocumented

Value
Mapping[str, SearchAttributeValues]
SearchAttributeValue: TypeAlias = (source)

Undocumented

Value
str | int | float | bool | datetime | Sequence[str]
SearchAttributeValues: TypeAlias = (source)

Undocumented

Value
list[str] | list[int] | list[float] | list[bool] | list[datetime]
def _apply_headers(source: Mapping[str, temporalio.api.common.v1.Payload] | None, dest: google.protobuf.internal.containers.MessageMap[str, temporalio.api.common.v1.Payload]): (source)

Undocumented

def _arg_or_args(arg: Any, args: Sequence[Any]) -> Sequence[Any]: (source)

Undocumented

def _type_hints_from_func(func: Callable) -> tuple[list[type] | None, type | None]: (source)

Extracts the type hints from the function.

Parameters
func:CallableFunction to extract hints from.
Returns
tuple[list[type] | None, type | None]Tuple containing parameter types and return type. The parameter types will be None if there are any non-positional parameters or if any of the parameters to not have an annotation that represents a class. If the first parameter is "self" with no attribute, it is not included.
def _warn_on_deprecated_search_attributes(attributes: SearchAttributes | Any | None, stack_level: int = 2): (source)

Undocumented

_arg_unset = (source)

Undocumented

_non_user_defined_callables = (source)

Undocumented