Move private dandi.files classes to _private.py

Author: jwodder

dandi/files/__init__.py

@@ -13,21 +13,14 @@
 
 from collections import deque
 from collections.abc import Iterator
-from dataclasses import dataclass
-from enum import Enum
 from pathlib import Path
 from typing import Optional
-import weakref
 
 from dandi import get_logger
-from dandi.consts import (
-    BIDS_DATASET_DESCRIPTION,
-    VIDEO_FILE_EXTENSIONS,
-    ZARR_EXTENSIONS,
-    dandiset_metadata_file,
-)
+from dandi.consts import BIDS_DATASET_DESCRIPTION, dandiset_metadata_file
 from dandi.exceptions import UnknownAssetError
 
+from ._private import BIDSFileFactory, DandiFileFactory
 from .bases import (
     DandiFile,
     DandisetMetadataFile,
@@ -196,81 +189,6 @@ def dandi_file(
     return factory(filepath, path)
 
 
-class DandiFileType(Enum):
-    """:meta private:"""
-
-    NWB = 1
-    ZARR = 2
-    VIDEO = 3
-    GENERIC = 4
-    BIDS_DATASET_DESCRIPTION = 5
-
-    @staticmethod
-    def classify(path: Path) -> DandiFileType:
-        if path.is_dir():
-            if not any(path.iterdir()):
-                raise UnknownAssetError("Empty directories cannot be assets")
-            if path.suffix in ZARR_EXTENSIONS:
-                return DandiFileType.ZARR
-            raise UnknownAssetError(
-                f"Directory has unrecognized suffix {path.suffix!r}"
-            )
-        elif path.name == BIDS_DATASET_DESCRIPTION:
-            return DandiFileType.BIDS_DATASET_DESCRIPTION
-        elif path.suffix == ".nwb":
-            return DandiFileType.NWB
-        elif path.suffix in VIDEO_FILE_EXTENSIONS:
-            return DandiFileType.VIDEO
-        else:
-            return DandiFileType.GENERIC
-
-
-class DandiFileFactory:
-    """:meta private:"""
-
-    CLASSES: dict[DandiFileType, type[LocalAsset]] = {
-        DandiFileType.NWB: NWBAsset,
-        DandiFileType.ZARR: ZarrAsset,
-        DandiFileType.VIDEO: VideoAsset,
-        DandiFileType.GENERIC: GenericAsset,
-        DandiFileType.BIDS_DATASET_DESCRIPTION: BIDSDatasetDescriptionAsset,
-    }
-
-    def __call__(self, filepath: Path, path: str) -> DandiFile:
-        return self.CLASSES[DandiFileType.classify(filepath)](
-            filepath=filepath, path=path
-        )
-
-
-@dataclass
-class BIDSFileFactory(DandiFileFactory):
-    """:meta private:"""
-
-    bids_dataset_description: BIDSDatasetDescriptionAsset
-
-    CLASSES = {
-        DandiFileType.NWB: NWBBIDSAsset,
-        DandiFileType.ZARR: ZarrBIDSAsset,
-        DandiFileType.VIDEO: GenericBIDSAsset,
-        DandiFileType.GENERIC: GenericBIDSAsset,
-    }
-
-    def __call__(self, filepath: Path, path: str) -> DandiFile:
-        ftype = DandiFileType.classify(filepath)
-        if ftype is DandiFileType.BIDS_DATASET_DESCRIPTION:
-            if filepath == self.bids_dataset_description.filepath:
-                return self.bids_dataset_description
-            else:
-                return BIDSDatasetDescriptionAsset(filepath=filepath, path=path)
-        df = self.CLASSES[ftype](
-            filepath=filepath,
-            path=path,
-            bids_dataset_description_ref=weakref.ref(self.bids_dataset_description),
-        )
-        self.bids_dataset_description.dataset_files.append(df)
-        return df
-
-
 def find_bids_dataset_description(
     dirpath: str | Path, dandiset_path: Optional[str | Path] = None
 ) -> Optional[BIDSDatasetDescriptionAsset]:

dandi/files/_private.py

@@ -0,0 +1,97 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from enum import Enum
+from pathlib import Path
+import weakref
+
+from dandi.consts import (
+    BIDS_DATASET_DESCRIPTION,
+    VIDEO_FILE_EXTENSIONS,
+    ZARR_EXTENSIONS,
+)
+from dandi.exceptions import UnknownAssetError
+
+from .bases import DandiFile, GenericAsset, LocalAsset, NWBAsset, VideoAsset
+from .bids import (
+    BIDSDatasetDescriptionAsset,
+    GenericBIDSAsset,
+    NWBBIDSAsset,
+    ZarrBIDSAsset,
+)
+from .zarr import ZarrAsset
+
+
+class DandiFileType(Enum):
+    """:meta private:"""
+
+    NWB = 1
+    ZARR = 2
+    VIDEO = 3
+    GENERIC = 4
+    BIDS_DATASET_DESCRIPTION = 5
+
+    @staticmethod
+    def classify(path: Path) -> DandiFileType:
+        if path.is_dir():
+            if not any(path.iterdir()):
+                raise UnknownAssetError("Empty directories cannot be assets")
+            if path.suffix in ZARR_EXTENSIONS:
+                return DandiFileType.ZARR
+            raise UnknownAssetError(
+                f"Directory has unrecognized suffix {path.suffix!r}"
+            )
+        elif path.name == BIDS_DATASET_DESCRIPTION:
+            return DandiFileType.BIDS_DATASET_DESCRIPTION
+        elif path.suffix == ".nwb":
+            return DandiFileType.NWB
+        elif path.suffix in VIDEO_FILE_EXTENSIONS:
+            return DandiFileType.VIDEO
+        else:
+            return DandiFileType.GENERIC
+
+
+class DandiFileFactory:
+    """:meta private:"""
+
+    CLASSES: dict[DandiFileType, type[LocalAsset]] = {
+        DandiFileType.NWB: NWBAsset,
+        DandiFileType.ZARR: ZarrAsset,
+        DandiFileType.VIDEO: VideoAsset,
+        DandiFileType.GENERIC: GenericAsset,
+        DandiFileType.BIDS_DATASET_DESCRIPTION: BIDSDatasetDescriptionAsset,
+    }
+
+    def __call__(self, filepath: Path, path: str) -> DandiFile:
+        return self.CLASSES[DandiFileType.classify(filepath)](
+            filepath=filepath, path=path
+        )
+
+
+@dataclass
+class BIDSFileFactory(DandiFileFactory):
+    """:meta private:"""
+
+    bids_dataset_description: BIDSDatasetDescriptionAsset
+
+    CLASSES = {
+        DandiFileType.NWB: NWBBIDSAsset,
+        DandiFileType.ZARR: ZarrBIDSAsset,
+        DandiFileType.VIDEO: GenericBIDSAsset,
+        DandiFileType.GENERIC: GenericBIDSAsset,
+    }
+
+    def __call__(self, filepath: Path, path: str) -> DandiFile:
+        ftype = DandiFileType.classify(filepath)
+        if ftype is DandiFileType.BIDS_DATASET_DESCRIPTION:
+            if filepath == self.bids_dataset_description.filepath:
+                return self.bids_dataset_description
+            else:
+                return BIDSDatasetDescriptionAsset(filepath=filepath, path=path)
+        df = self.CLASSES[ftype](
+            filepath=filepath,
+            path=path,
+            bids_dataset_description_ref=weakref.ref(self.bids_dataset_description),
+        )
+        self.bids_dataset_description.dataset_files.append(df)
+        return df