Fixing import of PotentialTools in WallGo/__init__.py (#341)

* Removed import of PotentialTools in WallGo/__init__.py

* Wrote draft of lazy import for PotentialTools

* Relative import again

* Tweak

* Solved import error locally

* Changed import statements in tests

* Trying something on scipy

* Installing with -e

* Removed _version

* Removed version from test

* Made main tests the same

* Added comment

* Removed -e for testing again

* Tweak

* Revert

* Changed [tool.setuptools] in pyproject.toml

* Fixed pyproject.toml

* Package data update for pyproject.toml

* Removed __all__ from __init__.

* Updated tests to include both 3.10 and 3.13

Author: og113

.github/workflows/main.yml

@@ -17,7 +17,7 @@ jobs:
 
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.11"]
+        python-version: ["3.10", "3.13"]
 
     steps:
       - uses: actions/checkout@v4
@@ -31,4 +31,4 @@ jobs:
         run: pip install .[tests]
 
       - name: Test with pytest
-        run: cd ${{ github.workspace }} && pytest -vs
+        run: pytest -vs

.github/workflows/publish.yml

@@ -22,7 +22,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
-        python-version: '3.11'
+        python-version: "3.11"
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

.github/workflows/tests.yml

@@ -17,7 +17,7 @@ jobs:
 
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.11"]
+        python-version: ["3.10", "3.13"]
 
     steps:
       - uses: actions/checkout@v4
@@ -31,4 +31,4 @@ jobs:
         run: pip install .[tests]
 
       - name: Test with pytest
-        run: cd ${{ github.workspace }} && pytest -vs
+        run: pytest -vs

pyproject.toml

@@ -68,16 +68,13 @@ Issues = "https://github.com/Wall-Go/WallGo/issues"
 Changelog = "https://github.com/Wall-Go/WallGo/blob/main/CHANGELOG.rst"
 
 [tool.setuptools]
+packages = ["WallGo", "WallGo.PotentialTools"]
+package-dir = {"" = "src"}
 include-package-data = true
 
-[tool.setuptools.packages.find]
-where = ["src"]
-include = ["WallGo"]
-#exclude = [ ... ]
-
 [tool.setuptools.package-data]
 # specify data files relative to packages. These need to be located inside the package. Including files from outside packages is apparently deprecated
-WallGo = ["Config/*.ini", "Data/*"]
+"WallGo.PotentialTools" = ["Config/*.ini", "Data/*.txt"]
 
 [tool.setuptools_scm]
 

src/WallGo/PotentialTools/__init__.py

@@ -7,7 +7,6 @@
 from .utils import getSafePathToResource
 
 
-
 _bInitialized = False  # pylint: disable=invalid-name
 """Configuration settings, using class from WallGo"""
 config = configparser.ConfigParser()

src/WallGo/__init__.py

@@ -1,12 +1,12 @@
 """Initialising WallGo package"""
 
+import types
 import warnings
-
-# subpackage
-from . import PotentialTools
+import importlib
 
 # package level modules
 from .boltzmann import BoltzmannSolver
+from .config import Config
 from .collisionArray import CollisionArray
 from .containers import PhaseInfo, BoltzmannBackground, BoltzmannDeltas, WallParams
 from .effectivePotential import EffectivePotential, VeffDerivativeSettings
@@ -27,7 +27,18 @@
 from .results import WallGoResults
 from .utils import getSafePathToResource
 
-from .config import Config
+# list of submodules for lazy importing
+submodules = ["PotentialTools"]
+
+
+def __getattr__(name: str) -> types.ModuleType:    # pylint: disable=invalid-name
+    """Lazy subpackage import, following Numpy and Scipy"""
+    if name in submodules:
+        return importlib.import_module(f'WallGo.{name}')
+    try:
+        return globals()[name]
+    except KeyError as esc:
+        raise AttributeError(f"Module 'WallGo' has no attribute '{name}'") from esc
 
 
 global _bCollisionModuleAvailable  # pylint: disable=invalid-name

tests/testsPotentialTools/test_IntegralInterpolation.py

@@ -4,9 +4,7 @@
 import pytest
 
 from WallGo import InterpolatableFunction, EExtrapolationType
-
 from WallGo import PotentialTools
-from WallGo.PotentialTools import JbIntegral, JfIntegral
 
 ### Test real parts of Jb, Jf integrals
 
@@ -20,7 +18,7 @@
 )
 def test_directJb(x: float, expectedResult: np.array) -> None:
 
-    Jb = JbIntegral(bUseAdaptiveInterpolation=False)
+    Jb = PotentialTools.JbIntegral(bUseAdaptiveInterpolation=False)
     assert Jb(x) == pytest.approx(expectedResult, rel=1e-6)
 
 
@@ -30,7 +28,7 @@ def test_directJb(x: float, expectedResult: np.array) -> None:
 )
 def test_directJb_derivative(x: float, expectedResult: float) -> None:
 
-    Jb = JbIntegral(bUseAdaptiveInterpolation=False)
+    Jb = PotentialTools.JbIntegral(bUseAdaptiveInterpolation=False)
     assert Jb.derivative(x, 1, False) == pytest.approx(expectedResult, rel=1e-6)
 
 
@@ -40,7 +38,7 @@ def test_directJb_derivative(x: float, expectedResult: float) -> None:
 )
 def test_directJf(x: float, expectedResult: float) -> None:
 
-    Jf = JfIntegral(bUseAdaptiveInterpolation=False)
+    Jf = PotentialTools.JfIntegral(bUseAdaptiveInterpolation=False)
     assert Jf(x) == pytest.approx(expectedResult, rel=1e-6)
 
 
@@ -50,21 +48,21 @@ def test_directJf(x: float, expectedResult: float) -> None:
 )
 def test_directJf_derivative(x: float, expectedResult: float) -> None:
 
-    Jf = JfIntegral(bUseAdaptiveInterpolation=False)
+    Jf = PotentialTools.JfIntegral(bUseAdaptiveInterpolation=False)
     assert Jf.derivative(x, 1, False) == pytest.approx(expectedResult, rel=1e-6)
 
 
 ## Interpolated Jb integral fixture, no extrapolation. The interpolation here is very rough to make this run fast
 @pytest.fixture()
 def Jb_interpolated() -> InterpolatableFunction:
-    Jb = JbIntegral(bUseAdaptiveInterpolation=False)
+    Jb = PotentialTools.JbIntegral(bUseAdaptiveInterpolation=False)
     Jb.newInterpolationTable(1.0, 10.0, 100)
     return Jb
 
 
 @pytest.fixture()
 def Jf_interpolated() -> InterpolatableFunction:
-    Jf = JfIntegral(bUseAdaptiveInterpolation=False)
+    Jf = PotentialTools.JfIntegral(bUseAdaptiveInterpolation=False)
     Jf.newInterpolationTable(1.0, 10.0, 100)
     return Jf
 
@@ -94,7 +92,7 @@ def Jf_interpolated() -> InterpolatableFunction:
     ],
 )
 def test_Jb_interpolated(
-    Jb_interpolated: JbIntegral,
+    Jb_interpolated: PotentialTools.JbIntegral,
     x: Union[float, np.array],
     expectedResult: Union[float, np.array],
 ) -> None:
@@ -103,7 +101,7 @@ def test_Jb_interpolated(
 
 
 @pytest.mark.parametrize("x", [-5, -1, 0, 0.5, 1, 5, 10])
-def test_Jb_derivative_interpolated(Jb_interpolated: JbIntegral, x: float) -> None:
+def test_Jb_derivative_interpolated(Jb_interpolated: PotentialTools.JbIntegral, x: float) -> None:
     np.testing.assert_allclose(
         Jb_interpolated.derivative(x, 1, True),
         Jb_interpolated.derivative(x, 1, False),
@@ -113,7 +111,7 @@ def test_Jb_derivative_interpolated(Jb_interpolated: JbIntegral, x: float) -> No
 
 @pytest.mark.parametrize("x", [-5, -1, 0, 0.5, 1, 5, 10])
 def test_Jb_second_derivative_interpolated(
-    Jb_interpolated: JbIntegral, x: float
+    Jb_interpolated: PotentialTools.JbIntegral, x: float
 ) -> None:
     np.testing.assert_allclose(
         Jb_interpolated.derivative(x, 2, True),
@@ -124,7 +122,7 @@ def test_Jb_second_derivative_interpolated(
 
 
 @pytest.mark.parametrize("x", [-5, -1, 0, 0.5, 1, 5, 10])
-def test_Jf_derivative_interpolated(Jf_interpolated: JfIntegral, x: float) -> None:
+def test_Jf_derivative_interpolated(Jf_interpolated: PotentialTools.JfIntegral, x: float) -> None:
     np.testing.assert_allclose(
         Jf_interpolated.derivative(x, 1, True),
         Jf_interpolated.derivative(x, 1, False),
@@ -134,7 +132,7 @@ def test_Jf_derivative_interpolated(Jf_interpolated: JfIntegral, x: float) -> No
 
 @pytest.mark.parametrize("x", [-5, -1, 0, 0.5, 1, 5, 10])
 def test_Jf_second_derivative_interpolated(
-    Jf_interpolated: JfIntegral, x: float
+    Jf_interpolated: PotentialTools.JfIntegral, x: float
 ) -> None:
     np.testing.assert_allclose(
         Jf_interpolated.derivative(x, 2, True),
@@ -148,7 +146,7 @@ def test_Jf_second_derivative_interpolated(
 
 
 ## Got lazy with parametrization here, so this is just one big function now
-def test_Jb_extrapolation_constant(Jb_interpolated: JbIntegral) -> None:
+def test_Jb_extrapolation_constant(Jb_interpolated: PotentialTools.JbIntegral) -> None:
 
     Jb = Jb_interpolated
     Jb.setExtrapolationType(
@@ -197,7 +195,7 @@ def test_Jb_extrapolation_constant(Jb_interpolated: JbIntegral) -> None:
 
 
 ##
-def test_Jb_extend_range(Jb_interpolated: JbIntegral) -> None:
+def test_Jb_extend_range(Jb_interpolated: PotentialTools.JbIntegral) -> None:
 
     Jb = Jb_interpolated
     relativeTolerance = 1e-6

tests/testsPotentialTools/test_setup.py

@@ -2,5 +2,5 @@
 
 
 def test_importPotentialTools() -> None:
-    """Testing import of WallGo"""
-    from WallGo import PotentialTools
+    """Testing import of PotentialTools from WallGo"""
+    from WallGo import PotentialTools