scrapli 2.0.0a2__py3-none-manylinux2010_x86_64.whl

scrapli/transport.py

@@ -0,0 +1,401 @@
+"""scrapli.transport"""
+
+from ctypes import c_char_p, c_int
+from dataclasses import dataclass, field
+from enum import Enum
+
+from scrapli.exceptions import OptionsException
+from scrapli.ffi_mapping import LibScrapliMapping
+from scrapli.ffi_types import (
+    DriverPointer,
+    to_c_string,
+)
+
+
+class TransportKind(str, Enum):
+    """
+    Enum representing the transport kind
+
+    Args:
+        N/A
+
+    Returns:
+        None
+
+    Raises:
+        N/A
+
+    """
+
+    BIN = "bin"
+    SSH2 = "ssh2"
+    TELNET = "telnet"
+    TEST = "test_"
+
+
+@dataclass
+class BinOptions:
+    """
+    Options holds bin transport options to pass to the ffi layer.
+
+    Args:
+        bin: path to binary to use for the transport
+        extra_open_args: extra args to pass to the binary
+        override_open_args: override all "normal" scrapli args with these args
+        ssh_config_path: path to ssh config file
+        known_hosts_path: path to known hosts file
+        enable_strict_key: enable ssh strict key checking
+        term_height: set the terminal height
+        term_width: set the terminal width
+
+    Returns:
+        None
+
+    Raises:
+        N/A
+
+    """
+
+    bin: str | None = None
+    extra_open_args: list[str] | None = None
+    override_open_args: list[str] | None = None
+    ssh_config_path: str | None = None
+    known_hosts_path: str | None = None
+    enable_strict_key: bool | None = None
+    term_height: int | None = None
+    term_width: int | None = None
+
+    _bin: c_char_p | None = field(init=False, default=None, repr=False)
+    _extra_open_args: c_char_p | None = field(init=False, default=None, repr=False)
+    _override_open_args: c_char_p | None = field(init=False, default=None, repr=False)
+    _ssh_config_path: c_char_p | None = field(init=False, default=None, repr=False)
+    _known_hosts_path: c_char_p | None = field(init=False, default=None, repr=False)
+
+    def apply(  # noqa: C901, PLR0912
+        self, ffi_mapping: LibScrapliMapping, ptr: DriverPointer
+    ) -> None:
+        """
+        Applies the options to the given driver pointer.
+
+        Should not be called directly/by users.
+
+        Args:
+            ffi_mapping: the handle to the ffi mapping singleton
+            ptr: the pointer to the underlying cli or netconf object
+
+        Returns:
+            None
+
+        Raises:
+            OptionsException: if any option apply returns a non-zero return code.
+
+        """
+        if self.bin is not None:
+            self._bin = to_c_string(self.bin)
+
+            status = ffi_mapping.options_mapping.transport_bin.set_bin(ptr, self._bin)
+            if status != 0:
+                raise OptionsException("failed to set bin transport bin")
+
+        if self.extra_open_args is not None:
+            self._extra_open_args = to_c_string(" ".join(self.extra_open_args))
+
+            status = ffi_mapping.options_mapping.transport_bin.set_extra_open_args(
+                ptr, self._extra_open_args
+            )
+            if status != 0:
+                raise OptionsException("failed to set bin transport extra open args")
+
+        if self.override_open_args is not None:
+            self._override_open_args = to_c_string(" ".join(self.override_open_args))
+
+            status = ffi_mapping.options_mapping.transport_bin.set_override_open_args(
+                ptr, self._override_open_args
+            )
+            if status != 0:
+                raise OptionsException("failed to set bin transport override open args")
+
+        if self.ssh_config_path is not None:
+            self._ssh_config_path = to_c_string(self.ssh_config_path)
+
+            status = ffi_mapping.options_mapping.transport_bin.set_ssh_config_path(
+                ptr, self._ssh_config_path
+            )
+            if status != 0:
+                raise OptionsException("failed to set bin transport ssh config path")
+
+        if self.known_hosts_path is not None:
+            self._known_hosts_path = to_c_string(self.known_hosts_path)
+
+            status = ffi_mapping.options_mapping.transport_bin.set_known_hosts_path(
+                ptr, self._known_hosts_path
+            )
+            if status != 0:
+                raise OptionsException("failed to set bin transport ssh known hosts path")
+
+        if self.enable_strict_key is not None:
+            status = ffi_mapping.options_mapping.transport_bin.set_enable_strict_key(ptr)
+            if status != 0:
+                raise OptionsException("failed to set bin transport enable strict key")
+
+        if self.term_height is not None:
+            status = ffi_mapping.options_mapping.transport_bin.set_term_height(
+                ptr, c_int(self.term_height)
+            )
+            if status != 0:
+                raise OptionsException("failed to set bin transport term height")
+
+        if self.term_width is not None:
+            status = ffi_mapping.options_mapping.transport_bin.set_term_width(
+                ptr, c_int(self.term_width)
+            )
+            if status != 0:
+                raise OptionsException("failed to set bin transport term width")
+
+
+@dataclass
+class Ssh2Options:
+    """
+    Options holds ssh2 transport options to pass to the ffi layer.
+
+    Args:
+        libssh2_trace: enable libssh2 tracing
+
+    Returns:
+        None
+
+    Raises:
+        N/A
+
+    """
+
+    libssh2_trace: bool | None = None
+
+    def apply(self, ffi_mapping: LibScrapliMapping, ptr: DriverPointer) -> None:
+        """
+        Applies the options to the given driver pointer.
+
+        Should not be called directly/by users.
+
+        Args:
+            ffi_mapping: the handle to the ffi mapping singleton
+            ptr: the pointer to the underlying cli or netconf object
+
+        Returns:
+            None
+
+        Raises:
+            OptionsException: if any option apply returns a non-zero return code.
+
+        """
+        if self.libssh2_trace is not None:
+            status = ffi_mapping.options_mapping.transport_ssh2.set_libssh2_trace(ptr)
+            if status != 0:
+                raise OptionsException("failed to set ssh2 transport trace")
+
+
+@dataclass
+class TelnetOptions:
+    """
+    Options holds telnet transport options to pass to the ffi layer.
+
+    Args:
+        N/A
+
+    Returns:
+        None
+
+    Raises:
+        N/A
+
+    """
+
+    def apply(self, ffi_mapping: LibScrapliMapping, ptr: DriverPointer) -> None:
+        """
+        Applies the options to the given driver pointer.
+
+        Should not be called directly/by users.
+
+        Args:
+            ffi_mapping: the handle to the ffi mapping singleton
+            ptr: the pointer to the underlying cli or netconf object
+
+        Returns:
+            None
+
+        Raises:
+            OptionsException: if any option apply returns a non-zero return code.
+
+        """
+        _, _ = ffi_mapping, ptr
+
+
+@dataclass
+class TestOptions:
+    """
+    Options holds test transport options to pass to the ffi layer.
+
+    Args:
+        f: the file to load/read for the transport
+
+    Returns:
+        None
+
+    Raises:
+        N/A
+
+    """
+
+    f: str | None = None
+
+    _f: c_char_p | None = field(init=False, default=None, repr=False)
+
+    def apply(self, ffi_mapping: LibScrapliMapping, ptr: DriverPointer) -> None:
+        """
+        Applies the options to the given driver pointer.
+
+        Should not be called directly/by users.
+
+        Args:
+            ffi_mapping: the handle to the ffi mapping singleton
+            ptr: the pointer to the underlying cli or netconf object
+
+        Returns:
+            None
+
+        Raises:
+            OptionsException: if any option apply returns a non-zero return code.
+
+        """
+        if self.f is not None:
+            self._f = to_c_string(self.f)
+
+            status = ffi_mapping.options_mapping.transport_test.set_f(ptr, self._f)
+            if status != 0:
+                raise OptionsException("failed to set test transport f")
+
+
+@dataclass
+class Options:
+    """
+    Options holds transport options to pass to the ffi layer.
+
+    Only one flavor of transport options can be set at a time. The active option determines the
+    transport to be used for the connection.
+
+    Args:
+        bin: the bin transport options
+        ssh2: the ssh2 transport options
+        telnet: the telnet transport options
+        test: the test transport options
+
+    Returns:
+        None
+
+    Raises:
+        N/A
+
+    """
+
+    bin: BinOptions | None = None
+    ssh2: Ssh2Options | None = None
+    telnet: TelnetOptions | None = None
+    test: TestOptions | None = None
+
+    _transport_kind: bytes | None = field(init=False, default=None, repr=False)
+
+    def __post_init__(self) -> None:
+        _set_fields = [f for f in [self.bin, self.ssh2, self.telnet, self.test] if f is not None]
+
+        if len(_set_fields) == 0:
+            self.bin = BinOptions()
+
+            return
+
+        if len(_set_fields) == 1:
+            return
+
+        raise OptionsException("more than one transport set")
+
+    def apply(self, ffi_mapping: LibScrapliMapping, ptr: DriverPointer) -> None:
+        """
+        Applies the options to the given driver pointer.
+
+        Should not be called directly/by users.
+
+        Args:
+            ffi_mapping: the handle to the ffi mapping singleton
+            ptr: the pointer to the underlying cli or netconf object
+
+        Returns:
+            None
+
+        Raises:
+            OptionsException: if any option apply returns a non-zero return code.
+
+        """
+        if self.bin:
+            self.bin.apply(ffi_mapping, ptr)
+        elif self.ssh2:
+            self.ssh2.apply(ffi_mapping, ptr)
+        elif self.telnet:
+            self.telnet.apply(ffi_mapping, ptr)
+        elif self.test:
+            self.test.apply(ffi_mapping, ptr)
+
+    def get_transport_kind(self) -> bytes:
+        """
+        Returns the encoded name of the selected transport kind
+
+        Should not be called directly/by users.
+
+        Args:
+            N/A
+
+        Returns:
+            bytes: the encoded name of the selected transport kind
+
+        Raises:
+            OptionsException: if any option apply returns a non-zero return code.
+
+        """
+        if self.bin:
+            self._transport_kind = TransportKind.BIN.encode(encoding="utf-8")
+        elif self.ssh2:
+            self._transport_kind = TransportKind.SSH2.encode(encoding="utf-8")
+        elif self.telnet:
+            self._transport_kind = TransportKind.TELNET.encode(encoding="utf-8")
+        else:
+            self._transport_kind = TransportKind.TEST.encode(encoding="utf-8")
+
+        return self._transport_kind
+
+    def __repr__(self) -> str:
+        """
+        Magic repr method for Options object
+
+        Args:
+            N/A
+
+        Returns:
+            str: repr for Options object
+
+        Raises:
+            N/A
+
+        """
+        if self.bin:
+            return (
+                # it will probably be "canonical" to import Options as SessionOptions, so we'll make
+                # the repr do that too
+                f"Transport{self.__class__.__name__}("
+                f"bin={self.bin!r}, "
+            )
+
+        if self.ssh2:
+            return f"Transport{self.__class__.__name__}(" f"ssh2={self.ssh2!r}, "
+
+        if self.telnet:
+            return f"Transport{self.__class__.__name__}(" f"telnet={self.telnet!r}, "
+
+        return f"Transport{self.__class__.__name__}(" f"test={self.test!r}, "

scrapli-2.0.0a2.dist-info/METADATA

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: scrapli
+Version: 2.0.0a2
+Summary: Fast, flexible, sync/async, Python 3.10+ screen scraping client specifically for network devices
+Author-email: Carl Montanari <carl.r.montanari@gmail.com>
+License-Expression: MIT
+Project-URL: Changelog, https://carlmontanari.github.io/scrapli/changelog
+Project-URL: Docs, https://carlmontanari.github.io/scrapli/
+Project-URL: Homepage, https://github.com/carlmontanari/scrapli
+Keywords: netconf,network,ssh,telnet,async
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: nox==2025.5.1; extra == "dev"
+Requires-Dist: black<26.0.0,>=25.1.0; extra == "dev"
+Requires-Dist: isort<7.0.0,>=6.0.1; extra == "dev"
+Requires-Dist: ruff<1.0.0,>=0.11.8; extra == "dev"
+Requires-Dist: mypy<2.0.0,>=1.15.0; extra == "dev"
+Requires-Dist: pytest<9.0.0,>=8.3.5; extra == "dev"
+Requires-Dist: pytest-cov<7.0.0,>=6.1.1; extra == "dev"
+Requires-Dist: pytest-asyncio<1.0.0,>=0.26.0; extra == "dev"
+Requires-Dist: pyats>=20.2; extra == "dev"
+Requires-Dist: genie>=20.2; extra == "dev"
+Requires-Dist: ntc-templates<8.0.0,>=1.1.0; extra == "dev"
+Requires-Dist: textfsm<2.0.0,>=1.1.0; extra == "dev"
+Provides-Extra: full
+Requires-Dist: ntc-templates<8.0.0,>=1.1.0; extra == "full"
+Requires-Dist: textfsm<2.0.0,>=1.1.0; extra == "full"
+Requires-Dist: pyats>=20.2; extra == "full"
+Requires-Dist: genie>=20.2; extra == "full"
+Provides-Extra: textfsm
+Requires-Dist: ntc-templates<8.0.0,>=1.1.0; extra == "textfsm"
+Requires-Dist: textfsm<2.0.0,>=1.1.0; extra == "textfsm"
+Provides-Extra: genie
+Requires-Dist: pyats>=20.2; extra == "genie"
+Requires-Dist: genie>=20.2; extra == "genie"
+Dynamic: license-file
+
+<p center><a href=""><img src=https://github.com/carlmontanari/scrapli/blob/main/scrapli.svg?sanitize=true/></a></p>

scrapli-2.0.0a2.dist-info/RECORD

@@ -0,0 +1,35 @@
+scrapli/__init__.py,sha256=qcOX4L_nCkch_3r5etnPI3XlktJTdsqBHyBuJhNBdPk,929
+scrapli/auth.py,sha256=LMYD31AMK0pyTa0RQo9I3ap3F1onmDylb2zQsHl6zrw,7907
+scrapli/cli.py,sha256=-WzN7uHnkgmmH6vdINp9Tr5rVAmoecSqvvpiWxY5dog,48186
+scrapli/cli_decorators.py,sha256=Mj1BfouFiAWb2bbVvhBgc9qqJou6mf-ClvK3Ngy1dJA,4412
+scrapli/cli_parse.py,sha256=b9l2w7TSKpHwNGumCsENvRO1R4NMKnOe5v2vfrweTUA,5171
+scrapli/cli_result.py,sha256=YkgAJ4LiEOiC46376EZjbRqoZzERyVmtwbU8VQ7Nl84,4914
+scrapli/exceptions.py,sha256=RNU720WL6efW_4Pdjruzp0M-Se-zQR3mFcsrzscvaPA,1524
+scrapli/ffi.py,sha256=QgPj1OK8t2swrt_T1nwRHR92DTwhBC_E4r5s6wOCHTI,2149
+scrapli/ffi_mapping.py,sha256=7tnL1mwBYc1dlSH6l2YG_a_5_6BaXmFZiMY1SkE9nOw,5017
+scrapli/ffi_mapping_cli.py,sha256=lIy4mD5MH0DT2fxgDH0WAG5zlsK5UXrzDh817q2VQRY,18503
+scrapli/ffi_mapping_netconf.py,sha256=zPciAB6gP_Zy8d6pwW6MnrSvrp0i5fg4HKgQ_PHqggg,44314
+scrapli/ffi_mapping_options.py,sha256=X2Y-B_K1e2f7aSbJ5pNktT3X7tDpdu_RZ1TX-ba75nI,27557
+scrapli/ffi_types.py,sha256=ZG9LqeNQ34FR4KGCEj4S0Al9qEMCIc8306Xfe8YTOUk,3230
+scrapli/helper.py,sha256=hiVHcczqFqhF0qAyiBn0mioL_fsI2pszCoM9VS_KYsw,1628
+scrapli/netconf.py,sha256=rf0YpTCZLVYkx3DZY2lCPg3dKZ_lgUG_JtfSfF2ts1Q,83819
+scrapli/netconf_decorators.py,sha256=C5yk5Gq7OD_V1g6rVOi8qzeA5MQHEI3B2IUXxyj0IIU,4464
+scrapli/netconf_result.py,sha256=JHvNa5KX6gEf5iwJxCc9Hlcg5ljhRWkd0aoGaXAtYPw,1174
+scrapli/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scrapli/session.py,sha256=8f3XvpZ-4-uw4uuRBVtQMbo8Ftzwu99uCwDL9_UQkO8,4275
+scrapli/transport.py,sha256=v_S4td5kezlUwqANwZh5pQhxgW2jEPCvCe97C8e0fmA,11313
+scrapli/definitions/__init__.py,sha256=d-XZBK_ZjN4Sy6SmhJL-T4imYY_UioM8gSiX-PKVDuE,26
+scrapli/definitions/arista_eos.yaml,sha256=ZR3BmdmGScJobQQZfW7gwOLj5wGxdpZ1omgraw9KgCc,1714
+scrapli/definitions/cisco_iosxe.yaml,sha256=nnqi8qQmFmKX4BgnuLMJqj0hAyqkVRmSfmDLsJKBFaA,1699
+scrapli/definitions/cisco_iosxr.yaml,sha256=hkxQe9sMyCx3Eo9BDSxHD1MWG6yxHl6EHnyjSTjD-_I,1317
+scrapli/definitions/cisco_nxos.yaml,sha256=ih_FiqkBJk3pgGou29DGN0tjrdkF_qqH5bJOa-V1SXg,1889
+scrapli/definitions/juniper_junos.yaml,sha256=bWErL-XgxwwnZv4R9MsSZFLla0VnVhrHqDQ3pZJ9-1I,2491
+scrapli/definitions/nokia_srlinux.yaml,sha256=2TrpoVCIwi-E_IzTsuQjmKBR4lSz_24c2mhhwv6e1ec,1042
+scrapli/lib/__init__.py,sha256=emX2ZjmnwMNIozlcKNDDXr_4zlryoLD8h2fM-CO3KZY,18
+scrapli/lib/libscrapli.0.0.1-alpha.10.dylib,sha256=-oOvGZigabVog8nUl9dajxGR8JqW1ZWHAJj-spKErVM,12922712
+scrapli/lib/libscrapli.so.0.0.1-alpha.10,sha256=-oOvGZigabVog8nUl9dajxGR8JqW1ZWHAJj-spKErVM,12922712
+scrapli-2.0.0a2.dist-info/licenses/LICENSE,sha256=IeyhkG2h_dAvJ7nAF0S4GSUg045jwI27YADV_KSJi50,1071
+scrapli-2.0.0a2.dist-info/METADATA,sha256=LIVee3xM1hOhkQb4R7JB0adJsPeRD0E5oJFwWWDmtJs,2286
+scrapli-2.0.0a2.dist-info/WHEEL,sha256=MmQ9OtX_bCFXAvVJko16lLGdPJhOLPMXVnSHtCQfmfw,108
+scrapli-2.0.0a2.dist-info/top_level.txt,sha256=piC9TaaPt0z-1Ryrs69hDvsIQkmE5ceDAAW5donUvsI,8
+scrapli-2.0.0a2.dist-info/RECORD,,

scrapli-2.0.0a2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-manylinux2010_x86_64
+

scrapli-2.0.0a2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Carl Montanari
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

scrapli-2.0.0a2.dist-info/top_level.txt

@@ -0,0 +1 @@
+scrapli