Compare commits
3
Commits
4ba768a3bf
...
v1.1.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0af38e28dd | ||
|
|
27b4fcce99 | ||
|
|
8607046fe9 |
No files matched your search
@@ -12,18 +12,18 @@ you `delete` or `clear` them.
|
||||
`requirements.txt`:
|
||||
|
||||
```
|
||||
aiokv @ git+ssh://git@git.rethinkstudios.io/rethink-public/aiokv.git@v1.0.0
|
||||
aiokv @ git+ssh://git@git.rethinkstudios.io/rethink-public/aiokv.git@v1.1.0
|
||||
```
|
||||
|
||||
Direct:
|
||||
|
||||
```bash
|
||||
pip install "aiokv @ git+ssh://git@git.rethinkstudios.io/rethink-public/aiokv.git@v1.0.0"
|
||||
pip install "aiokv @ git+ssh://git@git.rethinkstudios.io/rethink-public/aiokv.git@v1.1.0"
|
||||
```
|
||||
|
||||
Requires `aiofiles` (pulled transitively).
|
||||
|
||||
Drop the `@v1.0.0` suffix from the line above to install the latest unpinned.
|
||||
Drop the `@v1.1.0` suffix from the line above to install the latest unpinned.
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -59,6 +59,16 @@ kv = aiocache("state.json")
|
||||
|
||||
Prefer `AioKV` in new code.
|
||||
|
||||
## Memory model
|
||||
|
||||
The file is read once, on first use, and then served from memory: `get` / `get_all` don't
|
||||
touch the disk, and each `set` / `delete` writes the whole store back atomically. `get` and
|
||||
`get_all` return deep copies, and `set` stores the value's JSON round-trip (exactly what a
|
||||
reload would give back), so mutating a value you passed in or got back never changes the
|
||||
store. Because it is single-process, an edit to the file made by something else after the
|
||||
first read is not seen (and is overwritten by the next write). Orphaned temp files are swept
|
||||
once per instance, on its first save.
|
||||
|
||||
## Durability
|
||||
|
||||
Writes are **atomic**: data is written to a temp file in the same directory and
|
||||
|
||||
+1
-1
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
|
||||
|
||||
[project]
|
||||
name = "aiokv"
|
||||
version = "1.0.0"
|
||||
version = "1.1.0"
|
||||
description = "Async file-backed key-value store for single-process local state — atomic writes, no TTL, config-free, installable."
|
||||
requires-python = ">=3.10"
|
||||
dependencies = [
|
||||
|
||||
+52
-15
@@ -18,11 +18,13 @@ cross-process storage.
|
||||
|
||||
import os
|
||||
import re
|
||||
import copy
|
||||
import shutil
|
||||
import json
|
||||
import time
|
||||
import asyncio
|
||||
import logging
|
||||
from typing import Any, Dict
|
||||
from typing import Any, Dict, Optional
|
||||
|
||||
import aiofiles
|
||||
|
||||
@@ -40,31 +42,53 @@ class AioKV:
|
||||
"""
|
||||
self.file = file
|
||||
self.lock = asyncio.Lock()
|
||||
# the file is read once, then served from memory (single-process by contract);
|
||||
# None = not loaded yet
|
||||
self._data: Optional[Dict[str, Any]] = None
|
||||
self._swept = False
|
||||
|
||||
async def set(self, key: str, value: Any = None) -> None:
|
||||
"""set a value; if value is omitted or None, stores int(time.time())"""
|
||||
"""set a value; if value is omitted or None, stores int(time.time())
|
||||
|
||||
the value is stored as its json round-trip (what a reload from the file would give
|
||||
back), and the in-memory store is rolled back if the write fails"""
|
||||
self._check_key(key)
|
||||
value = value if value is not None else int(time.time())
|
||||
stored = json.loads(json.dumps(value, allow_nan=False))
|
||||
async with self.lock:
|
||||
cache = await self._load()
|
||||
cache[key] = value if value is not None else int(time.time())
|
||||
await self._save(cache)
|
||||
cache = await self._cache()
|
||||
missing = object()
|
||||
previous = cache.get(key, missing)
|
||||
cache[key] = stored
|
||||
try:
|
||||
await self._save(cache)
|
||||
except BaseException:
|
||||
if previous is missing:
|
||||
del cache[key]
|
||||
else:
|
||||
cache[key] = previous
|
||||
raise
|
||||
|
||||
async def get(self, key: str, default: Any = None) -> Any:
|
||||
"""return the value for key, or default if absent"""
|
||||
"""return a deep copy of the value for key, or default if absent"""
|
||||
self._check_key(key)
|
||||
async with self.lock:
|
||||
cache = await self._load()
|
||||
return cache.get(key, default)
|
||||
cache = await self._cache()
|
||||
return copy.deepcopy(cache[key]) if key in cache else default
|
||||
|
||||
async def delete(self, key: str) -> bool:
|
||||
"""delete a key; returns True if removed or absent, False on error"""
|
||||
try:
|
||||
self._check_key(key)
|
||||
async with self.lock:
|
||||
cache = await self._load()
|
||||
cache = await self._cache()
|
||||
if key in cache:
|
||||
del cache[key]
|
||||
await self._save(cache)
|
||||
value = cache.pop(key)
|
||||
try:
|
||||
await self._save(cache)
|
||||
except BaseException:
|
||||
cache[key] = value
|
||||
raise
|
||||
return True
|
||||
except Exception:
|
||||
log.exception("aiokv.delete() failed for key %s", key)
|
||||
@@ -82,15 +106,16 @@ class AioKV:
|
||||
await asyncio.to_thread(os.remove, target)
|
||||
except FileNotFoundError:
|
||||
pass
|
||||
self._data = {}
|
||||
return True
|
||||
except Exception:
|
||||
log.exception("aiokv.clear() failed")
|
||||
return False
|
||||
|
||||
async def get_all(self) -> Dict[str, Any]:
|
||||
"""return a dict of every key/value in the store"""
|
||||
"""return a deep copy of every key/value in the store"""
|
||||
async with self.lock:
|
||||
return await self._load()
|
||||
return copy.deepcopy(await self._cache())
|
||||
|
||||
@staticmethod
|
||||
def _check_key(key: str) -> None:
|
||||
@@ -98,6 +123,12 @@ class AioKV:
|
||||
if not isinstance(key, str):
|
||||
raise ValueError(f"aiokv keys must be str, got {type(key).__name__}")
|
||||
|
||||
async def _cache(self) -> Dict[str, Any]:
|
||||
"""the in-memory store, loading the file on first use; caller must hold the lock"""
|
||||
if self._data is None:
|
||||
self._data = await self._load()
|
||||
return self._data
|
||||
|
||||
async def _load(self) -> Dict[str, Any]:
|
||||
"""load the store, returning {} if absent or blank; raises JSONDecodeError on
|
||||
corrupt content and ValueError on valid-but-non-object JSON rather than masking it"""
|
||||
@@ -117,16 +148,22 @@ class AioKV:
|
||||
"""write atomically: temp file in the same dir, then os.replace over the realpath'd
|
||||
target (symlink-safe). process-crash safe (a crash mid-write leaves the prior good
|
||||
file intact), NOT power-loss safe - no fsync, so an OS/power failure can still lose
|
||||
the last write (acceptable: reconstructible single-process state, not a db)"""
|
||||
the last write (acceptable: reconstructible single-process state, not a db). an
|
||||
existing target's permission bits are copied onto the temp file before the payload
|
||||
is written, so a chmod 600 store stays 600 instead of taking the umask default"""
|
||||
target = await asyncio.to_thread(os.path.realpath, self.file)
|
||||
directory = os.path.dirname(target) or "."
|
||||
await asyncio.to_thread(os.makedirs, directory, exist_ok=True)
|
||||
await self._sweep_stale_tmp(directory, os.path.basename(target))
|
||||
if not self._swept:
|
||||
await self._sweep_stale_tmp(directory, os.path.basename(target))
|
||||
self._swept = True
|
||||
|
||||
payload = await asyncio.to_thread(json.dumps, cache, allow_nan=False)
|
||||
tmp = f"{target}.{os.getpid()}.tmp"
|
||||
try:
|
||||
async with aiofiles.open(tmp, mode="w", encoding="utf-8") as f:
|
||||
if await asyncio.to_thread(os.path.exists, target):
|
||||
await asyncio.to_thread(shutil.copymode, target, tmp)
|
||||
await f.write(payload)
|
||||
await asyncio.to_thread(os.replace, tmp, target)
|
||||
except Exception:
|
||||
|
||||
Reference in new issue
Block a user