scrapli 2.0.0a3__py3-none-musllinux_1_1_aarch64.whl → 2.0.0a5__py3-none-musllinux_1_1_aarch64.whl

scrapli/ffi_mapping.py

@@ -7,7 +7,6 @@ from ctypes import (
     c_char_p,
     c_int,
     c_uint8,
-    c_uint32,
 )
 
 from scrapli.ffi import get_libscrapli_path
@@ -43,12 +42,12 @@ class LibScrapliSharedMapping:
             [
                 DriverPointer,
             ],
-            c_uint32,
+            c_int,
         ] = lib.ls_shared_get_poll_fd
         lib.ls_shared_get_poll_fd.argtypes = [
             DriverPointer,
         ]
-        lib.ls_cli_alloc.restype = c_uint32
+        lib.ls_cli_alloc.restype = c_int
 
         self._free: Callable[
             [
@@ -61,37 +60,7 @@ class LibScrapliSharedMapping:
         ]
         lib.ls_shared_free.restype = None
 
-        self._read: Callable[
-            [
-                DriverPointer,
-                StringPointer,
-                IntPointer,
-            ],
-            int,
-        ] = lib.ls_shared_read_session
-        lib.ls_shared_read_session.argtypes = [
-            DriverPointer,
-            StringPointer,
-            IntPointer,
-        ]
-        lib.ls_shared_read_session.restype = c_int
-
-        self._write: Callable[
-            [
-                DriverPointer,
-                c_char_p,
-                c_bool,
-            ],
-            int,
-        ] = lib.ls_shared_write_session
-        lib.ls_shared_write_session.argtypes = [
-            DriverPointer,
-            c_char_p,
-            c_bool,
-        ]
-        lib.ls_shared_write_session.restype = c_uint8
-
-    def get_poll_fd(self, ptr: DriverPointer) -> c_uint32:
+    def get_poll_fd(self, ptr: DriverPointer) -> c_int:
         """
         Get the operation poll fd from the driver at ptr.
 
@@ -127,6 +96,70 @@ class LibScrapliSharedMapping:
         """
         return self._free(ptr)
 
+
+class LibScrapliSessionMapping:
+    """
+    Mapping to libscrapli shared (between cli/netconf) object functions mapping.
+
+    Should not be used/called directly.
+
+    Args:
+        N/A
+
+    Returns:
+        None
+
+    Raises:
+        N/A
+
+    """
+
+    def __init__(self, lib: CDLL) -> None:
+        self._read: Callable[
+            [
+                DriverPointer,
+                StringPointer,
+                IntPointer,
+            ],
+            int,
+        ] = lib.ls_session_read
+        lib.ls_session_read.argtypes = [
+            DriverPointer,
+            StringPointer,
+            IntPointer,
+        ]
+        lib.ls_session_read.restype = c_int
+
+        self._write: Callable[
+            [
+                DriverPointer,
+                c_char_p,
+                c_bool,
+            ],
+            int,
+        ] = lib.ls_session_write
+        lib.ls_session_write.argtypes = [
+            DriverPointer,
+            c_char_p,
+            c_bool,
+        ]
+        lib.ls_session_write.restype = c_uint8
+
+        self._write_and_return: Callable[
+            [
+                DriverPointer,
+                c_char_p,
+                c_bool,
+            ],
+            int,
+        ] = lib.ls_session_write_and_return
+        lib.ls_session_write_and_return.argtypes = [
+            DriverPointer,
+            c_char_p,
+            c_bool,
+        ]
+        lib.ls_session_write_and_return.restype = c_uint8
+
     def read(self, ptr: DriverPointer, buf: StringPointer, read_size: IntPointer) -> int:
         """
         Read from the session of driver at ptr.
@@ -148,7 +181,7 @@ class LibScrapliSharedMapping:
         """
         return self._read(ptr, buf, read_size)
 
-    def write(self, ptr: DriverPointer, buf: c_char_p, redacted: c_bool) -> int:
+    def write(self, ptr: DriverPointer, input_: c_char_p, redacted: c_bool) -> int:
         """
         Write to the session of driver at ptr.
 
@@ -156,7 +189,28 @@ class LibScrapliSharedMapping:
 
         Args:
             ptr: the ptr to the libscrapli cli/netconf object.
-            buf: buffer contents to write during the write operation..
+            input_: buffer contents to write during the write operation..
+            redacted: bool indicated if the write contents should be redacted from logs.
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._write(ptr, input_, redacted)
+
+    def write_and_return(self, ptr: DriverPointer, input_: c_char_p, redacted: c_bool) -> int:
+        """
+        Write and then send a return to the session of driver at ptr.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: the ptr to the libscrapli cli/netconf object.
+            input_: buffer contents to write during the write operation..
             redacted: bool indicated if the write contents should be redacted from logs.
 
         Returns:
@@ -167,7 +221,7 @@ class LibScrapliSharedMapping:
             N/A
 
         """
-        return self._write(ptr, buf, redacted)
+        return self._write_and_return(ptr, input_, redacted)
 
 
 class LibScrapliMapping:
@@ -197,6 +251,7 @@ class LibScrapliMapping:
     def __init__(self) -> None:
         self.lib = CDLL(get_libscrapli_path())
         self.shared_mapping = LibScrapliSharedMapping(self.lib)
+        self.session_mapping = LibScrapliSessionMapping(self.lib)
         self.cli_mapping = LibScrapliCliMapping(self.lib)
         self.netconf_mapping = LibScrapliNetconfMapping(self.lib)
         self.options_mapping = LibScrapliOptionsMapping(self.lib)

scrapli/ffi_mapping_cli.py

@@ -12,6 +12,8 @@ from ctypes import (
 from _ctypes import POINTER
 
 from scrapli.ffi_types import (
+    CANCEL,
+    BoolPointer,
     CancelPointer,
     DriverPointer,
     IntPointer,
@@ -171,7 +173,13 @@ class LibScrapliCliMapping:
         lib.ls_cli_fetch_operation.restype = c_uint8
 
         self._enter_mode: Callable[
-            [DriverPointer, OperationIdPointer, CancelPointer, c_char_p], int
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+                c_char_p,
+            ],
+            int,
         ] = lib.ls_cli_enter_mode
         lib.ls_cli_enter_mode.argtypes = [
             DriverPointer,
@@ -181,9 +189,14 @@ class LibScrapliCliMapping:
         ]
         lib.ls_cli_enter_mode.restype = c_uint8
 
-        self._get_prompt: Callable[[DriverPointer, OperationIdPointer, CancelPointer], int] = (
-            lib.ls_cli_get_prompt
-        )
+        self._get_prompt: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+            ],
+            int,
+        ] = lib.ls_cli_get_prompt
         lib.ls_cli_get_prompt.argtypes = [
             DriverPointer,
             OperationIdPointer,
@@ -249,6 +262,42 @@ class LibScrapliCliMapping:
         ]
         lib.ls_cli_send_prompted_input.restype = c_uint8
 
+        self._read_any: Callable[
+            [
+                DriverPointer,
+                OperationIdPointer,
+                CancelPointer,
+            ],
+            int,
+        ] = lib.ls_cli_read_any
+        lib.ls_cli_read_any.argtypes = [
+            DriverPointer,
+            OperationIdPointer,
+            CancelPointer,
+        ]
+        lib.ls_cli_read_any.restype = c_uint8
+
+        self._read_callback_should_execute: Callable[
+            [
+                c_char_p,
+                c_char_p,
+                c_char_p,
+                c_char_p,
+                c_char_p,
+                BoolPointer,
+            ],
+            int,
+        ] = lib.ls_cli_read_callback_should_execute
+        lib.ls_cli_read_callback_should_execute.argtypes = [
+            c_char_p,
+            c_char_p,
+            c_char_p,
+            c_char_p,
+            c_char_p,
+            POINTER(c_bool),
+        ]
+        lib.ls_cli_read_callback_should_execute.restype = c_uint8
+
     def alloc(
         self,
         *,
@@ -337,7 +386,9 @@ class LibScrapliCliMapping:
         )
 
     def open(
-        self, ptr: DriverPointer, operation_id: OperationIdPointer, cancel: CancelPointer
+        self,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
     ) -> int:
         """
         Open the driver at ptr.
@@ -347,7 +398,6 @@ class LibScrapliCliMapping:
         Args:
             ptr: the ptr to the libscrapli cli object.
             operation_id: c_int pointer that is filled with the operation id to poll for completion.
-            cancel: bool pointer that can be set to true to cancel the operation.
 
         Returns:
             int: return code, non-zero value indicates an error. technically a c_uint8 converted by
@@ -357,13 +407,16 @@ class LibScrapliCliMapping:
             N/A
 
         """
-        return self._open(ptr, operation_id, cancel)
+        return self._open(
+            ptr,
+            operation_id,
+            CANCEL,
+        )
 
     def close(
         self,
         ptr: DriverPointer,
         operation_id: OperationIdPointer,
-        cancel: CancelPointer,
     ) -> int:
         """
         Close the driver at ptr.
@@ -373,7 +426,6 @@ class LibScrapliCliMapping:
         Args:
             ptr: the ptr to the libscrapli cli object.
             operation_id: c_int pointer that is filled with the operation id to poll for completion.
-            cancel: bool pointer that can be set to true to cancel the operation.
 
         Returns:
             int: return code, non-zero value indicates an error. technically a c_uint8 converted by
@@ -386,7 +438,7 @@ class LibScrapliCliMapping:
         return self._close(
             ptr,
             operation_id,
-            cancel,
+            CANCEL,
         )
 
     def fetch_sizes(
@@ -491,7 +543,6 @@ class LibScrapliCliMapping:
         *,
         ptr: DriverPointer,
         operation_id: OperationIdPointer,
-        cancel: CancelPointer,
         requested_mode: c_char_p,
     ) -> int:
         """
@@ -502,7 +553,6 @@ class LibScrapliCliMapping:
         Args:
             ptr: ptr to the cli object
             operation_id: int pointer to fill with the id of the submitted operation
-            cancel: bool pointer that can be set to true to cancel the operation
             requested_mode: string name of the mode to enter
 
         Returns:
@@ -513,10 +563,18 @@ class LibScrapliCliMapping:
             N/A
 
         """
-        return self._enter_mode(ptr, operation_id, cancel, requested_mode)
+        return self._enter_mode(
+            ptr,
+            operation_id,
+            CANCEL,
+            requested_mode,
+        )
 
     def get_prompt(
-        self, *, ptr: DriverPointer, operation_id: OperationIdPointer, cancel: CancelPointer
+        self,
+        *,
+        ptr: DriverPointer,
+        operation_id: OperationIdPointer,
     ) -> int:
         """
         Get the current prompt for the cli object.
@@ -526,7 +584,6 @@ class LibScrapliCliMapping:
         Args:
             ptr: ptr to the cli object
             operation_id: int pointer to fill with the id of the submitted operation
-            cancel: bool pointer that can be set to true to cancel the operation
 
         Returns:
             int: return code, non-zero value indicates an error. technically a c_uint8 converted by
@@ -536,14 +593,17 @@ class LibScrapliCliMapping:
             N/A
 
         """
-        return self._get_prompt(ptr, operation_id, cancel)
+        return self._get_prompt(
+            ptr,
+            operation_id,
+            CANCEL,
+        )
 
     def send_input(
         self,
         *,
         ptr: DriverPointer,
         operation_id: OperationIdPointer,
-        cancel: CancelPointer,
         input_: c_char_p,
         requested_mode: c_char_p,
         input_handling: c_char_p,
@@ -558,7 +618,6 @@ class LibScrapliCliMapping:
         Args:
             ptr: ptr to the cli object
             operation_id: int pointer to fill with the id of the submitted operation
-            cancel: bool pointer that can be set to true to cancel the operation
             input_: the input to send
             requested_mode: string name of the mode to send the input in
             input_handling: string mapping to input handling enum that governs how the input is
@@ -577,7 +636,7 @@ class LibScrapliCliMapping:
         return self._send_input(
             ptr,
             operation_id,
-            cancel,
+            CANCEL,
             input_,
             requested_mode,
             input_handling,
@@ -590,7 +649,6 @@ class LibScrapliCliMapping:
         *,
         ptr: DriverPointer,
         operation_id: OperationIdPointer,
-        cancel: CancelPointer,
         input_: c_char_p,
         prompt: c_char_p,
         prompt_pattern: c_char_p,
@@ -609,7 +667,6 @@ class LibScrapliCliMapping:
         Args:
             ptr: ptr to the cli object
             operation_id: int pointer to fill with the id of the submitted operation
-            cancel: bool pointer that can be set to true to cancel the operation
             input_: the input to send
             prompt: the prompt to expect
             prompt_pattern: the prompt pattern to expect
@@ -633,7 +690,7 @@ class LibScrapliCliMapping:
         return self._send_prompted_input(
             ptr,
             operation_id,
-            cancel,
+            CANCEL,
             input_,
             prompt,
             prompt_pattern,
@@ -644,3 +701,70 @@ class LibScrapliCliMapping:
             hidden_response,
             retain_trailing_prompt,
         )
+
+    def read_any(self, ptr: DriverPointer, operation_id: OperationIdPointer) -> int:
+        """
+        Read any available data from the session, up to the normal timeout behavior.
+
+        Should (generally) not be called directly/by users.
+
+        Args:
+            ptr: the ptr to the libscrapli cli/netconf object.
+            operation_id: int pointer to fill with the id of the submitted operation
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._read_any(
+            ptr,
+            operation_id,
+            CANCEL,
+        )
+
+    def read_callback_should_execute(
+        self,
+        buf: c_char_p,
+        name: c_char_p,
+        contains: c_char_p,
+        contains_pattern: c_char_p,
+        not_contains: c_char_p,
+        execute: BoolPointer,
+    ) -> int:
+        """
+        Decide if a callback should execute for read_with_callbacks operations.
+
+        Should (generally) not be called directly/by users.
+
+        Done in zig due to regex checks and wanting to ensure we always use pcre2 (vs go re, py re).
+
+        Args:
+            buf: the buf to use to check if the callback should execute
+            name: the name of the callback
+            contains: the contains string to check for in the buf -- if found, the callback should
+                execute
+            contains_pattern: a string pattern that, if found, indicates the callback should execute
+            not_contains: string that contains data that should not be in the buf for hte callback
+                to execute
+            execute: bool pointer to update w/ execution state
+
+        Returns:
+            int: return code, non-zero value indicates an error. technically a c_uint8 converted by
+                ctypes.
+
+        Raises:
+            N/A
+
+        """
+        return self._read_callback_should_execute(
+            buf,
+            name,
+            contains,
+            contains_pattern,
+            not_contains,
+            execute,
+        )