Add repositories argument to audb.available()

audb/core/api.py

@@ -26,11 +26,13 @@
 def available(
     *,
     only_latest: bool = False,
+    repositories: Repository | Sequence[Repository] = None,
 ) -> pd.DataFrame:
     r"""List all databases that are available to the user.
 
     Args:
         only_latest: include only latest version of database
+        repositories: search only in the given repositories
 
     Returns:
         table with database name as index,
@@ -59,7 +61,12 @@ def add_database(name: str, version: str, repository: Repository):
             ]
         )
 
-    for repository in config.REPOSITORIES:
+    if repositories is not None:
+        repositories = audeer.to_list(repositories)
+    else:
+        repositories = config.REPOSITORIES
+
+    for repository in repositories:
         try:
             backend_interface = repository.create_backend_interface()
             with backend_interface.backend as backend:

tests/test_api.py

@@ -93,6 +93,36 @@ def test_default(self):
         assert "name0" in df.index
         assert "name1" in df.index
 
+    def test_repositories_all(self):
+        """Test repositories argument with all repositories."""
+        df = audb.available(repositories=audb.config.REPOSITORIES)
+        assert len(df) == 2
+
+    @pytest.mark.parametrize("repository_index", [0, 1])
+    @pytest.mark.parametrize("as_list", [False, True])
+    def test_repositories_single(self, repository_index, as_list):
+        """Test repositories argument with single repositories.
+
+        Args:
+            repository_index: select single repository
+                by the given index
+                from ``audb.config.REPOSITORIES``
+            as_list: if ``True``,
+                single repository is given as list
+                to ``repositories`` argument
+
+        """
+        repository = audb.config.REPOSITORIES[repository_index]
+        if as_list:
+            repositories = [repository]
+        else:
+            repositories = repository
+        df = audb.available(repositories=repositories)
+        assert len(df) == 1
+        assert df.host.iloc[0] == repository.host
+        assert df.repository.iloc[0] == repository.name
+        assert df.index[0] == f"name{repository_index}"
+
     def test_broken_database(self, repository_with_broken_database):
         """Test having a database only given as a folder."""
         df = audb.available()