python-etcd3-async 0.1.0__py3-none-any.whl

python_etcd3_async-0.1.0.dist-info/METADATA

@@ -0,0 +1,328 @@
+Metadata-Version: 2.4
+Name: python-etcd3-async
+Version: 0.1.0
+Summary: etcd3 async sdk
+Requires-Python: <4,>=3.12
+Requires-Dist: grpcio==1.76.0
+Requires-Dist: prometheus-client>=0.24.1
+Requires-Dist: protobuf==6.31.1
+Description-Content-Type: text/markdown
+
+# python-etcd3-async
+
+[中文文档](./README_CN.md) | English
+
+Python async client for the etcd API v3, supporting both synchronous and asynchronous operations.
+
+* Free software: Apache Software License 2.0
+* Python 3.12+
+
+## Features
+
+- **Full etcd v3 API support**: Key-Value operations, Leases, Locks, Watches, Transactions
+- **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
+- **Context manager**: Clean resource management for both sync and async
+
+## Quick Start
+
+### Async Client
+
+```python
+import asyncio
+from etcd3 import async_client
+
+async def main():
+    # Create client
+    client = await async_client(host='localhost', port=2379)
+
+    # Key-Value operations
+    await client.put('/mykey', 'Hello etcd!')
+    value, meta = await client.get('/mykey')
+    print(value)  # b'Hello etcd!'
+
+    await client.delete('/mykey')
+    await client.close()
+
+asyncio.run(main())
+```
+
+### Sync Client
+
+```python
+from etcd3 import client
+
+# Create sync client
+etcd = client(host='localhost', port=2379)
+
+# Key-Value operations
+etcd.put('/mykey', 'Hello etcd!')
+value, meta = etcd.get('/mykey')
+print(value)  # b'Hello etcd!'
+
+etcd.delete('/mykey')
+```
+
+## Key Features
+
+### Key-Value Operations
+
+```python
+# Put with lease
+lease = await client.lease(30)
+await client.put('/app/instance', 'value', lease=lease)
+
+# Get with prefix
+async for value, meta in client.get_prefix('/app/'):
+    print(f'{meta.key}: {value}')
+
+# Range query
+async for value, meta in client.get_range('/start', '/end'):
+    print(value)
+```
+
+### Leases (TTL)
+
+```python
+# Create lease with TTL
+lease = await client.lease(60)
+await client.put('/ephemeral/key', 'value', lease=lease)
+
+# Keep lease alive
+async for response in lease.refresh():
+    print(f'Lease TTL: {response.TTL}')
+
+# Revoke lease (deletes all attached keys)
+await lease.revoke()
+```
+
+### Distributed Locks
+
+```python
+# Acquire lock (full path like Go SDK)
+lock = await client.lock('/myapp/mylock', ttl=30)
+acquired = await lock.acquire(timeout=10)
+
+if acquired:
+    try:
+        # Critical section
+        print('Lock acquired')
+    finally:
+        await lock.release()
+
+# Or use context manager
+lock = client.lock('/myapp/mylock', ttl=30)
+async with lock:
+    # Critical section
+    pass
+```
+
+### Watch Changes
+
+```python
+# Watch single key
+events_iter, cancel = await client.watch('/mykey')
+async for event in events_iter:
+    print(f'Event: {event.event_type}, value: {event.value}')
+
+# Watch prefix
+events_iter, cancel = await client.watch_prefix('/app/')
+async for event in events_iter:
+    print(f'Changed: {event.key}')
+
+# Cancel watch
+cancel()
+
+# Watch with timeout (sync/async)
+events_iter, cancel = client.watch('/key', timeout=10)
+for event in events_iter:
+    print(event)
+```
+
+### Transactions
+
+```python
+# Conditional transaction
+success, response = await client.transaction(
+    compare=[
+        client.transactions.value('/key') == 'expected',
+    ],
+    success=[
+        client.transactions.put('/key', 'new_value'),
+    ],
+    failure=[
+        client.transactions.get('/key'),
+    ]
+)
+```
+
+### Cluster Management
+
+```python
+# List cluster members
+async for member in client.members():
+    print(f'{member.name}: {member.clientURLs}')
+
+# Add/remove/update members
+await client.add_member(['http://localhost:2380'])
+await client.remove_member(member_id)
+await client.update_member(member_id, ['http://localhost:2380'])
+```
+
+### Maintenance Operations
+
+```python
+# Get cluster status
+status = await client.status()
+print(f'Leader: {status.leader}')
+
+# Compact history
+await client.compact(revision, physical=True)
+
+# Defragment database
+await client.defragment()
+
+# Alarm management
+await client.create_alarm()  # Activate NOSPACE alarm
+alarms = [alarm async for alarm in client.list_alarms()]
+await client.disarm_alarm()
+```
+
+## Examples
+
+### Leader Election
+
+```python
+# Async: examples/leader_election.py
+# Sync: examples/leader_election_sync.py
+
+from etcd3 import async_client
+
+async def main():
+    client = await async_client(host='localhost', port=2379)
+    election = LeaderElection(client, 'my-service-leader', ttl=30)
+
+    if await election.try_become_leader():
+        print('Became leader')
+        # Do leader work...
+    else:
+        print('Not leader')
+
+    await election.close()
+    await client.close()
+```
+
+### Service Registration
+
+```python
+# Async: examples/service_registration.py
+# Sync: examples/service_registration_sync.py
+
+from etcd3 import async_client
+
+async def main():
+    client = await async_client(host='localhost', port=2379)
+    registry = ServiceRegistration(client)
+
+    lease = await registry.register(
+        service_name='my-service',
+        instance_id='instance-001',
+        host='192.168.1.100',
+        port=8080,
+        ttl=30,
+    )
+    registry.start_keepalive(lease)
+    # Service stays registered...
+```
+
+### Service Discovery
+
+```python
+# Async: examples/service_discovery.py
+# Sync: examples/service_discovery_sync.py
+
+from etcd3 import async_client
+
+async def main():
+    client = await async_client(host='localhost', port=2379)
+    discovery = ServiceDiscovery(client)
+
+    # Discover instances
+    instances = await discovery.discover('my-service')
+    print(f'Found {len(instances)} instances')
+
+    # Watch for changes
+    def on_change(new_instances):
+        print(f'Changed: {len(new_instances)} instances')
+
+    await discovery.watch('my-service', on_change)
+```
+
+## Configuration
+
+```python
+# Basic configuration
+client = await async_client(
+    host='localhost',
+    port=2379,
+    timeout=10,  # Request timeout in seconds
+)
+
+# Multiple endpoints with failover
+client = await async_client(
+    endpoints=['localhost:2379', 'localhost:22379'],
+    failover=True,  # Automatically switch to healthy endpoint
+)
+
+# TLS authentication
+client = await async_client(
+    host='localhost',
+    port=2379,
+    ca_cert='/path/to/ca.crt',
+    cert_key='/path/to/client.key',
+    cert_cert='/path/to/client.crt',
+)
+
+# User authentication
+client = await async_client(
+    host='localhost',
+    port=2379,
+    user='username',
+    password='password',
+)
+```
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `ETCD3_LOG_LEVEL` | Set logging level (DEBUG, INFO, WARNING, ERROR) |
+
+## API Reference
+
+### Client Factory
+
+| Function | Description |
+|----------|-------------|
+| `async_client()` | Create async client |
+| `client()` | Create sync client |
+
+### Key Methods
+
+| Category | Methods |
+|----------|---------|
+| **KV** | `get`, `put`, `delete`, `get_prefix`, `get_range`, `get_all` |
+| **Leases** | `lease`, `revoke_lease`, `refresh_lease`, `get_lease_info` |
+| **Locks** | `lock` |
+| **Watches** | `watch`, `watch_prefix`, `add_watch_callback`, `watch_once`, `cancel_watch` |
+| **Transactions** | `transaction` |
+| **Cluster** | `members`, `add_member`, `remove_member`, `update_member`, `status` |
+| **Maintenance** | `compact`, `defragment`, `hash`, `create_alarm`, `list_alarms`, `disarm_alarm`, `snapshot` |
+
+## References
+
+- Initial code 参考:
+  1. [python-etcd3](https://github.com/kragniz/python-etcd3)
+  2. [Go etcd client v3](https://pkg.go.dev/go.etcd.io/etcd/client/v3)

python_etcd3_async-0.1.0.dist-info/RECORD

@@ -0,0 +1,42 @@
+etcd3/__init__.py,sha256=_G81-O1yZsDNpMp_VvWDS8YNE9EgHEmgAhXdZ5VokP8,2811
+etcd3/async_client.py,sha256=wnzRgPzmFN2Xe0TPxSL-bHTo_lnL01l_I2L6arMGUaw,54229
+etcd3/async_client_extensions.py,sha256=IgW_2l0_h0AtFUFe6uPHYD-7UlBRMdMrwoWEsfDgI0U,34213
+etcd3/async_endpoint.py,sha256=nDQtXCze1H8SAHIFJ0HYc1dBY2Nc0gw_t3SVT5d1Zmg,4587
+etcd3/async_managers.py,sha256=bUbrqkeq1Rv_qhDGOkIqgSoqA-Lyo10Vbxc60KahtXc,17620
+etcd3/async_monitor.py,sha256=iZPac3Pqn5bI0ONguJJctQsi4b2ft4hWPknug6jj5RY,453
+etcd3/async_watch.py,sha256=m6I2BAoI54J-ZPVVMxao6XJQXvVyQ88Hp2QeauD9z20,15962
+etcd3/client.py,sha256=43OjwOGlxgA3pKTkMZoL4Aem0_Axk7TDrb6-TB6veos,72347
+etcd3/endpoint.py,sha256=aSMBmEitAADW0ABAZhc8L7jPYsQo8amEWKv6LJbsmC4,2589
+etcd3/events.py,sha256=e4gTiUE4SRon8R-if9SKORIM_jr8XtVye-GcV-owKdw,972
+etcd3/exceptions.py,sha256=mCsOaL6Pw1C72JZ8XqvTPiFsklk5CSjyDmMtdqv5Wv4,996
+etcd3/leases.py,sha256=7eVl0rA2IGIOBTHbBn0Te9SQ-TKBr4v20X7iUzWYcSo,2804
+etcd3/locks.py,sha256=KBtMS33FLGS13lcvJkIQPelnRLyTUXhqhJRs4De-uts,22533
+etcd3/log.py,sha256=sMo6av48x9Nf_YDIWdSv8R-VUeVXi1n17wGDAAaFnlM,4282
+etcd3/log_formatters.py,sha256=weWgMQjuI_cZFBEUORGCgkFJQIPvDUaiCLJN64t7s9o,7304
+etcd3/log_sampling.py,sha256=7PhNz-HOZ6sHdBiXS29YJ3baHY_L1VwJaq4NZt2yX78,6692
+etcd3/members.py,sha256=LLg6sAWDaaW0wzl_yBF3ialMQuaRKLFpFDEcmWcbqzY,1414
+etcd3/observability.py,sha256=BLOUMs1H2icF-tEWB_RoZFKoCNoXZt1ZZERGfckesW4,14215
+etcd3/shared.py,sha256=6-mhHNvGD6TPwq79EQa6oGxoZoGKR5oZSZkJeSbZpc8,16195
+etcd3/trace.py,sha256=OtOmAZ5uz7v7dqPoAaEM8d94prK5f5tSEJq7Qi2w_0c,6650
+etcd3/trace_attributes.py,sha256=oE_r3OMvbqm_BWlwKsTWjJucJEQ4osWu0HvwlyI9uc4,12025
+etcd3/transactions.py,sha256=FJe-J5QBm-pV_J9dGIMor35PHAXvb61bjSELkg5Bw4U,7587
+etcd3/utils.py,sha256=M1Rl9LwEvDUlkFBcaK6YPYLAPXjGmgt11d4WWqaNJHc,4811
+etcd3/watch.py,sha256=rPEvOm1nQOPzj00OV6GFObZ2uSQqNl2pEcT7ut7xO44,8838
+etcd3/exporters/__init__.py,sha256=9nMfrCsQ-pN5WUIY2ZHBsY4N3xmdD2Z24mDCi19hJE8,362
+etcd3/exporters/prometheus.py,sha256=goA42MAwuR-FI4QH5K4jMOJt51tfC2V9BTeAf9dL5hg,10211
+etcdrpc/__init__.py,sha256=msPVuBwxhRwvr3kn1r6RkUMalHpbXRfrg6A3bNmVu8s,547
+etcdrpc/auth.proto,sha256=Py2ysZTy4i89vxRHBdXK-KcPCkojcEfWXDNbDajLRWk,1170
+etcdrpc/auth_pb2.py,sha256=H-HBNZ64Mi0aqMIgjqvgdDcm5DBl9GIhqipRBCt1LlA,2120
+etcdrpc/auth_pb2.pyi,sha256=vEV6IzZnKObqDI6fJPtXAqRbnKZC3vXy4UAem_XZVvY,1985
+etcdrpc/auth_pb2_grpc.py,sha256=Xr3nckN8gNGTbWmOjz2OncHsPjwNBb4UaMGzqk4Jicg,892
+etcdrpc/kv.proto,sha256=OI66aiqsN584XUhviA7SacMPEww1y6BrCa0gz9moBzE,1395
+etcdrpc/kv_pb2.py,sha256=zMO9NYM2AUSzzu6GABRg_5ECpnQ7kcm4nBbBBFwrb94,1943
+etcdrpc/kv_pb2.pyi,sha256=_McnDO1AgFNMqjAGbA1TuEs4TQH7tBbuR7tU-zckYmM,1741
+etcdrpc/kv_pb2_grpc.py,sha256=PtuNgs59bODIsJCxPXtwfGwA26fVSYl7pDJwGNrFh4I,890
+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.1.0.dist-info/METADATA,sha256=OSgYlmcjLRkK0MJYJrKBb84luLROrXAPYeYe7H-N854,7724
+python_etcd3_async-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+python_etcd3_async-0.1.0.dist-info/RECORD,,

python_etcd3_async-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any