for some reason dev dependencies are needed to build docs

Author: MatthewMiddlehurst

.github/workflows/pr_core_dep_import.yml

@@ -0,0 +1,43 @@
+name: PR core dep module imports
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+    paths:
+      - "aeon/**"
+      - ".github/workflows/**"
+      - "pyproject.toml"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test-core-imports:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install aeon and dependencies
+        uses: nick-fields/retry@v3
+        with:
+          timeout_minutes: 30
+          max_attempts: 3
+          command: python -m pip install .
+
+      - name: Show dependencies
+        run: python -m pip list
+
+      - name: Run import test
+        run: python aeon/testing/tests/test_core_imports.py

.readthedocs.yml

@@ -9,7 +9,6 @@ python:
       path: .
       extra_requirements:
         - docs
-        - dev
 
 build:
   os: ubuntu-22.04

aeon/testing/tests/__init__.py

@@ -1 +1,13 @@
-"""Tests for the aeon package and testing module utiltiies."""
+"""Tests for the aeon package and testing module utilties."""
+
+import pkgutil
+
+import aeon
+
+# collect all modules
+ALL_AEON_MODULES = pkgutil.walk_packages(aeon.__path__, aeon.__name__ + ".")
+ALL_AEON_MODULES = [x[1] for x in ALL_AEON_MODULES]
+
+ALL_AEON_MODULES_NO_TESTS = [
+    x for x in ALL_AEON_MODULES if not any(part == "tests" for part in x.split("."))
+]

aeon/testing/tests/test_core_imports.py

@@ -0,0 +1,26 @@
+"""Tests that non-core dependencies are handled correctly in modules."""
+
+import re
+from importlib import import_module
+
+from aeon.testing.tests import ALL_AEON_MODULES_NO_TESTS
+
+if __name__ == "__main__":
+    """Test imports in aeon modules with core dependencies only.
+
+    Imports all modules and catch exceptions due to missing dependencies.
+    """
+    for module in ALL_AEON_MODULES_NO_TESTS:
+        try:
+            import_module(module)
+        except ModuleNotFoundError as e:  # pragma: no cover
+            dependency = "unknown"
+            match = re.search(r"\'(.+?)\'", str(e))
+            if match:
+                dependency = match.group(1)
+
+            raise ModuleNotFoundError(
+                f"The module: {module} should not require any non-core dependencies, "
+                f"but tried importing: '{dependency}'. Make sure non-core dependencies "
+                f"are properly isolated outside of tests/ directories."
+            ) from e

aeon/testing/tests/test_softdeps.py

@@ -1,23 +1,14 @@
 """Tests that soft dependencies are handled correctly in modules."""
 
-__maintainer__ = []
-
-import pkgutil
 import re
 from importlib import import_module
 
 import pytest
 
-import aeon
 from aeon.testing.testing_config import PR_TESTING
+from aeon.testing.tests import ALL_AEON_MODULES, ALL_AEON_MODULES_NO_TESTS
 
-# collect all modules
-modules = pkgutil.walk_packages(aeon.__path__, aeon.__name__ + ".")
-modules = [x[1] for x in modules]
-
-if PR_TESTING:  # pragma: no cover
-    # exclude test modules
-    modules = [x for x in modules if not any(part == "tests" for part in x.split("."))]
+modules = ALL_AEON_MODULES_NO_TESTS if PR_TESTING else ALL_AEON_MODULES
 
 
 def test_module_crawl():