add filesource for mavedb based on mavedb-fsspec

Author: PlushZ

lib/galaxy/files/sources/mavedb.py

@@ -0,0 +1,114 @@
+from typing import (
+    Optional,
+    Union,
+)
+
+from fsspec import AbstractFileSystem
+
+from galaxy.exceptions import AuthenticationRequired, MessageException
+from galaxy.files.models import AnyRemoteEntry, FilesSourceRuntimeContext
+from galaxy.files.sources._defaults import DEFAULT_SCHEME
+from galaxy.files.sources._fsspec import (
+    CacheOptionsDictType,
+    FsspecBaseFileSourceConfiguration,
+    FsspecBaseFileSourceTemplateConfiguration,
+    FsspecFilesSource,
+)
+from galaxy.util.config_templates import TemplateExpansion
+
+try:
+    from mavedb_fsspec import MaveDBFileSystem
+    from mavedb_fsspec.client import DEFAULT_BASE_URL
+except ImportError:
+    MaveDBFileSystem = None  # type: ignore[misc, assignment]
+    DEFAULT_BASE_URL = "https://api.mavedb.org/api/v1"
+
+
+class MaveDBFileSourceTemplateConfiguration(FsspecBaseFileSourceTemplateConfiguration):
+    base_url: Union[str, TemplateExpansion] = DEFAULT_BASE_URL
+    api_key: Union[str, TemplateExpansion, None] = None
+    timeout: Union[float, TemplateExpansion] = 30.0
+
+
+class MaveDBFileSourceConfiguration(FsspecBaseFileSourceConfiguration):
+    base_url: str = DEFAULT_BASE_URL
+    api_key: Optional[str] = None
+    timeout: float = 30.0
+
+
+class MaveDBFilesSource(FsspecFilesSource[MaveDBFileSourceTemplateConfiguration, MaveDBFileSourceConfiguration]):
+    plugin_type = "mavedb"
+    required_module = MaveDBFileSystem
+    required_package = "mavedb-fsspec"
+
+    template_config_class = MaveDBFileSourceTemplateConfiguration
+    resolved_config_class = MaveDBFileSourceConfiguration
+
+    def _open_fs(
+        self,
+        context: FilesSourceRuntimeContext[MaveDBFileSourceConfiguration],
+        cache_options: CacheOptionsDictType,
+    ) -> AbstractFileSystem:
+        if MaveDBFileSystem is None:
+            raise self.required_package_exception
+
+        config = context.config
+        return MaveDBFileSystem(
+            base_url=config.base_url,
+            api_key=config.api_key,
+            timeout=config.timeout,
+            **cache_options,
+        )
+
+    def _list(
+        self,
+        context: FilesSourceRuntimeContext[MaveDBFileSourceConfiguration],
+        path="/",
+        recursive=False,
+        write_intent: bool = False,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        query: Optional[str] = None,
+        sort_by: Optional[str] = None,
+    ) -> tuple[list[AnyRemoteEntry], int]:
+        collection = path.strip("/")
+        if recursive or collection not in {"score-sets", "my-score-sets"}:
+            return super()._list(context, path, recursive, write_intent, limit, offset, query, sort_by)
+
+        try:
+            cache_options = self._get_cache_options(context.config)
+            fs = self._open_fs(context, cache_options)
+            entries, total_count = fs.list_score_sets(  # type: ignore[attr-defined]
+                collection=collection,
+                limit=limit,
+                offset=offset,
+                query=query,
+            )
+            return [self._info_to_entry(entry, context.config) for entry in entries], total_count
+        except PermissionError as e:
+            raise AuthenticationRequired(
+                f"Permission Denied. Reason: {e}. Please check your credentials in your preferences for {self.label}."
+            )
+        except Exception as e:
+            raise MessageException(f"Problem listing file source path {path}. Reason: {e}") from e
+
+    def _info_to_entry(self, info: dict, config: MaveDBFileSourceConfiguration) -> AnyRemoteEntry:
+        entry = super()._info_to_entry(info, config)
+        display_name = info.get("display_name")
+        if display_name:
+            entry.name = display_name
+        return entry
+
+    def _write_from(
+        self,
+        _target_path: str,
+        _native_path: str,
+        _context: FilesSourceRuntimeContext[MaveDBFileSourceConfiguration],
+    ):
+        raise MessageException("MaveDB file sources are read-only and do not support exporting files.")
+
+    def get_scheme(self) -> str:
+        return self.scheme if self.scheme and self.scheme != DEFAULT_SCHEME else "mavedb"
+
+
+__all__ = ("MaveDBFilesSource",)

lib/galaxy/files/templates/examples/production_mavedb.yml

@@ -0,0 +1,19 @@
+- id: mavedb
+  version: 0
+  name: MaveDB
+  description: |
+      [MaveDB](https://www.mavedb.org) provides Multiplexed Assays of Variant Effect datasets.
+      This file source exposes read-only score set files through the public MaveDB API.
+  secrets:
+      api_key:
+          label: MaveDB API key
+          optional: true
+          help: |
+              Optional MaveDB API key. Public score set files do not require an API key.
+              A user API key can be generated in the MaveDB settings page for your account
+              and is needed to access private datasets.
+  configuration:
+      type: mavedb
+      base_url: https://api.mavedb.org/api/v1
+      api_key: "{{ secrets.api_key }}"
+      timeout: 30

lib/galaxy/files/templates/models.py

@@ -49,6 +49,7 @@
     "dataverse",
     "huggingface",
     "iiif",
+    "mavedb",
     "omero",
     "ssh",
 ]
@@ -395,6 +396,22 @@ class IIIFFileSourceConfiguration(StrictModel):
     manifest_url: str
 
 
+class MaveDBFileSourceTemplateConfiguration(StrictModel):
+    type: Literal["mavedb"]
+    base_url: Union[str, TemplateExpansion] = "https://api.mavedb.org/api/v1"
+    api_key: Union[str, TemplateExpansion, None] = None
+    timeout: Union[float, TemplateExpansion] = 30.0
+    template_start: Optional[str] = None
+    template_end: Optional[str] = None
+
+
+class MaveDBFileSourceConfiguration(StrictModel):
+    type: Literal["mavedb"]
+    base_url: str = "https://api.mavedb.org/api/v1"
+    api_key: Optional[str] = None
+    timeout: float = 30.0
+
+
 class OmeroFileSourceTemplateConfiguration(StrictModel):
     type: Literal["omero"]
     username: Union[str, TemplateExpansion]
@@ -434,6 +451,7 @@ class OmeroFileSourceConfiguration(StrictModel):
         DataverseFileSourceTemplateConfiguration,
         HuggingFaceFileSourceTemplateConfiguration,
         IIIFFileSourceTemplateConfiguration,
+        MaveDBFileSourceTemplateConfiguration,
         OmeroFileSourceTemplateConfiguration,
         SshFileSourceTemplateConfiguration,
     ],
@@ -459,6 +477,7 @@ class OmeroFileSourceConfiguration(StrictModel):
         DataverseFileSourceConfiguration,
         HuggingFaceFileSourceConfiguration,
         IIIFFileSourceConfiguration,
+        MaveDBFileSourceConfiguration,
         OmeroFileSourceConfiguration,
         SshFileSourceConfiguration,
     ],
@@ -542,6 +561,7 @@ def template_to_configuration(
     "dataverse": DataverseFileSourceConfiguration,
     "huggingface": HuggingFaceFileSourceConfiguration,
     "iiif": IIIFFileSourceConfiguration,
+    "mavedb": MaveDBFileSourceConfiguration,
     "omero": OmeroFileSourceConfiguration,
     "ssh": SshFileSourceConfiguration,
 }