Merge pull request #596 from scipp/lazy

SimonHeybrock · web-flow · commit 61c0a108a214 · 2025-02-04T05:19:33.000+01:00
MAINT: Use lazy_loader for lazy loading of submodules
diff --git a/.buildconfig/ci-linux.yml b/.buildconfig/ci-linux.yml
@@ -14,6 +14,7 @@ dependencies:
   - ipykernel==6.29.5
   - ipympl==0.9.4
   - ipywidgets==8.1.5
+  - lazy-loader==0.4
   - mantid==6.11.0
   - matplotlib==3.7.3
   - mpltoolbox==24.05.1
diff --git a/pyproject.toml b/pyproject.toml
@@ -31,6 +31,7 @@ dynamic = ["version"]
 # Run 'tox -e deps' after making changes here. This will update requirement files.
 # Make sure to list one dependency per line.
 dependencies = [
+    "lazy_loader",
     "h5py",
     "mpltoolbox",
     "numpy>=1.20",
diff --git a/requirements/base.in b/requirements/base.in
@@ -2,6 +2,7 @@
 # will not be touched by ``make_base.py``
 # --- END OF CUSTOM SECTION ---
 # The following was generated by 'tox -e deps', DO NOT EDIT MANUALLY!
+lazy_loader
 h5py
 mpltoolbox
 numpy>=1.20
diff --git a/requirements/base.txt b/requirements/base.txt
@@ -1,4 +1,4 @@
-# SHA1:8028b204890e7f7923037a4acbc74a34e7834749
+# SHA1:0d828cbacfc7cf912a961c413fba99e70fc9dde0
 #
 # This file is autogenerated by pip-compile-multi
 # To update, run:
@@ -9,14 +9,16 @@ contourpy==1.3.1
     # via matplotlib
 cycler==0.12.1
     # via matplotlib
-fonttools==4.55.3
+fonttools==4.55.6
     # via matplotlib
 h5py==3.12.1
     # via
     #   -r base.in
     #   scippnexus
 kiwisolver==1.4.8
     # via matplotlib
+lazy-loader==0.4
+    # via -r base.in
 matplotlib==3.10.0
     # via
     #   mpltoolbox
@@ -33,7 +35,9 @@ numpy==2.2.2
     #   scipp
     #   scipy
 packaging==24.2
-    # via matplotlib
+    # via
+    #   lazy-loader
+    #   matplotlib
 pillow==11.1.0
     # via matplotlib
 plopp==24.10.0
diff --git a/requirements/basetest.txt b/requirements/basetest.txt
@@ -9,7 +9,7 @@ appdirs==1.4.4
     # via pace-neutrons
 asttokens==3.0.0
     # via stack-data
-attrs==24.3.0
+attrs==25.1.0
     # via hypothesis
 brille==0.8.0
     # via pace-neutrons
@@ -36,17 +36,17 @@ exceptiongroup==1.2.2
     #   pytest
 execnet==2.1.1
     # via pytest-xdist
-executing==2.1.0
+executing==2.2.0
     # via stack-data
 flexcache==0.3
     # via pint
 flexparser==0.4
     # via pint
-fonttools==4.55.3
+fonttools==4.55.6
     # via matplotlib
 h5py==3.12.1
     # via euphonic
-hypothesis==6.124.1
+hypothesis==6.124.7
     # via -r basetest.in
 idna==3.10
     # via requests
@@ -123,7 +123,7 @@ pluggy==1.5.0
     # via pytest
 pooch==1.8.2
     # via -r basetest.in
-prompt-toolkit==3.0.48
+prompt-toolkit==3.0.50
     # via ipython
 psutil==6.1.1
     # via
diff --git a/requirements/ci.txt b/requirements/ci.txt
@@ -5,7 +5,7 @@
 #
 #    pip-compile-multi
 #
-cachetools==5.5.0
+cachetools==5.5.1
     # via tox
 certifi==2024.12.14
     # via requests
@@ -17,7 +17,7 @@ colorama==0.4.6
     # via tox
 distlib==0.3.9
     # via virtualenv
-filelock==3.16.1
+filelock==3.17.0
     # via
     #   tox
     #   virtualenv
@@ -38,7 +38,7 @@ platformdirs==4.3.6
     #   virtualenv
 pluggy==1.5.0
     # via tox
-pyproject-api==1.8.0
+pyproject-api==1.9.0
     # via tox
 requests==2.32.3
     # via -r ci.in
@@ -48,7 +48,7 @@ tomli==2.2.1
     # via
     #   pyproject-api
     #   tox
-tox==4.23.2
+tox==4.24.1
     # via -r ci.in
 typing-extensions==4.12.2
     # via tox
diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -91,7 +91,7 @@ prometheus-client==0.21.1
     # via jupyter-server
 pycparser==2.22
     # via cffi
-pydantic==2.10.5
+pydantic==2.10.6
     # via copier
 pydantic-core==2.27.2
     # via pydantic
diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -12,7 +12,7 @@ alabaster==1.0.0
     # via sphinx
 asttokens==3.0.0
     # via stack-data
-attrs==24.3.0
+attrs==25.1.0
     # via
     #   jsonschema
     #   referencing
@@ -50,7 +50,7 @@ docutils==0.21.2
     #   sphinxcontrib-bibtex
 exceptiongroup==1.2.2
     # via ipython
-executing==2.1.0
+executing==2.2.0
     # via stack-data
 fastjsonschema==2.21.1
     # via nbformat
@@ -146,7 +146,7 @@ platformdirs==4.3.6
     #   pooch
 pooch==1.8.2
     # via -r docs.in
-prompt-toolkit==3.0.48
+prompt-toolkit==3.0.50
     # via ipython
 psutil==6.1.1
     # via ipykernel
@@ -177,7 +177,7 @@ pyzmq==26.2.0
     # via
     #   ipykernel
     #   jupyter-client
-referencing==0.36.1
+referencing==0.36.2
     # via
     #   jsonschema
     #   jsonschema-specifications
diff --git a/requirements/nightly.in b/requirements/nightly.in
@@ -1,6 +1,7 @@
 
 # --- END OF CUSTOM SECTION ---
 # The following was generated by 'tox -e deps', DO NOT EDIT MANUALLY!
+lazy_loader
 h5py
 numpy>=1.20
 scipy>=1.7.0
diff --git a/requirements/nightly.txt b/requirements/nightly.txt
@@ -1,4 +1,4 @@
-# SHA1:ed7fd49975142ff15617b14285315691d682ab9c
+# SHA1:3823099f3a0aded08b0d6f1d0d41533ad913e37b
 #
 # This file is autogenerated by pip-compile-multi
 # To update, run:
@@ -9,7 +9,7 @@ appdirs==1.4.4
     # via pace-neutrons
 asttokens==3.0.0
     # via stack-data
-attrs==24.3.0
+attrs==25.1.0
     # via hypothesis
 brille==0.8.0
     # via pace-neutrons
@@ -36,20 +36,20 @@ exceptiongroup==1.2.2
     #   pytest
 execnet==2.1.1
     # via pytest-xdist
-executing==2.1.0
+executing==2.2.0
     # via stack-data
 flexcache==0.3
     # via pint
 flexparser==0.4
     # via pint
-fonttools==4.55.3
+fonttools==4.55.6
     # via matplotlib
 h5py==3.12.1
     # via
     #   -r nightly.in
     #   euphonic
     #   scippnexus
-hypothesis==6.124.1
+hypothesis==6.124.7
     # via -r nightly.in
 idna==3.10
     # via requests
@@ -77,6 +77,8 @@ jupyterlab-widgets==3.0.13
     # via ipywidgets
 kiwisolver==1.4.8
     # via matplotlib
+lazy-loader==0.4
+    # via -r nightly.in
 libpymcr==0.1.8
     # via pace-neutrons
 matplotlib==3.10.0
@@ -114,6 +116,7 @@ pace-neutrons==0.3.1
 packaging==24.2
     # via
     #   euphonic
+    #   lazy-loader
     #   matplotlib
     #   pooch
     #   pytest
@@ -139,7 +142,7 @@ pluggy==1.5.0
     # via pytest
 pooch==1.8.2
     # via -r nightly.in
-prompt-toolkit==3.0.48
+prompt-toolkit==3.0.50
     # via ipython
 psutil==6.1.1
     # via
diff --git a/requirements/static.txt b/requirements/static.txt
@@ -9,15 +9,15 @@ cfgv==3.4.0
     # via pre-commit
 distlib==0.3.9
     # via virtualenv
-filelock==3.16.1
+filelock==3.17.0
     # via virtualenv
-identify==2.6.5
+identify==2.6.6
     # via pre-commit
 nodeenv==1.9.1
     # via pre-commit
 platformdirs==4.3.6
     # via virtualenv
-pre-commit==4.0.1
+pre-commit==4.1.0
     # via -r static.in
 pyyaml==6.0.2
     # via pre-commit
diff --git a/src/scippneutron/__init__.py b/src/scippneutron/__init__.py
@@ -19,50 +19,30 @@
 except importlib.metadata.PackageNotFoundError:
     __version__ = "0.0.0"
 
-from .beamline_components import (
-    position,
-    source_position,
-    sample_position,
-    incident_beam,
-    scattered_beam,
-    Ltotal,
-    L1,
-    L2,
-    two_theta,
-)
-from .core import convert
-from .mantid import (
-    from_mantid,
-    to_mantid,
-    load_with_mantid,
-    fit,
-)
-from .instrument_view import instrument_view
-from .masking import MaskingTool
-from . import atoms
-from . import chopper
-from . import io
-
 del importlib
 
-__all__ = [
-    "position",
-    "source_position",
-    "sample_position",
-    "incident_beam",
-    "scattered_beam",
-    "Ltotal",
-    "L1",
-    "L2",
-    "two_theta",
-    "convert",
-    "from_mantid",
-    "to_mantid",
-    "io",
-    "load_with_mantid",
-    "fit",
-    "instrument_view",
-    "atoms",
-    "chopper",
-    "MaskingTool",
-]
+import lazy_loader as lazy
+
+submodules = ['atoms' 'chopper', 'io', 'conversion']
+
+__getattr__, __dir__, __all__ = lazy.attach(
+    __name__,
+    submodules=submodules,
+    submod_attrs={
+        'beamline_components': [
+            'position',
+            'source_position',
+            'sample_position',
+            'incident_beam',
+            'scattered_beam',
+            'Ltotal',
+            'L1',
+            'L2',
+            'two_theta',
+        ],
+        'core': ['convert', 'conversion_graph', 'deduce_conversion_graph'],
+        'mantid': ['from_mantid', 'to_mantid', 'load_with_mantid', 'fit'],
+        'instrument_view': ['instrument_view'],
+        'masking': ['MaskingTool'],
+    },
+)
diff --git a/src/scippneutron/chopper/__init__.py b/src/scippneutron/chopper/__init__.py
@@ -1,17 +1,8 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright (c) 2023 Scipp contributors (https://github.com/scipp)
+# Copyright (c) 2025 Scipp contributors (https://github.com/scipp)
 
 """Chopper utilities."""
 
-from .disk_chopper import DiskChopper, DiskChopperType
-from .filtering import collapse_plateaus, filter_in_phase, find_plateaus
-from .nexus_chopper import extract_chopper_from_nexus
+import lazy_loader as lazy
 
-__all__ = [
-    'DiskChopper',
-    'DiskChopperType',
-    'collapse_plateaus',
-    'filter_in_phase',
-    'find_plateaus',
-    'extract_chopper_from_nexus',
-]
+__getattr__, __dir__, __all__ = lazy.attach_stub(__name__, __file__)
diff --git a/src/scippneutron/chopper/__init__.pyi b/src/scippneutron/chopper/__init__.pyi
@@ -0,0 +1,6 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) 2025 Scipp contributors (https://github.com/scipp)
+
+from .disk_chopper import DiskChopper, DiskChopperType  # noqa: F401
+from .filtering import collapse_plateaus, filter_in_phase, find_plateaus  # noqa: F401
+from .nexus_chopper import extract_chopper_from_nexus  # noqa: F401
diff --git a/src/scippneutron/conversion/__init__.py b/src/scippneutron/conversion/__init__.py
@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright (c) 2023 Scipp contributors (https://github.com/scipp)
+# Copyright (c) 2025 Scipp contributors (https://github.com/scipp)
 # @author Jan-Lukas Wynen
 
 """Components for coordinate transformations.
@@ -14,6 +14,6 @@
 `Coordinate Transformations <../../user-guide/coordinate-transformations.rst>`_.
 """
 
-from . import beamline, tof
+import lazy_loader as lazy
 
-__all__ = ['beamline', 'tof']
+__getattr__, __dir__, __all__ = lazy.attach_stub(__name__, __file__)
diff --git a/src/scippneutron/conversion/__init__.pyi b/src/scippneutron/conversion/__init__.pyi
@@ -0,0 +1,5 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) 2025 Scipp contributors (https://github.com/scipp)
+# @author Jan-Lukas Wynen
+
+from . import beamline, graph, tof  # noqa: F401
diff --git a/src/scippneutron/conversion/graph/__init__.py b/src/scippneutron/conversion/graph/__init__.py
diff --git a/src/scippneutron/conversion/graph/__init__.pyi b/src/scippneutron/conversion/graph/__init__.pyi
diff --git a/src/scippneutron/core/__init__.py b/src/scippneutron/core/__init__.py
diff --git a/src/scippneutron/core/__init__.pyi b/src/scippneutron/core/__init__.pyi
diff --git a/src/scippneutron/io/__init__.py b/src/scippneutron/io/__init__.py
diff --git a/src/scippneutron/io/__init__.pyi b/src/scippneutron/io/__init__.pyi
