Extend pre-commit hooks with codespell (#1798)

* Extend pre-commit hooks with codespell

* Stepped versions of pre-commit hooks to the latest releases

Author: antonwolfy

.github/workflows/pre-commit.yml

@@ -18,10 +18,11 @@ jobs:
           sudo ln -s /usr/bin/clang-format-12 /usr/bin/clang-format
           clang-format --version
 
-      - name: Set up pylint
+      - name: Set up pip packages
         uses: BSFishy/pip-action@8f2d471d809dc20b6ada98c91910b6ae6243f318 # v1
         with:
           packages: |
+            codespell
             pylint
 
       - name: Checkout DPNP repo

.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
 -   repo: https://github.com/PyCQA/bandit
-    rev: '1.7.7'
+    rev: '1.7.8'
     hooks:
     -   id: bandit
         pass_filenames: false
@@ -42,8 +42,14 @@ repos:
     -   id: rst-directive-colons
     -   id: rst-inline-touching-normal
     -   id: text-unicode-replacement-char
+-   repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+    -   id: codespell
+        additional_dependencies:
+            - tomli
 -   repo: https://github.com/psf/black
-    rev: 23.12.1
+    rev: 24.4.0
     hooks:
     -   id: black
         args: ["--check", "--diff", "--color"]

doc/_templates/autosummary/class.rst

@@ -41,7 +41,7 @@
 {% endblock %}
 
    ..
-      Atributes
+      Attributes
 
 {% block attributes %} {% if attributes %}
 

doc/docstring_template.py

@@ -42,7 +42,7 @@
 
 Recommendations:
 1. Short description
-   maybe partially taken/combinated from `numpy` and `cupy` docstrings.
+   maybe partially taken/combined from `numpy` and `cupy` docstrings.
 2. Limitations basically should be described according to the code,
    paying attention to raised exceptions and fallback to `numpy`.
 3. See Also may include links to similar functionality in `dpnp`

dpnp/backend/cmake/Modules/IntelSYCLConfig.cmake

@@ -188,7 +188,7 @@ function(SYCL_FEATURE_TEST_RUN TEST_EXE)
     set(IntelSYCL_FOUND False)
     set(SYCL_REASON_FAILURE "SYCL: feature test execution failed!!")
   endif()
-  # TODO: what iff the result is false.. error or ignore?
+  # TODO: what if the result is false.. error or ignore?
 
   set( test_result "${result}" PARENT_SCOPE)
   set( test_output "${output}" PARENT_SCOPE)

dpnp/backend/examples/example_bs.cpp

@@ -144,13 +144,13 @@ void black_scholes(double *price,
     dpnp_memory_free_c(w1);
     double *halfs_mul_erf_w1 =
         (double *)dpnp_memory_alloc_c(size * sizeof(double));
-    // halfs_mul_erf_w1 = halfs * erf_w1
+    // halfs_mul_erf_w1 = half * erf_w1
     dpnp_multiply_c<double, double, double>(halfs_mul_erf_w1, half, scalar_size,
                                             &scalar_size, ndim, erf_w1, size,
                                             &size, ndim, NULL);
     dpnp_memory_free_c(erf_w1);
     double *d1 = (double *)dpnp_memory_alloc_c(size * sizeof(double));
-    // d1 = halfs + halfs_mul_erf_w1
+    // d1 = half + halfs_mul_erf_w1
     dpnp_add_c<double, double, double>(d1, half, scalar_size, &scalar_size,
                                        ndim, halfs_mul_erf_w1, size, &size,
                                        ndim, NULL);
@@ -161,13 +161,13 @@ void black_scholes(double *price,
     dpnp_memory_free_c(w2);
     double *halfs_mul_erf_w2 =
         (double *)dpnp_memory_alloc_c(size * sizeof(double));
-    // halfs_mul_erf_w2 = halfs * erf_w2
+    // halfs_mul_erf_w2 = half * erf_w2
     dpnp_multiply_c<double, double, double>(halfs_mul_erf_w2, half, scalar_size,
                                             &scalar_size, ndim, erf_w2, size,
                                             &size, ndim, NULL);
     dpnp_memory_free_c(erf_w2);
     double *d2 = (double *)dpnp_memory_alloc_c(size * sizeof(double));
-    // d2 = halfs + halfs_mul_erf_w2
+    // d2 = half + halfs_mul_erf_w2
     dpnp_add_c<double, double, double>(d2, half, scalar_size, &scalar_size,
                                        ndim, halfs_mul_erf_w2, size, &size,
                                        ndim, NULL);

dpnp/backend/extensions/blas/gemm.cpp

@@ -181,7 +181,7 @@ std::pair<sycl::event, sycl::event>
     }
     if (b_shape[1] != c_shape[1]) {
         throw py::value_error("The number of columns in B must be equal to "
-                              "the number of coulmns in result array.");
+                              "the number of columns in result array.");
     }
 
     size_t src_nelems = m * n;

dpnp/backend/extensions/blas/gemm_batch.cpp

@@ -198,7 +198,7 @@ std::pair<sycl::event, sycl::event>
     }
     if (b_shape[matrixB_nd - 1] != c_shape[resultC_nd - 1]) {
         throw py::value_error("The number of columns in B must be equal to "
-                              "the number of coulmns in result array.");
+                              "the number of columns in result array.");
     }
 
     bool shapes_equal = true;

dpnp/backend/extensions/sycl_ext/dispatcher_utils.hpp

@@ -300,11 +300,11 @@ struct coord_in_space<DispatchT, Matcher, std::tuple<CurrentAxis>>
     }
 };
 
-template <typename DispatchT, typename Matcher, typename... Axises>
-struct coord_in_space<DispatchT, Matcher, std::tuple<Axises...>>
+template <typename DispatchT, typename Matcher, typename... Axes>
+struct coord_in_space<DispatchT, Matcher, std::tuple<Axes...>>
 {
-    using CurrentAxis = typename pop_tuple_type<std::tuple<Axises...>>::element;
-    using OtherAxises = typename pop_tuple_type<std::tuple<Axises...>>::rest;
+    using CurrentAxis = typename pop_tuple_type<std::tuple<Axes...>>::element;
+    using OtherAxises = typename pop_tuple_type<std::tuple<Axes...>>::rest;
 
     static bool get(const DispatchT *data, int *result)
     {

dpnp/dpnp_iface_manipulation.py

@@ -1410,9 +1410,11 @@ def result_type(*arrays_and_dtypes):
     """
 
     usm_arrays_and_dtypes = [
-        dpnp.get_usm_ndarray(X)
-        if isinstance(X, (dpnp_array, dpt.usm_ndarray))
-        else X
+        (
+            dpnp.get_usm_ndarray(X)
+            if isinstance(X, (dpnp_array, dpt.usm_ndarray))
+            else X
+        )
         for X in arrays_and_dtypes
     ]
     return dpt.result_type(*usm_arrays_and_dtypes)