python-nso-client 0.1.1__tar.gz → 0.1.2__tar.gz

{python_nso_client-0.1.1 → python_nso_client-0.1.2}/Makefile

@@ -21,7 +21,7 @@ test: ## Run tests once, specify $TESTS for specific file/method
 	uv run pytest $(PYTEST_ARGS) $(TESTS)
 
 watch-test: ## Run tests every time code changes
-	watchexec $(WATCHEXEC_ARGS) poetry run pytest $(PYTEST_ARGS) $(TESTS)
+	watchexec $(WATCHEXEC_ARGS) uv run pytest $(PYTEST_ARGS) $(TESTS)
 
 publish: ## Publish a relase to PyPI
 	rm -fr dist/

{python_nso_client-0.1.1 → python_nso_client-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-nso-client
-Version: 0.1.1
+Version: 0.1.2
 Summary: Add your description here
 Author-email: James Harr <jharr@internet2.edu>
 License-Expression: Apache-2.0

{python_nso_client-0.1.1 → python_nso_client-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-nso-client"
-version = "0.1.1"
+version = "0.1.2"
 description = "Add your description here"
 readme = "README.md"
 license = "Apache-2.0"

{python_nso_client-0.1.1 → python_nso_client-0.1.2}/src/nso_client/__init__.py

@@ -25,7 +25,7 @@ from nso_client.exceptions import (
     RestConfError,
     YangPatchError,
 )
-from nso_client.types import ContentType, InsertWhere, PatchType
+from nso_client.types import ContentType, DryRunType, InsertWhere, PatchType, YangData
 
 __all__ = [
     "NSOClient",
@@ -44,7 +44,7 @@ class NSOCommitMode(Enum):
     NO_DEPLOY = "no-deploy"
 
     @classmethod
-    def _missing_(cls, value: str):
+    def _missing_(cls, value: object):
         raise Exception(
             f"{value} is not a valid {cls.__name__}"
             f"valid options are {cls._member_names_}"
@@ -68,7 +68,7 @@ class NSOClient:
         auth: BasicAuth | None = None,
         verify: bool | ssl.SSLContext = True,
         restconf_path: str = "/restconf/data",
-        logger: BoundLogger = None,
+        logger: BoundLogger | None = None,
         **commit_kwargs,
     ):
         """
@@ -90,7 +90,7 @@ class NSOClient:
             },
         )
         self.nso_url = nso_url + restconf_path
-        if not logger:
+        if logger is None:
             logger = structlog.get_logger()
         self.log = logger.bind(lib="NSOClient")
         self.commit_kwargs = commit_kwargs
@@ -98,9 +98,9 @@ class NSOClient:
     def get(
         self,
         path: str,
-        *path_params: list[str],
+        *path_params: str,
         **kwargs,
-    ) -> list | dict:
+    ) -> YangData:
         """
         Retrieve RestConf data at path.
 
@@ -113,7 +113,7 @@ class NSOClient:
         Raises:         RestConfError or a sub-class
         """
         url = self._make_url(path, path_params)
-        query_params = self.query_params(**kwargs)
+        query_params = self._query_params(**kwargs)
         response = self.session.get(url, params=query_params)
         self.log.debug(
             "NSO Query",
@@ -135,8 +135,8 @@ class NSOClient:
     def put(
         self,
         path: str,
-        *path_params: list[str],
-        payload: dict[str, str],
+        *path_params: str,
+        payload: YangData,
         **kwargs,
     ) -> None | DryRunResult:
         """
@@ -152,7 +152,7 @@ class NSOClient:
         Raises:         RestConfError or a sub-class
         """
         url = self._make_url(path, path_params)
-        query_params = self.query_params(**kwargs)
+        query_params = self._query_params(**kwargs)
         response = self.session.put(url, params=query_params, json=payload)
         self.log.info(
             "NSO Commit",
@@ -171,7 +171,7 @@ class NSOClient:
     def delete(
         self,
         path: str,
-        *path_params: list[str],
+        *path_params: str,
         **kwargs,
     ) -> None | DryRunResult:
         """
@@ -186,7 +186,7 @@ class NSOClient:
         Raises:         RestConfError or a sub-class
         """
         url = self._make_url(path, path_params)
-        query_params = self.query_params(**kwargs)
+        query_params = self._query_params(**kwargs)
         response = self.session.delete(url, params=query_params)
         self.log.info(
             "NSO Commit",
@@ -204,8 +204,8 @@ class NSOClient:
     def post(
         self,
         path: str,
-        *path_params: list[str],
-        payload: dict[str, str],
+        *path_params: str,
+        payload: YangData,
         **kwargs,
     ):
         """
@@ -219,7 +219,7 @@ class NSOClient:
         Raises:         RestConfError or a sub-class
         """
         url = self._make_url(path, path_params)
-        query_params = self.query_params(**kwargs)
+        query_params = self._query_params(**kwargs)
         response = self.session.post(url, json=payload, params=query_params)
         self.log.info(
             "NSO Commit/Call",
@@ -237,12 +237,12 @@ class NSOClient:
     def patch(
         self,
         path: str,
-        *path_params: list[str],
-        payload: dict[str, str],
+        *path_params: str,
+        payload: YangData,
         style: PatchType,
         ignore_codes=(),
         **kwargs,
-    ) -> PatchResult | DryRunResult:
+    ) -> YangData | DryRunResult:
         """
         PATCH data to a given path
 
@@ -273,7 +273,7 @@ class NSOClient:
         - https://datatracker.ietf.org/doc/html/draft-ietf-netconf-yang-patch-14#appendix-D.1.5
         """
         url = self._make_url(path, path_params)
-        query_params = self.query_params(**kwargs)
+        query_params = self._query_params(**kwargs)
 
         # If using YANG-Patch, change content-type
         headers = {}
@@ -301,7 +301,11 @@ class NSOClient:
         )
         return self._parse_response(response, ignore_codes)
 
-    def yang_patch(self, path: str, *path_params: list[str]) -> Patch:
+    def yang_patch(
+        self,
+        path: str,
+        *path_params: str,
+    ) -> Patch:
         """Prepare a request using the YANG-Patch.
 
         Example usage:
@@ -321,7 +325,7 @@ class NSOClient:
         self,
         response: httpx.Response,
         ignore_codes: list[int] = [],
-    ) -> dict | DryRunResult:
+    ) -> YangData | DryRunResult:
         self._raise_if_error(response, ignore_codes)
         if len(response.content) == 0:
             return None
@@ -330,7 +334,7 @@ class NSOClient:
             return DryRunResult(rv)
         return rv
 
-    def query_params(
+    def _query_params(
         self,
         **kwargs,
     ) -> dict[str, str]:
@@ -353,7 +357,7 @@ class NSOClient:
         if "unhide" in kwargs:
             unhide = kwargs.pop("unhide")
             if unhide:
-                query_params["unhide"] = ",".join()
+                query_params["unhide"] = ",".join(unhide)
         if "dry_run" in kwargs:
             query_params["dry-run"] = kwargs.pop("dry_run")
         if "content" in kwargs:
@@ -415,7 +419,7 @@ class Patch:
     path: str
     path_params: list[str]
     unhide: list[str]
-    edits = list[dict]
+    edits: list[dict[str, YangData]]
 
     def __init__(
         self,
@@ -441,9 +445,9 @@ class Patch:
     def create(
         self,
         path: str,
-        *path_params: list[str],
-        value: dict[str, str],
-        edit_id: str = None,
+        *path_params: str,
+        value: YangData,
+        edit_id: str | None = None,
     ) -> str:
         """Create an element at a path, fail if it this path already exists
         path:        Target path to modify, may include {}
@@ -469,8 +473,8 @@ class Patch:
     def delete(
         self,
         path: str,
-        *path_params: list[str],
-        edit_id: str = None,
+        *path_params: str,
+        edit_id: str | None = None,
     ):
         """Delete YANG data, fail if it does not exist
         path:        Target path to modify, may include {}
@@ -493,11 +497,11 @@ class Patch:
     def insert(
         self,
         path: str,
-        *path_params: list[str],
+        *path_params: str,
         where: InsertWhere,
-        point: str = None,
-        value: dict[str, str],
-        edit_id: str = None,
+        point: str | None = None,
+        value: YangData,
+        edit_id: str | None = None,
     ):
         """Create an element at a path, inserting before/after an existing element. Only valid for user-ordered items
 
@@ -529,9 +533,9 @@ class Patch:
     def merge(
         self,
         path: str,
-        *path_params: list[str],
-        value: dict[str, str],
-        edit_id: str = None,
+        *path_params: str,
+        value: YangData,
+        edit_id: str | None = None,
     ):
         """Merge data into an existing path
 
@@ -558,10 +562,10 @@ class Patch:
     def move(
         self,
         path: str,
-        *path_params: list[str],
+        *path_params: str,
         where: InsertWhere,
-        point: str = None,
-        edit_id: str = None,
+        point: str | None = None,
+        edit_id: str | None = None,
     ):
         """Move an existing element, only valid for user-ordered lists
 
@@ -591,12 +595,10 @@ class Patch:
     def replace(
         self,
         path: str,
-        *path_params: list[str],
-        value: dict[str, str],
-        edit_id: str = None,
+        *path_params: str,
+        value: YangData,
+        edit_id: str | None = None,
     ):
-        pass
-
         """Delete YANG data, succeed if it's already gone
         path:        Target path to modify, may include {}
         path_params: Values to fill into {} part of the format
@@ -618,8 +620,8 @@ class Patch:
 
     def commit(
         self,
-        patch_id: str = None,
-        comment: str = None,
+        patch_id: str | None = None,
+        comment: str | None = None,
         **kwargs,
     ) -> PatchResult | DryRunResult:
         """Execute the prepared patch. Patch is executed atomically
@@ -654,7 +656,7 @@ class Patch:
             edits = resp.get("edit-status", {}).get("edits", [])
             return PatchResult(
                 patch_id=resp["patch-id"],
-                edits={e["edit-id"] for e in edits},
+                edits={e["edit-id"]: e for e in edits},
                 ok=("ok" in resp),
             )
         else:
@@ -668,7 +670,7 @@ class PatchResult:
     """Result of a Patch operation"""
 
     patch_id: str
-    edits: dict[str, dict]
+    edits: dict[str, YangData]
     ok: bool
 
     def raise_if_error(self):
@@ -682,26 +684,21 @@ class DryRunResult:
     result.changes # => {"local-node": "..."}
     """
 
-    class DryRunType(Enum):
-        CLI = "cli"
-        XML = "xml"
-        NATIVE = "NATIVE"
-
     dry_run: DryRunType
-    changes: dict[str, str] | None  # "local-node" -> "data"
+    changes: dict[str, YangData]  # "local-node" -> "data"
 
-    def __init__(self, response: dict[str, any]):
+    def __init__(self, response: dict[str, YangData]):
         """Construct a response from a RestConf response"""
         response = response["dry-run-result"]
-        changes = {}
+        changes: dict[str, YangData] = {}
         if "cli" in response:
-            self.dry_run = self.DryRunType.CLI
+            self.dry_run = DryRunType.CLI
             changes = response["cli"]
         elif "result-xml" in response:
-            self.dry_run = self.DryRunType.XML
+            self.dry_run = DryRunType.XML
             changes = response["result-xml"]
         elif "native" in response:
-            self.dry_run = self.DryRunType.CLI
+            self.dry_run = DryRunType.CLI
             changes = response["native"]
         else:
             raise NotImplementedError(

{python_nso_client-0.1.1 → python_nso_client-0.1.2}/src/nso_client/types.py

@@ -1,4 +1,5 @@
 from enum import Enum
+from typing import TypeAlias
 
 
 class ContentType(str, Enum):
@@ -16,3 +17,14 @@ class InsertWhere(str, Enum):
     LAST = "last"
     BEFORE = "before"
     AFTER = "after"
+
+
+YangData: TypeAlias = (
+    None | bool | int | float | str | list["YangData"] | dict[str, "YangData"]
+)
+
+
+class DryRunType(str, Enum):
+    CLI = "cli"
+    XML = "xml"
+    NATIVE = "NATIVE"

{python_nso_client-0.1.1 → python_nso_client-0.1.2}/tests/test_nso_client.py

@@ -19,6 +19,7 @@ from nso_client import (
     NotFoundError,
     NSOClient,
 )
+from nso_client.types import DryRunType
 
 
 def test_get_200(httpx_mock: HTTPXMock):
@@ -166,7 +167,7 @@ def test_put_200_dry_run(httpx_mock: HTTPXMock):
 
     # Check
     assert isinstance(resp, DryRunResult)
-    assert resp.dry_run is DryRunResult.DryRunType.CLI
+    assert resp.dry_run is DryRunType.CLI
     assert resp.changes["local-node"]
     assert len(httpx_mock.get_requests()) == 1
 

{python_nso_client-0.1.1 → python_nso_client-0.1.2}/tests/test_patch.py

@@ -11,7 +11,7 @@ from fixtures import (
 )
 from nso_client import DryRunResult, NSOClient
 from nso_client.exceptions import PatchError, YangPatchError
-from nso_client.types import InsertWhere
+from nso_client.types import DryRunType, InsertWhere
 
 
 def test_patch_merge_200(httpx_mock: HTTPXMock):
@@ -153,7 +153,7 @@ def test_patch_create_dry_run_200(httpx_mock: HTTPXMock):
 
     # Check that the response read correctly
     assert type(resp) is DryRunResult
-    assert resp.dry_run == DryRunResult.DryRunType.CLI
+    assert resp.dry_run == DryRunType.CLI
     assert resp.changes["local-node"] == "Some changes"
 
     # Check that the call was made correctly

{python_nso_client-0.1.1 → python_nso_client-0.1.2}/uv.lock

@@ -205,7 +205,7 @@ wheels = [
 
 [[package]]
 name = "python-nso-client"
-version = "0.1.1"
+version = "0.1.2"
 source = { editable = "." }
 dependencies = [
     { name = "httpx" },