scrapli 2.0.0a2__tar.gz

scrapli-2.0.0a2/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/MANIFEST.in

@@ -0,0 +1,5 @@
+include requirements*.txt
+include scrapli/definitions/*.yaml
+include scrapli/lib/__init__.py
+include scrapli/lib/*.so.*
+include scrapli/lib/*.dylib

scrapli-2.0.0a2/PKG-INFO

@@ -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/README.md

@@ -0,0 +1 @@
+<p center><a href=""><img src=https://github.com/carlmontanari/scrapli/blob/main/scrapli.svg?sanitize=true/></a></p>

scrapli-2.0.0a2/pyproject.toml

@@ -0,0 +1,112 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = ["setuptools", "wheel", "ziglang==0.14.1"]
+
+[project]
+name = "scrapli"
+description = "Fast, flexible, sync/async, Python 3.10+ screen scraping client specifically for network devices"
+readme = "README.md"
+keywords = ["netconf", "network", "ssh", "telnet", "async"]
+license = "MIT"
+authors = [{ name = "Carl Montanari", email = "carl.r.montanari@gmail.com" }]
+requires-python = ">=3.10"
+classifiers = [
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dynamic = ["dependencies", "optional-dependencies", "version"]
+[project.urls]
+Changelog = "https://carlmontanari.github.io/scrapli/changelog"
+Docs = "https://carlmontanari.github.io/scrapli/"
+Homepage = "https://github.com/carlmontanari/scrapli"
+
+[tool.setuptools]
+packages = ["scrapli", "scrapli.definitions", "scrapli.lib"]
+
+[tool.setuptools.dynamic]
+version = { attr = "scrapli.__version__" }
+dependencies = { file = "requirements.txt" }
+optional-dependencies.dev = { file = [
+    "requirements-dev.txt",
+    "requirements-genie.txt",
+    "requirements-textfsm.txt",
+] }
+optional-dependencies.full = { file = [
+    "requirements-textfsm.txt",
+    "requirements-genie.txt",
+] }
+optional-dependencies.textfsm = { file = "requirements-textfsm.txt" }
+optional-dependencies.genie = { file = "requirements-genie.txt" }
+
+[tool.setuptools.package-data]
+scrapli = [
+    "py.typed",
+    "scrapli/definitions/*.yaml",
+    "scrapli/lib/*.so.*",
+    "scrapli/lib/*.dylib",
+]
+
+[tool.black]
+line-length = 100
+target-version = ["py313"]
+
+[tool.isort]
+profile = "black"
+line_length = 100
+multi_line_output = 3
+include_trailing_comma = true
+
+[tool.mypy]
+python_version = "3.13"
+pretty = true
+ignore_missing_imports = true
+warn_redundant_casts = true
+warn_unused_configs = true
+strict_optional = true
+
+[tool.ruff]
+include = ["setup.py", "scrapli/**.py", "tests/**.py"]
+line-length = 100
+
+[tool.ruff.lint]
+select = [
+    "FIX",
+    "D",
+    "PL",
+    "ERA",
+    "C90",
+    "N",
+    "PERF",
+    "E",
+    "W",
+    "D",
+    "F",
+    "UP",
+    "FURB",
+    "RUF",
+]
+ignore = [
+    "D105",  # Missing docstring in magic method
+    "D107",  # Missing docstring in `__init__`
+    "D212",  # Multi-line docstring summary should start at the first line
+    "D415",  # First line should end with a period, question mark, or exclamation point
+    "N818",  # Exception name `foo` should be named with an Error suffix
+    "UP015", # Unnecessary mode argument
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.per-file-ignores]
+"scrapli/ffi_mapping_*.py" = ["PLR0913"]
+"tests/**.py" = ["D", "E501", "PLR0913"]
+
+[tool.pytest.ini_options]
+asyncio_default_fixture_loop_scope = "function"

scrapli-2.0.0a2/requirements-dev.txt

@@ -0,0 +1,8 @@
+nox==2025.5.1
+black>=25.1.0,<26.0.0
+isort>=6.0.1,<7.0.0
+ruff>=0.11.8,<1.0.0
+mypy>=1.15.0,<2.0.0
+pytest>=8.3.5,<9.0.0
+pytest-cov>=6.1.1,<7.0.0
+pytest-asyncio>=0.26.0,<1.0.0

scrapli-2.0.0a2/requirements-genie.txt

@@ -0,0 +1,2 @@
+pyats>=20.2
+genie>=20.2

scrapli-2.0.0a2/requirements-textfsm.txt

@@ -0,0 +1,2 @@
+ntc-templates>=1.1.0,<8.0.0
+textfsm>=1.1.0,<2.0.0

scrapli-2.0.0a2/scrapli/__init__.py

@@ -0,0 +1,30 @@
+"""scrapli"""
+
+from scrapli.auth import LookupKeyValue
+from scrapli.auth import Options as AuthOptions
+from scrapli.cli import Cli
+from scrapli.netconf import Netconf
+from scrapli.netconf import Options as NetconfOptions
+from scrapli.session import Options as SessionOptions
+from scrapli.transport import BinOptions as TransportBinOptions
+from scrapli.transport import Options as TransportOptions
+from scrapli.transport import Ssh2Options as TransportSsh2Options
+from scrapli.transport import TelnetOptions as TransportTelnetOptions
+from scrapli.transport import TestOptions as TransportTestOptions
+
+__version__ = "2.0.0-alpha.2"
+__definitions_version__ = "471f12e"
+
+__all__ = (
+    "AuthOptions",
+    "Cli",
+    "LookupKeyValue",
+    "Netconf",
+    "NetconfOptions",
+    "SessionOptions",
+    "TransportBinOptions",
+    "TransportOptions",
+    "TransportSsh2Options",
+    "TransportTelnetOptions",
+    "TransportTestOptions",
+)

scrapli-2.0.0a2/scrapli/auth.py

@@ -0,0 +1,216 @@
+"""scrapli.auth"""
+
+from ctypes import c_char_p
+from dataclasses import dataclass, field
+
+from scrapli.exceptions import OptionsException
+from scrapli.ffi_mapping import LibScrapliMapping
+from scrapli.ffi_types import (
+    DriverPointer,
+    to_c_string,
+)
+
+
+@dataclass
+class LookupKeyValue:
+    """
+    Options a "lookup" key/value pair.
+
+    Used in conjuection with platform definition templating like `__lookup::enable` where "enable"
+    is the key to "lookup" in the list of lookup key/values.
+
+    Args:
+        key: the name of the lookup key
+        value: the value of the lookup key
+
+    Returns:
+        None
+
+    Raises:
+        N/A
+
+    """
+
+    key: str
+    value: str
+
+    _key: c_char_p | None = field(init=False, default=None, repr=False)
+    _value: c_char_p | None = field(init=False, default=None, repr=False)
+
+    def _get_c_strings(self) -> tuple[c_char_p, c_char_p]:
+        self._key = to_c_string(self.key)
+        self._value = to_c_string(self.value)
+
+        return self._key, self._value
+
+    def __repr__(self) -> str:
+        return f"{self.__class__.__name__}(key='{self.key}', value='REDACTED')"
+
+
+@dataclass
+class Options:
+    """
+    Options holds auth related options to pass to the ffi layer.
+
+    All arguments are optional, though you will almost certainly need to provide *some* -- for
+    example a username and password or key.
+
+    Args:
+        username: the username to use for the connection
+        password: the password to use for the connection
+        private_key_path: filepath to the ssh private key to use
+        private_key_passphrase: the private key passphrase if set
+        lookups: a list of key/values that can be "looked up" from a connection -- used in
+            conjunction with platform definition templating like `__lookup::enable` where "enable"
+            is the key to "lookup" in the list of lookup key/values.
+        in_session_auth_bypass: whether to bypass attempting in session authentication -- only
+             applicable to "bin" and "telnet" transports.
+        username_pattern: the regex pattern to use to look for a username prompt
+        password_pattern: the regex pattern to use to look for a password prompt
+        private_key_passphrase_pattern: the regex pattern to use to look for a passphrase prompt
+
+    Returns:
+        None
+
+    Raises:
+        N/A
+
+    """
+
+    username: str | None = None
+    password: str | None = None
+    private_key_path: str | None = None
+    private_key_passphrase: str | None = None
+    lookups: list[LookupKeyValue] | None = None
+    in_session_auth_bypass: bool | None = None
+    username_pattern: str | None = None
+    password_pattern: str | None = None
+    private_key_passphrase_pattern: str | None = None
+
+    _username: c_char_p | None = field(init=False, default=None, repr=False)
+    _password: c_char_p | None = field(init=False, default=None, repr=False)
+    _private_key_path: c_char_p | None = field(init=False, default=None, repr=False)
+    _private_key_passphrase: c_char_p | None = field(init=False, default=None, repr=False)
+    _username_pattern: c_char_p | None = field(init=False, default=None, repr=False)
+    _password_pattern: c_char_p | None = field(init=False, default=None, repr=False)
+    _private_key_passphrase_pattern: 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.username is not None:
+            self._username = to_c_string(self.username)
+
+            status = ffi_mapping.options_mapping.auth.set_username(ptr, self._username)
+            if status != 0:
+                raise OptionsException("failed to set auth username")
+
+        if self.password is not None:
+            self._password = to_c_string(self.password)
+
+            status = ffi_mapping.options_mapping.auth.set_password(ptr, self._password)
+            if status != 0:
+                raise OptionsException("failed to set auth password")
+
+        if self.private_key_path is not None:
+            self._private_key_path = to_c_string(self.private_key_path)
+
+            status = ffi_mapping.options_mapping.auth.set_private_key_path(
+                ptr, self._private_key_path
+            )
+            if status != 0:
+                raise OptionsException("failed to set auth private key path")
+
+        if self.private_key_passphrase is not None:
+            self._private_key_passphrase = to_c_string(self.private_key_passphrase)
+
+            status = ffi_mapping.options_mapping.auth.set_private_key_passphrase(
+                ptr, self._private_key_passphrase
+            )
+            if status != 0:
+                raise OptionsException("failed to set auth private key passphrase")
+
+        if self.lookups is not None:
+            for lookup in self.lookups:
+                status = ffi_mapping.options_mapping.auth.set_lookup_key_value(
+                    ptr, *lookup._get_c_strings()
+                )
+                if status != 0:
+                    raise OptionsException("failed to set auth lookup key/value")
+
+        if self.in_session_auth_bypass is not None:
+            status = ffi_mapping.options_mapping.auth.set_in_session_auth_bypass(ptr)
+            if status != 0:
+                raise OptionsException("failed to set session in session auth bypass")
+
+        if self.username_pattern is not None:
+            self._username_pattern = to_c_string(self.username_pattern)
+
+            status = ffi_mapping.options_mapping.auth.set_username_pattern(
+                ptr, self._username_pattern
+            )
+            if status != 0:
+                raise OptionsException("failed to set auth username pattern")
+
+        if self.password_pattern is not None:
+            self._password_pattern = to_c_string(self.password_pattern)
+
+            status = ffi_mapping.options_mapping.auth.set_password_pattern(
+                ptr, self._password_pattern
+            )
+            if status != 0:
+                raise OptionsException("failed to set auth password pattern")
+
+        if self.private_key_passphrase_pattern is not None:
+            self._private_key_passphrase_pattern = to_c_string(self.private_key_passphrase_pattern)
+
+            status = ffi_mapping.options_mapping.auth.set_private_key_passphrase_pattern(
+                ptr, self._private_key_passphrase_pattern
+            )
+            if status != 0:
+                raise OptionsException("failed to set auth private key passphrase pattern")
+
+    def __repr__(self) -> str:
+        """
+        Magic repr method for Options object
+
+        Args:
+            N/A
+
+        Returns:
+            str: repr for Options object
+
+        Raises:
+            N/A
+
+        """
+        return (
+            # it will probably be "canonical" to import Options as AuthOptions, so we'll make
+            # the repr do that too
+            f"Auth{self.__class__.__name__}("
+            f"username={self.username!r}, "
+            "password=REDACTED, "
+            f"private_key_path={self.private_key_path!r} "
+            f"private_key_passphrase={self.private_key_passphrase!r} "
+            f"lookups={self.lookups!r}) "
+            f"in_session_auth_bypass={self.in_session_auth_bypass!r}) "
+            f"username_pattern={self.username_pattern!r}) "
+            f"password_pattern={self.password_pattern!r}) "
+            f"private_key_passphrase_pattern={self.private_key_passphrase_pattern!r}) "
+        )