scrapli 2024.1.30__py3-none-any.whl → 2024.7.30.post1__py3-none-any.whl

scrapli/driver/core/cisco_nxos/async_driver.py

@@ -1,4 +1,5 @@
 """scrapli.driver.core.cisco_nxos.async_driver"""
+
 from copy import deepcopy
 from io import BytesIO
 from typing import Any, Callable, Dict, List, Optional, Union
@@ -47,7 +48,7 @@ async def nxos_on_close(conn: AsyncNetworkDriver) -> None:
 
 
 class AsyncNXOSDriver(AsyncNetworkDriver, NXOSDriverBase):
-    def __init__(
+    def __init__(  # pylint: disable=R0917
         self,
         host: str,
         privilege_levels: Optional[Dict[str, PrivilegeLevel]] = None,

scrapli/driver/core/cisco_nxos/base_driver.py

@@ -1,4 +1,5 @@
 """scrapli.driver.core.cisco_nxos.base_driver"""
+
 from typing import Dict
 
 from scrapli.driver.network.base_driver import PrivilegeLevel
@@ -7,7 +8,7 @@ from scrapli.exceptions import ScrapliValueError
 PRIVS = {
     "exec": (
         PrivilegeLevel(
-            pattern=r"^[\w.\-]{1,63}>\s?$",
+            pattern=r"^[\w.\-]{1,63}(\(maint\-mode\))?>\s?$",
             name="exec",
             previous_priv="",
             deescalate="",
@@ -18,7 +19,7 @@ PRIVS = {
     ),
     "privilege_exec": (
         PrivilegeLevel(
-            pattern=r"^[\w.\-]{1,63}#\s?$",
+            pattern=r"^[\w.\-]{1,63}(\(maint\-mode\))?#\s?$",
             name="privilege_exec",
             previous_priv="exec",
             deescalate="disable",
@@ -30,7 +31,7 @@ PRIVS = {
     ),
     "configuration": (
         PrivilegeLevel(
-            pattern=r"^[\w.\-]{1,63}\(config[\w.\-@/:\+]{0,32}\)#\s?$",
+            pattern=r"^[\w.\-]{1,63}(\(maint\-mode\))?\(config[\w.\-@/:\+]{0,32}\)#\s?$",
             name="configuration",
             previous_priv="privilege_exec",
             deescalate="end",
@@ -46,7 +47,11 @@ PRIVS = {
             # for now doesnt seem to be a reason to differentiate between them, so just have one
             # giant pattern
             pattern=(
-                r"(^[\w.\-]{1,63}\-tcl#\s?$)|" r"(^[\w.\-]{1,63}\(config\-tcl\)#\s?$)|" r"(^>\s?$)"
+                r"(^[\w.\-]{1,63}\-tcl#\s?$)|"
+                r"(^[\w.\-]{1,63}\(config\-tcl\)#\s?$)|"
+                r"(^>\s?$)|"
+                r"(^[\w.\-]{1,63}\(maint\-mode\-tcl\)#\s?$)|"
+                r"(^[\w.\-]{1,63}\(maint\-mode\)\(config\-tcl\)#\s?$)"
             ),
             name="tclsh",
             previous_priv="privilege_exec",

scrapli/driver/core/cisco_nxos/sync_driver.py

@@ -1,4 +1,5 @@
 """scrapli.driver.core.cisco_nxos.sync_driver"""
+
 from copy import deepcopy
 from io import BytesIO
 from typing import Any, Callable, Dict, List, Optional, Union
@@ -47,7 +48,7 @@ def nxos_on_close(conn: NetworkDriver) -> None:
 
 
 class NXOSDriver(NetworkDriver, NXOSDriverBase):
-    def __init__(
+    def __init__(  # pylint: disable=R0917
         self,
         host: str,
         privilege_levels: Optional[Dict[str, PrivilegeLevel]] = None,

scrapli/driver/core/juniper_junos/__init__.py

@@ -1,4 +1,5 @@
 """scrapli.driver.core.juniper_junos"""
+
 from scrapli.driver.core.juniper_junos.async_driver import AsyncJunosDriver
 from scrapli.driver.core.juniper_junos.sync_driver import JunosDriver
 

scrapli/driver/core/juniper_junos/async_driver.py

@@ -1,4 +1,5 @@
 """scrapli.driver.core.juniper_junos.async_driver"""
+
 from copy import deepcopy
 from io import BytesIO
 from typing import Any, Callable, Dict, List, Optional, Union
@@ -48,7 +49,7 @@ async def junos_on_close(conn: AsyncNetworkDriver) -> None:
 
 
 class AsyncJunosDriver(AsyncNetworkDriver):
-    def __init__(
+    def __init__(  # pylint: disable=R0917
         self,
         host: str,
         privilege_levels: Optional[Dict[str, PrivilegeLevel]] = None,

scrapli/driver/core/juniper_junos/base_driver.py

@@ -1,4 +1,5 @@
 """scrapli.driver.core.juniper_junos.base_driver"""
+
 from scrapli.driver.network.base_driver import PrivilegeLevel
 
 PRIVS = {

scrapli/driver/core/juniper_junos/sync_driver.py

@@ -1,4 +1,5 @@
 """scrapli.driver.core.juniper_junos.driver"""
+
 from copy import deepcopy
 from io import BytesIO
 from typing import Any, Callable, Dict, List, Optional, Union
@@ -48,7 +49,7 @@ def junos_on_close(conn: NetworkDriver) -> None:
 
 
 class JunosDriver(NetworkDriver):
-    def __init__(
+    def __init__(  # pylint: disable=R0917
         self,
         host: str,
         privilege_levels: Optional[Dict[str, PrivilegeLevel]] = None,

scrapli/driver/generic/__init__.py

@@ -1,4 +1,5 @@
 """scrapli.driver.generic"""
+
 from scrapli.driver.generic.async_driver import AsyncGenericDriver
 from scrapli.driver.generic.base_driver import ReadCallback
 from scrapli.driver.generic.sync_driver import GenericDriver

scrapli/driver/generic/async_driver.py

@@ -1,4 +1,5 @@
 """scrapli.driver.generic.async_driver"""
+
 import asyncio
 from io import BytesIO
 from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Tuple, Union
@@ -16,8 +17,25 @@ if TYPE_CHECKING:
     )
 
 
+async def generic_on_open(conn: "AsyncGenericDriver") -> None:
+    """
+    GenericDriver default on-open -- drains initial login by running a simple get_prompt
+
+    Args:
+        conn: GenericDriver object
+
+    Returns:
+        None
+
+    Raises:
+        N/A
+
+    """
+    await conn.get_prompt()
+
+
 class AsyncGenericDriver(AsyncDriver, BaseGenericDriver):
-    def __init__(
+    def __init__(  # pylint: disable=R0917
         self,
         host: str,
         port: Optional[int] = None,
@@ -39,7 +57,7 @@ class AsyncGenericDriver(AsyncDriver, BaseGenericDriver):
         ssh_config_file: Union[str, bool] = False,
         ssh_known_hosts_file: Union[str, bool] = False,
         on_init: Optional[Callable[..., Any]] = None,
-        on_open: Optional[Callable[..., Any]] = None,
+        on_open: Optional[Callable[..., Any]] = generic_on_open,
         on_close: Optional[Callable[..., Any]] = None,
         transport: str = "system",
         transport_options: Optional[Dict[str, Any]] = None,
@@ -97,7 +115,7 @@ class AsyncGenericDriver(AsyncDriver, BaseGenericDriver):
         return prompt
 
     @timeout_modifier
-    async def _send_command(
+    async def _send_command(  # pylint: disable=R0917
         self,
         command: str,
         strip_prompt: bool = True,
@@ -466,7 +484,7 @@ class AsyncGenericDriver(AsyncDriver, BaseGenericDriver):
             raw_response=raw_response, processed_response=processed_response, response=response
         )
 
-    async def read_callback(  # noqa: C901
+    async def read_callback(  # pylint: disable=R0917
         self,
         callbacks: List["ReadCallback"],
         initial_input: Optional[str] = None,
@@ -576,7 +594,8 @@ class AsyncGenericDriver(AsyncDriver, BaseGenericDriver):
                 _run_callback = callback.check(read_output=read_output)
 
                 if (
-                    callback.only_once is True
+                    _run_callback is True
+                    and callback.only_once is True
                     and callback._triggered is True  # pylint: disable=W0212
                 ):
                     self.logger.warning(

scrapli/driver/generic/base_driver.py

@@ -1,4 +1,5 @@
 """scrapli.driver.generic.base_driver"""
+
 import re
 from typing import (
     TYPE_CHECKING,
@@ -23,7 +24,7 @@ if TYPE_CHECKING:
 
 
 class ReadCallback:
-    def __init__(
+    def __init__(  # pylint: disable=R0917
         self,
         callback: Callable[
             [Union["GenericDriver", "AsyncGenericDriver"], str],
@@ -122,6 +123,8 @@ class ReadCallback:
         """
         if self.contains and not self._contains_bytes:
             self._contains_bytes = self.contains.encode()
+            if self.case_insensitive:
+                self._contains_bytes = self._contains_bytes.lower()
 
         return self._contains_bytes
 
@@ -142,6 +145,8 @@ class ReadCallback:
         """
         if self.not_contains and not self._not_contains_bytes:
             self._not_contains_bytes = self.not_contains.encode()
+            if self.case_insensitive:
+                self._not_contains_bytes = self._not_contains_bytes.lower()
 
         return self._not_contains_bytes
 

scrapli/driver/generic/sync_driver.py

@@ -1,4 +1,5 @@
 """scrapli.driver.generic.sync_driver"""
+
 import time
 from io import BytesIO
 from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Tuple, Union
@@ -16,8 +17,25 @@ if TYPE_CHECKING:
     )
 
 
+def generic_on_open(conn: "GenericDriver") -> None:
+    """
+    GenericDriver default on-open -- drains initial login by running a simple get_prompt
+
+    Args:
+        conn: GenericDriver object
+
+    Returns:
+        None
+
+    Raises:
+        N/A
+
+    """
+    conn.get_prompt()
+
+
 class GenericDriver(Driver, BaseGenericDriver):
-    def __init__(
+    def __init__(  # pylint: disable=R0917
         self,
         host: str,
         port: Optional[int] = None,
@@ -39,7 +57,7 @@ class GenericDriver(Driver, BaseGenericDriver):
         ssh_config_file: Union[str, bool] = False,
         ssh_known_hosts_file: Union[str, bool] = False,
         on_init: Optional[Callable[..., Any]] = None,
-        on_open: Optional[Callable[..., Any]] = None,
+        on_open: Optional[Callable[..., Any]] = generic_on_open,
         on_close: Optional[Callable[..., Any]] = None,
         transport: str = "system",
         transport_options: Optional[Dict[str, Any]] = None,
@@ -98,7 +116,7 @@ class GenericDriver(Driver, BaseGenericDriver):
         return prompt
 
     @timeout_modifier
-    def _send_command(
+    def _send_command(  # pylint: disable=R0917
         self,
         command: str,
         strip_prompt: bool = True,
@@ -191,7 +209,7 @@ class GenericDriver(Driver, BaseGenericDriver):
         )
         return response
 
-    def send_commands(
+    def send_commands(  # pylint: disable=R0917
         self,
         commands: List[str],
         *,
@@ -467,7 +485,7 @@ class GenericDriver(Driver, BaseGenericDriver):
             raw_response=raw_response, processed_response=processed_response, response=response
         )
 
-    def read_callback(
+    def read_callback(  # pylint: disable=R0917
         self,
         callbacks: List["ReadCallback"],
         initial_input: Optional[str] = None,
@@ -577,7 +595,8 @@ class GenericDriver(Driver, BaseGenericDriver):
                 _run_callback = callback.check(read_output=read_output)
 
                 if (
-                    callback.only_once is True
+                    _run_callback is True
+                    and callback.only_once is True
                     and callback._triggered is True  # pylint: disable=W0212
                 ):
                     self.logger.warning(

scrapli/driver/network/__init__.py

@@ -1,4 +1,5 @@
 """scrapli.driver.network"""
+
 from scrapli.driver.network.async_driver import AsyncNetworkDriver
 from scrapli.driver.network.sync_driver import NetworkDriver
 

scrapli/driver/network/async_driver.py

@@ -1,4 +1,5 @@
 """scrapli.driver.network.async_driver"""
+
 from collections import defaultdict
 from io import BytesIO
 from typing import Any, Callable, Dict, List, Optional, Tuple, Union
@@ -10,7 +11,7 @@ from scrapli.response import MultiResponse, Response
 
 
 class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
-    def __init__(
+    def __init__(  # pylint: disable=R0917
         self,
         host: str,
         privilege_levels: Dict[str, PrivilegeLevel],

scrapli/driver/network/base_driver.py

@@ -1,4 +1,5 @@
 """scrapli.driver.network.base_driver"""
+
 import re
 from collections import defaultdict
 from datetime import datetime
@@ -29,7 +30,7 @@ class PrivilegeLevel:
         "not_contains",
     )
 
-    def __init__(
+    def __init__(  # pylint: disable=R0917
         self,
         pattern: str,
         name: str,

scrapli/driver/network/sync_driver.py

@@ -1,4 +1,5 @@
 """scrapli.driver.network.sync_driver"""
+
 from collections import defaultdict
 from io import BytesIO
 from typing import Any, Callable, Dict, List, Optional, Tuple, Union
@@ -10,7 +11,7 @@ from scrapli.response import MultiResponse, Response
 
 
 class NetworkDriver(GenericDriver, BaseNetworkDriver):
-    def __init__(
+    def __init__(  # pylint: disable=R0917
         self,
         host: str,
         privilege_levels: Dict[str, PrivilegeLevel],

scrapli/exceptions.py

@@ -1,4 +1,5 @@
 """scrapli.exceptions"""
+
 from typing import Optional
 
 

scrapli/factory.py

@@ -1,4 +1,5 @@
 """scrapli.factory"""
+
 import importlib
 from copy import deepcopy
 from io import BytesIO
@@ -26,10 +27,10 @@ from scrapli.exceptions import (
 )
 from scrapli.helper import format_user_warning
 from scrapli.logging import logger
-from scrapli.transport import ASYNCIO_TRANSPORTS
+from scrapli.transport import ASYNCIO_TRANSPORTS, CORE_TRANSPORTS
 
 
-def _build_provided_kwargs_dict(  # pylint: disable=R0914
+def _build_provided_kwargs_dict(  # pylint: disable=R0914,R0917
     host: str,
     privilege_levels: Optional[Dict[str, PrivilegeLevel]],
     default_desired_privilege_level: Optional[str],
@@ -336,7 +337,7 @@ class Scrapli(NetworkDriver):
         logger.info(msg)
         return final_driver, additional_kwargs
 
-    def __new__(  # pylint: disable=R0914
+    def __new__(  # pylint: disable=R0914,R0917
         cls,
         platform: str,
         host: str,
@@ -464,7 +465,7 @@ class Scrapli(NetworkDriver):
         """
         logger.debug("Scrapli factory initialized")
 
-        if transport in ASYNCIO_TRANSPORTS:
+        if transport in CORE_TRANSPORTS and transport in ASYNCIO_TRANSPORTS:
             raise ScrapliValueError("Use 'AsyncScrapli' if using an async transport!")
 
         if not isinstance(platform, str):
@@ -635,7 +636,7 @@ class AsyncScrapli(AsyncNetworkDriver):
         logger.info(msg)
         return final_driver, additional_kwargs
 
-    def __new__(  # pylint: disable=R0914
+    def __new__(  # pylint: disable=R0914,R0917
         cls,
         platform: str,
         host: str,
@@ -763,7 +764,7 @@ class AsyncScrapli(AsyncNetworkDriver):
         """
         logger.debug("AsyncScrapli factory initialized")
 
-        if transport not in ASYNCIO_TRANSPORTS:
+        if transport in CORE_TRANSPORTS and transport not in ASYNCIO_TRANSPORTS:
             raise ScrapliValueError("Use 'Scrapli' if using a synchronous transport!")
 
         if not isinstance(platform, str):

scrapli/helper.py

@@ -1,15 +1,16 @@
 """scrapli.helper"""
+
 import importlib
 import importlib.resources
 import sys
 import urllib.request
-from io import BytesIO, TextIOWrapper
+from io import BufferedReader, BytesIO, TextIOWrapper
 from pathlib import Path
 from shutil import get_terminal_size
 from typing import Any, Dict, List, Optional, TextIO, Tuple, Union
 from warnings import warn
 
-from scrapli.exceptions import ScrapliValueError
+from scrapli.exceptions import ScrapliException, ScrapliValueError
 from scrapli.logging import logger
 from scrapli.settings import Settings
 
@@ -18,7 +19,14 @@ def _textfsm_get_template_directory() -> str:
     if sys.version_info >= (3, 9):
         return f"{importlib.resources.files('ntc_templates')}/templates"
 
-    with importlib.resources.path("ntc_templates", "templates") as path:
+    if sys.version_info >= (3, 11):
+        # https://docs.python.org/3/library/importlib.resources.html#importlib.resources.path
+        with importlib.resources.as_file(
+            importlib.resources.files("ntc_templates").joinpath("templates")
+        ) as path:
+            return str(path)
+
+    with importlib.resources.path("ntc_templates", "templates") as path:  # pylint: disable=W4902
         return str(path)
 
 
@@ -89,7 +97,7 @@ def _textfsm_to_dict(
 
 
 def textfsm_parse(
-    template: Union[str, TextIOWrapper], output: str, to_dict: bool = True
+    template: Union[str, TextIOWrapper], output: str, to_dict: bool = True, raise_err: bool = False
 ) -> Union[List[Any], Dict[str, Any]]:
     """
     Parse output with TextFSM and ntc-templates, try to return structured output
@@ -99,16 +107,20 @@ def textfsm_parse(
         output: unstructured output from device to parse
         to_dict: convert textfsm output from list of lists to list of dicts -- basically create dict
             from header and row data so it is easier to read/parse the output
+        raise_err: exceptions in the textfsm parser will raised for the caller to handle
 
     Returns:
         output: structured data
 
     Raises:
-        N/A
+        ScrapliException: If raise_err is set and a textfsm parsing error occurs, raises from the
+            originating textfsm.parser.TextFSMError exception.
 
     """
     import textfsm  # pylint: disable=C0415
 
+    template_file: Union[BufferedReader, TextIOWrapper]
+
     if not isinstance(template, TextIOWrapper):
         if template.startswith("http://") or template.startswith("https://"):
             with urllib.request.urlopen(template) as response:
@@ -117,7 +129,7 @@ def textfsm_parse(
                     encoding=response.headers.get_content_charset(),
                 )
         else:
-            template_file = TextIOWrapper(open(template, mode="rb"))  # pylint: disable=R1732
+            template_file = open(template, mode="rb")  # pylint: disable=R1732
     else:
         template_file = template
     re_table = textfsm.TextFSM(template_file)
@@ -128,8 +140,10 @@ def textfsm_parse(
                 structured_output=structured_output, header=re_table.header
             )
         return structured_output
-    except textfsm.parser.TextFSMError:
+    except textfsm.parser.TextFSMError as exc:
         logger.warning("failed to parse data with textfsm")
+        if raise_err:
+            raise ScrapliException(exc) from exc
     return []
 
 

scrapli/logging.py

@@ -1,5 +1,4 @@
 """scrapli.logging"""
-from ast import literal_eval
 
 # slightly irritating renaming to prevent a cyclic lookup in griffe for mkdocstrings
 from logging import FileHandler as FileHandler_
@@ -222,13 +221,13 @@ class ScrapliFileHandler(FileHandler_):
             # no message in the buffer, set the current record to the _record_buf
             self._record_buf = record
             # get the payload of the message after "read: " and re-convert it to bytes
-            self._record_msg_buf = literal_eval(record.msg[self._read_msg_prefix_len :])  # noqa
+            self._record_msg_buf = record.msg[self._read_msg_prefix_len :].encode()
             return
 
         # if we get here we know we are getting subsequent read messages we want to buffer -- the
         # log record data will all be the same, its just the payload that will be new, so add that
         # current payload to the _record_msg_buf buffer
-        self._record_msg_buf += literal_eval(record.msg[self._read_msg_prefix_len :])  # noqa
+        self._record_msg_buf += record.msg[self._read_msg_prefix_len :].encode()
 
 
 def get_instance_logger(

scrapli/response.py

@@ -1,4 +1,5 @@
 """scrapli.response"""
+
 from collections import UserList
 from datetime import datetime
 from io import TextIOWrapper
@@ -9,7 +10,7 @@ from scrapli.helper import _textfsm_get_template, genie_parse, textfsm_parse, tt
 
 
 class Response:
-    def __init__(
+    def __init__(  # pylint: disable=R0917
         self,
         host: str,
         channel_input: str,
@@ -141,7 +142,10 @@ class Response:
             self.failed = False
 
     def textfsm_parse_output(
-        self, template: Union[str, TextIO, None] = None, to_dict: bool = True
+        self,
+        template: Union[str, TextIO, None] = None,
+        to_dict: bool = True,
+        raise_err: bool = False,
     ) -> Union[Dict[str, Any], List[Any]]:
         """
         Parse results with textfsm, always return structured data
@@ -152,6 +156,7 @@ class Response:
             template: string path to textfsm template or opened textfsm template file
             to_dict: convert textfsm output from list of lists to list of dicts -- basically create
                 dict from header and row data so it is easier to read/parse the output
+            raise_err: exceptions in the textfsm parser will raised for the caller to handle
 
         Returns:
             structured_result: empty list or parsed data from textfsm
@@ -169,7 +174,12 @@ class Response:
             return []
 
         template = cast(Union[str, TextIOWrapper], template)
-        return textfsm_parse(template=template, output=self.result, to_dict=to_dict) or []
+        return (
+            textfsm_parse(
+                template=template, output=self.result, to_dict=to_dict, raise_err=raise_err
+            )
+            or []
+        )
 
     def genie_parse_output(self) -> Union[Dict[str, Any], List[Any]]:
         """

scrapli/ssh_config.py

@@ -1,4 +1,5 @@
 """scrapli.ssh_config"""
+
 import base64
 import hmac
 import os

scrapli/transport/base/__init__.py

@@ -1,4 +1,5 @@
 """scrapli.transport.base"""
+
 from scrapli.transport.base.async_transport import AsyncTransport
 from scrapli.transport.base.base_transport import BasePluginTransportArgs, BaseTransportArgs
 from scrapli.transport.base.sync_transport import Transport

scrapli/transport/base/async_transport.py

@@ -1,4 +1,5 @@
 """scrapli.transport.async_transport"""
+
 from abc import ABC, abstractmethod
 
 from scrapli.transport.base.base_transport import BaseTransport

scrapli/transport/base/base_socket.py

@@ -1,4 +1,5 @@
 """scrapli.transport.base.base_socket"""
+
 import socket
 from contextlib import suppress
 from typing import Optional, Set

scrapli/transport/base/base_transport.py

@@ -1,4 +1,5 @@
 """scrapli.transport.base_transport"""
+
 from abc import ABC, abstractmethod
 from dataclasses import dataclass
 from typing import Any, Dict

scrapli/transport/base/sync_transport.py

@@ -1,4 +1,5 @@
 """scrapli.transport.base_transport"""
+
 from abc import ABC, abstractmethod
 
 from scrapli.transport.base.base_transport import BaseTransport

scrapli/transport/plugins/asyncssh/transport.py

@@ -1,4 +1,5 @@
 """scrapli.transport.plugins.asyncssh.transport"""
+
 import asyncio
 from contextlib import suppress
 from dataclasses import dataclass
@@ -259,6 +260,9 @@ class AsyncsshTransport(AsyncTransport):
         if not self.stdout:
             raise ScrapliConnectionNotOpened
 
+        if self.stdout.at_eof():
+            raise ScrapliConnectionError("transport at EOF; no more data to be read")
+
         try:
             buf: bytes = await self.stdout.read(65535)
         except ConnectionLost as exc: