extend pre-commit hooks with cython-lint

Author: Vahid Tavanashad

.git-blame-ignore-revs

@@ -14,3 +14,5 @@
 
 # Transition from clang-format 11 to clang-format 18
 b37657e6ad9af16eaec2982d8e2397acd2af2881
+
+# Add cython-lint to pre-commit config

.pre-commit-config.yaml

@@ -42,3 +42,8 @@ repos:
     hooks:
     -   id: pretty-format-toml
         args: [--autofix]
+- repo: https://github.com/MarcoGorelli/cython-lint
+  rev: v0.16.6
+  hooks:
+  - id: cython-lint
+  - id: double-quote-cython-strings

dpctl/_backend.pxd

@@ -25,8 +25,8 @@ import os
 
 
 cdef extern from "syclinterface/dpctl_service.h":
-   cdef void DPCTLService_InitLogger(const char *, const char *)
-   cdef void DPCTLService_ShutdownLogger()
+    cdef void DPCTLService_InitLogger(const char *, const char *)
+    cdef void DPCTLService_ShutdownLogger()
 
 
 def _init_logger(log_dir=None):
@@ -62,7 +62,7 @@ def syclinterface_diagnostics(verbosity="warning", log_dir=None):
     function calls.
     """
     _allowed_verbosity = ["warning", "error"]
-    if not verbosity in _allowed_verbosity:
+    if verbosity not in _allowed_verbosity:
         raise ValueError(
             f"Verbosity argument not understood. "
             f"Permitted values are {_allowed_verbosity}"

dpctl/_diagnostics.pyx

@@ -35,8 +35,6 @@ from ._backend cimport (  # noqa: E211
     DPCTLContext_DeviceCount,
     DPCTLContext_GetDevices,
     DPCTLContext_Hash,
-    DPCTLDevice_Copy,
-    DPCTLDevice_Delete,
     DPCTLDeviceMgr_GetCachedContext,
     DPCTLDeviceVector_CreateFromArray,
     DPCTLDeviceVector_Delete,
@@ -216,7 +214,6 @@ cdef class SyclContext(_SyclContext):
     cdef int _init_context_from_devices(self, object devices, int props):
         cdef int num_devices = len(devices)
         cdef int i = 0
-        cdef int j = 0
         cdef size_t num_bytes
         cdef DPCTLDeviceVectorRef DVRef = NULL
         cdef error_handler_callback * eh_callback = NULL

dpctl/_sycl_context.pyx

@@ -53,7 +53,9 @@ cdef public api class SyclDevice(_SyclDevice) [
     cdef DPCTLSyclDeviceRef get_device_ref(self)
     cdef list create_sub_devices_equally(self, size_t count)
     cdef list create_sub_devices_by_counts(self, object counts)
-    cdef list create_sub_devices_by_affinity(self, _partition_affinity_domain_type domain)
+    cdef list create_sub_devices_by_affinity(
+        self, _partition_affinity_domain_type domain
+    )
     cdef cpp_bool equals(self, SyclDevice q)
     cdef int get_device_type_ordinal(self)
     cdef int get_overall_ordinal(self)

dpctl/_sycl_device.pxd

@@ -85,7 +85,6 @@ from ._backend cimport (  # noqa: E211
     DPCTLDevice_IsCPU,
     DPCTLDevice_IsGPU,
     DPCTLDeviceMgr_GetDeviceInfoStr,
-    DPCTLDeviceMgr_GetDevices,
     DPCTLDeviceMgr_GetPositionInDevices,
     DPCTLDeviceMgr_GetRelativeId,
     DPCTLDeviceSelector_Delete,
@@ -348,7 +347,7 @@ cdef class SyclDevice(_SyclDevice):
             if ret == -1:
                 raise SyclDeviceCreationError(
                     "Could not create a SyclDevice with the selector string "
-		            "'{selector_string}'".format(selector_string=arg)
+                    "'{selector_string}'".format(selector_string=arg)
                 )
         elif isinstance(arg, _SyclDevice):
             ret = self._init_from__SyclDevice(arg)
@@ -810,7 +809,6 @@ cdef class SyclDevice(_SyclDevice):
         cdef _aspect_type AT = _aspect_type._is_component
         return DPCTLDevice_HasAspect(self._device_ref, AT)
 
-
     @property
     def has_aspect_is_composite(self):
         """ Returns ``True`` if this device is a composite device, ``False``
@@ -1113,8 +1111,8 @@ cdef class SyclDevice(_SyclDevice):
 
     @property
     def sub_group_independent_forward_progress(self):
-        """ Returns ``True`` if the device supports independent forward progress of
-        sub-groups with respect to other sub-groups in the same work-group.
+        """ Returns ``True`` if the device supports independent forward progress
+        of sub-groups with respect to other sub-groups in the same work-group.
 
         Returns:
             bool:
@@ -1155,7 +1153,7 @@ cdef class SyclDevice(_SyclDevice):
             DPCTLSize_t_Array_Delete(sg_sizes)
             return res
         else:
-           return []
+            return []
 
     @property
     def sycl_platform(self):
@@ -1667,19 +1665,20 @@ cdef class SyclDevice(_SyclDevice):
 
                 - Specifying an int (``count``)
                     The returned list contains as
-                    many sub-devices as can be created such that each sub-device
-                    contains ``count`` compute units. If the device’s total number
-                    of compute units is not evenly divided by ``count``, then the
-                    remaining compute units are not included in any of the
-                    sub-devices.
+                    many sub-devices as can be created such that each
+                    sub-device contains ``count`` compute units. If the
+                    device’s total number of compute units is not evenly
+                    divided by ``count``, then the remaining compute units
+                    are not included in any of the sub-devices.
 
                 - Specifying an affinity domain as a string
-                    The supported values are: ``"numa"``, ``"L4_cache"``, ``"L3_cache"``,
-                    ``"L2_cache"``, ``"L1_cache"``, ``"next_partitionable"``.
+                    The supported values are: ``"numa"``, ``"L4_cache"``,
+                    ``"L3_cache"``, ``"L2_cache"``, ``"L1_cache"``,
+                    ``"next_partitionable"``.
 
                 - Specifying a collection of integral values
-                    For each non-zero value ``M`` in the collection, a sub-device with ``M``
-                    compute units is created.
+                    For each non-zero value ``M`` in the collection, a
+                    sub-device with ``M`` compute units is created.
 
         Returns:
             List[:class:`dpctl.SyclDevice`]:
@@ -1816,7 +1815,7 @@ cdef class SyclDevice(_SyclDevice):
         """
         cdef uint32_t clock_fr = DPCTLDevice_GetMaxClockFrequency(
             self._device_ref
-	)
+        )
         return clock_fr
 
     @property
@@ -1829,7 +1828,7 @@ cdef class SyclDevice(_SyclDevice):
         """
         cdef uint64_t max_alloc_sz = DPCTLDevice_GetMaxMemAllocSize(
             self._device_ref
-	)
+        )
         return max_alloc_sz
 
     @property
@@ -1875,7 +1874,7 @@ cdef class SyclDevice(_SyclDevice):
         """
         cdef uint64_t cache_sz = DPCTLDevice_GetGlobalMemCacheSize(
             self._device_ref
-	)
+        )
         return cache_sz
 
     @property
@@ -1888,7 +1887,7 @@ cdef class SyclDevice(_SyclDevice):
         """
         cdef uint64_t cache_line_sz = DPCTLDevice_GetGlobalMemCacheLineSize(
             self._device_ref
-	    )
+        )
         return cache_line_sz
 
     @property
@@ -1957,9 +1956,6 @@ cdef class SyclDevice(_SyclDevice):
                 assert level_zero_gpu == dev
         """
         cdef DPCTLSyclDeviceRef pDRef = NULL
-        cdef _backend_type BTy
-        cdef _device_type DTy
-        cdef int64_t relId = -1
         pDRef = DPCTLDevice_GetParentDevice(self._device_ref)
         if (pDRef is NULL):
             return _cached_filter_string(self)

dpctl/_sycl_device.pyx

@@ -437,7 +437,7 @@ cdef class _DefaultDeviceCache:
 
 
 _global_default_device_cache = ContextVar(
-    'global_default_device_cache',
+    "global_default_device_cache",
     default=_DefaultDeviceCache()
 )
 
@@ -452,5 +452,6 @@ cpdef SyclDevice _cached_default_device():
     """
     cdef _DefaultDeviceCache _cache = _global_default_device_cache.get()
     d_, changed_ = _cache.get_or_create()
-    if changed_: _global_default_device_cache.set(_cache)
+    if changed_:
+        _global_default_device_cache.set(_cache)
     return d_

dpctl/_sycl_device_factory.pyx

@@ -38,7 +38,6 @@ from ._backend cimport (  # noqa: E211
     DPCTLEvent_GetProfilingInfoSubmit,
     DPCTLEvent_GetWaitList,
     DPCTLEvent_Wait,
-    DPCTLEvent_WaitAndThrow,
     DPCTLEventVector_Delete,
     DPCTLEventVector_GetAt,
     DPCTLEventVector_Size,
@@ -220,7 +219,8 @@ cdef class SyclEvent(_SyclEvent):
 
     @staticmethod
     cdef void _wait(SyclEvent event):
-        with nogil: DPCTLEvent_Wait(event._event_ref)
+        with nogil:
+            DPCTLEvent_Wait(event._event_ref)
 
     @staticmethod
     def wait_for(event):
@@ -417,4 +417,5 @@ cdef class SyclEvent(_SyclEvent):
         Returns:
             None
         """
-        with nogil: DPCTLEvent_Wait(self._event_ref)
+        with nogil:
+            DPCTLEvent_Wait(self._event_ref)

dpctl/_sycl_event.pyx

@@ -238,8 +238,8 @@ cdef class SyclPlatform(_SyclPlatform):
         Args:
             verbosity (Literal[0, 1, 2], optional):.
                 The verbosity controls how much information is printed by the
-                function. Value ``0`` is the lowest level set by default and ``2``
-                is the highest level to print the most verbose output.
+                function. Value ``0`` is the lowest level set by default and
+                ``2`` is the highest level to print the most verbose output.
                 Default: ``0``
         """
         cdef size_t v = 0
@@ -367,7 +367,8 @@ cdef class SyclPlatform(_SyclPlatform):
 
     def __hash__(self):
         """
-        Returns a hash value by hashing the underlying ``sycl::platform`` object.
+        Returns a hash value by hashing the underlying ``sycl::platform``
+        object.
 
         Returns:
             int:
@@ -579,11 +580,11 @@ def lsplatform(verbosity=0):
             if v != 0:
                 print("Platform ", i, "::")
             PRef = DPCTLPlatformVector_GetAt(PVRef, i)
-            info_str = DPCTLPlatformMgr_GetInfo(PRef,v)
+            info_str = DPCTLPlatformMgr_GetInfo(PRef, v)
             py_info = <bytes> info_str
             DPCTLCString_Delete(info_str)
             DPCTLPlatform_Delete(PRef)
-            print(py_info.decode("utf-8"),end='')
+            print(py_info.decode("utf-8"), end="")
     DPCTLPlatformVector_Delete(PVRef)