eegdash 0.4.0.dev150__py3-none-any.whl → 0.4.0.dev162__py3-none-any.whl

eegdash/mongodb.py

@@ -4,50 +4,63 @@
 
 """MongoDB connection and operations management.
 
-This module provides thread-safe MongoDB connection management and high-level database
-operations for the EEGDash metadata database. It includes methods for finding, adding,
-and updating EEG data records with proper connection pooling and error handling.
+This module provides a thread-safe singleton manager for MongoDB connections,
+ensuring that connections to the database are handled efficiently and consistently
+across the application.
 """
 
 import threading
 
 from pymongo import MongoClient
-
-# MongoDB Operations
-# These methods provide a high-level interface to interact with the MongoDB
-# collection, allowing users to find, add, and update EEG data records.
-# - find:
-# - exist:
-# - add_request:
-# - add:
-# - update_request:
-# - remove_field:
-# - remove_field_from_db:
-# - close: Close the MongoDB connection.
-# - __del__: Destructor to close the MongoDB connection.
+from pymongo.collection import Collection
+from pymongo.database import Database
 
 
 class MongoConnectionManager:
-    """Singleton class to manage MongoDB client connections."""
+    """A thread-safe singleton to manage MongoDB client connections.
+
+    This class ensures that only one connection instance is created for each
+    unique combination of a connection string and staging flag. It provides
+    class methods to get a client and to close all active connections.
+
+    Attributes
+    ----------
+    _instances : dict
+        A dictionary to store singleton instances, mapping a
+        (connection_string, is_staging) tuple to a (client, db, collection)
+        tuple.
+    _lock : threading.Lock
+        A lock to ensure thread-safe instantiation of clients.
+
+    """
 
-    _instances = {}
+    _instances: dict[tuple[str, bool], tuple[MongoClient, Database, Collection]] = {}
     _lock = threading.Lock()
 
     @classmethod
-    def get_client(cls, connection_string: str, is_staging: bool = False):
-        """Get or create a MongoDB client for the given connection string and staging flag.
+    def get_client(
+        cls, connection_string: str, is_staging: bool = False
+    ) -> tuple[MongoClient, Database, Collection]:
+        """Get or create a MongoDB client for the given connection parameters.
+
+        This method returns a cached client if one already exists for the given
+        connection string and staging flag. Otherwise, it creates a new client,
+        connects to the appropriate database ("eegdash" or "eegdashstaging"),
+        and returns the client, database, and "records" collection.
 
         Parameters
         ----------
         connection_string : str
-            The MongoDB connection string
-        is_staging : bool
-            Whether to use staging database
+            The MongoDB connection string.
+        is_staging : bool, default False
+            If True, connect to the staging database ("eegdashstaging").
+            Otherwise, connect to the production database ("eegdash").
 
         Returns
         -------
-        tuple
-            A tuple of (client, database, collection)
+        tuple[MongoClient, Database, Collection]
+            A tuple containing the connected MongoClient instance, the Database
+            object, and the Collection object for the "records" collection.
 
         """
         # Create a unique key based on connection string and staging flag
@@ -66,8 +79,12 @@ class MongoConnectionManager:
         return cls._instances[key]
 
     @classmethod
-    def close_all(cls):
-        """Close all MongoDB client connections."""
+    def close_all(cls) -> None:
+        """Close all managed MongoDB client connections.
+
+        This method iterates through all cached client instances and closes
+        their connections. It also clears the instance cache.
+        """
         with cls._lock:
             for client, _, _ in cls._instances.values():
                 try:

eegdash/paths.py

@@ -18,12 +18,21 @@ from mne.utils import get_config as mne_get_config
 
 
 def get_default_cache_dir() -> Path:
-    """Resolve a consistent default cache directory for EEGDash.
+    """Resolve the default cache directory for EEGDash data.
+
+    The function determines the cache directory based on the following
+    priority order:
+    1. The path specified by the ``EEGDASH_CACHE_DIR`` environment variable.
+    2. The path specified by the ``MNE_DATA`` configuration in the MNE-Python
+       config file.
+    3. A hidden directory named ``.eegdash_cache`` in the current working
+       directory.
+
+    Returns
+    -------
+    pathlib.Path
+        The resolved, absolute path to the default cache directory.
 
-    Priority order:
-    1) Environment variable ``EEGDASH_CACHE_DIR`` if set.
-    2) MNE config ``MNE_DATA`` if set (aligns with tests and ecosystem caches).
-    3) ``.eegdash_cache`` under the current working directory.
     """
     # 1) Explicit env var wins
     env_dir = os.environ.get("EEGDASH_CACHE_DIR")

eegdash/utils.py

@@ -11,7 +11,22 @@ including MongoDB client initialization and configuration helpers.
 from mne.utils import get_config, set_config, use_log_level
 
 
-def _init_mongo_client():
+def _init_mongo_client() -> None:
+    """Initialize the default MongoDB connection URI in the MNE config.
+
+    This function checks if the ``EEGDASH_DB_URI`` is already set in the
+    MNE-Python configuration. If it is not set, this function sets it to the
+    default public EEGDash MongoDB Atlas cluster URI.
+
+    The operation is performed with MNE's logging level temporarily set to
+    "ERROR" to suppress verbose output.
+
+    Notes
+    -----
+    This is an internal helper function and is not intended for direct use
+    by end-users.
+
+    """
     with use_log_level("ERROR"):
         if get_config("EEGDASH_DB_URI") is None:
             set_config(

{eegdash-0.4.0.dev150.dist-info → eegdash-0.4.0.dev162.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eegdash
-Version: 0.4.0.dev150
+Version: 0.4.0.dev162
 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

eegdash-0.4.0.dev162.dist-info/RECORD

@@ -0,0 +1,37 @@
+eegdash/__init__.py,sha256=04SaQxsJAI5vCXSpaNxtNEuq-CPKUlMSaX3mdz5Xzng,704
+eegdash/api.py,sha256=az7uUYrEvJfBtzvkzYKzXqEztDSCMsCmgIywpdzYqc8,38381
+eegdash/bids_eeg_metadata.py,sha256=kEmFUe07tivkuIoC5T-YwfO4QQYJBxuc769ZBV1UCKo,16682
+eegdash/const.py,sha256=9WMetN7YMQJbkN2PhzItxtVRZ4VBXLP82vFu9pY6xok,9066
+eegdash/data_utils.py,sha256=nCiGi1LGClTOUUnEPfykcCtza1o4BDW9kb0JBymwbs4,26206
+eegdash/downloader.py,sha256=Z-9EEJildqJxIihwdtXc_h9kzCkuF9LWIwQEfyG9Huw,6030
+eegdash/logging.py,sha256=OQ4jMtwv1h-gzjxmr3PCpcsKi5-3Nhd3r9PJ4UN7oQI,1467
+eegdash/mongodb.py,sha256=9FJDeEebOD5RzNYfAf1lhr0R-pECAlnug6Sjhd9_oUw,3469
+eegdash/paths.py,sha256=dKaDlF87q47KwP-5arAFwx83i5IwGgmEfPfNauEtkds,1499
+eegdash/utils.py,sha256=u_fQ8DiA1b7dVLzwzZBhm8H-LUk6dga54WyqbbqYEJ4,1282
+eegdash/dataset/__init__.py,sha256=HKDfV2DHBv63BqYLBWDMvU8jbFNRC7DqQbxL7RG1DKQ,863
+eegdash/dataset/dataset.py,sha256=DnR6LoirPNV45MECq42MNtIPyhL7DTFuwPWavVWZmmA,8137
+eegdash/dataset/dataset_summary.csv,sha256=797SpPVVkT17y1uYY4GUqAyWSB2H9Ibqnubw7XSTjwA,23613
+eegdash/dataset/registry.py,sha256=5TOCWalA0RV7omRoYS0OzdcSaOTvXvqos74_Vj2jv0M,9127
+eegdash/features/__init__.py,sha256=BXNhjvL4_SSFAY1lcP9nyGpkbJNtoOMH4AHlF6OyABo,4078
+eegdash/features/datasets.py,sha256=5BQZMNwsUsugW05_qGSdKbCFVgI4KP8PGukLx5y8p2A,24569
+eegdash/features/decorators.py,sha256=xK6-HcusPRnKcUCot3DEzkoRjlazd9OLVvq6R8JO0Nw,3826
+eegdash/features/extractors.py,sha256=Fl9vIHBfajk33x7RMweDCrcb7ZlyivVx-ddV8owKeTc,11730
+eegdash/features/inspect.py,sha256=VhK621yv39qHw-cNMhZTeZjpXeWtuIJ-2j3gcrayobE,3875
+eegdash/features/serialization.py,sha256=ZyLgqVul4H0bLfffiVvb_p9_gtMGDFKetcC5AWjHD0I,3852
+eegdash/features/utils.py,sha256=lK-epGlkRm9_psqsbgiWzan_gFC8BuizCRu44PSTvco,6092
+eegdash/features/feature_bank/__init__.py,sha256=YsMXLC1FEtHL3IEw9pYw1fc5IY0x_hr2qWQowI5gZj8,2991
+eegdash/features/feature_bank/complexity.py,sha256=iy9uaLInsYdxKZlXHTWlgEpP9fVI-v9TqLGfnS15-Eg,3258
+eegdash/features/feature_bank/connectivity.py,sha256=bQ6KlxWm5GNpCS9ypLqBUr2L171Yq7wpBQT2tRQKTZ4,2159
+eegdash/features/feature_bank/csp.py,sha256=jKPrmqBj7FliybNbg035cVZddvVSkhk9OazcscDpipU,3303
+eegdash/features/feature_bank/dimensionality.py,sha256=j_Ds71Y1AbV2uLFQj8EuXQ4kzofLBlQtPV5snMkF7i4,3965
+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/hbn/__init__.py,sha256=hsI5pmIuYDzr--aE5UiToO-P9XL5fVRKahZzdsAodro,794
+eegdash/hbn/preprocessing.py,sha256=xp0HBz8WGhLI5c2Zkk4QiVUzGoIZep8YypnHNZsUJ4o,3800
+eegdash/hbn/windows.py,sha256=Z_fhG3kaHd5MAPg60FwFnxMJay8EzacXytUaCsOENGc,14408
+eegdash-0.4.0.dev162.dist-info/licenses/LICENSE,sha256=asisR-xupy_NrQBFXnx6yqXeZcYWLvbAaiETl25iXT0,931
+eegdash-0.4.0.dev162.dist-info/METADATA,sha256=inHG7-WQLXe7uptJa2dG2u6ODc9iOTz6-zpikjbJCjU,6804
+eegdash-0.4.0.dev162.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+eegdash-0.4.0.dev162.dist-info/top_level.txt,sha256=zavO69HQ6MyZM0aQMR2zUS6TAFc7bnN5GEpDpOpFZzU,8
+eegdash-0.4.0.dev162.dist-info/RECORD,,

eegdash-0.4.0.dev150.dist-info/RECORD

@@ -1,37 +0,0 @@
-eegdash/__init__.py,sha256=E0583aFzz3UAElK7BMSDvWmuTNyiEkhJXjqlNsxg7n0,704
-eegdash/api.py,sha256=vcme_BXxc0KpyLwQfrzV7lojM0s16P7KPq-62Gu9ee4,37241
-eegdash/bids_eeg_metadata.py,sha256=0fA5FDM4OlSS83JziRI7-hPvh-KRvwKBpT1dMeB4znk,14307
-eegdash/const.py,sha256=-cwrtncqJHZ19lGf2MK-IgKy7hTMfb6H-CeL50Oonyg,7883
-eegdash/data_utils.py,sha256=5g88vIuU_KTixWF2BV6wtQTs8ba23OPIMkrsEklmiE8,26548
-eegdash/downloader.py,sha256=ukkol-2Y-8FGgociwJR-3TqBfvbUuCuMt2L6E_6baDY,3638
-eegdash/logging.py,sha256=Jux2A3YM9m2ksETErEfUG7wnB7jpJw6v1JH9tQuYVJc,974
-eegdash/mongodb.py,sha256=oXjiNLf0-46r_0RbxG8Y8wQZl8MIcfGQt4_qieU2MqU,2469
-eegdash/paths.py,sha256=4-ae23KeXMP5yaKAJCNW7pQGV19c00ll0EGElV2rZn8,1255
-eegdash/utils.py,sha256=e7LdirPY0dAfMZNWTbgAguqzu-dq0zo-mtXB9nIzf_c,758
-eegdash/dataset/__init__.py,sha256=HKDfV2DHBv63BqYLBWDMvU8jbFNRC7DqQbxL7RG1DKQ,863
-eegdash/dataset/dataset.py,sha256=e_rliu4E-uPtz_miUSzGukUahCHHhyXB2Gu3pm3cyHo,7062
-eegdash/dataset/dataset_summary.csv,sha256=a5Y21LmBPKLVRt5uKNXO7lSRDjsDmJLzv6-3HryF5JU,23614
-eegdash/dataset/registry.py,sha256=KmPDfazhdsIyUouo3qdqDaHiTKHCZcEvXQJeHphZijY,7057
-eegdash/features/__init__.py,sha256=BXNhjvL4_SSFAY1lcP9nyGpkbJNtoOMH4AHlF6OyABo,4078
-eegdash/features/datasets.py,sha256=eV4d86EU4fu1yoIMdPQnot6YZDRGG4qE9h77lk7iVhU,18317
-eegdash/features/decorators.py,sha256=v0qaJz_dcX703p1fvFYbAIXmwK3d8naYGlq7fRVKn_w,1313
-eegdash/features/extractors.py,sha256=H7h6tP3dKoRcjDJpWWAo0ppmokCq5QlhqMcehYwYV9s,6845
-eegdash/features/inspect.py,sha256=PmbWhx5H_WqpnorUpWONUSkUtaIHkZblRa_Xyk7Szyc,1569
-eegdash/features/serialization.py,sha256=LmDrQEb-NLNgak_LabdDnr_J_v0QyLPzm_E8IiIHgMQ,2960
-eegdash/features/utils.py,sha256=eM6DdyOpdVfNh7dSPykJ0WaTDtaGvkCQWAmW0G8v60Y,3784
-eegdash/features/feature_bank/__init__.py,sha256=YsMXLC1FEtHL3IEw9pYw1fc5IY0x_hr2qWQowI5gZj8,2991
-eegdash/features/feature_bank/complexity.py,sha256=iy9uaLInsYdxKZlXHTWlgEpP9fVI-v9TqLGfnS15-Eg,3258
-eegdash/features/feature_bank/connectivity.py,sha256=bQ6KlxWm5GNpCS9ypLqBUr2L171Yq7wpBQT2tRQKTZ4,2159
-eegdash/features/feature_bank/csp.py,sha256=jKPrmqBj7FliybNbg035cVZddvVSkhk9OazcscDpipU,3303
-eegdash/features/feature_bank/dimensionality.py,sha256=j_Ds71Y1AbV2uLFQj8EuXQ4kzofLBlQtPV5snMkF7i4,3965
-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/hbn/__init__.py,sha256=hsI5pmIuYDzr--aE5UiToO-P9XL5fVRKahZzdsAodro,794
-eegdash/hbn/preprocessing.py,sha256=cfsLXnGuUaVJ3NhueDgmdc0w7jflmIi69occuB4bs7M,2609
-eegdash/hbn/windows.py,sha256=23KyVl0pQn4o40wM3Rsu8nl5tN-REAusU7wcv9L4a5U,10351
-eegdash-0.4.0.dev150.dist-info/licenses/LICENSE,sha256=asisR-xupy_NrQBFXnx6yqXeZcYWLvbAaiETl25iXT0,931
-eegdash-0.4.0.dev150.dist-info/METADATA,sha256=YbiJANCGZcLMSn2pjX73kOm0QO_pFzYTVifwtVhAZ_A,6804
-eegdash-0.4.0.dev150.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-eegdash-0.4.0.dev150.dist-info/top_level.txt,sha256=zavO69HQ6MyZM0aQMR2zUS6TAFc7bnN5GEpDpOpFZzU,8
-eegdash-0.4.0.dev150.dist-info/RECORD,,