Skip to content

Remove experimental warnings for worker versioning and envconfig #1315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
THardy98 merged 6 commits into from
Feb 3, 2026
Merged

Remove experimental warnings for worker versioning and envconfig #1315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2b0d78d
Remove experimental warnings for worker versioning and envconfig, for…
THardy98 Feb 3, 2026
d6a03c2
mark old worker versioning client-side APIs as deprecated
THardy98 Feb 3, 2026
b7fdf68
more experimental notice removals (forgot to save file)
THardy98 Feb 3, 2026
91a0edd
add deprecation arguments
THardy98 Feb 3, 2026
47a985d
Merge branch 'main' into remove-experimental-worker-versioning-and-en…
THardy98 Feb 3, 2026
13f76a0
formatting
THardy98 Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions temporalio/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1094,9 +1094,6 @@ async def start_update_with_start_workflow(
means that the call will not return successfully until the update has been
delivered to a worker.

.. warning::
This API is experimental

Args:
update: Update function or name on the workflow. arg: Single argument to the
update.
Expand Down Expand Up @@ -1431,8 +1428,8 @@ async def update_worker_build_id_compatibility(

For more on this feature, see https://docs.temporal.io/workers#worker-versioning

.. warning::
This API is experimental
.. deprecated::
Legacy API, see the docs above for new usage

Args:
task_queue: The task queue to target.
Expand Down Expand Up @@ -1461,8 +1458,8 @@ async def get_worker_build_id_compatibility(

For more on this feature, see https://docs.temporal.io/workers#worker-versioning

.. warning::
This API is experimental
.. deprecated::
Legacy API, see the docs above for new usage

Args:
task_queue: The task queue to target.
Expand Down Expand Up @@ -1493,8 +1490,8 @@ async def get_worker_task_reachability(

For more on this feature, see https://docs.temporal.io/workers#worker-versioning

.. warning::
This API is experimental
.. deprecated::
Legacy API, see the docs above for new usage

Args:
build_ids: The Build IDs to query the reachability of. At least one must be specified.
Expand Down
28 changes: 5 additions & 23 deletions temporalio/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1040,10 +1040,7 @@ def __post_init__(self):


class VersioningBehavior(IntEnum):
"""Specifies when a workflow might move from a worker of one Build Id to another.

WARNING: Experimental API.
"""
"""Specifies when a workflow might move from a worker of one Build Id to another."""

UNSPECIFIED = (
temporalio.api.enums.v1.VersioningBehavior.VERSIONING_BEHAVIOR_UNSPECIFIED
Expand All @@ -1061,10 +1058,7 @@ class VersioningBehavior(IntEnum):

@dataclass(frozen=True)
class WorkerDeploymentVersion:
"""Represents the version of a specific worker deployment.

WARNING: Experimental API.
"""
"""Represents the version of a specific worker deployment."""

deployment_name: str
build_id: str
Expand Down Expand Up @@ -1094,11 +1088,7 @@ def _to_proto(self) -> temporalio.api.deployment.v1.WorkerDeploymentVersion:


class VersioningOverride(ABC):
"""Represents the override of a worker's versioning behavior for a workflow execution.

.. warning::
Experimental API.
"""
"""Represents the override of a worker's versioning behavior for a workflow execution."""

@abstractmethod
def _to_proto(self) -> temporalio.api.workflow.v1.VersioningOverride:
Expand All @@ -1108,11 +1098,7 @@ def _to_proto(self) -> temporalio.api.workflow.v1.VersioningOverride:

@dataclass(frozen=True)
class PinnedVersioningOverride(VersioningOverride):
"""Workflow will be pinned to a specific deployment version.

.. warning::
Experimental API.
"""
"""Workflow will be pinned to a specific deployment version."""

version: WorkerDeploymentVersion

Expand All @@ -1131,11 +1117,7 @@ def _to_proto(self) -> temporalio.api.workflow.v1.VersioningOverride:

@dataclass(frozen=True)
class AutoUpgradeVersioningOverride(VersioningOverride):
"""The workflow will auto-upgrade to the current deployment version on the next workflow task.

.. warning::
Experimental API.
"""
"""The workflow will auto-upgrade to the current deployment version on the next workflow task."""

def _to_proto(self) -> temporalio.api.workflow.v1.VersioningOverride:
"""Convert to proto representation."""
Expand Down
15 changes: 1 addition & 14 deletions temporalio/envconfig.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,7 @@ def _read_source(source: DataSource | None) -> bytes | None:

@dataclass(frozen=True)
class ClientConfigTLS:
"""TLS configuration as specified as part of client configuration

.. warning::
Experimental API.
"""
"""TLS configuration as specified as part of client configuration"""

disabled: bool | None = None
"""If True, TLS is explicitly disabled. If False, TLS is explicitly enabled. If None, TLS behavior was not configured."""
Expand Down Expand Up @@ -168,9 +164,6 @@ def from_dict(cls, d: ClientConfigTLSDict | None) -> Self | None:
class ClientConnectConfig(TypedDict, total=False):
"""Arguments for `temporalio.client.Client.connect` that are configurable via
environment configuration.

.. warning::
Experimental API.
"""

target_host: str
Expand All @@ -187,9 +180,6 @@ class ClientConfigProfile:
This class holds the configuration as loaded from a file or environment.
See `to_client_connect_config` to transform the profile to `ClientConnectConfig`,
which can be used to create a client.

.. warning::
Experimental API.
"""

address: str | None = None
Expand Down Expand Up @@ -307,9 +297,6 @@ class ClientConfig:
This contains a mapping of profile names to client profiles. Use
`ClientConfigProfile.to_client_connect_config` to create a `ClientConnectConfig`
from a profile. See `ClientConfigProfile.load` to load an individual profile.

.. warning::
Experimental API.
"""

profiles: Mapping[str, ClientConfigProfile]
Expand Down
5 changes: 1 addition & 4 deletions temporalio/worker/_worker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -957,10 +957,7 @@ def _warn_if_nexus_task_executor_max_workers_is_inconsistent(

@dataclass
class WorkerDeploymentConfig:
"""Options for configuring the Worker Versioning feature.

WARNING: This is an experimental feature and may change in the future.
"""
"""Options for configuring the Worker Versioning feature."""

version: WorkerDeploymentVersion
use_worker_versioning: bool
Expand Down
3 changes: 0 additions & 3 deletions temporalio/workflow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,6 @@ def defn(
``Exception`` is set, it effectively will fail a workflow/update in
all user exception cases. WARNING: This setting is experimental.
versioning_behavior: Specifies the versioning behavior to use for this workflow.
WARNING: This setting is experimental.
"""

def decorator(cls: ClassType) -> ClassType:
Expand Down Expand Up @@ -444,8 +443,6 @@ class DynamicWorkflowConfig:
"""Specifies the versioning behavior to use for this workflow.

Always overrides the equivalent parameter on :py:func:`defn`.

WARNING: This setting is experimental.
"""


Expand Down