mirror of
https://github.com/stack-auth/stack.git
synced 2026-07-20 21:29:36 +08:00
Ejiro Asiuwhu
299718c9db
- DataVaultStore class with sync get/set/delete/list_keys methods - AsyncDataVaultStore class with async variants - Export both from models package
88 lines
3.0 KiB
Python
88 lines
3.0 KiB
Python
"""Data vault store classes for server-side key-value storage."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import Any
|
|
|
|
from stack_auth.errors import NotFoundError
|
|
|
|
|
|
class DataVaultStore:
|
|
"""Synchronous data vault store -- a server-side key-value store.
|
|
|
|
Obtained via ``StackServerApp.get_data_vault_store(store_id)``.
|
|
"""
|
|
|
|
def __init__(self, store_id: str, *, _client: Any) -> None:
|
|
self.id = store_id
|
|
self._client = _client
|
|
self._base_path = f"/data-vault/stores/{store_id}/items"
|
|
|
|
def get(self, key: str) -> str | None:
|
|
"""Get the value for a key, or ``None`` if not found."""
|
|
try:
|
|
data = self._client.request("GET", f"{self._base_path}/{key}")
|
|
except NotFoundError:
|
|
return None
|
|
if data is None:
|
|
return None
|
|
return data.get("value") if isinstance(data, dict) else data
|
|
|
|
def set(self, key: str, value: str) -> None:
|
|
"""Set or update the value for a key."""
|
|
self._client.request("PUT", f"{self._base_path}/{key}", body={"value": value})
|
|
|
|
def delete(self, key: str) -> None:
|
|
"""Delete a key-value pair. No error if key doesn't exist."""
|
|
self._client.request("DELETE", f"{self._base_path}/{key}")
|
|
|
|
def list_keys(self) -> list[str]:
|
|
"""Return all keys in the store."""
|
|
data = self._client.request("GET", self._base_path)
|
|
if data is None:
|
|
return []
|
|
# Response may be {"items": [...]} or a list directly
|
|
if isinstance(data, dict):
|
|
return data.get("items", [])
|
|
return data
|
|
|
|
|
|
class AsyncDataVaultStore:
|
|
"""Asynchronous data vault store -- a server-side key-value store.
|
|
|
|
Obtained via ``AsyncStackServerApp.get_data_vault_store(store_id)``.
|
|
"""
|
|
|
|
def __init__(self, store_id: str, *, _client: Any) -> None:
|
|
self.id = store_id
|
|
self._client = _client
|
|
self._base_path = f"/data-vault/stores/{store_id}/items"
|
|
|
|
async def get(self, key: str) -> str | None:
|
|
"""Get the value for a key, or ``None`` if not found."""
|
|
try:
|
|
data = await self._client.request("GET", f"{self._base_path}/{key}")
|
|
except NotFoundError:
|
|
return None
|
|
if data is None:
|
|
return None
|
|
return data.get("value") if isinstance(data, dict) else data
|
|
|
|
async def set(self, key: str, value: str) -> None:
|
|
"""Set or update the value for a key."""
|
|
await self._client.request("PUT", f"{self._base_path}/{key}", body={"value": value})
|
|
|
|
async def delete(self, key: str) -> None:
|
|
"""Delete a key-value pair. No error if key doesn't exist."""
|
|
await self._client.request("DELETE", f"{self._base_path}/{key}")
|
|
|
|
async def list_keys(self) -> list[str]:
|
|
"""Return all keys in the store."""
|
|
data = await self._client.request("GET", self._base_path)
|
|
if data is None:
|
|
return []
|
|
# Response may be {"items": [...]} or a list directly
|
|
if isinstance(data, dict):
|
|
return data.get("items", [])
|
|
return data
|