Feature/wrap safe call (arrayfire#7)

* Prevent using the backend explicitly

* Refactor statistics and arr layout

* Refactor safe_call

Author: roaffix

.flake8

@@ -4,7 +4,6 @@ import-order-style = pep8
 inline-quotes = double
 max-line-length = 119
 
-
 exclude =
     .venv/**
     build/**

arrayfire_wrapper/_backend.py

@@ -220,7 +220,7 @@ def clib(self) -> ctypes.CDLL:
 
 
 # Initialize the backend
-_backend = Backend()
+__backend = Backend()
 
 
 def get_backend() -> Backend:
@@ -233,4 +233,4 @@ def get_backend() -> Backend:
         Current active backend.
     """
 
-    return _backend
+    return __backend

arrayfire_wrapper/lib/__init__.py

@@ -361,8 +361,8 @@
     "clamp",
     "floor",
     "hypot",
-    "max_",
-    "min_",
+    "maxof",
+    "minof",
     "mod",
     "neg",
     "rem",
@@ -378,8 +378,8 @@
     clamp,
     floor,
     hypot,
-    max_,
-    min_,
+    maxof,
+    minof,
     mod,
     neg,
     rem,

arrayfire_wrapper/lib/_error_handler.py

@@ -1,20 +1,39 @@
 from __future__ import annotations
 
 import ctypes
-from collections.abc import Callable
+from typing import Any
 
-from arrayfire_wrapper.defines import AFArray
+from arrayfire_wrapper._backend import Backend, get_backend
+from arrayfire_wrapper.defines import AFArray, CDimT
+from arrayfire_wrapper.dtypes import to_str
 from arrayfire_wrapper.lib._broadcast import bcast_var
-from arrayfire_wrapper.lib._error_handler import safe_call
+from arrayfire_wrapper.lib._constants import ErrorCodes
 
 
-def binary_op(c_func: Callable, lhs: AFArray, rhs: AFArray, /) -> AFArray:
+def binary_op(c_func_name: str, lhs: AFArray, rhs: AFArray, /) -> AFArray:
     out = AFArray.create_null_pointer()
-    safe_call(c_func(ctypes.pointer(out), lhs, rhs, bcast_var.get()))
+    call_from_clib(c_func_name, ctypes.pointer(out), lhs, rhs, bcast_var.get())
     return out
 
 
-def unary_op(c_func: Callable, arr: AFArray, /) -> AFArray:
+def unary_op(c_func_name: str, arr: AFArray, /) -> AFArray:
     out = AFArray.create_null_pointer()
-    safe_call(c_func(ctypes.pointer(out), arr))
+    call_from_clib(c_func_name, ctypes.pointer(out), arr)
     return out
+
+
+def call_from_clib(func_name: str, *args: Any, clib_prefix: str = "af", **kwargs: Any) -> None:
+    backend = get_backend()
+    c_err = getattr(backend.clib, f"{clib_prefix}_{func_name}")(*args, **kwargs)
+
+    if c_err == ErrorCodes.NONE.value:
+        return
+
+    _process_error(backend)
+
+
+def _process_error(backend: Backend) -> None:
+    err_str = ctypes.c_char_p(0)
+    err_len = CDimT(0)
+    backend.clib.af_get_last_error(ctypes.pointer(err_str), ctypes.pointer(err_len))
+    raise RuntimeError(to_str(err_str))

arrayfire_wrapper/lib/_utility.py

@@ -1,10 +1,9 @@
 import ctypes
 
-from arrayfire_wrapper._backend import _backend
 from arrayfire_wrapper.defines import AFArray, ArrayBuffer, CDimT, CShape, CType
 from arrayfire_wrapper.dtypes import Dtype
 from arrayfire_wrapper.lib._constants import PointerSource
-from arrayfire_wrapper.lib._error_handler import safe_call
+from arrayfire_wrapper.lib._utility import call_from_clib
 
 
 def create_strided_array(
@@ -31,17 +30,16 @@ def create_strided_array(
     if len(strides) < 4:
         strides += (strides[-1],) * (4 - len(strides))
 
-    safe_call(
-        _backend.clib.af_create_strided_array(
-            ctypes.pointer(out),
-            ctypes.c_void_p(array_buffer.address),
-            offset,
-            c_shape.original_shape,
-            ctypes.pointer(c_shape.c_array),
-            CShape(*strides).c_array,
-            dtype.c_api_value,
-            pointer_source.value,
-        )
+    call_from_clib(
+        create_strided_array.__name__,
+        ctypes.pointer(out),
+        ctypes.c_void_p(array_buffer.address),
+        offset,
+        c_shape.original_shape,
+        ctypes.pointer(c_shape.c_array),
+        CShape(*strides).c_array,
+        dtype.c_api_value,
+        pointer_source.value,
     )
     return out
 
@@ -51,7 +49,7 @@ def get_offset(arr: AFArray, /) -> int:
     source: https://arrayfire.org/docs/group__internal__func__offset.htm#ga303cb334026bdb5cab86e038951d6a5a
     """
     out = CDimT(0)
-    safe_call(_backend.clib.af_get_offset(ctypes.pointer(out), arr))
+    call_from_clib(get_offset.__name__, ctypes.pointer(out), arr)
     return out.value
 
 
@@ -63,10 +61,8 @@ def get_strides(arr: AFArray) -> tuple[int, ...]:
     s1 = CDimT(0)
     s2 = CDimT(0)
     s3 = CDimT(0)
-    safe_call(
-        _backend.clib.af_get_strides(
-            ctypes.pointer(s0), ctypes.pointer(s1), ctypes.pointer(s2), ctypes.pointer(s3), arr
-        )
+    call_from_clib(
+        get_strides.__name__, ctypes.pointer(s0), ctypes.pointer(s1), ctypes.pointer(s2), ctypes.pointer(s3), arr
     )
     return (s0.value, s1.value, s2.value, s3.value)
 
@@ -76,7 +72,7 @@ def is_linear(arr: AFArray, /) -> bool:
     source: https://arrayfire.org/docs/group__internal__func__linear.htm#gaef70fb8591d16522a5b05bd7467e7d8a
     """
     out = ctypes.c_bool(False)
-    safe_call(_backend.clib.af_is_linear(ctypes.pointer(out), arr))
+    call_from_clib(is_linear.__name__, ctypes.pointer(out), arr)
     return bool(out.value)
 
 
@@ -85,5 +81,5 @@ def is_owner(arr: AFArray, /) -> bool:
     source: https://arrayfire.org/docs/group__internal__func__owner.htm#ga9db0eda6ffa4c49e7f66c3d53d62186a
     """
     out = ctypes.c_bool(False)
-    safe_call(_backend.clib.af_is_owner(ctypes.pointer(out), arr))
+    call_from_clib(is_owner.__name__, ctypes.pointer(out), arr)
     return bool(out.value)

arrayfire_wrapper/lib/array_layout.py

@@ -4,10 +4,8 @@
 import math
 from typing import Any
 
-from arrayfire_wrapper._backend import _backend
 from arrayfire_wrapper.lib._broadcast import bcast_var
-
-from ..._error_handler import safe_call
+from arrayfire_wrapper.lib.create_and_modify_array.manage_array import release_array
 
 
 class _IndexSequence(ctypes.Structure):
@@ -227,7 +225,7 @@ def __del__(self) -> None:
             # converted to basic C types so we have to
             # build the void_p from the value again.
             arr = ctypes.c_void_p(self.idx.arr)
-            safe_call(_backend.clib.af_release_array(arr))
+            release_array(arr)  # type: ignore[arg-type]
 
 
 class CIndexStructure:

arrayfire_wrapper/lib/create_and_modify_array/assignment_and_indexing/_indexing.py

@@ -1,10 +1,8 @@
 import ctypes
 from typing import Any
 
-from arrayfire_wrapper._backend import _backend
 from arrayfire_wrapper.defines import AFArray
-
-from ..._error_handler import safe_call
+from arrayfire_wrapper.lib._utility import call_from_clib
 
 # TODO fix typing for indices across all functions
 
@@ -14,7 +12,7 @@ def assign_gen(lhs: AFArray, rhs: AFArray, ndims: int, indices: Any, /) -> AFArr
     source: https://arrayfire.org/docs/group__index__func__assign.htm#ga93cd5199c647dce0e3b823f063b352ae
     """
     out = AFArray(0)
-    safe_call(_backend.clib.af_assign_gen(ctypes.pointer(out), lhs, ndims, indices.pointer, rhs))
+    call_from_clib(assign_gen.__name__, ctypes.pointer(out), lhs, ndims, indices.pointer, rhs)
     return out
 
 
@@ -23,5 +21,5 @@ def assign_seq(lhs: AFArray, rhs: AFArray, ndims: int, indices: Any, /) -> AFArr
     source: https://arrayfire.org/docs/group__index__func__assign.htm#ga3b201c3114941b6f8d0e344afcd18457
     """
     out = AFArray(0)
-    safe_call(_backend.clib.af_assign_seq(ctypes.pointer(out), lhs, ndims, indices.pointer, rhs))
+    call_from_clib(assign_seq.__name__, ctypes.pointer(out), lhs, ndims, indices.pointer, rhs)
     return out

arrayfire_wrapper/lib/create_and_modify_array/assignment_and_indexing/assign.py

@@ -1,10 +1,8 @@
 import ctypes
 from typing import Any
 
-from arrayfire_wrapper._backend import _backend
 from arrayfire_wrapper.defines import AFArray, CDimT
-
-from ..._error_handler import safe_call
+from arrayfire_wrapper.lib._utility import call_from_clib
 
 # TODO unfinished module
 
@@ -14,5 +12,5 @@ def index_gen(arr: AFArray, ndims: int, indices: Any, /) -> AFArray:
     source: https://arrayfire.org/docs/group__index__func__index.htm#ga14a7d149dba0ed0b977335a3df9d91e6
     """
     out = AFArray.create_null_pointer()
-    safe_call(_backend.clib.af_index_gen(ctypes.pointer(out), arr, CDimT(ndims), indices.pointer))
+    call_from_clib(index_gen.__name__, ctypes.pointer(out), arr, CDimT(ndims), indices.pointer)
     return out

arrayfire_wrapper/lib/create_and_modify_array/assignment_and_indexing/index.py

@@ -1,15 +1,13 @@
 import ctypes
 
-from arrayfire_wrapper._backend import _backend
 from arrayfire_wrapper.defines import AFArray
-
-from ..._error_handler import safe_call
+from arrayfire_wrapper.lib._utility import call_from_clib
 
 
 def lookup(arr: AFArray, indices: AFArray, dim: int, /) -> AFArray:
     """
     source: https://arrayfire.org/docs/group__index__func__assign.htm#ga93cd5199c647dce0e3b823f063b352ae
     """
     out = AFArray(0)
-    safe_call(_backend.clib.af_assign_gen(ctypes.pointer(out), arr, indices, ctypes.c_int(dim)))
+    call_from_clib(lookup.__name__, ctypes.pointer(out), arr, indices, ctypes.c_int(dim))
     return out