Split lazy signals into their modules to defer dask import when importing non lazy signals

Author: ericpre

hyperspy/_signals/complex_signal.py

@@ -29,7 +29,6 @@
     PLOT2D_KWARGS_DOCSTRING,
 )
 from hyperspy.docstrings.signal import (
-    LAZYSIGNAL_DOC,
     NUM_WORKERS_ARG,
     SHOW_PROGRESSBAR_ARG,
 )
@@ -420,9 +419,3 @@ def argand_diagram(self, size=[256, 256], range=None):
             argand_diagram.axes_manager.signal_axes[1].units = units_imag
 
         return argand_diagram
-
-
-class LazyComplexSignal(ComplexSignal, signals.LazySignal):
-    """Lazy general signal class for complex data."""
-
-    __doc__ += LAZYSIGNAL_DOC.replace("__BASECLASS__", "ComplexSignal")

hyperspy/_signals/complex_signal1d.py

@@ -19,7 +19,6 @@
 
 from hyperspy import signals
 from hyperspy._signals.common_signal1d import CommonSignal1D
-from hyperspy.docstrings.signal import LAZYSIGNAL_DOC
 
 
 class ComplexSignal1D(signals.ComplexSignal, CommonSignal1D):
@@ -29,9 +28,3 @@ class ComplexSignal1D(signals.ComplexSignal, CommonSignal1D):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-
-
-class LazyComplexSignal1D(ComplexSignal1D, signals.LazyComplexSignal):
-    """Lazy signal class for complex 1-dimensional data."""
-
-    __doc__ += LAZYSIGNAL_DOC.replace("__BASECLASS__", "ComplexSignal1D")

hyperspy/_signals/complex_signal2d.py

@@ -25,7 +25,6 @@
     PLOT2D_DOCSTRING,
     PLOT2D_KWARGS_DOCSTRING,
 )
-from hyperspy.docstrings.signal import LAZYSIGNAL_DOC
 
 
 class ComplexSignal2D(signals.ComplexSignal, CommonSignal2D):
@@ -121,9 +120,3 @@ def plot(
         PLOT2D_DOCSTRING,
         PLOT2D_KWARGS_DOCSTRING,
     )
-
-
-class LazyComplexSignal2D(ComplexSignal2D, signals.LazyComplexSignal):
-    """Lazy Signal class for complex 2-dimensional data."""
-
-    __doc__ += LAZYSIGNAL_DOC.replace("__BASECLASS__", "ComplexSignal2D")

hyperspy/_signals/lazy_complex_signal.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+# Copyright 2007-2025 The HyperSpy developers
+#
+# This file is part of HyperSpy.
+#
+# HyperSpy is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# HyperSpy is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with HyperSpy. If not, see <https://www.gnu.org/licenses/#GPL>.
+
+from hyperspy import signals
+from hyperspy._signals.complex_signal import ComplexSignal
+from hyperspy.docstrings.signal import LAZYSIGNAL_DOC
+
+
+class LazyComplexSignal(ComplexSignal, signals.LazySignal):
+    """Lazy general signal class for complex data."""
+
+    __doc__ += LAZYSIGNAL_DOC.replace("__BASECLASS__", "ComplexSignal")

hyperspy/_signals/lazy_complex_signal1d.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+# Copyright 2007-2025 The HyperSpy developers
+#
+# This file is part of HyperSpy.
+#
+# HyperSpy is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# HyperSpy is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with HyperSpy. If not, see <https://www.gnu.org/licenses/#GPL>.
+
+from hyperspy import signals
+from hyperspy._signals.complex_signal1d import ComplexSignal1D
+from hyperspy.docstrings.signal import LAZYSIGNAL_DOC
+
+
+class LazyComplexSignal1D(ComplexSignal1D, signals.LazyComplexSignal):
+    """Lazy signal class for complex 1-dimensional data."""
+
+    __doc__ += LAZYSIGNAL_DOC.replace("__BASECLASS__", "ComplexSignal1D")

hyperspy/_signals/lazy_complex_signal2d.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+# Copyright 2007-2025 The HyperSpy developers
+#
+# This file is part of HyperSpy.
+#
+# HyperSpy is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# HyperSpy is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with HyperSpy. If not, see <https://www.gnu.org/licenses/#GPL>.
+
+from hyperspy import signals
+from hyperspy._signals.complex_signal2d import ComplexSignal2D
+from hyperspy.docstrings.signal import LAZYSIGNAL_DOC
+
+
+class LazyComplexSignal2D(ComplexSignal2D, signals.LazyComplexSignal):
+    """Lazy Signal class for complex 2-dimensional data."""
+
+    __doc__ += LAZYSIGNAL_DOC.replace("__BASECLASS__", "ComplexSignal2D")

hyperspy/_signals/lazy_signal1d.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+# Copyright 2007-2025 The HyperSpy developers
+#
+# This file is part of HyperSpy.
+#
+# HyperSpy is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# HyperSpy is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with HyperSpy. If not, see <https://www.gnu.org/licenses/#GPL>.
+
+from hyperspy import signals
+from hyperspy._signals.signal1d import Signal1D
+from hyperspy.docstrings.signal import LAZYSIGNAL_DOC
+
+
+class LazySignal1D(signals.LazySignal, Signal1D):
+    """Lazy general 1D signal class."""
+
+    __doc__ += LAZYSIGNAL_DOC.replace("__BASECLASS__", "Signal1D")

hyperspy/_signals/lazy_signal2d.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+# Copyright 2007-2025 The HyperSpy developers
+#
+# This file is part of HyperSpy.
+#
+# HyperSpy is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# HyperSpy is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with HyperSpy. If not, see <https://www.gnu.org/licenses/#GPL>.
+
+from hyperspy import signals
+from hyperspy._signals.signal2d import Signal2D
+from hyperspy.docstrings.signal import LAZYSIGNAL_DOC
+
+
+class LazySignal2D(signals.LazySignal, Signal2D):
+    """Lazy general 2D signal class."""
+
+    __doc__ += LAZYSIGNAL_DOC.replace("__BASECLASS__", "Signal2D")

hyperspy/_signals/signal1d.py

@@ -35,7 +35,6 @@
 )
 from hyperspy.docstrings.signal import (
     IN_PLACE,
-    LAZYSIGNAL_DOC,
     NAVIGATION_MASK_ARG,
     NUM_WORKERS_ARG,
     SHOW_PROGRESSBAR_ARG,
@@ -1757,9 +1756,3 @@ def plot(
         BASE_PLOT_DOCSTRING_PARAMETERS,
         PLOT1D_DOCSTRING,
     )
-
-
-class LazySignal1D(signals.LazySignal, Signal1D):
-    """Lazy general 1D signal class."""
-
-    __doc__ += LAZYSIGNAL_DOC.replace("__BASECLASS__", "Signal1D")

hyperspy/_signals/signal2d.py

@@ -35,7 +35,6 @@
     PLOT2D_KWARGS_DOCSTRING,
 )
 from hyperspy.docstrings.signal import (
-    LAZYSIGNAL_DOC,
     NUM_WORKERS_ARG,
     SHOW_PROGRESSBAR_ARG,
 )
@@ -1118,9 +1117,3 @@ def find_peaks(
         DISPLAY_DT,
         TOOLKIT_DT,
     )
-
-
-class LazySignal2D(signals.LazySignal, Signal2D):
-    """Lazy general 2D signal class."""
-
-    __doc__ += LAZYSIGNAL_DOC.replace("__BASECLASS__", "Signal2D")