catalystwan 2.0.0a1__tar.gz → 2.0.0a2__tar.gz

catalystwan-2.0.0a2/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: catalystwan
+Version: 2.0.0a2
+Summary: Cisco Catalyst WAN SDK for Python
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/cisco-en-programmability/catalystwan-sdk-next-python
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Internet
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: packaging>=23.0
+Requires-Dist: requests>=2.32.3
+Requires-Dist: typing-extensions>=4.12.2
+Requires-Dist: urllib3>=2.2.2
+Requires-Dist: catalystwan-types==2.0.0a0
+Requires-Dist: catalystwan-v20-15==2.0.0a1
+Requires-Dist: catalystwan-v20-16==2.0.0a1
+Provides-Extra: test
+Requires-Dist: pytest>=8.2.2; extra == "test"
+Provides-Extra: ver-all
+Requires-Dist: catalystwan-v20-15==2.0.0a1; extra == "ver-all"
+Requires-Dist: catalystwan-v20-16==2.0.0a1; extra == "ver-all"
+Provides-Extra: ver-2015
+Requires-Dist: catalystwan-v20-15==2.0.0a1; extra == "ver-2015"
+Provides-Extra: ver-2016
+Requires-Dist: catalystwan-v20-16==2.0.0a1; extra == "ver-2016"
+Dynamic: license-file
+
+Cisco Catalyst WAN SDK 2.0
+==========================
+
+Welcome to the official documentation for the Cisco Catalyst WAN SDK, a package designed for creating simple and parallel automatic requests via the official SD-WAN Manager API.
+
+Overview
+--------
+
+Cisco Catalyst WAN SDK serves as a multiple session handler (provider, provider as a tenant, tenant) and is environment-independent. You just need a connection to any SD-WAN Manager.
+
+Supported Catalystwan WAN Server Versions
+-----------------------------------------
+
+- 20.15
+- 20.16
+
+
+Important Notice: Version Incompatibility
+-----------------------------------------
+
+We are excited to announce the release of Cisco Catalyst WAN SDK version 2.0.
+This new version introduces a range of enhancements and features designed
+to improve performance and usability. However, it is important to note that version 2.0
+is not compatible with any previous legacy versions of the SDK.
+
+
+Actions Recommended:
+    Backup: Ensure you have backups of your current projects before attempting to upgrade.
+    Review Documentation: Carefully review the updated documentation and release notes for guidance on migration and new features.
+    Test Thoroughly: Test your projects thoroughly in a development environment before deploying version 2.0 in production.
+
+We appreciate your understanding and cooperation as we continue to enhance the Cisco Catalyst WAN SDK. Should you have any questions or require assistance, please reach out through our support channels.
+
+Thank you for your continued support and feedback!
+
+
+Not recommend to use in production environments.
+------------------------------------------------
+Cisco Catalyst WAN SDK in its `pre-alpha` release phase. This marks a significant milestone
+in empowering developers to unlock the full capabilities of Cisco's networking solutions.
+Please note that, as a pre-alpha release, this version of the SDK is still in active development
+and testing. It is provided "as is," with limited support offered on a best-effort basis.
+
+
+Supported Python Versions
+-------------------------
+
+Python >= 3.8
+
+> If you don't have a specific version, you can just use [Pyenv](https://github.com/pyenv/pyenv) to manage Python versions.
+
+
+Installation
+------------
+
+To install the SDK, run the following command:
+
+```bash
+pip install catalystwan==2.0.0a0
+```
+
+To manually install the necessary Python packages in editable mode, you can use the `pip install -e` command.
+
+```bash
+pip install -e ./packages/catalystwan-types \
+            -e ./packages/catalystwan-core \
+            -e ./versions/catalystwan-v20_15 \
+            -e ./versions/catalystwan-v20_16
+```
+
+
+Getting Started
+---------------
+
+To execute SDK APIs, you need to create a `ApiClient`. Use the `create_client()` method to configure a session, perform authentication, and obtain a `ApiClient` instance in an operational state.
+
+### Example Usage
+
+Here's a quick example of how to use the SDK:
+
+```python
+from catalystwan.core import create_client
+
+url = "example.com"
+username = "admin"
+password = "password123"
+
+with create_client(url=url, username=username, password=password) as client:
+    result = client.health.devices.get_devices_health()
+    print(result)
+```
+
+If you need to preform more complex operations that require models, they can utilize an alias: `m`.
+```python
+
+with create_client(...) as client:
+    result = client.admin.aaa.update_aaa_config(
+        client.admin.aaa.m.Aaa(
+            accounting: True,
+            admin_auth_order: False,
+            audit_disable: False,
+            auth_fallback: False,
+            auth_order: ["local"]
+        )
+    )
+    print(result)
+```
+
+Using an alias allows for easier access and management of models, simplifying workflows and improving efficiency. This approach helps streamline operations without requiring direct integration with underlying models, making them more user-friendly and scalable.

catalystwan-2.0.0a2/README.md

@@ -0,0 +1,109 @@
+Cisco Catalyst WAN SDK 2.0
+==========================
+
+Welcome to the official documentation for the Cisco Catalyst WAN SDK, a package designed for creating simple and parallel automatic requests via the official SD-WAN Manager API.
+
+Overview
+--------
+
+Cisco Catalyst WAN SDK serves as a multiple session handler (provider, provider as a tenant, tenant) and is environment-independent. You just need a connection to any SD-WAN Manager.
+
+Supported Catalystwan WAN Server Versions
+-----------------------------------------
+
+- 20.15
+- 20.16
+
+
+Important Notice: Version Incompatibility
+-----------------------------------------
+
+We are excited to announce the release of Cisco Catalyst WAN SDK version 2.0.
+This new version introduces a range of enhancements and features designed
+to improve performance and usability. However, it is important to note that version 2.0
+is not compatible with any previous legacy versions of the SDK.
+
+
+Actions Recommended:
+    Backup: Ensure you have backups of your current projects before attempting to upgrade.
+    Review Documentation: Carefully review the updated documentation and release notes for guidance on migration and new features.
+    Test Thoroughly: Test your projects thoroughly in a development environment before deploying version 2.0 in production.
+
+We appreciate your understanding and cooperation as we continue to enhance the Cisco Catalyst WAN SDK. Should you have any questions or require assistance, please reach out through our support channels.
+
+Thank you for your continued support and feedback!
+
+
+Not recommend to use in production environments.
+------------------------------------------------
+Cisco Catalyst WAN SDK in its `pre-alpha` release phase. This marks a significant milestone
+in empowering developers to unlock the full capabilities of Cisco's networking solutions.
+Please note that, as a pre-alpha release, this version of the SDK is still in active development
+and testing. It is provided "as is," with limited support offered on a best-effort basis.
+
+
+Supported Python Versions
+-------------------------
+
+Python >= 3.8
+
+> If you don't have a specific version, you can just use [Pyenv](https://github.com/pyenv/pyenv) to manage Python versions.
+
+
+Installation
+------------
+
+To install the SDK, run the following command:
+
+```bash
+pip install catalystwan==2.0.0a0
+```
+
+To manually install the necessary Python packages in editable mode, you can use the `pip install -e` command.
+
+```bash
+pip install -e ./packages/catalystwan-types \
+            -e ./packages/catalystwan-core \
+            -e ./versions/catalystwan-v20_15 \
+            -e ./versions/catalystwan-v20_16
+```
+
+
+Getting Started
+---------------
+
+To execute SDK APIs, you need to create a `ApiClient`. Use the `create_client()` method to configure a session, perform authentication, and obtain a `ApiClient` instance in an operational state.
+
+### Example Usage
+
+Here's a quick example of how to use the SDK:
+
+```python
+from catalystwan.core import create_client
+
+url = "example.com"
+username = "admin"
+password = "password123"
+
+with create_client(url=url, username=username, password=password) as client:
+    result = client.health.devices.get_devices_health()
+    print(result)
+```
+
+If you need to preform more complex operations that require models, they can utilize an alias: `m`.
+```python
+
+with create_client(...) as client:
+    result = client.admin.aaa.update_aaa_config(
+        client.admin.aaa.m.Aaa(
+            accounting: True,
+            admin_auth_order: False,
+            audit_disable: False,
+            auth_fallback: False,
+            auth_order: ["local"]
+        )
+    )
+    print(result)
+```
+
+Using an alias allows for easier access and management of models, simplifying workflows and improving efficiency. This approach helps streamline operations without requiring direct integration with underlying models, making them more user-friendly and scalable.

{catalystwan-2.0.0a1 → catalystwan-2.0.0a2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "catalystwan"
-version = "2.0.0a1"
+version = "2.0.0a2"
 description = "Cisco Catalyst WAN SDK for Python"
 dependencies = [
     "packaging >= 23.0",
@@ -12,7 +12,9 @@ dependencies = [
     "catalystwan-v20-16 == 2.0.0a1"
 ]
 readme = "README.md"
-license = {file = "LICENSE"}
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+
 requires-python = ">= 3.8"
 classifiers = [
   # one of:
@@ -21,7 +23,6 @@ classifiers = [
   # "Development Status :: 5 - Production/Stable"
   "Development Status :: 3 - Alpha",
   "Intended Audience :: Developers",
-  "License :: OSI Approved :: Apache Software License",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3",
   "Programming Language :: Python :: 3.8",

catalystwan-2.0.0a2/src/catalystwan/core/__init__.py

@@ -0,0 +1,2 @@
+from catalystwan.core.client import create_client as create_client
+from catalystwan.core.client import create_client_from_auth as create_client_from_auth

catalystwan-2.0.0a2/src/catalystwan/core/client.py

@@ -0,0 +1,159 @@
+from __future__ import annotations
+
+import logging
+from contextlib import contextmanager
+from copy import copy
+from inspect import isclass
+from typing import TYPE_CHECKING, Generator, Optional, Type, TypeVar, Union, cast, overload
+
+from catalystwan.core.apigw_auth import ApiGwAuth
+from catalystwan.core.exceptions import CatalystwanException
+from catalystwan.core.loader import load_client
+from catalystwan.core.request_adapter import RequestAdapter
+from catalystwan.core.request_limiter import RequestLimiter
+from catalystwan.core.session import ManagerSession, create_base_url, create_manager_session
+from catalystwan.core.vmanage_auth import vManageAuth
+from typing_extensions import TypeGuard
+
+if TYPE_CHECKING:
+    from catalystwan.core.loader import ApiClient
+
+
+class CatalystwanNotAClientException(CatalystwanException): ...
+
+
+Client = TypeVar("Client")
+
+
+# TODO: Better TypeGuards - it may be hard since we want to avoid direct imports
+# For now, it's more of a hack for typing purposes
+def _is_client_instance(obj: object) -> TypeGuard[ApiClient]:
+    return not isclass(obj) and hasattr(obj, "api_version")
+
+
+def _is_client_class(obj: object) -> TypeGuard[Type[ApiClient]]:
+    return isclass(obj) and hasattr(obj, "api_version")
+
+
+@overload
+@contextmanager
+def create_client_from_auth(
+    url: str,
+    auth: Union[vManageAuth, ApiGwAuth],
+    port: Optional[int] = None,
+    subdomain: Optional[str] = None,
+    logger: Optional[logging.Logger] = None,
+    request_limiter: Optional[RequestLimiter] = None,
+) -> Generator[ApiClient, None, None]: ...
+
+
+@overload
+@contextmanager
+def create_client_from_auth(
+    url: str,
+    auth: Union[vManageAuth, ApiGwAuth],
+    port: Optional[int] = None,
+    subdomain: Optional[str] = None,
+    logger: Optional[logging.Logger] = None,
+    request_limiter: Optional[RequestLimiter] = None,
+    *,
+    api_client_class: Type[Client],
+) -> Generator[Client, None, None]: ...
+
+
+@contextmanager
+def create_client_from_auth(
+    url: str,
+    auth: Union[vManageAuth, ApiGwAuth],
+    port: Optional[int] = None,
+    subdomain: Optional[str] = None,
+    logger: Optional[logging.Logger] = None,
+    request_limiter: Optional[RequestLimiter] = None,
+    api_client_class: Optional[Type[Client]] = None,
+) -> Generator[Union[ApiClient, Client], None, None]:
+    if logger is None:
+        logger = logging.getLogger(__name__)
+    session = ManagerSession(
+        base_url=create_base_url(url, port),
+        auth=auth,
+        subdomain=subdomain,
+        logger=logger,
+        request_limiter=request_limiter,
+    )
+    with session.login():
+        version = session.api_version.base_version
+        if api_client_class is None:
+            logger.debug(f"Choosing client for version {version}...")
+            client = load_client(session.api_version.base_version)
+            logger.debug(f"Client for version {version} loaded")
+            yield client(RequestAdapter(session=session, logger=logger))
+        elif _is_client_class(api_client_class):
+            logger.debug(f"Creating instance for client class {api_client_class}")
+            yield api_client_class(RequestAdapter(session=session, logger=logger))
+        else:
+            raise CatalystwanNotAClientException(f"{api_client_class} is not a client class")
+
+
+@overload
+@contextmanager
+def create_client(
+    url: str,
+    username: str,
+    password: str,
+    port: Optional[int] = None,
+    subdomain: Optional[str] = None,
+    logger: Optional[logging.Logger] = None,
+) -> Generator[ApiClient, None, None]: ...
+
+
+@overload
+@contextmanager
+def create_client(
+    url: str,
+    username: str,
+    password: str,
+    port: Optional[int] = None,
+    subdomain: Optional[str] = None,
+    logger: Optional[logging.Logger] = None,
+    *,
+    api_client_class: Type[Client],
+) -> Generator[Client, None, None]: ...
+
+
+@contextmanager
+def create_client(
+    url: str,
+    username: str,
+    password: str,
+    port: Optional[int] = None,
+    subdomain: Optional[str] = None,
+    logger: Optional[logging.Logger] = None,
+    api_client_class: Optional[Type[Client]] = None,
+) -> Generator[Union[ApiClient, Client], None, None]:
+    if logger is None:
+        logger = logging.getLogger(__name__)
+    with create_manager_session(url, username, password, port, subdomain, logger) as session:
+        if api_client_class is None:
+            version = session.api_version.base_version
+            logger.debug(f"Choosing client for version {version}...")
+            client = load_client(session.api_version.base_version)
+            logger.debug(f"Client for version {version} loaded")
+            yield client(RequestAdapter(session=session, logger=logger))
+        elif _is_client_class(api_client_class):
+            logger.debug(f"Creating instance for client class {api_client_class}")
+            yield api_client_class(RequestAdapter(session=session, logger=logger))
+        else:
+            raise CatalystwanNotAClientException(f"{api_client_class} is not a client class")
+
+
+@contextmanager
+def copy_client(client: Client) -> Generator[Client, None, None]:
+    if _is_client_instance(client):
+        request_adapter = copy(client._request_adapter)
+        session = request_adapter.session
+        with session.login():
+            new_client = load_client(session.api_version.base_version)(request_adapter)
+            assert new_client.api_version == client.api_version
+            yield cast(Client, new_client)
+    else:
+        raise CatalystwanNotAClientException(f"{client} is not a client instance")

{catalystwan-2.0.0a1 → catalystwan-2.0.0a2}/src/catalystwan/core/models/deserialize.py

@@ -1,14 +1,15 @@
 from collections import deque
 from copy import deepcopy
-from dataclasses import fields, is_dataclass
+from dataclasses import dataclass, fields, is_dataclass
 from functools import reduce
 from inspect import isclass, unwrap
-from typing import Any, Dict, List, Literal, Protocol, Tuple, Type, TypeVar, Union
+from typing import Any, Dict, List, Literal, Optional, Protocol, Tuple, Type, TypeVar, Union, cast
 
 from catalystwan.core.exceptions import (
     CatalystwanModelInputException,
     CatalystwanModelValidationError,
 )
+from catalystwan.core.models.utils import count_matching_keys
 from catalystwan.core.types import MODEL_TYPES, AliasPath, DataclassInstance
 from typing_extensions import Annotated, get_args, get_origin, get_type_hints
 
@@ -19,6 +20,13 @@ class ValueExtractorCallable(Protocol):
     def __call__(self, field_value: Any) -> Any: ...
 
 
+@dataclass
+class ExtractedValue:
+    value: Any
+    exact_match: bool
+    matched_keys: Optional[int] = None
+
+
 class ModelDeserializer:
     def __init__(self, model: Type[T]) -> None:
         self.model = model
@@ -47,7 +55,6 @@ class ModelDeserializer:
 
     def __check_errors(self):
         if self._exceptions:
-            print(self._exceptions)
             # Put exceptions from current model first
             self._exceptions.sort(key=lambda x: isinstance(x, CatalystwanModelValidationError))
             current_model_errors = sum(
@@ -58,67 +65,91 @@ class ModelDeserializer:
                 message += f"{exc}\n"
             raise CatalystwanModelValidationError(message)
 
-    def __is_optional(self, t: Any) -> bool:
-        if get_origin(t) is Union and type(None) in get_args(t):
-            return True
-        return False
-
-    def __extract_type(self, field_type: Any, field_value: Any, field_name: str) -> Any:
+    def __extract_type(self, field_type: Any, field_value: Any, field_name: str) -> ExtractedValue:
         origin = get_origin(field_type)
         # check for simple types and classes
         if origin is None:
-            if field_type is Any:
-                return field_value
-            if isinstance(field_value, field_type):
-                return field_value
+            if field_type is Any or isinstance(field_value, field_type):
+                return ExtractedValue(value=field_value, exact_match=True)
+            # Do not cast bool values
+            elif field_type is bool:
+                ...
+            # False/Empty values (like empty string or list) can match to None
+            elif field_type is type(None):
+                if not field_value:
+                    return ExtractedValue(value=None, exact_match=False)
             elif is_dataclass(field_type):
-                assert isinstance(field_type, type)
-                return deserialize(field_type, **field_value)
+                model_instance = deserialize(
+                    cast(Type[DataclassInstance], field_type), **field_value
+                )
+                return ExtractedValue(
+                    value=model_instance,
+                    exact_match=False,
+                    matched_keys=count_matching_keys(model_instance, field_value),
+                )
             elif isclass(unwrap(field_type)):
                 if isinstance(field_value, dict):
-                    return field_type(**field_value)
+                    return ExtractedValue(value=field_type(**field_value), exact_match=False)
                 else:
                     try:
-                        return field_type(field_value)
+                        return ExtractedValue(value=field_type(field_value), exact_match=False)
                     except ValueError:
                         raise CatalystwanModelInputException(
                             f"Unable to match or cast input value for {field_name} [expected_type={unwrap(field_type)}, input={field_value}, input_type={type(field_value)}]"
                         )
+        # List is an exact match only if all of its elements are
         elif origin is list:
             if isinstance(field_value, list):
-                return [
-                    self.__extract_type(get_args(field_type)[0], value, field_name)
-                    for value in field_value
-                ]
-        elif self.__is_optional(field_type):
-            if field_value is None:
-                return None
-            else:
-                try:
-                    return self.__extract_type(get_args(field_type)[0], field_value, field_name)
-                except CatalystwanModelInputException as e:
-                    if not field_value:
-                        return None
-                    raise e
+                values = []
+                exact_match = True
+                for value in field_value:
+                    extracted_value = self.__extract_type(
+                        get_args(field_type)[0], value, field_name
+                    )
+                    values.append(extracted_value.value)
+                    if not extracted_value.exact_match:
+                        exact_match = False
+                return ExtractedValue(value=values, exact_match=exact_match)
         elif origin is Literal:
             for arg in get_args(field_type):
                 try:
                     if type(arg)(field_value) == arg:
-                        return type(arg)(field_value)
+                        return ExtractedValue(
+                            value=type(arg)(field_value), exact_match=type(arg) is type(field_value)
+                        )
                 except Exception:
                     continue
         elif origin is Annotated:
             validator, caster = field_type.__metadata__
             if validator(field_value):
-                return field_value
-            return caster(field_value)
-        # TODO: Currently, casting is done left-to-right. Searching deeper for a better match may be the way to go.
+                return ExtractedValue(value=field_value, exact_match=True)
+            return ExtractedValue(value=caster(field_value), exact_match=False)
+        # When parsing Unions, try to find the best match. Currently, it involves:
+        # 1. Finding the exact match
+        # 2. If not found, favors dataclasses - sorted by number of matched keys, then None values
+        # 3. If no dataclasses are present, return the leftmost matched argument
         elif origin is Union:
+            matches: List[ExtractedValue] = []
             for arg in get_args(field_type):
                 try:
-                    return self.__extract_type(arg, field_value, field_name)
+                    extracted_value = self.__extract_type(arg, field_value, field_name)
+                    # exact match, return
+                    if extracted_value.exact_match:
+                        return extracted_value
+                    else:
+                        matches.append(extracted_value)
                 except Exception:
                     continue
+            # Only one element matched, return
+            if len(matches) == 1:
+                return matches[0]
+            # Only non-exact matches left, sort and return first element
+            elif len(matches) > 1:
+                matches.sort(
+                    key=lambda x: (x.matched_keys is not None, x.matched_keys, x.value is None),
+                    reverse=True,
+                )
+                return matches[0]
         # Correct type not found, add exception
         raise CatalystwanModelInputException(
             f"Unable to match or cast input value for {field_name} [expected_type={unwrap(field_type)}, input={field_value}, input_type={type(field_value)}]"
@@ -131,7 +162,7 @@ class ModelDeserializer:
         kwargs_copy = deepcopy(kwargs)
         new_args = []
         new_kwargs = {}
-        field_types = get_type_hints(cls)
+        field_types = get_type_hints(cls, include_extras=True)
         for field in fields(cls):
             if not field.init:
                 continue
@@ -141,7 +172,9 @@ class ModelDeserializer:
                 field_value = args_copy.popleft()
                 try:
                     new_args.append(
-                        self.__extract_type(field_type, value_extractor(field_value), field.name)
+                        self.__extract_type(
+                            field_type, value_extractor(field_value), field.name
+                        ).value
                     )
                 except (
                     CatalystwanModelInputException,
@@ -165,7 +198,7 @@ class ModelDeserializer:
             try:
                 new_kwargs[field.name] = self.__extract_type(
                     field_type, value_extractor(field_value), field.name
-                )
+                ).value
             except (
                 CatalystwanModelInputException,
                 CatalystwanModelValidationError,

catalystwan-2.0.0a2/src/catalystwan/core/models/utils.py

@@ -0,0 +1,27 @@
+from dataclasses import is_dataclass
+from typing import TypeVar, cast
+
+from catalystwan.core.types import DataclassInstance
+
+DataclassType = TypeVar("DataclassType", bound=DataclassInstance)
+
+
+def count_matching_keys(model: DataclassType, model_payload: dict):
+    matched_keys = 0
+    for key, value in model_payload.items():
+        try:
+            model_value = getattr(model, key)
+            matched_keys += 1
+            if is_dataclass(model_value) and isinstance(value, dict):
+                matched_keys += count_matching_keys(cast(DataclassType, model_value), value)
+            elif (
+                isinstance(model_value, list)
+                and all([is_dataclass(element) for element in model_value])
+                and isinstance(value, list)
+            ):
+                for model_v, input_v in zip(model_value, value):
+                    matched_keys += count_matching_keys(model_v, input_v)
+        except AttributeError:
+            continue
+
+    return matched_keys