Renamed Memory class to _Memor yto reflect that it is not intended for user consumption

Author: oleksandr-pavlyk

dpctl/_memory.pxd

@@ -25,7 +25,7 @@ from ._backend cimport DPPLSyclUSMRef
 from ._sycl_core cimport SyclQueue, SyclDevice, SyclContext
 
 
-cdef class Memory:
+cdef class _Memory:
     cdef DPPLSyclUSMRef memory_ptr
     cdef Py_ssize_t nbytes
     cdef SyclQueue queue
@@ -47,13 +47,13 @@ cdef class Memory:
     cdef SyclDevice get_pointer_device(DPPLSyclUSMRef p, SyclContext ctx)
 
 
-cdef class MemoryUSMShared(Memory):
+cdef class MemoryUSMShared(_Memory):
     pass
 
 
-cdef class MemoryUSMHost(Memory):
+cdef class MemoryUSMHost(_Memory):
     pass
 
 
-cdef class MemoryUSMDevice(Memory):
+cdef class MemoryUSMDevice(_Memory):
     pass

dpctl/_memory.pyx

@@ -127,7 +127,7 @@ cdef class _BufferData:
         else:
             # Obtain device from pointer and context
             ctx = <SyclContext> ary_syclobj
-            dev = Memory.get_pointer_device(buf.p, ctx)
+            dev = _Memory.get_pointer_device(buf.p, ctx)
             # Use context and device to create a queue to
             # be able to copy memory
             buf.queue = SyclQueue._create_from_context_and_device(ctx, dev)
@@ -139,7 +139,7 @@ def _to_memory(unsigned char [::1] b, str usm_kind):
     """
     Constructs Memory of the same size as the argument 
     and copies data into it"""
-    cdef Memory res
+    cdef _Memory res
 
     if (usm_kind == "shared"):
         res = MemoryUSMShared(len(b))
@@ -156,7 +156,7 @@ def _to_memory(unsigned char [::1] b, str usm_kind):
     return res
 
 
-cdef class Memory:
+cdef class _Memory:
     cdef _cinit_empty(self):
         self.memory_ptr = NULL
         self.nbytes = 0
@@ -205,9 +205,9 @@ cdef class Memory:
             raise ValueError("Non-positive number of bytes found.")
 
     cdef _cinit_other(self, object other):
-        cdef Memory other_mem
-        if isinstance(other, Memory):
-            other_mem = <Memory> other
+        cdef _Memory other_mem
+        if isinstance(other, _Memory):
+            other_mem = <_Memory> other
             self.memory_ptr = other_mem.memory_ptr
             self.nbytes = other_mem.nbytes
             self.queue = other_mem.queue
@@ -428,7 +428,7 @@ cdef class Memory:
         return SyclDevice._create(dref)
 
 
-cdef class MemoryUSMShared(Memory):
+cdef class MemoryUSMShared(_Memory):
     """
     MemoryUSMShared(nbytes, alignment=0, queue=None, copy=False) allocates nbytes of
     USM shared memory.
@@ -460,7 +460,7 @@ cdef class MemoryUSMShared(Memory):
         self._getbuffer(buffer, flags)
 
 
-cdef class MemoryUSMHost(Memory):
+cdef class MemoryUSMHost(_Memory):
     """
     MemoryUSMHost(nbytes, alignment=0, queue=None, copy=False) allocates nbytes of
     USM host memory.
@@ -492,7 +492,7 @@ cdef class MemoryUSMHost(Memory):
         self._getbuffer(buffer, flags)
 
 
-cdef class MemoryUSMDevice(Memory):
+cdef class MemoryUSMDevice(_Memory):
     """
     MemoryUSMDevice(nbytes, alignment=0, queue=None, copy=False) allocates nbytes of
     USM device memory.

dpctl/_sycl_core.pyx

@@ -30,7 +30,7 @@ from __future__ import print_function
 from enum import Enum, auto
 import logging
 from ._backend cimport *
-from ._memory cimport Memory
+from ._memory cimport _Memory
 from libc.stdlib cimport malloc, free
 
 
@@ -445,7 +445,7 @@ cdef class SyclQueue:
             elif isinstance(arg, ctypes.c_double):
                 kargs[idx] = <void*><size_t>(ctypes.addressof(arg))
                 kargty[idx] = _arg_data_type._DOUBLE
-            elif isinstance(arg, Memory):
+            elif isinstance(arg, _Memory):
                 kargs[idx]= <void*>(<size_t>arg._pointer)
                 kargty[idx] = _arg_data_type._VOID_PTR
             else:
@@ -620,25 +620,25 @@ cdef class SyclQueue:
         cdef void *c_dest
         cdef void *c_src
 
-        if isinstance(dest, Memory):
-            c_dest = <void*>(<Memory>dest).memory_ptr
+        if isinstance(dest, _Memory):
+            c_dest = <void*>(<_Memory>dest).memory_ptr
         else:
-            raise TypeError("Parameter dest should have type Memory.")
+            raise TypeError("Parameter `dest` should have type _Memory.")
 
-        if isinstance(src, Memory):
-            c_src = <void*>(<Memory>src).memory_ptr
+        if isinstance(src, _Memory):
+            c_src = <void*>(<_Memory>src).memory_ptr
         else:
-            raise TypeError("Parameter src should have type Memory.")
+            raise TypeError("Parameter `src` should have type _Memory.")
 
         DPPLQueue_Memcpy(self._queue_ref, c_dest, c_src, count)
 
     cpdef prefetch (self, mem, size_t count=0):
        cdef void *ptr
 
-       if isinstance(mem, Memory):
-           ptr = <void*>(<Memory>mem).memory_ptr
+       if isinstance(mem, _Memory):
+           ptr = <void*>(<_Memory>mem).memory_ptr
        else:
-           raise TypeError("Parameter mem should have type Memory")
+           raise TypeError("Parameter `mem` should have type _Memory")
 
        if (count <=0 or count > self.nbytes):
            count = self.nbytes
@@ -648,10 +648,10 @@ cdef class SyclQueue:
     cpdef mem_advise (self, mem, size_t count, int advice):
        cdef void *ptr
 
-       if isinstance(mem, Memory):
-           ptr = <void*>(<Memory>mem).memory_ptr
+       if isinstance(mem, _Memory):
+           ptr = <void*>(<_Memory>mem).memory_ptr
        else:
-           raise TypeError("Parameter mem should have type Memory")
+           raise TypeError("Parameter `mem` should have type _Memory")
 
        if (count <=0 or count > self.nbytes):
            count = self.nbytes

dpctl/tests/test_sycl_queue_memcpy.py

@@ -60,13 +60,13 @@ def test_memcpy_type_error(self):
             q.memcpy(None, mobj, 3)
 
         self.assertEqual(type(cm.exception), TypeError)
-        self.assertEqual(str(cm.exception), "Parameter dest should have type Memory.")
+        self.assertEqual(str(cm.exception), "Parameter `dest` should have type _Memory.")
 
         with self.assertRaises(TypeError) as cm:
             q.memcpy(mobj, None, 3)
 
         self.assertEqual(type(cm.exception), TypeError)
-        self.assertEqual(str(cm.exception), "Parameter src should have type Memory.")
+        self.assertEqual(str(cm.exception), "Parameter `src` should have type _Memory.")
 
 
 if __name__ == "__main__":