catalystwan 0.40.2.dev1__py3-none-any.whl → 2.0.0a1__py3-none-any.whl

catalystwan-2.0.0a1.dist-info/METADATA

@@ -0,0 +1,239 @@
+Metadata-Version: 2.1
+Name: catalystwan
+Version: 2.0.0a1
+Summary: Cisco Catalyst WAN SDK for Python
+License: Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright (c) 2024 Cisco Systems, Inc. and/or its affiliates
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+        
+Project-URL: Homepage, https://github.com/cisco-en-programmability/catalystwan-sdk-next-python
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+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-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'
+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'
+

catalystwan-2.0.0a1.dist-info/RECORD

@@ -0,0 +1,24 @@
+catalystwan/core/__init__.py,sha256=BtFD4803qN7cxzpl1hrUMMfV29mBEPH3DbCWcsJAhYM,148
+catalystwan/core/abstractions.py,sha256=-Srp20skc9WDu6m2zGUjA34rEJPd12XQgDTGf_qicXk,738
+catalystwan/core/apigw_auth.py,sha256=-ZnoXzMB86SuRhJ5o7OL9BuVJTZvKQp9EW1zWu_4Iao,4706
+catalystwan/core/client.py,sha256=FPQEAqyLK-NQDOExEYEBzKQvghQ4Y7h2l6VY1IENSRI,2599
+catalystwan/core/encoder.py,sha256=hY_Osk9yyqvDgveB2pHmH5kzAzIO11vNT-kmSEmvgGA,243
+catalystwan/core/exceptions.py,sha256=Fhs69uEe-Uq4G4q3XS4N4oSQZJcjmlbL9jKtNkRWspQ,6680
+catalystwan/core/loader.py,sha256=AGjXJEt3qptG-B7iCKhXG0Y9p-wfG_-xD4H_6aSEiQ4,1133
+catalystwan/core/metadata.py,sha256=JIXC3um36dWLkEWCADo8pxsCsq8jjPguHF1u-4Ws2FQ,2102
+catalystwan/core/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+catalystwan/core/request_adapter.py,sha256=90bQcK6hiMpaqW3mxCM4HHsT9GTwcDHNz3Bu62oME6g,9783
+catalystwan/core/request_limiter.py,sha256=l0afY5HCpXCC_M6RoQSlg-X3k_bnTLieHGFfopuBDCk,521
+catalystwan/core/response.py,sha256=xj3MwOUt8lj4M3rElR5vnRThHlN1lU6xsNOCBsY1QXc,7824
+catalystwan/core/session.py,sha256=3uqHslMzq4CD_N0IEzygnEgbTGEi0NT1ljqA0CmuE8U,21504
+catalystwan/core/types.py,sha256=X-u8OdRkCmJFA7NWZIgsrxvu83vFoDey5Z4Bqha0fdc,702
+catalystwan/core/version.py,sha256=cVKyfW_COPiF961Wlo3Gf5JL-2ZoFC1TfEfh49EUBEg,2959
+catalystwan/core/vmanage_auth.py,sha256=dJwxtA6XgOSghlrhW4G2kBbNaTHBPsTBSmg4-kuMLGc,11019
+catalystwan/core/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+catalystwan/core/models/deserialize.py,sha256=eYuLmn04j5kzvMs8MXlPmBf9B1uFaW-utksthbViKk4,8308
+catalystwan/core/models/serialize.py,sha256=RW8zJ4NUMwIBtOaoLLuFTx5WS2rQdcfKiARjA3XX-W0,5110
+catalystwan-2.0.0a1.dist-info/LICENSE,sha256=97ROi91Vxrj_Jio2v8FI9E8-y6x2uYdQRaFlrEbVjkc,11375
+catalystwan-2.0.0a1.dist-info/METADATA,sha256=wAB7GAuqsLAsrv9kK8eC6yYZt20EavOUG8kHKZ0EjBU,14487
+catalystwan-2.0.0a1.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
+catalystwan-2.0.0a1.dist-info/top_level.txt,sha256=0mv3rTOajNOAxvPHv_tHJpukVsP0plO5rD1ORKVDUM4,12
+catalystwan-2.0.0a1.dist-info/RECORD,,

{catalystwan-0.40.2.dev1.dist-info → catalystwan-2.0.0a1.dist-info}/WHEEL

@@ -1,4 +1,5 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.4.0
+Generator: setuptools (75.3.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
+

catalystwan-2.0.0a1.dist-info/top_level.txt

@@ -0,0 +1 @@
+catalystwan

catalystwan/abstractions.py

@@ -1,77 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-from typing import Optional, Protocol, Type, TypeVar
-
-from packaging.version import Version  # type: ignore
-from requests import PreparedRequest
-
-from catalystwan.typed_list import DataSequence
-from catalystwan.utils.session_type import SessionType
-
-T = TypeVar("T")
-
-
-class APIEndpointClientResponse(Protocol):
-    """
-    Interface to response object. Fits "requests.Response"
-    but set of methods is minimal to allow easy migration to another client if needed
-    """
-
-    @property
-    def text(self) -> str:
-        ...
-
-    @property
-    def content(self) -> bytes:
-        ...
-
-    def dataobj(self, cls: Type[T], sourcekey: Optional[str], validate: bool) -> T:
-        ...
-
-    def dataseq(self, cls: Type[T], sourcekey: Optional[str], validate: bool) -> DataSequence[T]:
-        ...
-
-    def json(self) -> dict:
-        ...
-
-
-class APIEndpointClient(Protocol):
-    """
-    Interface to client object.
-    We only need a 'request' function and few vmanage session properties obtained from server.
-    Matched to fit "requests.Session" but migration to other client is possible.
-    At his point not very clean as injection of custom kwargs is possible (and sometimes used)
-    """
-
-    def request(self, method: str, url: str, **kwargs) -> APIEndpointClientResponse:
-        ...
-
-    @property
-    def api_version(self) -> Version:
-        ...
-
-    @property
-    def session_type(self) -> Optional[SessionType]:
-        ...
-
-    @property
-    def validate_responses(self) -> bool:
-        ...
-
-
-class AuthProtocol(Protocol):
-    """
-    Additional interface for Auth to handle login/logout for multiple auth types by common ManagerSession
-    """
-
-    def logout(self, client: APIEndpointClient) -> None:
-        ...
-
-    def clear(self, last_request: Optional[PreparedRequest]) -> None:
-        ...
-
-    def increase_session_count(self) -> None:
-        ...
-
-    def decrease_session_count(self) -> None:
-        ...

catalystwan/api/admin_tech_api.py

@@ -1,176 +0,0 @@
-# Copyright 2022 Cisco Systems, Inc. and its affiliates
-
-"""
-Module for handling admintech logs for a device
-"""
-from __future__ import annotations
-
-import logging
-import time
-from pathlib import Path
-from typing import TYPE_CHECKING, List, Optional
-
-from catalystwan.dataclasses import AdminTech, DeviceAdminTech
-from catalystwan.exceptions import CatalystwanException, ManagerHTTPError
-from catalystwan.response import ManagerResponse
-from catalystwan.utils.creation_tools import create_dataclass
-
-if TYPE_CHECKING:
-    from catalystwan.session import ManagerSession
-
-logger = logging.getLogger(__name__)
-
-
-class GenerateAdminTechLogError(CatalystwanException):
-    pass
-
-
-class DownloadAdminTechLogError(CatalystwanException):
-    pass
-
-
-class RequestTokenIdNotFound(CatalystwanException):
-    pass
-
-
-class AdminTechAPI:
-    """Class for handling admintech logs for a device.
-
-    Attributes:
-        session: logged in API client session
-
-    Usage example:
-        # Create session
-        session = create_manager_session(...)
-        # Get admintech data for all devices
-        all_admintechs = session.api.admin_tech.get_all()
-    """
-
-    def __init__(self, session: ManagerSession) -> None:
-        self.session = session
-
-    def __str__(self) -> str:
-        return str(self.session)
-
-    def get(self, device_id: str) -> List[DeviceAdminTech]:
-        """Gets admintech log information for a device.
-
-        Args:
-            device_id: device ID (usually system-ip)
-        Returns:
-            AdminTech object list for given device
-        """
-        body = {"deviceIP": device_id}
-        response = self.session.post(url="/dataservice/device/tools/admintechlist", json=body)
-        items = response.json()["data"]
-        return [create_dataclass(DeviceAdminTech, item) for item in items]
-
-    def get_all(self) -> List[AdminTech]:
-        """Gets admintech log information for all devices.
-
-        Returns:
-            AdminTech objects list for all devices
-        """
-        response = self.session.get("/dataservice/device/tools/admintechs")
-        items = response.json()["data"]
-        return [create_dataclass(AdminTech, item) for item in items]
-
-    def generate(
-        self,
-        device_id: str,
-        exclude_cores: bool = True,
-        exclude_tech: bool = False,
-        exclude_logs: bool = True,
-        request_timeout: int = 3600,
-        polling_timeout: int = 1200,
-        polling_interval: int = 30,
-    ) -> str:
-        """Generates admintech log for a device.
-        Args:
-            device_id: device ID (usually system-ip)
-            exclude_cores: exclude core in generated admintech log file
-            exclude_tech: exclude tech in generated admintech log file
-            exclude_logs: exclude logs in generated admintech log file
-            request_timeout: wait time in seconds to generate admintech after request
-            polling_timeout: retry period in seconds for successfull request
-            polling_interval: polling interval in seconds between request attempts
-        Returns:
-            filename of generated admintech log
-        """
-        create_admin_tech_error_msgs = "Admin tech creation already in progress"
-        body = {
-            "deviceIP": device_id,
-            "exclude-cores": exclude_cores,
-            "exclude-tech": exclude_tech,
-            "exclude-logs": exclude_logs,
-        }
-        polling_timer = polling_timeout
-        while polling_timer > 0:
-            logger.info(
-                f"Starting AdminTech log creation for {device_id}, waiting up to {request_timeout} seconds to complete"
-            )
-            try:
-                response = self.session.post(
-                    url="/dataservice/device/tools/admintech",
-                    json=body,
-                    timeout=request_timeout,
-                )
-            except ManagerHTTPError as http_error:
-                response = http_error.response  # type: ignore
-            if response.status_code == 200:
-                filename = response.json()["fileName"]
-                self._get_token_id(filename=filename, timeout=request_timeout, interval=polling_interval)
-                return filename
-            if response.status_code == 400 and create_admin_tech_error_msgs in response.json().get("error", {}).get(
-                "details", ""
-            ):
-                logger.warning(f"Admin tech creation already in progress, retrying in {polling_interval} seconds")
-            else:
-                raise GenerateAdminTechLogError(f"It is not possible to generate admintech log for {device_id}")
-            time.sleep(polling_interval)
-            polling_timer -= polling_interval
-        raise GenerateAdminTechLogError(f"It is not possible to generate admintech log for {device_id}")
-
-    def _get_token_id(self, filename: str, timeout: int, interval: int) -> str:
-        # Wait for the file to be ready and obtain the token_id
-        end_time = time.time() + timeout
-        while time.time() < end_time:
-            admin_techs = self.get_all()
-            for admin_tech in admin_techs:
-                if filename == admin_tech.filename and admin_tech.state == "done":
-                    return admin_tech.token_id
-            time.sleep(interval)
-        raise RequestTokenIdNotFound(
-            f"requestTokenId of admin tech generation request not found for file name: {filename}"
-        )
-
-    def delete(self, filename: str, timeout: int = 3600, interval: int = 30) -> ManagerResponse:
-        """Deletes admin tech logs for a device.
-        Args:
-            filename: name of admin_tech file
-        Returns:
-            response: http response for delete operation
-        """
-
-        token_id = self._get_token_id(filename, timeout, interval)
-        response = self.session.delete(f"/dataservice/device/tools/admintech/{token_id}")
-        if response.status_code == 200:
-            logger.info(f"Deleted AdminTech file {filename} on remote")
-        return response
-
-    def download(self, filename: str, download_dir: Optional[Path] = None) -> Path:
-        """Downloads admintech log for a device.
-        Args:
-            filename: name of admin_tech file
-            download_dir: download directory (defaults to current working directory)
-        Returns:
-            path to downloaded admin_tech file
-        """
-        if not download_dir:
-            download_dir = Path.cwd()
-        download_path = download_dir / filename
-        url = f"/dataservice/device/tools/admintech/download/{filename}"
-        if self.session.get_file(url=url, filename=download_path).status_code != 200:
-            raise DownloadAdminTechLogError(f"Cannot download admin tech file: {filename} from remote")
-        logger.info(f"Downloaded AdminTech file to: {download_path}")
-        return download_path