scrapli 2023.7.30__py3-none-any.whl → 2024.7.30__py3-none-any.whl

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,6 +17,23 @@ 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__(
         self,
@@ -35,10 +53,11 @@ class GenericDriver(Driver, BaseGenericDriver):
         timeout_ops: float = 30.0,
         comms_prompt_pattern: str = r"^\S{0,48}[#>$~@:\]]\s*$",
         comms_return_char: str = "\n",
+        comms_roughly_match_inputs: bool = False,
         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,
@@ -64,6 +83,7 @@ class GenericDriver(Driver, BaseGenericDriver):
             timeout_ops=timeout_ops,
             comms_prompt_pattern=comms_prompt_pattern,
             comms_return_char=comms_return_char,
+            comms_roughly_match_inputs=comms_roughly_match_inputs,
             ssh_config_file=ssh_config_file,
             ssh_known_hosts_file=ssh_known_hosts_file,
             on_init=on_init,
@@ -102,6 +122,7 @@ class GenericDriver(Driver, BaseGenericDriver):
         strip_prompt: bool = True,
         failed_when_contains: Optional[Union[str, List[str]]] = None,
         eager: bool = False,
+        eager_input: bool = False,
         timeout_ops: Optional[float] = None,
     ) -> Response:
         """
@@ -118,6 +139,8 @@ class GenericDriver(Driver, BaseGenericDriver):
             eager: if eager is True we do not read until prompt is seen at each command sent to the
                 channel. Do *not* use this unless you know what you are doing as it is possible that
                 it can make scrapli less reliable!
+            eager_input: when true does *not* try to read our input off the channel -- generally
+                this should be left alone unless you know what you are doing!
             timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
                 the duration of the operation, value is reset to initial value after operation is
                 completed
@@ -142,7 +165,7 @@ class GenericDriver(Driver, BaseGenericDriver):
             failed_when_contains=failed_when_contains,
         )
         raw_response, processed_response = self.channel.send_input(
-            channel_input=command, strip_prompt=strip_prompt, eager=eager
+            channel_input=command, strip_prompt=strip_prompt, eager=eager, eager_input=eager_input
         )
         return self._post_send_command(
             raw_response=raw_response, processed_response=processed_response, response=response
@@ -154,6 +177,7 @@ class GenericDriver(Driver, BaseGenericDriver):
         *,
         strip_prompt: bool = True,
         failed_when_contains: Optional[Union[str, List[str]]] = None,
+        eager_input: bool = False,
         timeout_ops: Optional[float] = None,
     ) -> Response:
         """
@@ -163,6 +187,8 @@ class GenericDriver(Driver, BaseGenericDriver):
             command: string to send to device in privilege exec mode
             strip_prompt: strip prompt or not, defaults to True (yes, strip the prompt)
             failed_when_contains: string or list of strings indicating failure if found in response
+            eager_input: when true does *not* try to read our input off the channel -- generally
+                this should be left alone unless you know what you are doing!
             timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
                 the duration of the operation, value is reset to initial value after operation is
                 completed
@@ -178,6 +204,7 @@ class GenericDriver(Driver, BaseGenericDriver):
             command=command,
             strip_prompt=strip_prompt,
             failed_when_contains=failed_when_contains,
+            eager_input=eager_input,
             timeout_ops=timeout_ops,
         )
         return response
@@ -190,6 +217,7 @@ class GenericDriver(Driver, BaseGenericDriver):
         failed_when_contains: Optional[Union[str, List[str]]] = None,
         stop_on_failed: bool = False,
         eager: bool = False,
+        eager_input: bool = False,
         timeout_ops: Optional[float] = None,
     ) -> MultiResponse:
         """
@@ -204,6 +232,8 @@ class GenericDriver(Driver, BaseGenericDriver):
             eager: if eager is True we do not read until prompt is seen at each command sent to the
                 channel. Do *not* use this unless you know what you are doing as it is possible that
                 it can make scrapli less reliable!
+            eager_input: when true does *not* try to read our input off the channel -- generally
+                this should be left alone unless you know what you are doing!
             timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
                 the duration of the operation, value is reset to initial value after operation is
                 completed. Note that this is the timeout value PER COMMAND sent, not for the total
@@ -224,6 +254,7 @@ class GenericDriver(Driver, BaseGenericDriver):
                 failed_when_contains=failed_when_contains,
                 timeout_ops=timeout_ops,
                 eager=eager,
+                eager_input=eager_input,
             )
             responses.append(response)
             if stop_on_failed and response.failed is True:
@@ -239,6 +270,7 @@ class GenericDriver(Driver, BaseGenericDriver):
                 failed_when_contains=failed_when_contains,
                 timeout_ops=timeout_ops,
                 eager=False,
+                eager_input=eager_input,
             )
             responses.append(response)
 
@@ -252,6 +284,7 @@ class GenericDriver(Driver, BaseGenericDriver):
         failed_when_contains: Optional[Union[str, List[str]]] = None,
         stop_on_failed: bool = False,
         eager: bool = False,
+        eager_input: bool = False,
         timeout_ops: Optional[float] = None,
     ) -> MultiResponse:
         """
@@ -266,6 +299,8 @@ class GenericDriver(Driver, BaseGenericDriver):
             eager: if eager is True we do not read until prompt is seen at each command sent to the
                 channel. Do *not* use this unless you know what you are doing as it is possible that
                 it can make scrapli less reliable!
+            eager_input: when true does *not* try to read our input off the channel -- generally
+                this should be left alone unless you know what you are doing!
             timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
                 the duration of the operation, value is reset to initial value after operation is
                 completed. Note that this is the timeout value PER COMMAND sent, not for the total
@@ -286,6 +321,7 @@ class GenericDriver(Driver, BaseGenericDriver):
             failed_when_contains=failed_when_contains,
             stop_on_failed=stop_on_failed,
             eager=eager,
+            eager_input=eager_input,
             timeout_ops=timeout_ops,
         )
 
@@ -531,7 +567,13 @@ class GenericDriver(Driver, BaseGenericDriver):
         """
         if initial_input is not None:
             self.channel.write(channel_input=f"{initial_input}{self.comms_return_char}")
-            return self.read_callback(callbacks=callbacks, initial_input=None)
+            return self.read_callback(
+                callbacks=callbacks,
+                initial_input=None,
+                read_output=read_output,
+                read_delay=read_delay,
+                read_timeout=read_timeout,
+            )
 
         original_transport_timeout = self.timeout_transport
 

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
@@ -29,6 +30,7 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
         timeout_transport: float = 30.0,
         timeout_ops: float = 30.0,
         comms_return_char: str = "\n",
+        comms_roughly_match_inputs: bool = False,
         ssh_config_file: Union[str, bool] = False,
         ssh_known_hosts_file: Union[str, bool] = False,
         on_init: Optional[Callable[..., Any]] = None,
@@ -64,6 +66,7 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
             timeout_transport=timeout_transport,
             timeout_ops=timeout_ops,
             comms_return_char=comms_return_char,
+            comms_roughly_match_inputs=comms_roughly_match_inputs,
             ssh_config_file=ssh_config_file,
             ssh_known_hosts_file=ssh_known_hosts_file,
             on_init=on_init,
@@ -219,6 +222,7 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
         *,
         strip_prompt: bool = True,
         failed_when_contains: Optional[Union[str, List[str]]] = None,
+        eager_input: bool = False,
         timeout_ops: Optional[float] = None,
     ) -> Response:
         """
@@ -230,6 +234,8 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
             command: string to send to device in privilege exec mode
             strip_prompt: True/False strip prompt from returned output
             failed_when_contains: string or list of strings indicating failure if found in response
+            eager_input: when true does *not* try to read our input off the channel -- generally
+                this should be left alone unless you know what you are doing!
             timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
                 the duration of the operation, value is reset to initial value after operation is
                 completed
@@ -250,6 +256,7 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
             command=command,
             strip_prompt=strip_prompt,
             failed_when_contains=failed_when_contains,
+            eager_input=eager_input,
             timeout_ops=timeout_ops,
         )
         self._update_response(response)
@@ -264,6 +271,7 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
         failed_when_contains: Optional[Union[str, List[str]]] = None,
         stop_on_failed: bool = False,
         eager: bool = False,
+        eager_input: bool = False,
         timeout_ops: Optional[float] = None,
     ) -> MultiResponse:
         """
@@ -280,6 +288,8 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
             eager: if eager is True we do not read until prompt is seen at each command sent to the
                 channel. Do *not* use this unless you know what you are doing as it is possible that
                 it can make scrapli less reliable!
+            eager_input: when true does *not* try to read our input off the channel -- generally
+                this should be left alone unless you know what you are doing!
             timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
                 the duration of the operation, value is reset to initial value after operation is
                 completed. Note that this is the timeout value PER COMMAND sent, not for the total
@@ -303,6 +313,7 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
             failed_when_contains=failed_when_contains,
             stop_on_failed=stop_on_failed,
             eager=eager,
+            eager_input=eager_input,
             timeout_ops=timeout_ops,
         )
 
@@ -319,6 +330,7 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
         failed_when_contains: Optional[Union[str, List[str]]] = None,
         stop_on_failed: bool = False,
         eager: bool = False,
+        eager_input: bool = False,
         timeout_ops: Optional[float] = None,
     ) -> MultiResponse:
         """
@@ -333,6 +345,8 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
             eager: if eager is True we do not read until prompt is seen at each command sent to the
                 channel. Do *not* use this unless you know what you are doing as it is possible that
                 it can make scrapli less reliable!
+            eager_input: when true does *not* try to read our input off the channel -- generally
+                this should be left alone unless you know what you are doing!
             timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
                 the duration of the operation, value is reset to initial value after operation is
                 completed. Note that this is the timeout value PER COMMAND sent, not for the total
@@ -356,6 +370,7 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
             failed_when_contains=failed_when_contains,
             stop_on_failed=stop_on_failed,
             eager=eager,
+            eager_input=eager_input,
             timeout_ops=timeout_ops,
         )
 
@@ -477,6 +492,7 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
         stop_on_failed: bool = False,
         privilege_level: str = "",
         eager: bool = False,
+        eager_input: bool = False,
         timeout_ops: Optional[float] = None,
     ) -> MultiResponse:
         """
@@ -498,6 +514,8 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
             eager: if eager is True we do not read until prompt is seen at each command sent to the
                 channel. Do *not* use this unless you know what you are doing as it is possible that
                 it can make scrapli less reliable!
+            eager_input: when true does *not* try to read our input off the channel -- generally
+                this should be left alone unless you know what you are doing!
             timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
                 the duration of the operation, value is reset to initial value after operation is
                 completed. Note that this is the timeout value PER CONFIG sent, not for the total
@@ -525,6 +543,7 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
             failed_when_contains=failed_when_contains,
             stop_on_failed=stop_on_failed,
             eager=eager,
+            eager_input=eager_input,
             timeout_ops=timeout_ops,
         )
 
@@ -542,6 +561,7 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
         stop_on_failed: bool = False,
         privilege_level: str = "",
         eager: bool = False,
+        eager_input: bool = False,
         timeout_ops: Optional[float] = None,
     ) -> Response:
         """
@@ -563,6 +583,8 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
             eager: if eager is True we do not read until prompt is seen at each command sent to the
                 channel. Do *not* use this unless you know what you are doing as it is possible that
                 it can make scrapli less reliable!
+            eager_input: when true does *not* try to read our input off the channel -- generally
+                this should be left alone unless you know what you are doing!
             timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
                 the duration of the operation, value is reset to initial value after operation is
                 completed. Note that this is the timeout value PER CONFIG sent, not for the total
@@ -585,6 +607,7 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
             stop_on_failed=stop_on_failed,
             privilege_level=privilege_level,
             eager=eager,
+            eager_input=eager_input,
             timeout_ops=timeout_ops,
         )
         return self._post_send_config(config=config, multi_response=multi_response)
@@ -598,6 +621,7 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
         stop_on_failed: bool = False,
         privilege_level: str = "",
         eager: bool = False,
+        eager_input: bool = False,
         timeout_ops: Optional[float] = None,
     ) -> MultiResponse:
         """
@@ -619,6 +643,8 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
             eager: if eager is True we do not read until prompt is seen at each command sent to the
                 channel. Do *not* use this unless you know what you are doing as it is possible that
                 it can make scrapli less reliable!
+            eager_input: when true does *not* try to read our input off the channel -- generally
+                this should be left alone unless you know what you are doing!
             timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
                 the duration of the operation, value is reset to initial value after operation is
                 completed. Note that this is the timeout value PER CONFIG sent, not for the total
@@ -640,5 +666,6 @@ class AsyncNetworkDriver(AsyncGenericDriver, BaseNetworkDriver):
             stop_on_failed=stop_on_failed,
             privilege_level=privilege_level,
             eager=eager,
+            eager_input=eager_input,
             timeout_ops=timeout_ops,
         )

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

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
@@ -29,6 +30,7 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
         timeout_transport: float = 30.0,
         timeout_ops: float = 30.0,
         comms_return_char: str = "\n",
+        comms_roughly_match_inputs: bool = False,
         ssh_config_file: Union[str, bool] = False,
         ssh_known_hosts_file: Union[str, bool] = False,
         on_init: Optional[Callable[..., Any]] = None,
@@ -64,6 +66,7 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
             timeout_transport=timeout_transport,
             timeout_ops=timeout_ops,
             comms_return_char=comms_return_char,
+            comms_roughly_match_inputs=comms_roughly_match_inputs,
             ssh_config_file=ssh_config_file,
             ssh_known_hosts_file=ssh_known_hosts_file,
             on_init=on_init,
@@ -219,6 +222,7 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
         *,
         strip_prompt: bool = True,
         failed_when_contains: Optional[Union[str, List[str]]] = None,
+        eager_input: bool = False,
         timeout_ops: Optional[float] = None,
     ) -> Response:
         """
@@ -230,6 +234,8 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
             command: string to send to device in privilege exec mode
             strip_prompt: True/False strip prompt from returned output
             failed_when_contains: string or list of strings indicating failure if found in response
+            eager_input: when true does *not* try to read our input off the channel -- generally
+                this should be left alone unless you know what you are doing!
             timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
                 the duration of the operation, value is reset to initial value after operation is
                 completed
@@ -250,6 +256,7 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
             command=command,
             strip_prompt=strip_prompt,
             failed_when_contains=failed_when_contains,
+            eager_input=eager_input,
             timeout_ops=timeout_ops,
         )
         self._update_response(response)
@@ -264,6 +271,7 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
         failed_when_contains: Optional[Union[str, List[str]]] = None,
         stop_on_failed: bool = False,
         eager: bool = False,
+        eager_input: bool = False,
         timeout_ops: Optional[float] = None,
     ) -> MultiResponse:
         """
@@ -280,6 +288,8 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
             eager: if eager is True we do not read until prompt is seen at each command sent to the
                 channel. Do *not* use this unless you know what you are doing as it is possible that
                 it can make scrapli less reliable!
+            eager_input: when true does *not* try to read our input off the channel -- generally
+                this should be left alone unless you know what you are doing!
             timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
                 the duration of the operation, value is reset to initial value after operation is
                 completed. Note that this is the timeout value PER COMMAND sent, not for the total
@@ -303,6 +313,7 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
             failed_when_contains=failed_when_contains,
             stop_on_failed=stop_on_failed,
             eager=eager,
+            eager_input=eager_input,
             timeout_ops=timeout_ops,
         )
 
@@ -319,6 +330,7 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
         failed_when_contains: Optional[Union[str, List[str]]] = None,
         stop_on_failed: bool = False,
         eager: bool = False,
+        eager_input: bool = False,
         timeout_ops: Optional[float] = None,
     ) -> MultiResponse:
         """
@@ -333,6 +345,8 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
             eager: if eager is True we do not read until prompt is seen at each command sent to the
                 channel. Do *not* use this unless you know what you are doing as it is possible that
                 it can make scrapli less reliable!
+            eager_input: when true does *not* try to read our input off the channel -- generally
+                this should be left alone unless you know what you are doing!
             timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
                 the duration of the operation, value is reset to initial value after operation is
                 completed. Note that this is the timeout value PER COMMAND sent, not for the total
@@ -356,6 +370,7 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
             failed_when_contains=failed_when_contains,
             stop_on_failed=stop_on_failed,
             eager=eager,
+            eager_input=eager_input,
             timeout_ops=timeout_ops,
         )
 
@@ -477,6 +492,7 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
         stop_on_failed: bool = False,
         privilege_level: str = "",
         eager: bool = False,
+        eager_input: bool = False,
         timeout_ops: Optional[float] = None,
     ) -> MultiResponse:
         """
@@ -498,6 +514,8 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
             eager: if eager is True we do not read until prompt is seen at each command sent to the
                 channel. Do *not* use this unless you know what you are doing as it is possible that
                 it can make scrapli less reliable!
+            eager_input: when true does *not* try to read our input off the channel -- generally
+                this should be left alone unless you know what you are doing!
             timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
                 the duration of the operation, value is reset to initial value after operation is
                 completed. Note that this is the timeout value PER CONFIG sent, not for the total
@@ -525,6 +543,7 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
             failed_when_contains=failed_when_contains,
             stop_on_failed=stop_on_failed,
             eager=eager,
+            eager_input=eager_input,
             timeout_ops=timeout_ops,
         )
 
@@ -542,6 +561,7 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
         stop_on_failed: bool = False,
         privilege_level: str = "",
         eager: bool = False,
+        eager_input: bool = False,
         timeout_ops: Optional[float] = None,
     ) -> Response:
         """
@@ -563,6 +583,8 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
             eager: if eager is True we do not read until prompt is seen at each command sent to the
                 channel. Do *not* use this unless you know what you are doing as it is possible that
                 it can make scrapli less reliable!
+            eager_input: when true does *not* try to read our input off the channel -- generally
+                this should be left alone unless you know what you are doing!
             timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
                 the duration of the operation, value is reset to initial value after operation is
                 completed. Note that this is the timeout value PER CONFIG sent, not for the total
@@ -585,6 +607,7 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
             stop_on_failed=stop_on_failed,
             privilege_level=privilege_level,
             eager=eager,
+            eager_input=eager_input,
             timeout_ops=timeout_ops,
         )
         return self._post_send_config(config=config, multi_response=multi_response)
@@ -598,6 +621,7 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
         stop_on_failed: bool = False,
         privilege_level: str = "",
         eager: bool = False,
+        eager_input: bool = False,
         timeout_ops: Optional[float] = None,
     ) -> MultiResponse:
         """
@@ -619,6 +643,8 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
             eager: if eager is True we do not read until prompt is seen at each command sent to the
                 channel. Do *not* use this unless you know what you are doing as it is possible that
                 it can make scrapli less reliable!
+            eager_input: when true does *not* try to read our input off the channel -- generally
+                this should be left alone unless you know what you are doing!
             timeout_ops: timeout ops value for this operation; only sets the timeout_ops value for
                 the duration of the operation, value is reset to initial value after operation is
                 completed. Note that this is the timeout value PER CONFIG sent, not for the total
@@ -640,5 +666,6 @@ class NetworkDriver(GenericDriver, BaseNetworkDriver):
             stop_on_failed=stop_on_failed,
             privilege_level=privilege_level,
             eager=eager,
+            eager_input=eager_input,
             timeout_ops=timeout_ops,
         )

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,7 +27,7 @@ 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
@@ -44,6 +45,7 @@ def _build_provided_kwargs_dict(  # pylint: disable=R0914
     timeout_transport: Optional[float],
     timeout_ops: Optional[float],
     comms_return_char: Optional[str],
+    comms_roughly_match_inputs: Optional[bool],
     ssh_config_file: Optional[Union[str, bool]],
     ssh_known_hosts_file: Optional[Union[str, bool]],
     on_init: Optional[Callable[..., Any]],
@@ -97,6 +99,7 @@ def _build_provided_kwargs_dict(  # pylint: disable=R0914
         "timeout_transport": timeout_transport,
         "timeout_ops": timeout_ops,
         "comms_return_char": comms_return_char,
+        "comms_roughly_match_inputs": comms_roughly_match_inputs,
         "ssh_config_file": ssh_config_file,
         "ssh_known_hosts_file": ssh_known_hosts_file,
         "on_init": on_init,
@@ -351,6 +354,7 @@ class Scrapli(NetworkDriver):
         timeout_transport: Optional[float] = None,
         timeout_ops: Optional[float] = None,
         comms_return_char: Optional[str] = None,
+        comms_roughly_match_inputs: Optional[bool] = None,
         ssh_config_file: Optional[Union[str, bool]] = None,
         ssh_known_hosts_file: Optional[Union[str, bool]] = None,
         on_init: Optional[Callable[..., Any]] = None,
@@ -388,6 +392,12 @@ class Scrapli(NetworkDriver):
             timeout_transport: timeout for ssh|telnet transport in seconds
             timeout_ops: timeout for ssh channel operations
             comms_return_char: character to use to send returns to host
+            comms_roughly_match_inputs: indicates if the channel should "roughly" match inputs sent
+                to the device. If False (default) inputs are strictly checked, as in any input
+                *must* be read back exactly on the channel. When set to True all input chars *must*
+                be read back in order in the output and all chars must be present, but the *exact*
+                input string does not need to be seen. This can be useful if a device echoes back
+                extra characters or rewrites the terminal during command input.
             ssh_config_file: string to path for ssh config file, True to use default ssh config file
                 or False to ignore default ssh config file
             ssh_known_hosts_file: string to path for ssh known hosts file, True to use default known
@@ -455,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):
@@ -474,6 +484,7 @@ class Scrapli(NetworkDriver):
             timeout_transport=timeout_transport,
             timeout_ops=timeout_ops,
             comms_return_char=comms_return_char,
+            comms_roughly_match_inputs=comms_roughly_match_inputs,
             ssh_config_file=ssh_config_file,
             ssh_known_hosts_file=ssh_known_hosts_file,
             on_init=on_init,
@@ -642,6 +653,7 @@ class AsyncScrapli(AsyncNetworkDriver):
         timeout_transport: Optional[float] = None,
         timeout_ops: Optional[float] = None,
         comms_return_char: Optional[str] = None,
+        comms_roughly_match_inputs: Optional[bool] = None,
         ssh_config_file: Optional[Union[str, bool]] = None,
         ssh_known_hosts_file: Optional[Union[str, bool]] = None,
         on_init: Optional[Callable[..., Any]] = None,
@@ -679,6 +691,12 @@ class AsyncScrapli(AsyncNetworkDriver):
             timeout_transport: timeout for ssh|telnet transport in seconds
             timeout_ops: timeout for ssh channel operations
             comms_return_char: character to use to send returns to host
+            comms_roughly_match_inputs: indicates if the channel should "roughly" match inputs sent
+                to the device. If False (default) inputs are strictly checked, as in any input
+                *must* be read back exactly on the channel. When set to True all input chars *must*
+                be read back in order in the output and all chars must be present, but the *exact*
+                input string does not need to be seen. This can be useful if a device echoes back
+                extra characters or rewrites the terminal during command input.
             ssh_config_file: string to path for ssh config file, True to use default ssh config file
                 or False to ignore default ssh config file
             ssh_known_hosts_file: string to path for ssh known hosts file, True to use default known
@@ -746,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):
@@ -765,6 +783,7 @@ class AsyncScrapli(AsyncNetworkDriver):
             timeout_transport=timeout_transport,
             timeout_ops=timeout_ops,
             comms_return_char=comms_return_char,
+            comms_roughly_match_inputs=comms_roughly_match_inputs,
             ssh_config_file=ssh_config_file,
             ssh_known_hosts_file=ssh_known_hosts_file,
             on_init=on_init,