Merge pull request #981 from dandi/gh-979

Add `get_assets_by_glob()`

dandi/dandiapi.py

@@ -1022,6 +1022,31 @@ def get_assets_with_path_prefix(
                 f"No such version: {self.version_id!r} of Dandiset {self.identifier}"
             )
 
+    def get_assets_by_glob(
+        self, pattern: str, order: Optional[str] = None
+    ) -> Iterator["RemoteAsset"]:
+        """
+        .. versionadded:: 0.44.0
+
+        Returns an iterator of all assets in this version of the Dandiset whose
+        `~RemoteAsset.path` attributes match the glob pattern ``pattern``
+
+        Assets can be sorted by a given field by passing the name of that field
+        as the ``order`` parameter.  The accepted field names are
+        ``"created"``, ``"modified"``, and ``"path"``.  Prepend a hyphen to the
+        field name to reverse the sort order.
+        """
+        try:
+            for a in self.client.paginate(
+                f"{self.version_api_path}assets/",
+                params={"glob": pattern, "order": order},
+            ):
+                yield RemoteAsset.from_data(self, a)
+        except HTTP404Error:
+            raise NotFoundError(
+                f"No such version: {self.version_id!r} of Dandiset {self.identifier}"
+            )
+
     def get_asset_by_path(self, path: str) -> "RemoteAsset":
         """
         Fetch the asset in this version of the Dandiset whose

dandi/tests/test_dandiapi.py

@@ -607,6 +607,20 @@ def test_get_assets_with_path_prefix(text_dandiset: SampleDandiset) -> None:
     ] == ["subdir2/coconut.txt", "subdir2/banana.txt", "subdir1/apple.txt"]
 
 
+def test_get_assets_by_glob(text_dandiset: SampleDandiset) -> None:
+    assert sorted(
+        asset.path for asset in text_dandiset.dandiset.get_assets_by_glob("*a*.txt")
+    ) == ["subdir1/apple.txt", "subdir2/banana.txt"]
+    assert [
+        asset.path
+        for asset in text_dandiset.dandiset.get_assets_by_glob("*a*.txt", order="path")
+    ] == ["subdir1/apple.txt", "subdir2/banana.txt"]
+    assert [
+        asset.path
+        for asset in text_dandiset.dandiset.get_assets_by_glob("*a*.txt", order="-path")
+    ] == ["subdir2/banana.txt", "subdir1/apple.txt"]
+
+
 def test_empty_zarr_iterfiles(new_dandiset: SampleDandiset) -> None:
     client = new_dandiset.client
     r = client.post(