Linting fixes

Author: edwinsolisf

.flake8

@@ -8,4 +8,6 @@ max-line-length = 119
 exclude =
     .venv/**
     build/**
-    benchmarks/**
+    benchmarks/**
+    docs/*
+    tests/test_documentation/test_documentation.py

arrayfire/__init__.py

@@ -103,8 +103,6 @@
 
 from arrayfire.library.array_functions import (
     constant,
-    zeros,
-    ones,
     copy_array,
     diag,
     eval,
@@ -119,17 +117,19 @@
     lookup,
     lower,
     moddims,
-    reshape,
+    ones,
     pad,
     range,
     reorder,
     replace,
+    reshape,
     select,
     set_manual_eval_flag,
     shift,
     tile,
     transpose,
     upper,
+    zeros,
 )
 
 __all__ += ["gloh", "orb", "sift", "dog", "fast", "harris", "susan", "hamming_matcher", "nearest_neighbour"]

arrayfire/array_object.py

@@ -758,10 +758,10 @@ def __getitem__(self, key: IndexKey, /) -> Array:
         ndims = self.ndim
 
         indexing = key
-        
-        if isinstance(key, int | float | slice): # when indexing with one dimension, treat it as indexing a flat array
+
+        if isinstance(key, int | float | slice):  # when indexing with one dimension, treat it as indexing a flat array
             ndims = 1
-        elif isinstance(key, Array): # when indexing with one array, treat it as indexing a flat array
+        elif isinstance(key, Array):  # when indexing with one array, treat it as indexing a flat array
             ndims = 1
             if key.is_bool:
                 indexing = wrapper.where(key.arr)
@@ -836,9 +836,9 @@ def __setitem__(self, key: IndexKey, value: int | float | bool | Array, /) -> No
             del_other = False
 
         indexing = key
-        if isinstance(key, int | float | slice): # when indexing with one dimension, treat it as indexing a flat array
+        if isinstance(key, int | float | slice):  # when indexing with one dimension, treat it as indexing a flat array
             ndims = 1
-        elif isinstance(key, Array): # when indexing with one array, treat it as indexing a flat array
+        elif isinstance(key, Array):  # when indexing with one array, treat it as indexing a flat array
             ndims = 1
             if key.is_bool:
                 indexing = wrapper.where(key.arr)
@@ -930,7 +930,8 @@ def T(self) -> Array:
 
         Note
         ----
-        - The array instance must be two-dimensional. If the array instance is not two-dimensional, an error should be raised.
+        - The array instance must be two-dimensional. If the array instance is not two-dimensional,
+            | an error should be raised.
 
         """
         if self.ndim < 2:
@@ -949,11 +950,13 @@ def H(self) -> Array:
         -------
         Array
             Two-dimensional array whose first and last dimensions (axes) are permuted in reverse order relative to
-            original array with its elements complex conjugated. The returned array must have the same data type as the original array.
+            | original array with its elements complex conjugated.
+            | The returned array must have the same data type as the original array.
 
         Note
         ----
-        - The array instance must be two-dimensional. If the array instance is not two-dimensional, an error should be raised.
+        - The array instance must be two-dimensional. If the array instance is not two-dimensional,
+            | an error should be raised.
 
         """
         if self.ndim < 2:
@@ -1191,7 +1194,8 @@ def reshape(self, shape) -> Array:
         -------
         out : af.Array
             - An array containing the same data as `array` with the specified shape.
-            - The total number of elements in `array` must match the product of the dimensions specified in the `shape` tuple.
+            - The total number of elements in `array` must match the product of the dimensions
+                | specified in the `shape` tuple.
 
         Raises
         ------

arrayfire/library/array_functions.py

@@ -73,6 +73,7 @@ def constant(scalar: int | float | complex, shape: tuple[int, ...] = (1,), dtype
     """
     return cast(Array, wrapper.create_constant_array(scalar, shape, dtype))
 
+
 def zeros(shape: tuple[int, ...], dtype: Dtype = float32) -> Array:
     """
     Create a multi-dimensional array filled with zeros
@@ -100,6 +101,7 @@ def zeros(shape: tuple[int, ...], dtype: Dtype = float32) -> Array:
     """
     return constant(0, shape, dtype)
 
+
 def ones(shape: tuple[int, ...], dtype: Dtype = float32) -> Array:
     """
     Create a multi-dimensional array filled with ones
@@ -127,6 +129,7 @@ def ones(shape: tuple[int, ...], dtype: Dtype = float32) -> Array:
     """
     return constant(1, shape, dtype)
 
+
 @afarray_as_array
 def diag(array: Array, /, *, diag_index: int = 0, extract: bool = True) -> Array:
     """
@@ -311,7 +314,8 @@ def lower(array: Array, /, *, is_unit_diag: bool = False) -> Array:
     Notes
     -----
     - The function does not alter the elements above the main diagonal; it simply does not include them in the output.
-    - This function can be useful for mathematical operations that require lower triangular matrices, such as certain types of matrix factorizations.
+    - This function can be useful for mathematical operations that require lower triangular matrices,
+         | such as certain types of matrix factorizations.
 
     Examples
     --------
@@ -367,7 +371,8 @@ def upper(array: Array, /, *, is_unit_diag: bool = False) -> Array:
     Notes
     -----
     - The function does not alter the elements below the main diagonal; it simply does not include them in the output.
-    - This function can be useful for mathematical operations that require upper triangular matrices, such as certain types of matrix factorizations.
+    - This function can be useful for mathematical operations that require upper triangular matrices,
+        | such as certain types of matrix factorizations.
 
     Examples
     --------
@@ -872,6 +877,7 @@ def moddims(array: Array, shape: tuple[int, ...], /) -> Array:
     # TODO add examples to doc
     return cast(Array, wrapper.moddims(array.arr, shape))
 
+
 def reshape(array: Array, shape: tuple[int, ...], /) -> Array:
     """
     Modify the shape of the array without changing the data layout.
@@ -907,6 +913,7 @@ def reshape(array: Array, shape: tuple[int, ...], /) -> Array:
     """
     return moddims(array, shape)
 
+
 @afarray_as_array
 def reorder(array: Array, /, *, shape: tuple[int, ...] = (1, 0, 2, 3)) -> Array:
     """

arrayfire/library/computer_vision.py

@@ -164,7 +164,8 @@ def sift(
     tuple[Features, Array]
         A tuple containing:
         - An ArrayFire Features object encapsulating the detected keypoints.
-        - An ArrayFire Array containing the corresponding descriptors for each keypoint. The descriptors are 128-dimensional vectors describing the local appearance around each keypoint.
+        - An ArrayFire Array containing the corresponding descriptors for each keypoint.
+            | The descriptors are 128-dimensional vectors describing the local appearance around each keypoint.
 
     Note
     ----

arrayfire/library/linear_algebra.py

@@ -92,7 +92,7 @@ def gemm(
     rhs_opts: MatProp = MatProp.NONE,
     alpha: int | float = 1.0,
     beta: int | float = 0.0,
-    accum: Array = None
+    accum: Array = None,
 ) -> Array:
     """
     Performs BLAS general matrix multiplication (GEMM) on two Array instances.

docs/afjit.py

@@ -5,13 +5,15 @@
 # removed, then the execution of this code would be equivalent to the
 # following function.
 
-import arrayfire as af
 import time
 
+import arrayfire as af
+
 samples = int(9e8)
 x = af.randu((samples))
 y = af.randu((samples))
 
+
 def pi_no_jit(x, y, samples):
     temp = x * x
     af.eval(temp)
@@ -23,11 +25,13 @@ def pi_no_jit(x, y, samples):
     af.eval(temp)
     return 4.0 * af.sum(temp) / samples
 
+
 def pi_jit(x, y, samples):
     temp = af.sqrt(x * x + y * y) < 1
     af.eval(temp)
     return 4.0 * af.sum(temp) / samples
 
+
 # Print device info
 af.info()
 
@@ -47,4 +51,4 @@ def pi_jit(x, y, samples):
 end = time.perf_counter()
 print("no jit:", end - start, res)
 
-# [jit-endsnippet]
+# [jit-endsnippet]

docs/arrayandmatrixmanipulation.py

@@ -64,11 +64,11 @@
 
 print(a)
 
-moddims_a = af.moddims(a,(2,4))
+moddims_a = af.moddims(a, (2, 4))
 
 print(moddims_a)
 
-moddims_b = af.moddims(a,(len(a),))
+moddims_b = af.moddims(a, (len(a),))
 print(moddims_b)
 
 # [manipulation4-endsnippet]
@@ -79,24 +79,24 @@
 
 import arrayfire as af
 
-a = af.randu((2,2,3,1))
+a = af.randu((2, 2, 3, 1))
 
 print(a)
 
-a_reorder = af.reorder(a,())
+a_reorder = af.reorder(a, ())
 # [manipulation5-endsnippet]
 
 # [manipulation6-snippet]
 
 import arrayfire as af
 
-a = af.randu((3,5))
+a = af.randu((3, 5))
 print(a)
 
-a_shift = af.shift(a,(0,2))
+a_shift = af.shift(a, (0, 2))
 print(a_shift)
 
-a_shift1 = af.shift(a,(-1,2))
+a_shift1 = af.shift(a, (-1, 2))
 print(a_shift1)
 
 # [manipulation6-endsnippet]
@@ -106,17 +106,17 @@
 
 import arrayfire as af
 
-a = af.randu((3,)) #[3,1,1,1]
+a = af.randu((3,))  # [3,1,1,1]
 
-print (a)
+print(a)
 
-a_tile = af.tile(a,(2,)) 
+a_tile = af.tile(a, (2,))
 print(a_tile)
 
-a_tile1 = af.tile(a,(2,2))
+a_tile1 = af.tile(a, (2, 2))
 print(a_tile1)
 
-a_tile2 = af.tile(a,(1,2,3)) 
+a_tile2 = af.tile(a, (1, 2, 3))
 print(a_tile2)
 # [manipulation7-endsnippet]
 
@@ -125,18 +125,18 @@
 
 import arrayfire as af
 
-a = af.randu((3,3))
-print(a)  #[3 3 1 1]
+a = af.randu((3, 3))
+print(a)  # [3 3 1 1]
 
-''' 0.3949     0.8465     0.3709
+""" 0.3949     0.8465     0.3709
     0.3561     0.9399     0.2751
-    0.6097     0.6802     0.2720'''
-    
+    0.6097     0.6802     0.2720"""
+
 
 a_transpose = af.transpose(a)
-print(a_transpose) #[3 3 1 1]
+print(a_transpose)  # [3 3 1 1]
 
-''' 0.3949     0.3561     0.6097
+""" 0.3949     0.3561     0.6097
         0.8465     0.9399     0.6802
-        0.3709     0.2751     0.2720'''
+        0.3709     0.2751     0.2720"""
 # [manipulation8-endsnippet]

docs/conf.py

@@ -2,47 +2,47 @@
 #
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
-import sys
 import os
-sys.path.insert(0, os.path.abspath('..'))
+import sys
+
+sys.path.insert(0, os.path.abspath(".."))
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'ArrayFire'
-copyright = '2025, ArrayFire'
-author = 'ArrayFire'
-release = ''
+project = "ArrayFire"
+copyright = "2025, ArrayFire"
+author = "ArrayFire"
+release = ""
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
-    'sphinx.ext.duration',
-    'sphinx.ext.doctest',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.mathjax',
-    'sphinx_collapse',
+    "sphinx.ext.duration",
+    "sphinx.ext.doctest",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.mathjax",
+    "sphinx_collapse",
 ]
 
-templates_path = ['_templates']
+templates_path = ["_templates"]
 exclude_patterns = []
 
 
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'sphinxawesome_theme'
-html_static_path = ['_static']
+html_theme = "sphinxawesome_theme"
+html_static_path = ["_static"]
 html_permalinks = False
 html_theme_options = {
     "logo_light": "_static/../images/arrayfire_icon.png",
-    "logo_dark": "_static/../images/arrayfire_icon.png"
+    "logo_dark": "_static/../images/arrayfire_icon.png",
 }
 
 # -- Suppress specific warnings --------------------------------------------
 
 suppress_warnings = [
-    'ref.include_missing',
+    "ref.include_missing",
 ]