python-etcd3-async 0.2.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

etcd3/__init__.py

@@ -51,7 +51,7 @@ from etcd3.async_single_client import async_client
 
 __author__ = "owasd"
 __email__ = ""
-__version__ = "0.2.0"
+__version__ = "0.2.1"
 
 __all__ = (
     "etcdrpc",

etcd3/async_client_extensions.py

@@ -176,20 +176,20 @@ class AsyncKVOperations:
         channel = await self.client._get_channel()
         return etcdrpc.KVStub(channel)
 
-    @_async_handle_errors
-    async def get_response(self, key, **kwargs):
-        """Get the value of a key from etcd.
+    async def _range(self, range_request):
+        """Run a range request.
 
-        :param key: key in etcd to get
-        :type key: str or bytes
-        :param kwargs: Additional arguments (revision, limit, sort_order, etc.)
-        :returns: RangeResponse from etcd
+        Reads are idempotent, so a transient failure can be retried. The
+        stub is created per attempt so that a retry picks up a freshly
+        built channel.
+
+        :param range_request: the request to send
+        :type range_request: etcdrpc.RangeRequest
+        :returns: the range response
+        :rtype: etcdrpc.RangeResponse
         """
-        range_request = self.client._build_get_range_request(key, **kwargs)
 
-        async def _range():
-            # The stub is created per attempt so that a retry picks up a
-            # freshly built channel.
+        async def _do_range():
             kv_stub = await self._get_kv_stub()
             return await kv_stub.Range(
                 range_request,
@@ -198,8 +198,19 @@ class AsyncKVOperations:
                 metadata=self.client.metadata,
             )
 
-        # Reads are idempotent, so a transient failure can be retried.
-        response = await self.client._retry_with_backoff(_range)
+        return await self.client._retry_with_backoff(_do_range)
+
+    @_async_handle_errors
+    async def get_response(self, key, **kwargs):
+        """Get the value of a key from etcd.
+
+        :param key: key in etcd to get
+        :type key: str or bytes
+        :param kwargs: Additional arguments (revision, limit, sort_order, etc.)
+        :returns: RangeResponse from etcd
+        """
+        range_request = self.client._build_get_range_request(key, **kwargs)
+        response = await self._range(range_request)
 
         # Set trace attributes from response
         endpoint = (
@@ -293,6 +304,9 @@ class AsyncKVOperations:
         :type ignore_value: bool
         :param ignore_lease: if True, update the key using the current lease
         :type ignore_lease: bool
+        :returns: the response header, or the previous key-value metadata
+            when ``prev_kv`` is True
+        :rtype: :class:`.rpc_pb2.ResponseHeader` or :class:`.KVMetadata`
         """
         put_request = RequestBuilder.build_put_request(
             key=key,

etcd3/async_multi_client.py

@@ -840,8 +840,9 @@ class AsyncMultiEndpointEtcd3Client:
         :type ignore_value: bool
         :param ignore_lease: if True, update the key using the current lease
         :type ignore_lease: bool
-        :returns: a response containing a header and the prev_kv
-        :rtype: :class:`.rpc_pb2.PutResponse`
+        :returns: the response header, or the previous key-value metadata
+            when ``prev_kv`` is True
+        :rtype: :class:`.rpc_pb2.ResponseHeader` or :class:`.KVMetadata`
         """
         return await self.kv.put(
             key,
@@ -1026,10 +1027,10 @@ class AsyncMultiEndpointEtcd3Client:
         :type return_response: bool
         :param range_end: End of the key range (for range deletes)
         :type range_end: str or bytes, optional
-        :returns: True if the key has been deleted when
-                  ``return_response`` is False and a response containing
-                  a header, the number of deleted keys and prev_kvs when
-                  ``return_response`` is True
+        :returns: the number of deleted keys when ``return_response`` is
+            False, and a response containing a header, the number of
+            deleted keys and prev_kvs when ``return_response`` is True
+        :rtype: int or :class:`.rpc_pb2.DeleteRangeResponse`
         """
         return await self.kv.delete(
             key, prev_kv=prev_kv, return_response=return_response, range_end=range_end

etcd3/sync_kv_operations.py

@@ -83,16 +83,20 @@ class SyncKVOperations:
             max_create_revision=max_create_revision,
         )
 
-    @_sync_handle_errors
-    @monitor_request("kv.get_response")
-    @log_operation("kv.get")
-    def get_response(self, key, **kwargs):
-        """Get the value of a key from etcd."""
-        range_request = self._build_get_range_request(key, **kwargs)
+    def _range(self, range_request):
+        """Run a range request.
+
+        Reads are idempotent, so a transient failure can be retried. The
+        stub is created per attempt so that a retry picks up a freshly
+        built channel.
 
-        def _range():
-            # The stub is created per attempt so that a retry picks up a
-            # freshly built channel.
+        :param range_request: the request to send
+        :type range_request: etcdrpc.RangeRequest
+        :returns: the range response
+        :rtype: etcdrpc.RangeResponse
+        """
+
+        def _do_range():
             kv_stub = etcdrpc.KVStub(self.channel)
             return kv_stub.Range(
                 range_request,
@@ -101,8 +105,15 @@ class SyncKVOperations:
                 metadata=self.metadata,
             )
 
-        # Reads are idempotent, so a transient failure can be retried.
-        return self.client._retry_with_backoff(_range)
+        return self.client._retry_with_backoff(_do_range)
+
+    @_sync_handle_errors
+    @monitor_request("kv.get_response")
+    @log_operation("kv.get")
+    def get_response(self, key, **kwargs):
+        """Get the value of a key from etcd."""
+        range_request = self._build_get_range_request(key, **kwargs)
+        return self._range(range_request)
 
     def get(self, key, **kwargs):
         """
@@ -139,15 +150,7 @@ class SyncKVOperations:
             range_end=utils.prefix_range_end(utils.to_bytes(key_prefix)),
             **kwargs,
         )
-
-        # Create KV stub directly
-        kv_stub = etcdrpc.KVStub(self.channel)
-        return kv_stub.Range(
-            range_request,
-            self.timeout,
-            credentials=self.call_credentials,
-            metadata=self.metadata,
-        )
+        return self._range(range_request)
 
     def get_prefix(self, key_prefix, **kwargs):
         """
@@ -176,15 +179,7 @@ class SyncKVOperations:
             sort_target=sort_target,
             **kwargs,
         )
-
-        # Create KV stub directly
-        kv_stub = etcdrpc.KVStub(self.channel)
-        return kv_stub.Range(
-            range_request,
-            self.timeout,
-            credentials=self.call_credentials,
-            metadata=self.metadata,
-        )
+        return self._range(range_request)
 
     def get_range(self, range_start, range_end, **kwargs):
         """
@@ -209,15 +204,7 @@ class SyncKVOperations:
             sort_target=sort_target,
             keys_only=keys_only,
         )
-
-        # Create KV stub directly
-        kv_stub = etcdrpc.KVStub(self.channel)
-        return kv_stub.Range(
-            range_request,
-            self.timeout,
-            credentials=self.call_credentials,
-            metadata=self.metadata,
-        )
+        return self._range(range_request)
 
     def get_all(self, **kwargs):
         """
@@ -329,7 +316,7 @@ class SyncKVOperations:
         :rtype: bool
         """
         status, _ = self.client.transaction(
-            compare=[self.transactions.create(key) == "0"],
+            compare=[self.transactions.create(key) == 0],
             success=[self.transactions.put(key, value, lease=lease)],
             failure=[],
         )

{python_etcd3_async-0.2.0.dist-info → python_etcd3_async-0.2.1.dist-info}/METADATA

@@ -1,11 +1,28 @@
 Metadata-Version: 2.5
 Name: python-etcd3-async
-Version: 0.2.0
+Version: 0.2.1
 Summary: etcd3 async sdk
+Project-URL: Repository, https://cnb.cool/owasd/python3-etcd-async
+Project-URL: Source, https://cnb.cool/owasd/python3-etcd-async
+Project-URL: Homepage, https://cnb.cool/owasd/python3-etcd-async
+Project-URL: Issues, https://cnb.cool/owasd/python3-etcd-async/issues
+Project-URL: Changelog, https://cnb.cool/owasd/python3-etcd-async/blob/main/docs/en/resources/history.md
+Author: owasd
+License-Expression: Apache-2.0
+Keywords: async,etcd,etcd3,grpc,kubernetes
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: <4,>=3.12
-Requires-Dist: grpcio==1.76.0
+Requires-Dist: grpcio>=1.76.0
 Requires-Dist: prometheus-client>=0.24.1
-Requires-Dist: protobuf==6.31.1
+Requires-Dist: protobuf>=6.31.1
 Description-Content-Type: text/markdown
 
 # python-etcd3-async
@@ -23,7 +40,7 @@ Python async client for the etcd API v3, supporting both synchronous and asynchr
 - **Async/Sync dual support**: Same API for both async and sync usage with feature parity
 - **Automatic reconnection**: Auto-rebuild stale connections (e.g., after etcd server restart)
 - **Keepalive error propagation**: Lease keepalive errors are properly propagated for connection loss detection
-- **Endpoint failover**: Built-in support for multiple endpoints with automatic failover
+- **Endpoint failover**: Built-in support for multiple endpoints with opt-in automatic failover (`failover=True`)
 - **Context manager**: Clean resource management for both sync and async
 - **Observability**: Structured logging, OpenTelemetry tracing, and Prometheus metrics
 
@@ -272,8 +289,14 @@ client = await async_client(
 )
 
 # Multiple endpoints with failover
-client = await async_client(
-    endpoints=['localhost:2379', 'localhost:22379'],
+# (the single-endpoint factory does not take endpoints=)
+from etcd3 import AsyncMultiEndpointEtcd3Client, AsyncEndpoint
+
+client = AsyncMultiEndpointEtcd3Client(
+    endpoints=[
+        AsyncEndpoint('localhost', 2379, secure=False),
+        AsyncEndpoint('localhost', 22379, secure=False),
+    ],
     failover=True,  # Automatically switch to healthy endpoint
 )
 

{python_etcd3_async-0.2.0.dist-info → python_etcd3_async-0.2.1.dist-info}/RECORD

@@ -1,11 +1,11 @@
-etcd3/__init__.py,sha256=Evxr9VwSTbdwE5F5mwmTz9blukSTIwlz6_yRLjeX3tw,3433
+etcd3/__init__.py,sha256=Xu6id_lViZcLA1ks-5XP4MxI0Uw4bePB9r5P8oxtpjw,3433
 etcd3/async_client.py,sha256=gHNwLMJ9ZJx6XQuAUE4PSPcG2nIeV1E3flgQBPzEqGg,2162
-etcd3/async_client_extensions.py,sha256=S1ZjJubMYtQf0itJ_cOesbvlmmJ2aK3Lp_ARxR6UUHE,37704
+etcd3/async_client_extensions.py,sha256=JqrkkrGSprWrUa9EFol3i0uWdvTesYJmPytHTJw--_4,38193
 etcd3/async_config.py,sha256=tjGR_SP25uYpC0wI9LoHxKgPuL7yaSHWtUQrcPrx0uQ,3530
 etcd3/async_endpoint.py,sha256=ojNBRgtZ7DJQDL7WAZnO7cQ24fCFYcMRcdFxT-_2A2w,5310
 etcd3/async_managers.py,sha256=05qIGGR4RTu8iPO5Ejrf6CRB_zzqvHa4Gd-rBXIpFD4,19378
 etcd3/async_monitor.py,sha256=iZPac3Pqn5bI0ONguJJctQsi4b2ft4hWPknug6jj5RY,453
-etcd3/async_multi_client.py,sha256=fwvU_6_fd9ZJ7rwne170g8pJgA7blnvWEcL4Yq-tAGw,52044
+etcd3/async_multi_client.py,sha256=O7ySYsy9ZfKhgC-jqCazI6vbf5W0N5W1qYE4Sh8GKBk,52143
 etcd3/async_single_client.py,sha256=vCi-RhwcZ34cR_hRf2BXdcAcPEvJjknv3wkWM8zHF-I,5145
 etcd3/async_watch.py,sha256=k6hY8yKl2H6QOYa5t1CCQ0dJ20lFPUo7s-jOHMRdMwE,16973
 etcd3/auth.py,sha256=gWd6Cl2CMe4P6i4SsLQ_9UMv9bNSCs_QAMqyOVfKQ3k,21896
@@ -26,7 +26,7 @@ etcd3/observability.py,sha256=BLOUMs1H2icF-tEWB_RoZFKoCNoXZt1ZZERGfckesW4,14215
 etcd3/shared.py,sha256=7vTHM34dlnW9D45YAKhAmoW1-EJB8GwlOjzfpeq77BU,9362
 etcd3/single_client.py,sha256=sG3tna7i_1y5u_XuwvsH0BeMQIj6uaKL5XgOYRpratI,5014
 etcd3/sync_cluster_operations.py,sha256=YgJGjqdSEhzp-0A1QIwXJtZNw-IbjDnxTDCiZKJydIE,4319
-etcd3/sync_kv_operations.py,sha256=L8ZWfzuY3fqBiIw7moTA-UOATfZHtzmP81q4hICgpog,23252
+etcd3/sync_kv_operations.py,sha256=KLqd_6J8oSqRpQSbONKWw7aBrQjYWsS5lLG6M_46pNQ,22895
 etcd3/sync_lock_operations.py,sha256=XkezEM0lDGKhj3BPiMtmfFteWatm-XbZewAtjcreuwM,1091
 etcd3/sync_maintenance_operations.py,sha256=oDXRfrMsTYvpMKbvD0K1k1nwgzyYcnjmqO8jZ3QZfUI,8397
 etcd3/trace.py,sha256=OtOmAZ5uz7v7dqPoAaEM8d94prK5f5tSEJq7Qi2w_0c,6650
@@ -49,6 +49,6 @@ etcdrpc/rpc.proto,sha256=UD4vXbdPUNHSLSx7K_UltWqJjWswHBKSs0t9aNMA4qg,31351
 etcdrpc/rpc_pb2.py,sha256=8qhnULNr8jym0qyivDVqJB86H_u1Rb_K8iY8FNT9e0s,30252
 etcdrpc/rpc_pb2.pyi,sha256=TfPtHXIluO_D1rchVMVfoSgZTPQLk-YNhmcJBIt9XIk,35473
 etcdrpc/rpc_pb2_grpc.py,sha256=HOifyKL0X3BmLkS1r0tWTMfyfChBiy76O6Ys12kT5n8,73810
-python_etcd3_async-0.2.0.dist-info/METADATA,sha256=a4feA5oLLPypoy9h62zNbPBwhsZ879k4bpp5EepXFHM,8723
-python_etcd3_async-0.2.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
-python_etcd3_async-0.2.0.dist-info/RECORD,,
+python_etcd3_async-0.2.1.dist-info/METADATA,sha256=rAl7AYfE7X0qAUkbbweW3FK3rETVFa4WFi-cbyZX0aQ,9871
+python_etcd3_async-0.2.1.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+python_etcd3_async-0.2.1.dist-info/RECORD,,