Overhaul of where stuff lives to get dict to store stuff in docs

Author: nabobalis

sunkit_image/coalignment/interface.py

@@ -11,15 +11,10 @@
 from sunpy.util.exceptions import SunpyUserWarning
 
 __all__ = [
-    "REGISTERED_METHODS",
     "AffineParams",
     "coalign",
-    "register_coalignment_method",
 ]
 
-# Global Dictionary to store the registered methods and their names
-REGISTERED_METHODS = {}
-
 
 class AffineParams(NamedTuple):
     """
@@ -38,21 +33,7 @@ class AffineParams(NamedTuple):
     translation: tuple[float, float]
 
 
-def register_coalignment_method(name):
-    """
-    Registers a coalignment method to be used by the coalignment interface.
-
-    Parameters
-    ----------
-    name : str
-        The name of the coalignment method.
-    """
-
-    def decorator(func):
-        REGISTERED_METHODS[name] = func
-        return func
 
-    return decorator
 
 
 def _update_fits_wcs_metadata(target_map, reference_map, affine_params):
@@ -193,8 +174,9 @@ def coalign(target_map, reference_map, method='match_template', **kwargs):
     return _update_fits_wcs_metadata(target_map, reference_map, affine_params)
 
 
+from sunkit_image.coalignment.register import REGISTERED_METHODS  # isort:skip # NOQA: E402
 # Generate the string with allowable coalignment-function names for use in docstrings
 _coalignment_function_names = ", ".join([f"``'{name}'``" for name in REGISTERED_METHODS])
 # Insert into the docstring for coalign. We cannot use the add_common_docstring decorator
 # due to what would be a circular loop in definitions.
-coalign.__doc__ = coalign.__doc__.format(coalignment_function_names=_coalignment_function_names)  # TYPE: IGNORE
+coalign.__doc__ = coalign.__doc__.format(coalignment_function_names=_coalignment_function_names)  # type: ignore

sunkit_image/coalignment/match_template.py

@@ -3,7 +3,7 @@
 
 from sunpy import log
 
-from sunkit_image.coalignment.interface import AffineParams, register_coalignment_method
+from sunkit_image.coalignment.register import register_coalignment_method
 
 __all__ = ["match_template_coalign"]
 
@@ -110,6 +110,8 @@ def match_template_coalign(target_array, reference_array, **kwargs):
         - translation : `tuple`
             A tuple containing the x and y translation values.
     """
+    from sunkit_image.coalignment.interface import AffineParams  # NOQA: PLC0415
+
     corr = match_template(np.float64(reference_array), np.float64(target_array), **kwargs)
     # TODO: Work out what is going on
     if corr.ndim != target_array.ndim:

sunkit_image/coalignment/phase_cross_correlation.py

@@ -3,7 +3,7 @@
 
 from sunpy import log
 
-from sunkit_image.coalignment.interface import AffineParams, register_coalignment_method
+from sunkit_image.coalignment.register import register_coalignment_method
 
 __all__ = ["phase_cross_correlation_coalign"]
 
@@ -36,6 +36,8 @@ def phase_cross_correlation_coalign(target_array, reference_array, **kwargs):
         - translation : `tuple`
             A tuple containing the x and y translation values.
     """
+    from sunkit_image.coalignment.interface import AffineParams  # NOQA: PLC0415
+
     if target_array.shape != reference_array.shape:
         raise ValueError("Input and target arrays must be the same shape.")
     shift, _, _ = phase_cross_correlation(reference_array, target_array, **kwargs)

sunkit_image/coalignment/register.py

@@ -0,0 +1,23 @@
+__all__ = [
+    "REGISTERED_METHODS",
+    "register_coalignment_method",
+]
+
+# Global Dictionary to store the registered methods and their names
+REGISTERED_METHODS = {}
+
+def register_coalignment_method(name):
+    """
+    Registers a coalignment method to be used by the coalignment interface.
+
+    Parameters
+    ----------
+    name : str
+        The name of the coalignment method.
+    """
+
+    def decorator(func):
+        REGISTERED_METHODS[name] = func
+        return func
+
+    return decorator

sunkit_image/coalignment/tests/test_interface.py renamed to sunkit_image/coalignment/tests/test_register.py

@@ -1,4 +1,5 @@
-from sunkit_image.coalignment.interface import REGISTERED_METHODS, register_coalignment_method
+from sunkit_image.coalignment import coalign
+from sunkit_image.coalignment.register import REGISTERED_METHODS, register_coalignment_method
 
 
 def test_register_coalignment_method():
@@ -9,3 +10,9 @@ def test_func():
     assert "test_method" in REGISTERED_METHODS
     assert REGISTERED_METHODS["test_method"] == test_func
     assert test_func() == "Test function"
+
+
+def test_coalignment_method_in_docstring():
+    assert (
+        "phase_cross_correlation" in coalign.__doc__
+    )