Skip to content

Commit 8a9806d

Browse files
committed
chore: remove FDv2 pre-release warnings for GA promotion
FDv2 / data-saving mode is going GA per the SDK release-standards spec. Removes the pre-release warning prose ("not stable, and not subject to any backwards compatibility guarantees", "not suitable for production usage", "You have been warned") from FDv2-related docstrings. Descriptive docstrings are preserved. SDK-2349
1 parent 4d1d409 commit 8a9806d

6 files changed

Lines changed: 0 additions & 140 deletions

File tree

ldclient/impl/datasourcev2/__init__.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,4 @@
66
and are not part of the public API of the LaunchDarkly Python SDK.
77
They are subject to change without notice and should not be used directly
88
by users of the SDK.
9-
10-
You have been warned.
119
"""

ldclient/impl/datasystem/protocolv2.py

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,6 @@
1212
class DeleteObject:
1313
"""
1414
Specifies the deletion of a particular object.
15-
16-
This type is not stable, and not subject to any backwards
17-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
18-
19-
Do not use it.
20-
You have been warned.
2115
"""
2216

2317
version: int
@@ -59,12 +53,6 @@ def from_dict(data: dict) -> "DeleteObject":
5953
class PutObject:
6054
"""
6155
Specifies the addition of a particular object with upsert semantics.
62-
63-
This type is not stable, and not subject to any backwards
64-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
65-
66-
Do not use it.
67-
You have been warned.
6856
"""
6957

7058
version: int
@@ -111,12 +99,6 @@ def from_dict(data: dict) -> "PutObject":
11199
class Goodbye:
112100
"""
113101
Goodbye represents a goodbye event.
114-
115-
This type is not stable, and not subject to any backwards
116-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
117-
118-
Do not use it.
119-
You have been warned.
120102
"""
121103

122104
reason: str
@@ -146,12 +128,6 @@ def from_dict(data: dict) -> "Goodbye":
146128
class Error:
147129
"""
148130
Error represents an error event.
149-
150-
This type is not stable, and not subject to any backwards
151-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
152-
153-
Do not use it.
154-
You have been warned.
155131
"""
156132

157133
payload_id: str

ldclient/impl/integrations/files/file_data_sourcev2.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,6 @@ class _FileDataSourceV2:
5050
"""
5151
Internal implementation of both Initializer and Synchronizer protocols for file-based data.
5252
53-
This type is not stable, and not subject to any backwards
54-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
55-
56-
Do not use it.
57-
You have been warned.
58-
5953
This component reads feature flag and segment data from local files and provides them
6054
via the FDv2 protocol interfaces. Each instance implements both Initializer and Synchronizer
6155
protocols:

ldclient/integrations/__init__.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -289,12 +289,6 @@ def new_data_source(paths: List[str], auto_update: bool = False, poll_interval:
289289
def new_data_source_v2(paths: str | List[str], poll_interval: float = 1, force_polling: bool = False) -> DataSourceBuilder:
290290
"""Provides a way to use local files as a source of feature flag state using the FDv2 protocol.
291291
292-
This type is not stable, and not subject to any backwards
293-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
294-
295-
Do not use it.
296-
You have been warned.
297-
298292
This returns a builder that can be used with the FDv2 data system configuration as both an
299293
Initializer and a Synchronizer. When used as an Initializer, it reads files once. When used
300294
as a Synchronizer, it watches for file changes and automatically updates when files are modified.

ldclient/integrations/test_datav2.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -540,12 +540,6 @@ class TestDataV2:
540540
A mechanism for providing dynamically updatable feature flag state in a
541541
simplified form to an SDK client in test scenarios using the FDv2 protocol.
542542
543-
This type is not stable, and not subject to any backwards
544-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
545-
546-
Do not use it.
547-
You have been warned.
548-
549543
Unlike ``Files``, this mechanism does not use any external resources. It provides only
550544
the data that the application has put into it using the ``update`` method.
551545
::

ldclient/interfaces.py

Lines changed: 0 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,6 @@ class DataStoreMode(Enum):
1919
"""
2020
DataStoreMode represents the mode of operation of a Data Store in FDV2
2121
mode.
22-
23-
This enum is not stable, and not subject to any backwards compatibility
24-
guarantees or semantic versioning. It is not suitable for production usage.
25-
26-
Do not use it.
27-
You have been warned.
2822
"""
2923

3024
READ_ONLY = 'read-only'
@@ -1143,12 +1137,6 @@ def remove_listener(self, listener: Callable[[DataStoreStatus], None]):
11431137
class EventName(str, Enum):
11441138
"""
11451139
EventName represents the name of an event that can be sent by the server for FDv2.
1146-
1147-
This type is not stable, and not subject to any backwards
1148-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
1149-
1150-
Do not use it.
1151-
You have been warned.
11521140
"""
11531141

11541142
PUT_OBJECT = "put-object"
@@ -1192,12 +1180,6 @@ class EventName(str, Enum):
11921180
class Selector:
11931181
"""
11941182
Selector represents a particular snapshot of data.
1195-
1196-
This type is not stable, and not subject to any backwards
1197-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
1198-
1199-
Do not use it.
1200-
You have been warned.
12011183
"""
12021184

12031185
state: str = ""
@@ -1252,12 +1234,6 @@ def from_dict(data: dict) -> "Selector":
12521234
class ChangeType(Enum):
12531235
"""
12541236
ChangeType specifies if an object is being upserted or deleted.
1255-
1256-
This type is not stable, and not subject to any backwards
1257-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
1258-
1259-
Do not use it.
1260-
You have been warned.
12611237
"""
12621238

12631239
PUT = "put"
@@ -1274,12 +1250,6 @@ class ChangeType(Enum):
12741250
class ObjectKind(str, Enum):
12751251
"""
12761252
ObjectKind represents the kind of object.
1277-
1278-
This type is not stable, and not subject to any backwards
1279-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
1280-
1281-
Do not use it.
1282-
You have been warned.
12831253
"""
12841254

12851255
FLAG = "flag"
@@ -1290,12 +1260,6 @@ class ObjectKind(str, Enum):
12901260
class Change:
12911261
"""
12921262
Change represents a change to a piece of data, such as an update or deletion.
1293-
1294-
This type is not stable, and not subject to any backwards
1295-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
1296-
1297-
Do not use it.
1298-
You have been warned.
12991263
"""
13001264

13011265
action: ChangeType
@@ -1308,12 +1272,6 @@ class Change:
13081272
class IntentCode(str, Enum):
13091273
"""
13101274
IntentCode represents the various intents that can be sent by the server.
1311-
1312-
This type is not stable, and not subject to any backwards
1313-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
1314-
1315-
Do not use it.
1316-
You have been warned.
13171275
"""
13181276

13191277
TRANSFER_FULL = "xfer-full"
@@ -1336,12 +1294,6 @@ class IntentCode(str, Enum):
13361294
class ChangeSet:
13371295
"""
13381296
ChangeSet represents a list of changes to be applied.
1339-
1340-
This type is not stable, and not subject to any backwards
1341-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
1342-
1343-
Do not use it.
1344-
You have been warned.
13451297
"""
13461298

13471299
intent_code: IntentCode
@@ -1355,12 +1307,6 @@ class Basis:
13551307
Basis represents the initial payload of data that a data source can
13561308
provide. Initializers provide this via fetch, whereas Synchronizers provide
13571309
it asynchronously.
1358-
1359-
This type is not stable, and not subject to any backwards
1360-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
1361-
1362-
Do not use it.
1363-
You have been warned.
13641310
"""
13651311

13661312
change_set: ChangeSet
@@ -1378,12 +1324,6 @@ class Basis:
13781324
class ChangeSetBuilder:
13791325
"""
13801326
ChangeSetBuilder is a helper for constructing a ChangeSet.
1381-
1382-
This type is not stable, and not subject to any backwards
1383-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
1384-
1385-
Do not use it.
1386-
You have been warned.
13871327
"""
13881328

13891329
def __init__(self):
@@ -1490,12 +1430,6 @@ def add_delete(self, kind, key, version):
14901430
class Payload:
14911431
"""
14921432
Payload represents a payload delivered in a streaming response.
1493-
1494-
This type is not stable, and not subject to any backwards
1495-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
1496-
1497-
Do not use it.
1498-
You have been warned.
14991433
"""
15001434

15011435
id: str
@@ -1539,12 +1473,6 @@ class ServerIntent:
15391473
"""
15401474
ServerIntent represents the type of change associated with the payload
15411475
(e.g., transfer full, transfer changes, etc.)
1542-
1543-
This type is not stable, and not subject to any backwards
1544-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
1545-
1546-
Do not use it.
1547-
You have been warned.
15481476
"""
15491477

15501478
payload: Payload
@@ -1582,12 +1510,6 @@ class SelectorStore(Protocol):
15821510
"""
15831511
SelectorStore represents a component capable of providing Selectors
15841512
for data retrieval.
1585-
1586-
This type is not stable, and not subject to any backwards
1587-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
1588-
1589-
Do not use it.
1590-
You have been warned.
15911513
"""
15921514

15931515
@abstractmethod
@@ -1611,12 +1533,6 @@ class Initializer(Protocol): # pylint: disable=too-few-public-methods
16111533
which may be stale but is fast to retrieve. This initial data serves as a
16121534
foundation for a Synchronizer to build upon, enabling it to provide updates
16131535
as new changes occur.
1614-
1615-
This type is not stable, and not subject to any backwards
1616-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
1617-
1618-
Do not use it.
1619-
You have been warned.
16201536
"""
16211537

16221538
@property
@@ -1643,12 +1559,6 @@ class Update:
16431559
"""
16441560
Update represents the results of a synchronizer's ongoing sync
16451561
method.
1646-
1647-
This type is not stable, and not subject to any backwards
1648-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
1649-
1650-
Do not use it.
1651-
You have been warned.
16521562
"""
16531563

16541564
state: DataSourceState
@@ -1673,12 +1583,6 @@ class Synchronizer(Protocol): # pylint: disable=too-few-public-methods
16731583
It is responsible for yielding Update objects that represent the current state
16741584
of the data source, including any changes that have occurred since the last
16751585
synchronization.
1676-
1677-
This type is not stable, and not subject to any backwards
1678-
compatibility guarantees or semantic versioning. It is not suitable for production usage.
1679-
1680-
Do not use it.
1681-
You have been warned.
16821586
"""
16831587
@property
16841588
@abstractmethod

0 commit comments

Comments
 (0)