eegdash 0.3.4.dev69__py3-none-any.whl → 0.3.4.dev70__py3-none-any.whl

eegdash/__init__.py

@@ -7,4 +7,4 @@ __init__mongo_client()
 
 __all__ = ["EEGDash", "EEGDashDataset", "EEGChallengeDataset"]
 
-__version__ = "0.3.4.dev69"
+__version__ = "0.3.4.dev70"

eegdash/registry.py

@@ -1,52 +1,39 @@
 from __future__ import annotations
 
-import csv
 from pathlib import Path
 from typing import Any, Dict
 
+import pandas as pd
+from tabulate import tabulate
+
 
 def register_openneuro_datasets(
     summary_file: str | Path,
     *,
     base_class=None,
     namespace: Dict[str, Any] | None = None,
+    add_to_all: bool = True,
 ) -> Dict[str, type]:
-    """Dynamically create dataset classes from a summary file.
-
-    Parameters
-    ----------
-    summary_file : str | Path
-        Path to a CSV file where each line starts with the dataset identifier.
-    base_class : type | None
-        Base class for the generated datasets. If ``None``, defaults to
-        :class:`eegdash.api.EEGDashDataset`.
-    namespace : dict | None
-        Mapping where the new classes will be registered. Defaults to the
-        module's global namespace.
-
-    Returns
-    -------
-    dict
-        Mapping from class names to the generated classes.
-
-    """
+    """Dynamically create dataset classes from a summary file."""
     if base_class is None:
         from .api import EEGDashDataset as base_class  # lazy import
 
     summary_path = Path(summary_file)
     namespace = namespace if namespace is not None else globals()
+    module_name = namespace.get("__name__", __name__)
     registered: Dict[str, type] = {}
 
-    with summary_path.open() as f:
-        reader = csv.reader(f)
-        for row in reader:
-            if not row:
-                continue
-            dataset_id = row[0].strip()
-            if not dataset_id or dataset_id.startswith("#"):
-                continue
-            class_name = dataset_id.upper()
+    df = pd.read_csv(summary_path, comment="#", skip_blank_lines=True)
+    for _, row_series in df.iterrows():
+        row = row_series.tolist()
+        dataset_id = str(row[0]).strip()
+        if not dataset_id:
+            continue
+
+        class_name = dataset_id.upper()
 
+        # avoid zero-arg super() here
+        def make_init(_dataset: str):
             def __init__(
                 self,
                 cache_dir: str,
@@ -54,19 +41,96 @@ def register_openneuro_datasets(
                 s3_bucket: str | None = None,
                 **kwargs,
             ):
-                q = {"dataset": self._dataset}
+                q = {"dataset": _dataset}
                 if query:
                     q.update(query)
-                super().__init__(
-                    query=q, cache_dir=cache_dir, s3_bucket=s3_bucket, **kwargs
+                # call base_class.__init__ directly
+                base_class.__init__(
+                    self,
+                    query=q,
+                    cache_dir=cache_dir,
+                    s3_bucket=s3_bucket,
+                    **kwargs,
                 )
 
-            cls = type(
-                class_name,
-                (base_class,),
-                {"_dataset": dataset_id, "__init__": __init__},
-            )
-            namespace[class_name] = cls
-            registered[class_name] = cls
+            return __init__
+
+        init = make_init(dataset_id)
+
+        doc = f"""Create an instance for OpenNeuro dataset ``{dataset_id}``.
+
+        {markdown_table(row_series)}
+
+        Parameters
+        ----------
+        cache_dir : str
+            Local cache directory.
+        query : dict | None
+            Extra Mongo query merged with ``{{'dataset': '{dataset_id}'}}``.
+        s3_bucket : str | None
+            Optional S3 bucket name.
+        **kwargs
+            Passed through to {base_class.__name__}.
+        """
+
+        init.__doc__ = doc
+
+        cls = type(
+            class_name,
+            (base_class,),
+            {
+                "_dataset": dataset_id,
+                "__init__": init,
+                "__doc__": doc,
+                "__module__": module_name,  #
+            },
+        )
+
+        namespace[class_name] = cls
+        registered[class_name] = cls
+
+        if add_to_all:
+            ns_all = namespace.setdefault("__all__", [])
+            if isinstance(ns_all, list) and class_name not in ns_all:
+                ns_all.append(class_name)
 
     return registered
+
+
+def markdown_table(row_series: pd.Series) -> str:
+    """Create a reStructuredText grid table from a pandas Series."""
+    if row_series.empty:
+        return ""
+
+    # Prepare the dataframe with user's suggested logic
+    df = (
+        row_series.to_frame()
+        .T.rename(
+            columns={
+                "n_subjects": "#Subj",
+                "nchans_set": "#Chan",
+                "n_tasks": "#Classes",
+                "sampling_freqs": "Freq(Hz)",
+                "duration_hours_total": "Duration(H)",
+            }
+        )
+        .reindex(
+            columns=[
+                "dataset",
+                "#Subj",
+                "#Chan",
+                "#Classes",
+                "Freq(Hz)",
+                "Duration(H)",
+            ]
+        )
+        .infer_objects(copy=False)
+        .fillna("")
+    )
+
+    # Use tabulate for the final rst formatting
+    table = tabulate(df, headers="keys", tablefmt="rst", showindex=False)
+
+    # Indent the table to fit within the admonition block
+    indented_table = "\n".join("    " + line for line in table.split("\n"))
+    return f"\n\n{indented_table}"

{eegdash-0.3.4.dev69.dist-info → eegdash-0.3.4.dev70.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eegdash
-Version: 0.3.4.dev69
+Version: 0.3.4.dev70
 Summary: EEG data for machine learning
 Author-email: Young Truong <dt.young112@gmail.com>, Arnaud Delorme <adelorme@gmail.com>, Aviv Dotan <avivd220@gmail.com>, Oren Shriki <oren70@gmail.com>, Bruno Aristimunha <b.aristimunha@gmail.com>
 License-Expression: GPL-3.0-only
@@ -38,6 +38,7 @@ Requires-Dist: tqdm
 Requires-Dist: xarray
 Requires-Dist: h5io>=0.2.4
 Requires-Dist: pymatreader
+Requires-Dist: tabulate
 Provides-Extra: tests
 Requires-Dist: pytest; extra == "tests"
 Requires-Dist: pytest-cov; extra == "tests"

{eegdash-0.3.4.dev69.dist-info → eegdash-0.3.4.dev70.dist-info}/RECORD

@@ -1,4 +1,4 @@
-eegdash/__init__.py,sha256=jE7WgvWD5alhbtOwzVZ0NCFWRdTx2_xEOrf40uPu8QY,240
+eegdash/__init__.py,sha256=z1uESq6VO66_4UpTGGFDW06PF_7WagRrULPFrTXrsYI,240
 eegdash/api.py,sha256=OqOZ27GYURSAZwTQHSs0QcW_6Mq1i_5XHP6KMcihb8A,27295
 eegdash/data_config.py,sha256=OS6ERO-jHrnEOfMJUehY7ieABdsRw_qWzOKJ4pzSfqw,1323
 eegdash/data_utils.py,sha256=_dycnPmGfTbYs7bc6edHxUn_m01dLYtp92_k44ffEoY,26475
@@ -6,7 +6,7 @@ eegdash/dataset.py,sha256=ooLoxMFy2I8BY9gJl6ncTp_Gz-Rq0Z-o4NJyyomxLcU,2670
 eegdash/dataset_summary.csv,sha256=EfnPciglkf4Vgc8dDq_1x7Woeeze1II8vOhx60g4yhc,8670
 eegdash/mongodb.py,sha256=GD3WgA253oFgpzOHrYaj4P1mRjNtDMT5Oj4kVvHswjI,2006
 eegdash/preprocessing.py,sha256=7S_TTRKPKEk47tTnh2D6WExBt4cctAMxUxGDjJqq5lU,2221
-eegdash/registry.py,sha256=u2TqnMZPhnhItFupPbV50QGemeImnuc18wnEkKzLtL8,2118
+eegdash/registry.py,sha256=cxqX53GYyDvg5DkiqJkvjqHDPI72JTPlI4qVh2sILu8,3873
 eegdash/utils.py,sha256=wU9CBQZLW_LIQIBwhgQm5bU4X-rSsVNPdeF2iE4QGJ4,410
 eegdash/features/__init__.py,sha256=BXNhjvL4_SSFAY1lcP9nyGpkbJNtoOMH4AHlF6OyABo,4078
 eegdash/features/datasets.py,sha256=kU1DO70ArSIy-LF1hHD2NN4iT-kJrI0mVpSkyV_OSeI,18301
@@ -23,8 +23,8 @@ eegdash/features/feature_bank/dimensionality.py,sha256=j_Ds71Y1AbV2uLFQj8EuXQ4kz
 eegdash/features/feature_bank/signal.py,sha256=3Tb8z9gX7iZipxQJ9DSyy30JfdmW58kgvimSyZX74p8,3404
 eegdash/features/feature_bank/spectral.py,sha256=bNB7skusePs1gX7NOU6yRlw_Gr4UOCkO_ylkCgybzug,3319
 eegdash/features/feature_bank/utils.py,sha256=DGh-Q7-XFIittP7iBBxvsJaZrlVvuY5mw-G7q6C-PCI,1237
-eegdash-0.3.4.dev69.dist-info/licenses/LICENSE,sha256=asisR-xupy_NrQBFXnx6yqXeZcYWLvbAaiETl25iXT0,931
-eegdash-0.3.4.dev69.dist-info/METADATA,sha256=ez_LqhgS-Lhf-GYlNnhi0ffE50YT3bvzlqNv8UUce5A,10340
-eegdash-0.3.4.dev69.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-eegdash-0.3.4.dev69.dist-info/top_level.txt,sha256=zavO69HQ6MyZM0aQMR2zUS6TAFc7bnN5GEpDpOpFZzU,8
-eegdash-0.3.4.dev69.dist-info/RECORD,,
+eegdash-0.3.4.dev70.dist-info/licenses/LICENSE,sha256=asisR-xupy_NrQBFXnx6yqXeZcYWLvbAaiETl25iXT0,931
+eegdash-0.3.4.dev70.dist-info/METADATA,sha256=5jX-LB-ep0hcsCio2zFUKO3201B_0sa5gTbeha0I24k,10364
+eegdash-0.3.4.dev70.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+eegdash-0.3.4.dev70.dist-info/top_level.txt,sha256=zavO69HQ6MyZM0aQMR2zUS6TAFc7bnN5GEpDpOpFZzU,8
+eegdash-0.3.4.dev70.dist-info/RECORD,,