Merge branch 'main' into issue-13826

Author: tsbinns

doc/changes/dev/13673.other.rst

@@ -0,0 +1 @@
+Reorganized EDF submodule structure by moving private functionality into the public ``mne.io`` namespace to improve module consistency and avoid exposing private modules in the Credits page, by `Aniket Singh Yadav`_.

doc/sphinxext/credit_tools.py

@@ -345,6 +345,8 @@ def generate_credit_rst(app=None, *, verbose=False):
     globs["bin/*"] = "mne.commands"
     globs["mne/morph_map.py"] = "mne.surface"
     globs["mne/baseline.py"] = "mne.epochs"
+    globs["mne/io/edf/_open.py"] = "mne.io"
+    globs["mne/_edf/open.py"] = "mne.io"
     for key in """
         parallel.py rank.py misc.py data/*.* defaults.py fixes.py icons/*.* icons.*
     """.strip().split():
@@ -392,15 +394,30 @@ def generate_credit_rst(app=None, *, verbose=False):
             other_files.add(fname)
             mod = "other"
         for e, pm in counts.items():
-            if mod == "mne._fiff":
-                raise RuntimeError
+            # Assert no private (_-prefixed) submodules appear without a redirect
+            if mod.startswith("mne.") and mod.split(".")[-1].startswith("_"):
+                raise RuntimeError(
+                    f"Private submodule {mod!r} found in credit page for {fname!r}. "
+                    "Add an override in credit_tools.py to remap it to a public module."
+                )
             # sanity check a bit
             if mod != "null" and (".png" in fname or "/manual/" in fname):
                 raise RuntimeError(f"Unexpected {mod} {fname}")
             mod_stats[mod][e] += pm
             mod_stats["mne"][e] += pm
             total_lines += pm
     mod_stats.pop("null")  # stuff we shouldn't give credit for
+    # Assert no private (_-prefixed) submodule names remain after null-removal
+    private_mods = [
+        m
+        for m in mod_stats
+        if m.startswith("mne.") and m.split(".")[-1].startswith("_")
+    ]
+    if private_mods:
+        raise RuntimeError(
+            f"Private submodule(s) {private_mods} found in credit page. "
+            "Update credit_tools.py to remap them to a public module."
+        )
     mod_stats = dict(
         (k, mod_stats[k])
         for k in sorted(

mne/_edf/open.py mne/io/edf/_open.pymne/_edf/open.py renamed to mne/io/edf/_open.py

@@ -2,12 +2,10 @@
 # License: BSD-3-Clause
 # Copyright the MNE-Python contributors.
 
-# Maybe we can move this one to utils or something like that.
 from pathlib import Path
 
-from mne._fiff.open import _NoCloseRead
-
-from ..utils import _file_like, _validate_type, logger
+from ..._fiff.open import _NoCloseRead
+from ...utils import _file_like, _validate_type, logger
 
 
 def _gdf_edf_get_fid(fname, **kwargs):

mne/io/edf/edf.py

@@ -13,7 +13,6 @@
 import numpy as np
 from scipy.interpolate import interp1d
 
-from ..._edf.open import _gdf_edf_get_fid
 from ..._fiff.constants import FIFF
 from ..._fiff.meas_info import _empty_info, _unique_channel_names
 from ..._fiff.utils import _blk_read_lims, _mult_cal_one
@@ -30,6 +29,7 @@
     warn,
 )
 from ..base import BaseRaw, _get_scaling
+from ._open import _gdf_edf_get_fid
 
 
 class FileType(Enum):