Damien/fabric-orchestrator
1
0
Fork 0
Code Issues 16 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(gnmi): remove async context manager references from client

Browse Source 
Remove outdated async documentation from GNMIClient module:
- Remove async context manager from feature list
- Remove async usage example from class docstring

The client now only documents synchronous usage patterns.
This commit is contained in:
darnodo
2025-12-31 17:48:29 +01:00
parent 5b3517c355
commit 97cdc161da
1 changed files with 0 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/gnmi/client.py
View File

@@ -3,7 +3,6 @@ gNMI Client Wrapper for Fabric Orchestrator.
This module provides a high-level gNMI client using pygnmi with: This module provides a high-level gNMI client using pygnmi with:
- Connection management - Connection management
- Async context manager support
- Error handling with meaningful exceptions - Error handling with meaningful exceptions
""" """
@@ -82,10 +81,6 @@ class GNMIClient:
Provides high-level methods for gNMI operations with proper Provides high-level methods for gNMI operations with proper
error handling and context manager support. error handling and context manager support.
Usage:
async with GNMIClient(host="leaf1", port=6030, ...) as client:
caps = await client.capabilities()
Or synchronously: Or synchronously:
with GNMIClient(host="leaf1", port=6030, ...) as client: with GNMIClient(host="leaf1", port=6030, ...) as client:
caps = client.capabilities() caps = client.capabilities()