scrapli 2.0.0a3__py3-none-macosx_11_0_arm64.whl → 2.0.0a5__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.0a3.dist-info → scrapli-2.0.0a5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scrapli
-Version: 2.0.0a3
+Version: 2.0.0a5
 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.0a5.dist-info/RECORD

@@ -0,0 +1,67 @@
+scrapli/__init__.py,sha256=G3vjD5_RuxNDmBIefMHrVKYNg1A68L63Xqd-oN1qPBg,916
+scrapli/auth.py,sha256=kTbgydd5pWoAbQXGSW46slweKiaTdSxy3E7N7jshnME,8282
+scrapli/cli.py,sha256=LKBqSlfig8nL-OlD8qIOUApyyPUT9_L-MoBtmBTSWAs,57045
+scrapli/cli_decorators.py,sha256=Mj1BfouFiAWb2bbVvhBgc9qqJou6mf-ClvK3Ngy1dJA,4412
+scrapli/cli_parse.py,sha256=fIdRx2cEAgjCqn2N4Q3sXY_g1Sk4wrsWQ7ula_nMQOU,5188
+scrapli/cli_result.py,sha256=q4RG-F_fNFNbHmlC2koLbjEzkpNddI_IqUwZpKGaLU4,6005
+scrapli/exceptions.py,sha256=RNU720WL6efW_4Pdjruzp0M-Se-zQR3mFcsrzscvaPA,1524
+scrapli/ffi.py,sha256=wnAaSMd0x2aknCyKHrLvUbOkOu0yEocw8uCQlgiBDwM,2149
+scrapli/ffi_mapping.py,sha256=3kP-u9BsKaUe-9MtxzvL9P3qnYzFnzA5-35fiQZzsDk,6451
+scrapli/ffi_mapping_cli.py,sha256=USSlwnfsZtHtV7ZzDFrL248HdfIHuv61TqD122V2owI,21337
+scrapli/ffi_mapping_netconf.py,sha256=G7VmR-pIQI5G4SEkDYoAtDVa_pfDaTRM2U9chfXhqaY,42156
+scrapli/ffi_mapping_options.py,sha256=1Y8BUWv0pG07qWMtv_pZjIqICb604Hu--COnr_z7SUI,28368
+scrapli/ffi_types.py,sha256=1ziWVjC82HVdZMg5-52AzvEYYBt6vba6NgSzjwRq5RM,4501
+scrapli/helper.py,sha256=Cf8sQq8PMFLI2QAyxvG2Zd1DqTeKRO_BrOld4CDi4EQ,2963
+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=vg6uMpsXrx6kOyNxnyg0OZ74w2U9rj1aPk0oz__2D0c,9506
+scrapli/definitions/__init__.py,sha256=d-XZBK_ZjN4Sy6SmhJL-T4imYY_UioM8gSiX-PKVDuE,26
+scrapli/definitions/aethra_atosnt.yaml,sha256=K_S4Iec_lA6hmleF85bs2AJr3gQjO4dbtUiMSoIzx5Q,189
+scrapli/definitions/alcatel_aos.yaml,sha256=oHM9F93-eApg9zuR65M1JCQTgxdwr0-c0V2IcbQNKH8,213
+scrapli/definitions/arista_eos.yaml,sha256=WNgxbzEm3Jrz0K2emmM4jTixCYfPU6oD2Vl3_Rz_0Uw,1751
+scrapli/definitions/aruba_aoscx.yaml,sha256=FQlRxBOGUdGueveBx9ek3kWoowzfAvRPByypyu_0XD4,868
+scrapli/definitions/cisco_aireos.yaml,sha256=QewqV3DINNrOmJTOjcPma4qeznlEeuhJ8NQB9giIQVY,801
+scrapli/definitions/cisco_asa.yaml,sha256=60v3PwEV7-aSVztmZbd_9oig4259no-euva9rHnEDg0,1313
+scrapli/definitions/cisco_cbs.yaml,sha256=ds1-fBOThR3W5VA8XqrkF2yAzeMVtUIo4WIXNPA0fdw,1399
+scrapli/definitions/cisco_ftd.yaml,sha256=rIbZ1gBMiJULJAjaj3sl95o73bep5ojVRgRfD94SoKY,1039
+scrapli/definitions/cisco_iosxe.yaml,sha256=nnqi8qQmFmKX4BgnuLMJqj0hAyqkVRmSfmDLsJKBFaA,1699
+scrapli/definitions/cisco_iosxr.yaml,sha256=hkxQe9sMyCx3Eo9BDSxHD1MWG6yxHl6EHnyjSTjD-_I,1317
+scrapli/definitions/cisco_nxos.yaml,sha256=6zJVtPDyh7U0y2zRl524okCPusRS-hlDOwpoWtVQjyA,1949
+scrapli/definitions/cumulus_linux.yaml,sha256=0KPBMGoxGSL-znA-KURiPPJw_-prUX4UKexPi83rWt0,668
+scrapli/definitions/cumulus_vtysh.yaml,sha256=QOVG77ioTy057wbGuqMfvATnqS75Y3_hskOFho_3j4g,1007
+scrapli/definitions/datacom_dmos.yaml,sha256=CpEJlg4i4GXg_jkZdttuQwyk6RjhEU74GF2X7hinwsw,696
+scrapli/definitions/datacom_dmswitch.yaml,sha256=Z1NKSUM_F4dkPAHiMjKaI_mqa_JPRMaEvSw43t8tCqs,745
+scrapli/definitions/default.yaml,sha256=iGegcCtWsGCnb9Z5yYVf2uFGyE1QKw5FkGnLBoYiIbw,169
+scrapli/definitions/dell_emc.yaml,sha256=TcsN5xf61RDHg8aIIw-DsvOBaiMtk9qp3E13MIGldUo,1313
+scrapli/definitions/dell_enterprisesonic.yaml,sha256=iOC4dkx6tSTzJe6L4dVeVwnR-7MMJJLpK4kbxJuU08I,970
+scrapli/definitions/dlink_os.yaml,sha256=vJqLO-BW0I7fI_K6HXfEsNPm9jMbR8yrIqdf2Q-Tr-k,1295
+scrapli/definitions/edgecore_ecs.yaml,sha256=taxJAu0GW5aXIFlp3XethnsAAz37oLaVrEP_QOD-PHg,915
+scrapli/definitions/eltex_esr.yaml,sha256=qZ-hCaQImgJjVUt7BuzzfgUU4spOERDEdG-A24yT1-8,1217
+scrapli/definitions/fortinet_fortios.yaml,sha256=dLwUKbaCXHfnJmKGoIuGC9ld61SG4UgMcdCnJvfIB9w,468
+scrapli/definitions/fortinet_wlc.yaml,sha256=QkFN7ZE5bN4cYpzNsoUbl7FvjroCfMXApUFSPeszVhE,899
+scrapli/definitions/hp_comware.yaml,sha256=nOdm6ImtR9CR0V-UnXyzqnzLTkBSKmsfO5-iCjtzC9Y,852
+scrapli/definitions/huawei_smartax.yaml,sha256=E5XHM40UVAiv0tNZqqZFmFNcnm6M4WM0CUpb3Qf1eoA,1511
+scrapli/definitions/huawei_vrp.yaml,sha256=3j1XJr9XDo_GtGeAlvf2F4INDyM6by-dqaItO-8Qej8,2205
+scrapli/definitions/juniper_junos.yaml,sha256=WETQGc8QCCTo-cu2-K32BNMlAH6lHLZGRNIxUZbpW30,2592
+scrapli/definitions/nokia_srlinux.yaml,sha256=xi9nMWXnwBpv_g8IBrOcww-I3vSwYTEo3-OpPJIUXx0,1324
+scrapli/definitions/nokia_sros.yaml,sha256=8vYccqUDz1YdY7cBSBS_S72HbCULm--r1PyyMBE73MA,720
+scrapli/definitions/nokia_sros_classic.yaml,sha256=xoZjeP4YaBNK9X9IgsQ8KXUBU1054qUhBnqGSdv-2ng,772
+scrapli/definitions/nokia_sros_classic_aram.yaml,sha256=nRdtrQe6cMq5eee8ttw7JQJspjTikxQcuWSupe0ZveI,584
+scrapli/definitions/paloalto_panos.yaml,sha256=pvK4XO9YNtt0VSWPmU9-VZn2fYldWCIBTTTtvzk8zsM,880
+scrapli/definitions/raisecom_ros.yaml,sha256=GTAoA-YkCZRw719VLN1omeRrGGs4fAJPzKdCixMHT-w,1288
+scrapli/definitions/ruckus_fastiron.yaml,sha256=9T95H7z-twIRHi8H4WdUF2oQ2NEp-QcGql6oGwLKwTo,1249
+scrapli/definitions/ruckus_unleashed.yaml,sha256=93C7alrRuPu05ZOdMtgNULTOM-MV_ZY9A_brfrTnDU0,1679
+scrapli/definitions/siemens_roxii.yaml,sha256=HtuER7N45x5XsRP9NePTgo2SIFoO7D78anou8GTvs4c,737
+scrapli/definitions/versa_flexvnf.yaml,sha256=31cDWn2QhwPUxsb5fVI0Bs6utWXIvkDfRH8POUn65XY,1086
+scrapli/definitions/vyos_vyos.yaml,sha256=R2x4R-33opgocFXVdxZfCRSNUPt0F_lMSJe6m9bJNzw,958
+scrapli/definitions/zyxel_dslam.yaml,sha256=OVZXtwKkEQ_zjX4j4ZEFXMsP7Y7UziFkyfEYHzqtW9g,412
+scrapli/lib/__init__.py,sha256=emX2ZjmnwMNIozlcKNDDXr_4zlryoLD8h2fM-CO3KZY,18
+scrapli/lib/libscrapli.0.0.1-alpha.17.dylib,sha256=mp5UYE6wTotiFRdXpdgTfYSmbsenzq2LREaElGgK9Xc,5504088
+scrapli-2.0.0a5.dist-info/licenses/LICENSE,sha256=IeyhkG2h_dAvJ7nAF0S4GSUg045jwI27YADV_KSJi50,1071
+scrapli-2.0.0a5.dist-info/METADATA,sha256=holO5Rx518SE2VdkuaderSoSsEG8yN2pQQffMKPBgpk,2286
+scrapli-2.0.0a5.dist-info/WHEEL,sha256=jc2C2uw104ioj1TL9cE0YO67_kdAwX4W8JgYPomxr5M,105
+scrapli-2.0.0a5.dist-info/top_level.txt,sha256=piC9TaaPt0z-1Ryrs69hDvsIQkmE5ceDAAW5donUvsI,8
+scrapli-2.0.0a5.dist-info/RECORD,,

scrapli-2.0.0a3.dist-info/RECORD

@@ -1,34 +0,0 @@
-scrapli/__init__.py,sha256=WcoeX97YFLS6MNLwnhlCZaUQZRZ5qftj5fYWOhAyu9o,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=ACZJULpslVhGBd0SrZQ4mkwr0ZIn_6tD0z1LgAcVJEM,5484024
-scrapli-2.0.0a3.dist-info/licenses/LICENSE,sha256=IeyhkG2h_dAvJ7nAF0S4GSUg045jwI27YADV_KSJi50,1071
-scrapli-2.0.0a3.dist-info/METADATA,sha256=gdi0WMI58yL5THIN5mvyN_F__PrE4fZ4DbtymoGwf1k,2286
-scrapli-2.0.0a3.dist-info/WHEEL,sha256=jc2C2uw104ioj1TL9cE0YO67_kdAwX4W8JgYPomxr5M,105
-scrapli-2.0.0a3.dist-info/top_level.txt,sha256=piC9TaaPt0z-1Ryrs69hDvsIQkmE5ceDAAW5donUvsI,8
-scrapli-2.0.0a3.dist-info/RECORD,,