Skip to content

Commit b09449c

Browse files
authored
Remove experimental warnings for worker versioning and envconfig (#1315)
* Remove experimental warnings for worker versioning and envconfig, for GA (also a lingering warning for UwS) * mark old worker versioning client-side APIs as deprecated * more experimental notice removals (forgot to save file) * add deprecation arguments * formatting
1 parent 425a2bf commit b09449c

5 files changed

Lines changed: 13 additions & 53 deletions

File tree

temporalio/client.py

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1094,9 +1094,6 @@ async def start_update_with_start_workflow(
10941094
means that the call will not return successfully until the update has been
10951095
delivered to a worker.
10961096
1097-
.. warning::
1098-
This API is experimental
1099-
11001097
Args:
11011098
update: Update function or name on the workflow. arg: Single argument to the
11021099
update.
@@ -1431,8 +1428,8 @@ async def update_worker_build_id_compatibility(
14311428
14321429
For more on this feature, see https://docs.temporal.io/workers#worker-versioning
14331430
1434-
.. warning::
1435-
This API is experimental
1431+
.. deprecated::
1432+
Legacy API, see the docs above for new usage
14361433
14371434
Args:
14381435
task_queue: The task queue to target.
@@ -1461,8 +1458,8 @@ async def get_worker_build_id_compatibility(
14611458
14621459
For more on this feature, see https://docs.temporal.io/workers#worker-versioning
14631460
1464-
.. warning::
1465-
This API is experimental
1461+
.. deprecated::
1462+
Legacy API, see the docs above for new usage
14661463
14671464
Args:
14681465
task_queue: The task queue to target.
@@ -1493,8 +1490,8 @@ async def get_worker_task_reachability(
14931490
14941491
For more on this feature, see https://docs.temporal.io/workers#worker-versioning
14951492
1496-
.. warning::
1497-
This API is experimental
1493+
.. deprecated::
1494+
Legacy API, see the docs above for new usage
14981495
14991496
Args:
15001497
build_ids: The Build IDs to query the reachability of. At least one must be specified.

temporalio/common.py

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1040,10 +1040,7 @@ def __post_init__(self):
10401040

10411041

10421042
class VersioningBehavior(IntEnum):
1043-
"""Specifies when a workflow might move from a worker of one Build Id to another.
1044-
1045-
WARNING: Experimental API.
1046-
"""
1043+
"""Specifies when a workflow might move from a worker of one Build Id to another."""
10471044

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

10621059
@dataclass(frozen=True)
10631060
class WorkerDeploymentVersion:
1064-
"""Represents the version of a specific worker deployment.
1065-
1066-
WARNING: Experimental API.
1067-
"""
1061+
"""Represents the version of a specific worker deployment."""
10681062

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

10951089

10961090
class VersioningOverride(ABC):
1097-
"""Represents the override of a worker's versioning behavior for a workflow execution.
1098-
1099-
.. warning::
1100-
Experimental API.
1101-
"""
1091+
"""Represents the override of a worker's versioning behavior for a workflow execution."""
11021092

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

11091099
@dataclass(frozen=True)
11101100
class PinnedVersioningOverride(VersioningOverride):
1111-
"""Workflow will be pinned to a specific deployment version.
1112-
1113-
.. warning::
1114-
Experimental API.
1115-
"""
1101+
"""Workflow will be pinned to a specific deployment version."""
11161102

11171103
version: WorkerDeploymentVersion
11181104

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

11321118
@dataclass(frozen=True)
11331119
class AutoUpgradeVersioningOverride(VersioningOverride):
1134-
"""The workflow will auto-upgrade to the current deployment version on the next workflow task.
1135-
1136-
.. warning::
1137-
Experimental API.
1138-
"""
1120+
"""The workflow will auto-upgrade to the current deployment version on the next workflow task."""
11391121

11401122
def _to_proto(self) -> temporalio.api.workflow.v1.VersioningOverride:
11411123
"""Convert to proto representation."""

temporalio/envconfig.py

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -100,11 +100,7 @@ def _read_source(source: DataSource | None) -> bytes | None:
100100

101101
@dataclass(frozen=True)
102102
class ClientConfigTLS:
103-
"""TLS configuration as specified as part of client configuration
104-
105-
.. warning::
106-
Experimental API.
107-
"""
103+
"""TLS configuration as specified as part of client configuration"""
108104

109105
disabled: bool | None = None
110106
"""If True, TLS is explicitly disabled. If False, TLS is explicitly enabled. If None, TLS behavior was not configured."""
@@ -168,9 +164,6 @@ def from_dict(cls, d: ClientConfigTLSDict | None) -> Self | None:
168164
class ClientConnectConfig(TypedDict, total=False):
169165
"""Arguments for `temporalio.client.Client.connect` that are configurable via
170166
environment configuration.
171-
172-
.. warning::
173-
Experimental API.
174167
"""
175168

176169
target_host: str
@@ -187,9 +180,6 @@ class ClientConfigProfile:
187180
This class holds the configuration as loaded from a file or environment.
188181
See `to_client_connect_config` to transform the profile to `ClientConnectConfig`,
189182
which can be used to create a client.
190-
191-
.. warning::
192-
Experimental API.
193183
"""
194184

195185
address: str | None = None
@@ -307,9 +297,6 @@ class ClientConfig:
307297
This contains a mapping of profile names to client profiles. Use
308298
`ClientConfigProfile.to_client_connect_config` to create a `ClientConnectConfig`
309299
from a profile. See `ClientConfigProfile.load` to load an individual profile.
310-
311-
.. warning::
312-
Experimental API.
313300
"""
314301

315302
profiles: Mapping[str, ClientConfigProfile]

temporalio/worker/_worker.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -957,10 +957,7 @@ def _warn_if_nexus_task_executor_max_workers_is_inconsistent(
957957

958958
@dataclass
959959
class WorkerDeploymentConfig:
960-
"""Options for configuring the Worker Versioning feature.
961-
962-
WARNING: This is an experimental feature and may change in the future.
963-
"""
960+
"""Options for configuring the Worker Versioning feature."""
964961

965962
version: WorkerDeploymentVersion
966963
use_worker_versioning: bool

temporalio/workflow.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,6 @@ def defn(
139139
``Exception`` is set, it effectively will fail a workflow/update in
140140
all user exception cases. WARNING: This setting is experimental.
141141
versioning_behavior: Specifies the versioning behavior to use for this workflow.
142-
WARNING: This setting is experimental.
143142
"""
144143

145144
def decorator(cls: ClassType) -> ClassType:
@@ -444,8 +443,6 @@ class DynamicWorkflowConfig:
444443
"""Specifies the versioning behavior to use for this workflow.
445444
446445
Always overrides the equivalent parameter on :py:func:`defn`.
447-
448-
WARNING: This setting is experimental.
449446
"""
450447

451448

0 commit comments

Comments
 (0)