Add typing module and TODOs

Author: znicholls

TODO.md

@@ -0,0 +1,8 @@
+- read through everything
+    - check docstrings
+    - check naming (if you want to propose a consistent naming convention, go for it)
+- consider adding `m_error_v_w.build_instances` too, might be headache to pass arrays of things up and down correctly
+- clean up
+- final review (including deleting this file)
+- merge
+- move onto a basic result type with a subclass specifically for integers (`ResultInt` or something)

meson.build

@@ -82,6 +82,7 @@ if pyprojectwheelbuild_enabled
     'src/example_fgen_basic/get_wavelength.py',
     'src/example_fgen_basic/pyfgen_runtime/__init__.py',
     'src/example_fgen_basic/pyfgen_runtime/exceptions.py',
+    'src/example_fgen_basic/typing.py',
   )
 
     # The ancillary library,

pyproject.toml

@@ -149,7 +149,7 @@ source = [
 ]
 branch = true
 omit = [
-    # TODO: check this file
+    # TODO: test these files directly when splitting out pyfgen_runtime
     "*exceptions.py",
     "*runtime_helpers.py",
 ]

src/example_fgen_basic/error_v/creation.py

@@ -28,8 +28,7 @@
     ) from exc
 
 if TYPE_CHECKING:
-    # TODO: bring back in numpy type hints
-    NP_ARRAY_OF_INT = None
+    from example_fgen_basic.typing import NP_ARRAY_OF_INT
 
 
 def create_error(inv: int) -> ErrorV:

src/example_fgen_basic/error_v/error_v_manager.f90

@@ -2,8 +2,6 @@
 !>
 !> Written by hand here.
 !> Generation to be automated in future (including docstrings of some sort).
-!
-! TODO: make it possible to reallocate the number of instances
 module m_error_v_manager
 
     use m_error_v, only: ErrorV

src/example_fgen_basic/error_v/passing.py

@@ -30,9 +30,7 @@
     ) from exc
 
 if TYPE_CHECKING:
-    # TODO: bring back in numpy type hints
-    NP_ARRAY_OF_INT = None
-    NP_ARRAY_OF_BOOL = None
+    from example_fgen_basic.typing import NP_ARRAY_OF_BOOL, NP_ARRAY_OF_INT
 
 
 def pass_error(inv: ErrorV) -> bool:

src/example_fgen_basic/typing.py

@@ -0,0 +1,43 @@
+"""
+Type hints which are too annoying to remember
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from typing import Any, TypeAlias, Union
+
+    import numpy as np
+    import numpy.typing as npt
+
+    NP_ARRAY_OF_INT: TypeAlias = npt.NDArray[np.integer]
+    """
+    Type alias for an array of numpy int
+    """
+
+    NP_ARRAY_OF_FLOAT: TypeAlias = npt.NDArray[np.floating]
+    """
+    Type alias for an array of numpy floats
+    """
+
+    NP_FLOAT_OR_INT: TypeAlias = Union[np.floating, np.integer]
+    """
+    Type alias for a numpy float or int (not complex)
+    """
+
+    NP_ARRAY_OF_FLOAT_OR_INT: TypeAlias = npt.NDArray[NP_FLOAT_OR_INT]
+    """
+    Type alias for an array of numpy float or int (not complex)
+    """
+
+    NP_ARRAY_OF_NUMBER: TypeAlias = npt.NDArray[np.number[Any]]
+    """
+    Type alias for an array of numpy float or int (including complex)
+    """
+
+    NP_ARRAY_OF_BOOL: TypeAlias = npt.NDArray[np.bool]
+    """
+    Type alias for an array of booleans
+    """