chore: add base file_keeper:proxy adapter

Author: smotornyuk

docs/adapters/proxy.md

@@ -156,14 +156,6 @@ No specific settings
 
 [opendal operators]: https://opendal.apache.org/docs/python/api/operator/
 
-### `file_keeper:proxy`
-
-| Setting   | Type | Default | Description                         |
-|-----------|------|---------|-------------------------------------|
-| `adapter` | str  | `None`  | Name of the proxified adapter.      |
-| `options` | dict | `{}`    | Settings for the proxified adapter. |
-
-
 ### `file_keeper:redis`
 
 | Setting  | Type        | Default | Description                                 |

docs/configuration.md

@@ -96,7 +96,6 @@ nav:
       - adapters/fs.md
       - adapters/memory.md
       - adapters/null.md
-      - adapters/proxy.md
       - adapters/redis.md
       - adapters/sqlalchemy.md
       - adapters/zip.md

mkdocs.yml

@@ -117,6 +117,7 @@ self = ["file_keeper"]
 addopts = "-p no:ckan"
 markers = [
         "fk_storage_option: modify storage configuration",
+        "expect_storage_capability: test relies on given capability available in the storage fixture"
 ]
 
 [tool.pyright]

pyproject.toml

@@ -1,4 +1,5 @@
 """Memory adapter."""
+
 from __future__ import annotations
 
 import dataclasses
@@ -25,8 +26,9 @@ class Settings(fk.Settings):
 
 class Uploader(fk.Uploader):
     """Memory uploader."""
+
     storage: MemoryStorage
-    capabilities: fk.Capability = fk.Capability.UPLOADER_CAPABILITIES
+    capabilities: fk.Capability = fk.Capability.CREATE | fk.Capability.MULTIPART
 
     @override
     def upload(self, location: fk.Location, upload: fk.Upload, extras: dict[str, Any]) -> fk.FileData:
@@ -107,8 +109,18 @@ def multipart_complete(self, data: fk.FileData, extras: dict[str, Any]) -> fk.Fi
 
 class Manager(fk.Manager):
     """Memory manager."""
+
     storage: MemoryStorage
-    capabilities: fk.Capability = fk.Capability.MANAGER_CAPABILITIES
+    capabilities: fk.Capability = (
+        fk.Capability.ANALYZE
+        | fk.Capability.SCAN
+        | fk.Capability.COPY
+        | fk.Capability.MOVE
+        | fk.Capability.APPEND
+        | fk.Capability.COMPOSE
+        | fk.Capability.EXISTS
+        | fk.Capability.REMOVE
+    )
 
     @override
     def remove(self, data: fk.FileData, extras: dict[str, Any]) -> bool:
@@ -189,6 +201,7 @@ def analyze(self, location: fk.Location, extras: dict[str, Any]) -> fk.FileData:
 
 class Reader(fk.Reader):
     """Memory reader."""
+
     storage: MemoryStorage
     capabilities: fk.Capability = fk.Capability.READER_CAPABILITIES
 

src/file_keeper/default/adapters/memory.py

@@ -1,4 +1,5 @@
 """Null adapter."""
+
 from __future__ import annotations
 
 import dataclasses
@@ -20,6 +21,7 @@ class Settings(fk.Settings):
 
 class Uploader(fk.Uploader):
     """Null uploader."""
+
     storage: NullStorage
     capabilities: fk.Capability = fk.Capability.UPLOADER_CAPABILITIES
 
@@ -48,9 +50,26 @@ def multipart_complete(self, data: fk.FileData, extras: dict[str, Any]) -> fk.Fi
     def multipart_remove(self, data: fk.FileData, extras: dict[str, Any]) -> bool:
         return False
 
+    @override
+    def resumable_start(self, data: fk.FileData, extras: dict[str, Any]) -> fk.FileData:
+        return super().resumable_start(data, extras)
+
+    @override
+    def resumable_refresh(self, data: fk.FileData, extras: dict[str, Any]) -> fk.FileData:
+        return super().resumable_refresh(data, extras)
+
+    @override
+    def resumable_resume(self, data: fk.FileData, extras: dict[str, Any]) -> fk.FileData:
+        return super().resumable_resume(data, extras)
+
+    @override
+    def resumable_remove(self, data: fk.FileData, extras: dict[str, Any]) -> bool:
+        return super().resumable_remove(data, extras)
+
 
 class Manager(fk.Manager):
     """Null manager."""
+
     storage: NullStorage
     capabilities: fk.Capability = fk.Capability.MANAGER_CAPABILITIES
 
@@ -86,9 +105,14 @@ def scan(self, extras: dict[str, Any]) -> Iterable[str]:
     def analyze(self, location: fk.Location, extras: dict[str, Any]) -> fk.FileData:
         return fk.FileData(location)
 
+    @override
+    def signed(self, action: fk.SignedAction, duration: int, location: fk.Location, extras: dict[str, Any]) -> str:
+        return location
+
 
 class Reader(fk.Reader):
     """Null reader."""
+
     storage: NullStorage
     capabilities: fk.Capability = fk.Capability.READER_CAPABILITIES
 

src/file_keeper/default/adapters/null.py

@@ -1,14 +1,41 @@
 """Proxy-storage adapter."""
+
 from __future__ import annotations
 
+import dataclasses
+from collections.abc import Mapping
+from typing import Any, ClassVar
+
 import file_keeper as fk
 
-# settings:
-# * adapter(str)
-# * options(dict)
+
+@dataclasses.dataclass
+class Settings(fk.Settings):
+    """Proxy settings."""
+
+    options: dict[str, Any] = dataclasses.field(default_factory=dict)
+
+    storage: fk.Storage = None  # pyright: ignore[reportAssignmentType]
+
+    def __post_init__(self, **kwargs: Any):
+        super().__post_init__(**kwargs)
+
+        if not self.storage:
+            self.storage = fk.make_storage(self.name, self.options)
 
 
 @fk.Storage.register
 class ProxyStorage:
     """Wrapper for other storages."""
+
     hidden = True
+    ProxySettingsFactory: ClassVar[type[Settings]] = Settings
+    proxy_settings: Settings
+
+    def __init__(self, settings: Mapping[str, Any] | Settings, /):
+        self.proxy_settings = (  # pyright: ignore[reportAttributeAccessIssue]
+            settings if isinstance(settings, Settings) else self.ProxySettingsFactory.from_dict(settings)
+        )
+
+    def __getattr__(self, name: str):
+        return getattr(self.proxy_settings.storage, name)

src/file_keeper/default/adapters/proxy.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Any
+
+import pytest
+from faker import Faker
+
+import file_keeper as fk
+import file_keeper.default.adapters.proxy as proxy
+
+Settings = proxy.Settings
+Storage = proxy.ProxyStorage
+
+
+@pytest.fixture
+def storage(storage_settings: dict[str, Any]):
+    settings = {"options": {"type": "file_keeper:memory"}}
+    settings.update(storage_settings)
+
+    return Storage(settings)
+
+
+class TestSettings:
+    def test_creation(self, tmp_path: Path): ...
+
+
+class TestStorage:
+    def test_basic(self, storage: fk.Storage, faker: Faker):
+        assert isinstance(storage.proxy_settings.storage, fk.adapters["file_keeper:memory"])  # pyright: ignore[reportAttributeAccessIssue]
+
+        assert storage.settings is storage.proxy_settings.storage.settings  # pyright: ignore[reportAttributeAccessIssue]
+
+        content = faker.binary(100)
+        info = storage.upload(fk.Location("test"), fk.make_upload(content))
+
+        assert storage.content(info) == content
+        assert storage.proxy_settings.storage.content(info) == content  # pyright: ignore[reportAttributeAccessIssue]