Move __all__ to PEP-8 recommended location (#683)

Module level "dunders" (i.e. names with two leading and two trailing underscores) such as __all__, __author__, __version__, etc. should be placed after the module docstring but before any import statements except from __future__ imports. Python mandates that future-imports must appear in the module before any other code except docstrings.

Signed-off-by: nstarman <nstarman@users.noreply.github.com>

Author: nstarman

src/array_api_stubs/__init__.py

@@ -1,2 +1 @@
 from . import _2021_12, _2022_12, _draft
-

src/array_api_stubs/_draft/_types.py

@@ -6,6 +6,27 @@
 """
 from __future__ import annotations
 
+__all__ = [
+    "Any",
+    "List",
+    "Literal",
+    "NestedSequence",
+    "Optional",
+    "PyCapsule",
+    "SupportsBufferProtocol",
+    "SupportsDLPack",
+    "Tuple",
+    "Union",
+    "Sequence",
+    "array",
+    "device",
+    "dtype",
+    "ellipsis",
+    "finfo_object",
+    "iinfo_object",
+    "Enum",
+]
+
 from dataclasses import dataclass
 from typing import (
     Any,
@@ -34,21 +55,25 @@
 @dataclass
 class finfo_object:
     """Dataclass returned by `finfo`."""
+
     bits: int
     eps: float
     max: float
     min: float
     smallest_normal: float
     dtype: dtype
 
+
 @dataclass
 class iinfo_object:
     """Dataclass returned by `iinfo`."""
+
     bits: int
     max: int
     min: int
     dtype: dtype
 
+
 _T_co = TypeVar("_T_co", covariant=True)
 
 
@@ -58,25 +83,3 @@ def __getitem__(self, key: int, /) -> Union[_T_co, NestedSequence[_T_co]]:
 
     def __len__(self, /) -> int:
         ...
-
-
-__all__ = [
-    "Any",
-    "List",
-    "Literal",
-    "NestedSequence",
-    "Optional",
-    "PyCapsule",
-    "SupportsBufferProtocol",
-    "SupportsDLPack",
-    "Tuple",
-    "Union",
-    "Sequence",
-    "array",
-    "device",
-    "dtype",
-    "ellipsis",
-    "finfo_object",
-    "iinfo_object",
-    "Enum",
-]

src/array_api_stubs/_draft/array_object.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+__all__ = ["array"]
+
 from ._types import (
     array,
     dtype as Dtype,
@@ -1059,5 +1061,3 @@ def to_device(
 
 
 array = _array
-
-__all__ = ["array"]

src/array_api_stubs/_draft/constants.py

@@ -1,3 +1,5 @@
+__all__ = ["e", "inf", "nan", "newaxis", "pi"]
+
 e = 2.718281828459045
 """
 IEEE 754 floating-point representation of Euler's constant.
@@ -26,5 +28,3 @@
 
 ``pi = 3.1415926535897932384626433...``
 """
-
-__all__ = ["e", "inf", "nan", "newaxis", "pi"]

src/array_api_stubs/_draft/creation_functions.py

@@ -1,3 +1,23 @@
+__all__ = [
+    "arange",
+    "asarray",
+    "empty",
+    "empty_like",
+    "eye",
+    "from_dlpack",
+    "full",
+    "full_like",
+    "linspace",
+    "meshgrid",
+    "ones",
+    "ones_like",
+    "tril",
+    "triu",
+    "zeros",
+    "zeros_like",
+]
+
+
 from ._types import (
     List,
     NestedSequence,
@@ -563,23 +583,3 @@ def zeros_like(
     out: array
         an array having the same shape as ``x`` and filled with zeros.
     """
-
-
-__all__ = [
-    "arange",
-    "asarray",
-    "empty",
-    "empty_like",
-    "eye",
-    "from_dlpack",
-    "full",
-    "full_like",
-    "linspace",
-    "meshgrid",
-    "ones",
-    "ones_like",
-    "tril",
-    "triu",
-    "zeros",
-    "zeros_like",
-]

src/array_api_stubs/_draft/data_type_functions.py

@@ -1,3 +1,6 @@
+__all__ = ["astype", "can_cast", "finfo", "iinfo", "isdtype", "result_type"]
+
+
 from ._types import Union, Tuple, array, dtype, finfo_object, iinfo_object
 
 
@@ -208,6 +211,3 @@ def result_type(*arrays_and_dtypes: Union[array, dtype]) -> dtype:
     out: dtype
         the dtype resulting from an operation involving the input arrays and dtypes.
     """
-
-
-__all__ = ["astype", "can_cast", "finfo", "iinfo", "isdtype", "result_type"]

src/array_api_stubs/_draft/data_types.py

@@ -1,3 +1,6 @@
+__all__ = ["__eq__"]
+
+
 from ._types import dtype
 
 
@@ -17,6 +20,3 @@ def __eq__(self: dtype, other: dtype, /) -> bool:
     out: bool
         a boolean indicating whether the data type objects are equal.
     """
-
-
-__all__ = ["__eq__"]

src/array_api_stubs/_draft/elementwise_functions.py

@@ -1,3 +1,66 @@
+__all__ = [
+    "abs",
+    "acos",
+    "acosh",
+    "add",
+    "asin",
+    "asinh",
+    "atan",
+    "atan2",
+    "atanh",
+    "bitwise_and",
+    "bitwise_left_shift",
+    "bitwise_invert",
+    "bitwise_or",
+    "bitwise_right_shift",
+    "bitwise_xor",
+    "ceil",
+    "conj",
+    "cos",
+    "cosh",
+    "divide",
+    "equal",
+    "exp",
+    "expm1",
+    "floor",
+    "floor_divide",
+    "greater",
+    "greater_equal",
+    "imag",
+    "isfinite",
+    "isinf",
+    "isnan",
+    "less",
+    "less_equal",
+    "log",
+    "log1p",
+    "log2",
+    "log10",
+    "logaddexp",
+    "logical_and",
+    "logical_not",
+    "logical_or",
+    "logical_xor",
+    "multiply",
+    "negative",
+    "not_equal",
+    "positive",
+    "pow",
+    "real",
+    "remainder",
+    "round",
+    "sign",
+    "sin",
+    "sinh",
+    "square",
+    "sqrt",
+    "subtract",
+    "tan",
+    "tanh",
+    "trunc",
+]
+
+
 from ._types import array
 
 
@@ -2477,66 +2540,3 @@ def trunc(x: array, /) -> array:
     - If ``x_i`` is ``-0``, the result is ``-0``.
     - If ``x_i`` is ``NaN``, the result is ``NaN``.
     """
-
-
-__all__ = [
-    "abs",
-    "acos",
-    "acosh",
-    "add",
-    "asin",
-    "asinh",
-    "atan",
-    "atan2",
-    "atanh",
-    "bitwise_and",
-    "bitwise_left_shift",
-    "bitwise_invert",
-    "bitwise_or",
-    "bitwise_right_shift",
-    "bitwise_xor",
-    "ceil",
-    "conj",
-    "cos",
-    "cosh",
-    "divide",
-    "equal",
-    "exp",
-    "expm1",
-    "floor",
-    "floor_divide",
-    "greater",
-    "greater_equal",
-    "imag",
-    "isfinite",
-    "isinf",
-    "isnan",
-    "less",
-    "less_equal",
-    "log",
-    "log1p",
-    "log2",
-    "log10",
-    "logaddexp",
-    "logical_and",
-    "logical_not",
-    "logical_or",
-    "logical_xor",
-    "multiply",
-    "negative",
-    "not_equal",
-    "positive",
-    "pow",
-    "real",
-    "remainder",
-    "round",
-    "sign",
-    "sin",
-    "sinh",
-    "square",
-    "sqrt",
-    "subtract",
-    "tan",
-    "tanh",
-    "trunc",
-]

src/array_api_stubs/_draft/fft.py

@@ -1,3 +1,20 @@
+__all__ = [
+    "fft",
+    "ifft",
+    "fftn",
+    "ifftn",
+    "rfft",
+    "irfft",
+    "rfftn",
+    "irfftn",
+    "hfft",
+    "ihfft",
+    "fftfreq",
+    "rfftfreq",
+    "fftshift",
+    "ifftshift",
+]
+
 from ._types import Tuple, Union, Sequence, array, Optional, Literal, device
 
 
@@ -651,21 +668,3 @@ def ifftshift(x: array, /, *, axes: Union[int, Sequence[int]] = None) -> array:
 
     .. versionadded:: 2022.12
     """
-
-
-__all__ = [
-    "fft",
-    "ifft",
-    "fftn",
-    "ifftn",
-    "rfft",
-    "irfft",
-    "rfftn",
-    "irfftn",
-    "hfft",
-    "ihfft",
-    "fftfreq",
-    "rfftfreq",
-    "fftshift",
-    "ifftshift",
-]

src/array_api_stubs/_draft/indexing_functions.py

@@ -1,3 +1,5 @@
+__all__ = ["take"]
+
 from ._types import Union, Optional, array
 
 
@@ -29,6 +31,3 @@ def take(x: array, indices: array, /, *, axis: Optional[int] = None) -> array:
 
     .. versionadded:: 2022.12
     """
-
-
-__all__ = ["take"]