scrapli 2.0.0a3__py3-none-macosx_11_0_arm64.whl → 2.0.0a4__py3-none-macosx_11_0_arm64.whl

scrapli/__init__.py

@@ -12,7 +12,8 @@ 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.3"
+__version__ = "2.0.0-alpha.4"
+__calendar_version__ = "2025.6.7"
 __definitions_version__ = "471f12e"
 
 __all__ = (

scrapli/cli.py

@@ -1,7 +1,6 @@
 """scrapli.cli"""
 
 import importlib.resources
-from collections.abc import Callable
 from ctypes import (
     c_bool,
     c_char_p,
@@ -31,14 +30,13 @@ from scrapli.exceptions import (
 )
 from scrapli.ffi_mapping import LibScrapliMapping
 from scrapli.ffi_types import (
-    CancelPointer,
     DriverPointer,
     IntPointer,
-    LogFuncCallback,
     OperationIdPointer,
     U64Pointer,
     ZigSlice,
     ZigU64Slice,
+    ffi_logger_wrapper,
     to_c_string,
 )
 from scrapli.helper import (
@@ -47,6 +45,7 @@ from scrapli.helper import (
     wait_for_available_operation_result_async,
 )
 from scrapli.session import Options as SessionOptions
+from scrapli.transport import BinOptions as TransportBinOptions
 from scrapli.transport import Options as TransportOptions
 
 CLI_DEFINITIONS_PATH_OVERRIDE_ENV = "SCRAPLI_DEFINITIONS_PATH"
@@ -93,7 +92,6 @@ class Cli:
         definition_file_or_name: str,
         host: str,
         *,
-        logger_callback: Callable[[int, str], None] | None = None,
         port: int = 22,
         auth_options: AuthOptions | None = None,
         session_options: SessionOptions | None = None,
@@ -105,6 +103,7 @@ class Cli:
             logger_name += f":{logging_uid}"
 
         self.logger = getLogger(logger_name)
+        self.logger_callback = ffi_logger_wrapper(logger=self.logger)
         self._logging_uid = logging_uid
 
         self.ffi_mapping = LibScrapliMapping()
@@ -117,18 +116,13 @@ class Cli:
         # why. in this case we also just store the host since thats cheap and we need it as a string
         # in places too
         self.host = host
-        self._host = to_c_string(host)
-
-        self.logger_callback = (
-            LogFuncCallback(logger_callback) if logger_callback else LogFuncCallback(0)
-        )
-        self._logger_callback = logger_callback
+        self._host = to_c_string(s=host)
 
         self.port = port
 
         self.auth_options = auth_options or AuthOptions()
         self.session_options = session_options or SessionOptions()
-        self.transport_options = transport_options or TransportOptions()
+        self.transport_options = transport_options or TransportBinOptions()
 
         self.ptr: DriverPointer | None = None
         self.poll_fd: int = 0
@@ -264,7 +258,6 @@ class Cli:
         return Cli(
             host=self.host,
             definition_file_or_name=self.definition_file_or_name,
-            logger_callback=self._logger_callback,
             port=self.port,
             auth_options=self.auth_options,
             session_options=self.session_options,
@@ -307,7 +300,7 @@ class Cli:
             logger_callback=self.logger_callback,
             host=self._host,
             port=c_int(self.port),
-            transport_kind=c_char_p(self.transport_options.get_transport_kind()),
+            transport_kind=c_char_p(self.transport_options.transport_kind.encode(encoding="utf-8")),
         )
         if ptr == 0:  # type: ignore[comparison-overlap]
             raise AllocationException("failed to allocate cli")
@@ -319,7 +312,7 @@ class Cli:
                 ptr=self._ptr_or_exception(),
             )
         )
-        if poll_fd == 0:
+        if poll_fd <= 0:
             raise AllocationException("failed to allocate cli")
 
         self.poll_fd = poll_fd
@@ -393,9 +386,9 @@ class Cli:
 
     def _open(
         self,
+        *,
         operation_id: OperationIdPointer,
-        cancel: CancelPointer,
-    ) -> c_uint:
+    ) -> None:
         self._alloc()
 
         self.auth_options.apply(self.ffi_mapping, self._ptr_or_exception())
@@ -405,15 +398,12 @@ class Cli:
         status = self.ffi_mapping.cli_mapping.open(
             ptr=self._ptr_or_exception(),
             operation_id=operation_id,
-            cancel=cancel,
         )
         if status != 0:
             self._free()
 
             raise OpenException("failed to submit open operation")
 
-        return c_uint(operation_id.contents.value)
-
     def open(
         self,
     ) -> Result:
@@ -431,11 +421,10 @@ class Cli:
 
         """
         operation_id = OperationIdPointer(c_uint(0))
-        cancel = CancelPointer(c_bool(False))
 
-        operation_id = self._open(operation_id=operation_id, cancel=cancel)
+        self._open(operation_id=operation_id)
 
-        return self._get_result(operation_id=operation_id)
+        return self._get_result(operation_id=operation_id.contents.value)
 
     async def open_async(self) -> Result:
         """
@@ -452,24 +441,23 @@ class Cli:
 
         """
         operation_id = OperationIdPointer(c_uint(0))
-        cancel = CancelPointer(c_bool(False))
 
-        operation_id = self._open(operation_id=operation_id, cancel=cancel)
+        self._open(operation_id=operation_id)
 
-        return await self._get_result_async(operation_id=operation_id)
-
-    def _close(self) -> c_uint:
-        operation_id = OperationIdPointer(c_uint(0))
-        cancel = CancelPointer(c_bool(False))
+        return await self._get_result_async(operation_id=operation_id.contents.value)
 
+    def _close(
+        self,
+        *,
+        operation_id: OperationIdPointer,
+    ) -> None:
         status = self.ffi_mapping.cli_mapping.close(
-            ptr=self._ptr_or_exception(), operation_id=operation_id, cancel=cancel
+            ptr=self._ptr_or_exception(),
+            operation_id=operation_id,
         )
         if status != 0:
             raise CloseException("submitting close operation")
 
-        return c_uint(operation_id.contents.value)
-
     def close(
         self,
     ) -> Result:
@@ -487,9 +475,11 @@ class Cli:
             CloseException: if the operation fails
 
         """
-        operation_id = self._close()
+        operation_id = OperationIdPointer(c_uint(0))
+
+        self._close(operation_id=operation_id)
 
-        result = self._get_result(operation_id=operation_id)
+        result = self._get_result(operation_id=operation_id.contents.value)
 
         self._free()
 
@@ -512,9 +502,11 @@ class Cli:
             CloseException: if the operation fails
 
         """
-        operation_id = self._close()
+        operation_id = OperationIdPointer(c_uint(0))
 
-        result = await self._get_result_async(operation_id=operation_id)
+        self._close(operation_id=operation_id)
+
+        result = await self._get_result_async(operation_id=operation_id.contents.value)
 
         self._free()
 
@@ -658,13 +650,11 @@ class Cli:
         self,
         *,
         operation_id: OperationIdPointer,
-        cancel: CancelPointer,
         requested_mode: c_char_p,
     ) -> c_uint:
         status = self.ffi_mapping.cli_mapping.enter_mode(
             ptr=self._ptr_or_exception(),
             operation_id=operation_id,
-            cancel=cancel,
             requested_mode=requested_mode,
         )
         if status != 0:
@@ -698,12 +688,12 @@ class Cli:
         _ = operation_timeout_ns
 
         operation_id = OperationIdPointer(c_uint(0))
-        cancel = CancelPointer(c_bool(False))
 
         _requested_mode = to_c_string(requested_mode)
 
         operation_id = self._enter_mode(
-            operation_id=operation_id, cancel=cancel, requested_mode=_requested_mode
+            operation_id=operation_id,
+            requested_mode=_requested_mode,
         )
 
         return self._get_result(operation_id=operation_id)
@@ -734,12 +724,12 @@ class Cli:
         _ = operation_timeout_ns
 
         operation_id = OperationIdPointer(c_uint(0))
-        cancel = CancelPointer(c_bool(False))
 
         _requested_mode = to_c_string(requested_mode)
 
         operation_id = self._enter_mode(
-            operation_id=operation_id, cancel=cancel, requested_mode=_requested_mode
+            operation_id=operation_id,
+            requested_mode=_requested_mode,
         )
 
         return await self._get_result_async(operation_id=operation_id)
@@ -748,12 +738,10 @@ class Cli:
         self,
         *,
         operation_id: OperationIdPointer,
-        cancel: CancelPointer,
     ) -> c_uint:
         status = self.ffi_mapping.cli_mapping.get_prompt(
             ptr=self._ptr_or_exception(),
             operation_id=operation_id,
-            cancel=cancel,
         )
         if status != 0:
             raise SubmitOperationException("submitting get prompt operation failed")
@@ -784,9 +772,8 @@ class Cli:
         _ = operation_timeout_ns
 
         operation_id = OperationIdPointer(c_uint(0))
-        cancel = CancelPointer(c_bool(False))
 
-        operation_id = self._get_prompt(operation_id=operation_id, cancel=cancel)
+        operation_id = self._get_prompt(operation_id=operation_id)
 
         return self._get_result(operation_id=operation_id)
 
@@ -814,9 +801,8 @@ class Cli:
         _ = operation_timeout_ns
 
         operation_id = OperationIdPointer(c_uint(0))
-        cancel = CancelPointer(c_bool(False))
 
-        operation_id = self._get_prompt(operation_id=operation_id, cancel=cancel)
+        operation_id = self._get_prompt(operation_id=operation_id)
 
         return await self._get_result_async(operation_id=operation_id)
 
@@ -824,7 +810,6 @@ class Cli:
         self,
         *,
         operation_id: OperationIdPointer,
-        cancel: CancelPointer,
         input_: c_char_p,
         requested_mode: c_char_p,
         input_handling: c_char_p,
@@ -834,7 +819,6 @@ class Cli:
         status = self.ffi_mapping.cli_mapping.send_input(
             ptr=self._ptr_or_exception(),
             operation_id=operation_id,
-            cancel=cancel,
             input_=input_,
             requested_mode=requested_mode,
             input_handling=input_handling,
@@ -880,7 +864,6 @@ class Cli:
         _ = operation_timeout_ns
 
         operation_id = OperationIdPointer(c_uint(0))
-        cancel = CancelPointer(c_bool(False))
 
         _input = to_c_string(input_)
         _requested_mode = to_c_string(requested_mode)
@@ -888,7 +871,6 @@ class Cli:
 
         operation_id = self._send_input(
             operation_id=operation_id,
-            cancel=cancel,
             input_=_input,
             requested_mode=_requested_mode,
             input_handling=_input_handling,
@@ -932,7 +914,6 @@ class Cli:
         _ = operation_timeout_ns
 
         operation_id = OperationIdPointer(c_uint(0))
-        cancel = CancelPointer(c_bool(False))
 
         _input = to_c_string(input_)
         _requested_mode = to_c_string(requested_mode)
@@ -940,7 +921,6 @@ class Cli:
 
         operation_id = self._send_input(
             operation_id=operation_id,
-            cancel=cancel,
             input_=_input,
             requested_mode=_requested_mode,
             input_handling=_input_handling,
@@ -986,8 +966,6 @@ class Cli:
         # meaning all the "inputs" combined, not individually
         _ = operation_timeout_ns
 
-        cancel = CancelPointer(c_bool(False))
-
         result: Result | None = None
 
         for input_ in inputs:
@@ -999,7 +977,6 @@ class Cli:
 
             operation_id = self._send_input(
                 operation_id=operation_id,
-                cancel=cancel,
                 input_=_input,
                 requested_mode=_requested_mode,
                 input_handling=_input_handling,
@@ -1055,8 +1032,6 @@ class Cli:
         # meaning all the "inputs" combined, not individually
         _ = operation_timeout_ns
 
-        cancel = CancelPointer(c_bool(False))
-
         result: Result | None = None
 
         for input_ in inputs:
@@ -1068,7 +1043,6 @@ class Cli:
 
             operation_id = self._send_input(
                 operation_id=operation_id,
-                cancel=cancel,
                 input_=_input,
                 requested_mode=_requested_mode,
                 input_handling=_input_handling,
@@ -1179,7 +1153,6 @@ class Cli:
         self,
         *,
         operation_id: OperationIdPointer,
-        cancel: CancelPointer,
         input_: c_char_p,
         prompt: c_char_p,
         prompt_pattern: c_char_p,
@@ -1193,7 +1166,6 @@ class Cli:
         status = self.ffi_mapping.cli_mapping.send_prompted_input(
             ptr=self._ptr_or_exception(),
             operation_id=operation_id,
-            cancel=cancel,
             input_=input_,
             prompt=prompt,
             prompt_pattern=prompt_pattern,
@@ -1252,7 +1224,6 @@ class Cli:
         _ = operation_timeout_ns
 
         operation_id = OperationIdPointer(c_uint(0))
-        cancel = CancelPointer(c_bool(False))
 
         _input = to_c_string(input_)
         _prompt = to_c_string(prompt)
@@ -1264,7 +1235,6 @@ class Cli:
 
         operation_id = self._send_prompted_input(
             operation_id=operation_id,
-            cancel=cancel,
             input_=_input,
             prompt=_prompt,
             prompt_pattern=_prompt_pattern,
@@ -1321,7 +1291,6 @@ class Cli:
         _ = operation_timeout_ns
 
         operation_id = OperationIdPointer(c_uint(0))
-        cancel = CancelPointer(c_bool(False))
 
         _input = to_c_string(input_)
         _prompt = to_c_string(prompt)
@@ -1333,7 +1302,6 @@ class Cli:
 
         operation_id = self._send_prompted_input(
             operation_id=operation_id,
-            cancel=cancel,
             input_=_input,
             prompt=_prompt,
             prompt_pattern=_prompt_pattern,

scrapli/ffi.py

@@ -10,7 +10,7 @@ from scrapli.exceptions import LibScrapliException
 
 logger = getLogger(__name__)
 
-LIBSCRAPLI_VERSION = "0.0.1-alpha.10"
+LIBSCRAPLI_VERSION = "0.0.1-alpha.13"
 LIBSCRAPLI_PATH_OVERRIDE_ENV = "LIBSCRAPLI_PATH"
 LIBSCRAPLI_CACHE_PATH_OVERRIDE_ENV = "LIBSCRAPLI_CACHE_PATH"
 XDG_CACHE_HOME_ENV = "XDG_CACHE_HOME"

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[
             [
@@ -91,7 +90,7 @@ class LibScrapliSharedMapping:
         ]
         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.
 

scrapli/ffi_mapping_cli.py

@@ -12,6 +12,7 @@ from ctypes import (
 from _ctypes import POINTER
 
 from scrapli.ffi_types import (
+    CANCEL,
     CancelPointer,
     DriverPointer,
     IntPointer,
@@ -171,7 +172,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 +188,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,
@@ -337,7 +349,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 +361,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 +370,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 +389,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 +401,7 @@ class LibScrapliCliMapping:
         return self._close(
             ptr,
             operation_id,
-            cancel,
+            CANCEL,
         )
 
     def fetch_sizes(
@@ -491,7 +506,6 @@ class LibScrapliCliMapping:
         *,
         ptr: DriverPointer,
         operation_id: OperationIdPointer,
-        cancel: CancelPointer,
         requested_mode: c_char_p,
     ) -> int:
         """
@@ -502,7 +516,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 +526,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 +547,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 +556,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 +581,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 +599,7 @@ class LibScrapliCliMapping:
         return self._send_input(
             ptr,
             operation_id,
-            cancel,
+            CANCEL,
             input_,
             requested_mode,
             input_handling,
@@ -590,7 +612,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 +630,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 +653,7 @@ class LibScrapliCliMapping:
         return self._send_prompted_input(
             ptr,
             operation_id,
-            cancel,
+            CANCEL,
             input_,
             prompt,
             prompt_pattern,