Rename py_list_to_c_array() to c_array() objectbox#24

Also, py_list_to_c_pointer() to c_array_pointer()

Author: loryruta

objectbox/c.py

@@ -330,8 +330,8 @@ def c_voidp_as_bytes(voidp, size):
     return memoryview(ctypes.cast(voidp, ctypes.POINTER(ctypes.c_ubyte * size))[0]).tobytes()
 
 
-def py_list_to_c_array(py_list: Union[List[Any], np.ndarray], c_type):
-    """ Converts the given python list or ndarray into a C array. """
+def c_array(py_list: Union[List[Any], np.ndarray], c_type):
+    """ Converts the given python list or ndarray into a C array of c_type. """
     if isinstance(py_list, np.ndarray):
         if py_list.ndim != 1:
             raise Exception(f"ndarray is expected to be 1-dimensional. Input shape: {py_list.shape}")
@@ -342,9 +342,9 @@ def py_list_to_c_array(py_list: Union[List[Any], np.ndarray], c_type):
         raise Exception(f"Unsupported Python list type: {type(py_list)}")
 
 
-def py_list_to_c_pointer(py_list: Union[List[Any], np.ndarray], c_type):
-    """ Converts the given python list or ndarray into a C array, and returns a pointer type. """
-    return ctypes.cast(py_list_to_c_array(py_list, c_type), ctypes.POINTER(c_type))
+def c_array_pointer(py_list: Union[List[Any], np.ndarray], c_type):
+    """ Converts the given python list or ndarray into a C array of c_type. Returns its pointer type. """
+    return ctypes.cast(c_array(py_list, c_type), ctypes.POINTER(c_type))
 
 
 # OBX_model* (void);

objectbox/query.py

@@ -91,16 +91,16 @@ def count(self) -> int:
         count = ctypes.c_uint64()
         obx_query_count(self._c_query, ctypes.byref(count))
         return int(count.value)
-    
+
     def remove(self) -> int:
         count = ctypes.c_uint64()
         obx_query_remove(self._c_query, ctypes.byref(count))
         return int(count.value)
-    
+
     def offset(self, offset: int) -> 'Query':
         obx_query_offset(self._c_query, offset)
         return self
-    
+
     def limit(self, limit: int) -> 'Query':
         obx_query_limit(self._c_query, limit)
         return self
@@ -121,7 +121,7 @@ def set_parameter_vector_f32(self,
         if isinstance(value, np.ndarray) and value.dtype != np.float32:
             raise Exception(f"value dtype is expected to be np.float32, got: {value.dtype}")
         prop_id = self._entity.get_property_id(prop)
-        c_value = py_list_to_c_array(value, ctypes.c_float)
+        c_value = c_array(value, ctypes.c_float)
         num_el = len(value)
         obx_query_param_vector_float32(self._c_query, self._entity.id, prop_id, c_value, num_el)
         return self

objectbox/query_builder.py

@@ -113,17 +113,17 @@ def nearest_neighbors_f32(self, prop: Union[int, str, Property], query_vector: U
         if isinstance(query_vector, np.ndarray) and query_vector.dtype != np.float32:
             raise Exception(f"query_vector dtype is expected to be np.float32, got: {query_vector.dtype}")
         prop_id = self._entity.get_property_id(prop)
-        c_query_vector = py_list_to_c_array(query_vector, ctypes.c_float)
+        c_query_vector = c_array(query_vector, ctypes.c_float)
         cond = obx_qb_nearest_neighbors_f32(self._c_builder, prop_id, c_query_vector, element_count)
         return cond
 
     def any(self, conditions: List[obx_qb_cond]) -> obx_qb_cond:
-        c_conditions = py_list_to_c_pointer(conditions, obx_qb_cond)
+        c_conditions = c_array(conditions, obx_qb_cond)
         cond = obx_qb_any(self._c_builder, c_conditions, len(conditions))
         return cond
 
     def all(self, conditions: List[obx_qb_cond]) -> obx_qb_cond:
-        c_conditions = py_list_to_c_pointer(conditions, obx_qb_cond)
+        c_conditions = c_array_pointer(conditions, obx_qb_cond)
         cond = obx_qb_all(self._c_builder, c_conditions, len(conditions))
         return cond