scrapli 2.0.0a2__py3-none-macosx_11_0_arm64.whl → 2.0.0a4__py3-none-macosx_11_0_arm64.whl

scrapli/transport.py

@@ -1,5 +1,6 @@
 """scrapli.transport"""
 
+from abc import ABC, abstractmethod
 from ctypes import c_char_p, c_int
 from dataclasses import dataclass, field
 from enum import Enum
@@ -33,8 +34,74 @@ class TransportKind(str, Enum):
     TEST = "test_"
 
 
+class Options(ABC):
+    """
+    Options is the base class for transport related option containers.
+
+    Args:
+        N/A
+
+    Returns:
+        None
+
+    Raises:
+        N/A
+
+    """
+
+    _transport_kind: TransportKind | None = None
+
+    @property
+    def transport_kind(self) -> TransportKind:
+        """
+        Returns/sets the encoded name of the selected transport kind
+
+        Should not be called directly/by users.
+
+        Args:
+            N/A
+
+        Returns:
+            TransportKind: the selected transport kind
+
+        Raises:
+            OptionsException: if any option apply returns a non-zero return code.
+
+        """
+        if isinstance(self, BinOptions):
+            self._transport_kind = TransportKind.BIN
+        elif isinstance(self, Ssh2Options):
+            self._transport_kind = TransportKind.SSH2
+        elif isinstance(self, TelnetOptions):
+            self._transport_kind = TransportKind.TELNET
+        else:
+            self._transport_kind = TransportKind.TEST
+
+        return self._transport_kind
+
+    @abstractmethod
+    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.
+
+        """
+        raise NotImplementedError
+
+
 @dataclass
-class BinOptions:
+class BinOptions(Options):
     """
     Options holds bin transport options to pass to the ffi layer.
 
@@ -154,7 +221,7 @@ class BinOptions:
 
 
 @dataclass
-class Ssh2Options:
+class Ssh2Options(Options):
     """
     Options holds ssh2 transport options to pass to the ffi layer.
 
@@ -195,7 +262,7 @@ class Ssh2Options:
 
 
 @dataclass
-class TelnetOptions:
+class TelnetOptions(Options):
     """
     Options holds telnet transport options to pass to the ffi layer.
 
@@ -231,7 +298,7 @@ class TelnetOptions:
 
 
 @dataclass
-class TestOptions:
+class TestOptions(Options):
     """
     Options holds test transport options to pass to the ffi layer.
 
@@ -273,129 +340,3 @@ class TestOptions:
             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 → scrapli-2.0.0a4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scrapli
-Version: 2.0.0a2
+Version: 2.0.0a4
 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

{scrapli-2.0.0a2.dist-info → scrapli-2.0.0a4.dist-info}/RECORD

@@ -1,23 +1,23 @@
-scrapli/__init__.py,sha256=qcOX4L_nCkch_3r5etnPI3XlktJTdsqBHyBuJhNBdPk,929
+scrapli/__init__.py,sha256=8EEtOO1ZjuAWHUnHduW-hL7Rvvxh1Omns3f9TtU9bpE,963
 scrapli/auth.py,sha256=LMYD31AMK0pyTa0RQo9I3ap3F1onmDylb2zQsHl6zrw,7907
-scrapli/cli.py,sha256=-WzN7uHnkgmmH6vdINp9Tr5rVAmoecSqvvpiWxY5dog,48186
+scrapli/cli.py,sha256=6tHDilvmYW1DxAJyXNa65zQZRxlDBL9Z4zeCR6GOcyU,46942
 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.py,sha256=ao0D9NZLo1zv6r9-z06hAiNgch_2QV6XYyIfBfawMOI,2149
+scrapli/ffi_mapping.py,sha256=bMB6XkJimV9xZ83jg01m2jWZevwCaRf-0LGxaYct_54,4994
+scrapli/ffi_mapping_cli.py,sha256=4m_e4WoLlgr3s_2aS-N92HrFEvRHz_eMrlorNW_x6xk,18218
+scrapli/ffi_mapping_netconf.py,sha256=G7VmR-pIQI5G4SEkDYoAtDVa_pfDaTRM2U9chfXhqaY,42156
 scrapli/ffi_mapping_options.py,sha256=X2Y-B_K1e2f7aSbJ5pNktT3X7tDpdu_RZ1TX-ba75nI,27557
-scrapli/ffi_types.py,sha256=ZG9LqeNQ34FR4KGCEj4S0Al9qEMCIc8306Xfe8YTOUk,3230
+scrapli/ffi_types.py,sha256=aYZ0YTUyU_jgowrQgwBTm_iL4A6BMLl8-hMf1P8-9b4,4501
 scrapli/helper.py,sha256=hiVHcczqFqhF0qAyiBn0mioL_fsI2pszCoM9VS_KYsw,1628
-scrapli/netconf.py,sha256=rf0YpTCZLVYkx3DZY2lCPg3dKZ_lgUG_JtfSfF2ts1Q,83819
+scrapli/netconf.py,sha256=T_Op82Qjo5P3WCb-OMOiAYqgu82oqzuymet4AmGFUD0,80054
 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/transport.py,sha256=vg6uMpsXrx6kOyNxnyg0OZ74w2U9rj1aPk0oz__2D0c,9506
 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
@@ -26,9 +26,9 @@ scrapli/definitions/cisco_nxos.yaml,sha256=ih_FiqkBJk3pgGou29DGN0tjrdkF_qqH5bJOa
 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-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=jc2C2uw104ioj1TL9cE0YO67_kdAwX4W8JgYPomxr5M,105
-scrapli-2.0.0a2.dist-info/top_level.txt,sha256=piC9TaaPt0z-1Ryrs69hDvsIQkmE5ceDAAW5donUvsI,8
-scrapli-2.0.0a2.dist-info/RECORD,,
+scrapli/lib/libscrapli.0.0.1-alpha.13.dylib,sha256=r6iXD-yJZSNRfh0Ga4mhTdbtJde93auDJFA1HZ6KJwQ,5484120
+scrapli-2.0.0a4.dist-info/licenses/LICENSE,sha256=IeyhkG2h_dAvJ7nAF0S4GSUg045jwI27YADV_KSJi50,1071
+scrapli-2.0.0a4.dist-info/METADATA,sha256=-h27C1hAYIbru9lW7bSHBSJTjXOxYmGtq2KyNDamlUk,2286
+scrapli-2.0.0a4.dist-info/WHEEL,sha256=jc2C2uw104ioj1TL9cE0YO67_kdAwX4W8JgYPomxr5M,105
+scrapli-2.0.0a4.dist-info/top_level.txt,sha256=piC9TaaPt0z-1Ryrs69hDvsIQkmE5ceDAAW5donUvsI,8
+scrapli-2.0.0a4.dist-info/RECORD,,