varco-memcached 0.1.0__tar.gz

varco_memcached-0.1.0/.gitignore

@@ -0,0 +1,209 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+todo*.txt
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

varco_memcached-0.1.0/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.4
+Name: varco-memcached
+Version: 0.1.0
+Summary: Memcached cache backend for varco — MemcachedCache built on aiomcache
+Project-URL: Homepage, https://github.com/edoardoscarpaci/varco
+Project-URL: Repository, https://github.com/edoardoscarpaci/varco/tree/main/varco_memcached
+Project-URL: Issues, https://github.com/edoardoscarpaci/varco/issues
+Author-email: "edoardo.scarpaci" <edoardo.scarpaci@gmail.com>
+License: Apache-2.0
+Keywords: async,cache,fastapi,memcached,varco
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: aiomcache>=0.8
+Requires-Dist: providify>=0.1.4a3
+Requires-Dist: pydantic-settings>=2.0
+Requires-Dist: varco-core
+Description-Content-Type: text/markdown
+
+# varco-memcached
+
+Memcached cache backend for the [varco](https://github.com/edoardoscarpaci/varco) framework.

varco_memcached-0.1.0/README.md

@@ -0,0 +1,3 @@
+# varco-memcached
+
+Memcached cache backend for the [varco](https://github.com/edoardoscarpaci/varco) framework.

varco_memcached-0.1.0/pyproject.toml

@@ -0,0 +1,61 @@
+[project]
+name          = "varco-memcached"
+version       = "0.1.0"
+description   = "Memcached cache backend for varco — MemcachedCache built on aiomcache"
+authors       = [{ name = "edoardo.scarpaci", email = "edoardo.scarpaci@gmail.com" }]
+readme        = "README.md"
+license       = { text = "Apache-2.0" }
+requires-python = ">=3.12"
+keywords      = ["fastapi", "memcached", "cache", "async", "varco"]
+classifiers   = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = [
+    # Workspace sibling — resolved from the monorepo via [tool.uv.sources] below.
+    "varco-core",
+    # aiomcache is a pure-Python asyncio Memcached client.
+    "aiomcache>=0.8",
+    # Used for @Configuration / @Provider in MemcachedCacheConfiguration.
+    "providify>=0.1.4a3",
+    # Used for MemcachedCacheSettings — SettingsConfigDict + BaseSettings.
+    "pydantic-settings>=2.0",
+]
+
+[project.urls]
+Homepage   = "https://github.com/edoardoscarpaci/varco"
+Repository = "https://github.com/edoardoscarpaci/varco/tree/main/varco_memcached"
+Issues     = "https://github.com/edoardoscarpaci/varco/issues"
+
+[tool.uv.sources]
+# Resolve varco-core from the workspace so editable changes are visible immediately.
+varco-core = { workspace = true }
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0",
+    "pytest-asyncio>=0.24",
+    # testcontainers[memcached] spins up a real Memcached instance via Docker for
+    # integration tests.  Marked @pytest.mark.integration — run with: pytest -m integration
+    "testcontainers>=4.0",
+]
+
+[build-system]
+requires      = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["varco_memcached"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths    = ["tests"]
+markers      = [
+    "integration: real Memcached instance required (disabled by default — use -m integration)",
+]

varco_memcached-0.1.0/tests/test_cache.py

@@ -0,0 +1,378 @@
+"""
+Unit tests for varco_memcached.cache
+======================================
+All tests mock ``aiomcache.Client`` — no real Memcached instance required.
+
+A ``FakeMemcached`` test double replaces ``aiomcache.Client`` via
+``unittest.mock.patch``, providing an in-memory dict-backed implementation
+that mirrors the aiomcache commands used by ``MemcachedCache``
+(``get``, ``set``, ``delete``, ``close``).
+
+DESIGN: FakeMemcached stores keys as bytes
+    aiomcache requires ``bytes`` keys — the fake intentionally uses
+    ``dict[bytes, bytes]`` to surface any caller that forgets to encode.
+
+Sections
+--------
+- ``MemcachedCacheSettings``    — defaults, memcached_key(), frozen, env prefix
+- ``MemcachedCache`` lifecycle  — start/stop, double-start guard, context manager
+- ``MemcachedCache`` set/get    — round-trip, TTL (exptime), no-TTL, prefix
+- ``MemcachedCache`` delete     — removes key; removes from registry; idempotent
+- ``MemcachedCache`` exists     — true/false; strategy gate
+- ``MemcachedCache`` clear      — only removes registry keys; leaves untracked keys
+- ``MemcachedCache`` strategy   — ExplicitStrategy gates get/exists
+- ``MemcachedCacheConfiguration`` — wires settings + cache via Providify
+"""
+
+from __future__ import annotations
+
+from unittest.mock import patch
+
+import pytest
+
+from varco_core.cache import ExplicitStrategy
+from varco_memcached.cache import (
+    MemcachedCache,
+    MemcachedCacheConfiguration,
+    MemcachedCacheSettings,
+)
+
+
+# ── FakeMemcached ───────────────────────────────────────────────────────────────
+
+
+class FakeMemcached:
+    """
+    In-memory Memcached fake.
+
+    Keys and values are stored as ``bytes`` — matching the aiomcache contract.
+    Supports: get, set, delete, close.
+
+    Does NOT implement real TTL expiry — tests that need TTL expiry use
+    real Memcached via the integration test suite.
+
+    Async safety: ✅ — all methods are ``async def``, safe to await in tests.
+    """
+
+    def __init__(self) -> None:
+        # bytes → bytes mapping mirrors aiomcache's raw byte storage.
+        self._store: dict[bytes, bytes] = {}
+        # Track the exptime passed to set() — used to assert TTL behaviour.
+        self._exptime: dict[bytes, int] = {}
+
+    async def get(self, key: bytes) -> bytes | None:
+        return self._store.get(key)
+
+    async def set(self, key: bytes, value: bytes, exptime: int = 0) -> bool:
+        self._store[key] = value
+        self._exptime[key] = exptime
+        return True
+
+    async def delete(self, key: bytes) -> bool:
+        # Idempotent — do not raise on missing key.
+        self._store.pop(key, None)
+        self._exptime.pop(key, None)
+        return True
+
+    async def close(self) -> None:
+        pass
+
+
+# ── Fixtures ─────────────────────────────────────────────────────────────────────
+
+
+@pytest.fixture
+def fake_mc() -> FakeMemcached:
+    return FakeMemcached()
+
+
+@pytest.fixture
+def settings() -> MemcachedCacheSettings:
+    return MemcachedCacheSettings(host="fake-mc", port=11211)
+
+
+@pytest.fixture
+async def cache(
+    settings: MemcachedCacheSettings,
+    fake_mc: FakeMemcached,
+) -> MemcachedCache:
+    with patch("varco_memcached.cache.aiomcache.Client", return_value=fake_mc):
+        async with MemcachedCache(settings) as c:
+            yield c
+
+
+# ── MemcachedCacheSettings ──────────────────────────────────────────────────────
+
+
+class TestMemcachedCacheSettings:
+    def test_defaults(self) -> None:
+        s = MemcachedCacheSettings()
+        assert s.host == "localhost"
+        assert s.port == 11211
+        assert s.pool_size == 2
+        assert s.key_prefix == ""
+        assert s.default_ttl is None
+
+    def test_frozen(self) -> None:
+        s = MemcachedCacheSettings()
+        with pytest.raises(Exception):
+            s.host = "other"  # type: ignore[misc]
+
+    def test_memcached_key_no_prefix(self) -> None:
+        s = MemcachedCacheSettings()
+        assert s.memcached_key("user:1") == b"user:1"
+
+    def test_memcached_key_with_prefix(self) -> None:
+        s = MemcachedCacheSettings(key_prefix="myapp:")
+        assert s.memcached_key("user:1") == b"myapp:user:1"
+
+    def test_from_dict(self) -> None:
+        s = MemcachedCacheSettings.from_dict(
+            {"host": "mc.prod", "port": 11212, "key_prefix": "prod:"}
+        )
+        assert s.host == "mc.prod"
+        assert s.port == 11212
+        assert s.key_prefix == "prod:"
+
+
+# ── MemcachedCache lifecycle ────────────────────────────────────────────────────
+
+
+class TestMemcachedCacheLifecycle:
+    async def test_not_started_raises_on_get(
+        self, settings: MemcachedCacheSettings
+    ) -> None:
+        c = MemcachedCache(settings)
+        with pytest.raises(RuntimeError, match="not started"):
+            await c.get("k")
+
+    async def test_not_started_raises_on_set(
+        self, settings: MemcachedCacheSettings
+    ) -> None:
+        c = MemcachedCache(settings)
+        with pytest.raises(RuntimeError, match="not started"):
+            await c.set("k", "v")
+
+    async def test_double_start_raises(
+        self, settings: MemcachedCacheSettings, fake_mc: FakeMemcached
+    ) -> None:
+        with patch("varco_memcached.cache.aiomcache.Client", return_value=fake_mc):
+            c = MemcachedCache(settings)
+            await c.start()
+            with pytest.raises(RuntimeError, match="already-started"):
+                await c.start()
+            await c.stop()
+
+    async def test_stop_before_start_noop(
+        self, settings: MemcachedCacheSettings
+    ) -> None:
+        c = MemcachedCache(settings)
+        await c.stop()  # must not raise
+
+    async def test_context_manager_starts_and_stops(
+        self, settings: MemcachedCacheSettings, fake_mc: FakeMemcached
+    ) -> None:
+        with patch("varco_memcached.cache.aiomcache.Client", return_value=fake_mc):
+            async with MemcachedCache(settings) as c:
+                assert c._client is not None
+            assert c._client is None
+
+    async def test_repr_started(self, cache: MemcachedCache) -> None:
+        text = repr(cache)
+        assert "MemcachedCache" in text
+        assert "started=True" in text
+
+    async def test_repr_not_started(self, settings: MemcachedCacheSettings) -> None:
+        text = repr(MemcachedCache(settings))
+        assert "started=False" in text
+
+
+# ── MemcachedCache set / get ────────────────────────────────────────────────────
+
+
+class TestMemcachedCacheSetGet:
+    async def test_set_and_get_roundtrip(self, cache: MemcachedCache) -> None:
+        await cache.set("user:1", {"name": "Alice", "age": 30})
+        result = await cache.get("user:1")
+        assert result == {"name": "Alice", "age": 30}
+
+    async def test_get_missing_returns_none(self, cache: MemcachedCache) -> None:
+        assert await cache.get("missing") is None
+
+    async def test_set_with_ttl_passes_exptime(
+        self,
+        cache: MemcachedCache,
+        fake_mc: FakeMemcached,
+        settings: MemcachedCacheSettings,
+    ) -> None:
+        await cache.set("k", "v", ttl=120)
+        mc_key = settings.memcached_key("k")
+        assert fake_mc._exptime.get(mc_key) == 120
+
+    async def test_set_without_ttl_uses_zero_exptime(
+        self,
+        cache: MemcachedCache,
+        fake_mc: FakeMemcached,
+        settings: MemcachedCacheSettings,
+    ) -> None:
+        # 0 = no expiry in Memcached protocol
+        await cache.set("k", "v")
+        mc_key = settings.memcached_key("k")
+        assert fake_mc._exptime.get(mc_key) == 0
+
+    async def test_default_ttl_from_settings(self, fake_mc: FakeMemcached) -> None:
+        settings = MemcachedCacheSettings(host="fake-mc", port=11211, default_ttl=60.0)
+        with patch("varco_memcached.cache.aiomcache.Client", return_value=fake_mc):
+            async with MemcachedCache(settings) as cache:
+                await cache.set("k", "v")
+                mc_key = settings.memcached_key("k")
+                assert fake_mc._exptime.get(mc_key) == 60
+
+    async def test_key_prefix_applied_in_storage(self, fake_mc: FakeMemcached) -> None:
+        settings = MemcachedCacheSettings(
+            host="fake-mc", port=11211, key_prefix="myapp:"
+        )
+        with patch("varco_memcached.cache.aiomcache.Client", return_value=fake_mc):
+            async with MemcachedCache(settings) as cache:
+                await cache.set("user:1", "Alice")
+                assert b"myapp:user:1" in fake_mc._store
+
+    async def test_set_tracks_key_in_registry(self, cache: MemcachedCache) -> None:
+        await cache.set("user:1", "Alice")
+        # The logical key (unprefixed) must be tracked.
+        assert "user:1" in cache._key_registry
+
+
+# ── MemcachedCache delete ───────────────────────────────────────────────────────
+
+
+class TestMemcachedCacheDelete:
+    async def test_delete_removes_key(self, cache: MemcachedCache) -> None:
+        await cache.set("k", "v")
+        await cache.delete("k")
+        assert await cache.get("k") is None
+
+    async def test_delete_removes_from_registry(self, cache: MemcachedCache) -> None:
+        await cache.set("k", "v")
+        assert "k" in cache._key_registry
+        await cache.delete("k")
+        assert "k" not in cache._key_registry
+
+    async def test_delete_nonexistent_noop(self, cache: MemcachedCache) -> None:
+        await cache.delete("missing")  # must not raise
+
+
+# ── MemcachedCache exists ───────────────────────────────────────────────────────
+
+
+class TestMemcachedCacheExists:
+    async def test_exists_true(self, cache: MemcachedCache) -> None:
+        await cache.set("k", "v")
+        assert await cache.exists("k") is True
+
+    async def test_exists_false_for_missing(self, cache: MemcachedCache) -> None:
+        assert await cache.exists("missing") is False
+
+    async def test_exists_false_when_strategy_invalidates(
+        self, fake_mc: FakeMemcached, settings: MemcachedCacheSettings
+    ) -> None:
+        strategy = ExplicitStrategy()
+        with patch("varco_memcached.cache.aiomcache.Client", return_value=fake_mc):
+            async with MemcachedCache(settings, strategy=strategy) as cache:
+                await cache.set("k", "v")
+                strategy.invalidate("k")
+                assert await cache.exists("k") is False
+
+
+# ── MemcachedCache clear ────────────────────────────────────────────────────────
+
+
+class TestMemcachedCacheClear:
+    async def test_clear_removes_tracked_keys(self, cache: MemcachedCache) -> None:
+        await cache.set("a", 1)
+        await cache.set("b", 2)
+        await cache.clear()
+        assert await cache.get("a") is None
+        assert await cache.get("b") is None
+
+    async def test_clear_empties_registry(self, cache: MemcachedCache) -> None:
+        await cache.set("a", 1)
+        await cache.set("b", 2)
+        await cache.clear()
+        assert len(cache._key_registry) == 0
+
+    async def test_clear_does_not_remove_untracked_keys(
+        self, fake_mc: FakeMemcached, settings: MemcachedCacheSettings
+    ) -> None:
+        # Put a key directly into the fake store (simulating another client).
+        untracked_key = b"other:key"
+        fake_mc._store[untracked_key] = b'"external"'
+
+        with patch("varco_memcached.cache.aiomcache.Client", return_value=fake_mc):
+            async with MemcachedCache(settings) as cache:
+                await cache.set("a", 1)
+                await cache.clear()
+                # The externally-written key must survive.
+                assert untracked_key in fake_mc._store
+
+    async def test_clear_noop_when_empty(self, cache: MemcachedCache) -> None:
+        await cache.clear()  # must not raise
+
+
+# ── MemcachedCache + ExplicitStrategy ───────────────────────────────────────────
+
+
+class TestMemcachedCacheWithStrategy:
+    async def test_strategy_invalidates_get(
+        self, fake_mc: FakeMemcached, settings: MemcachedCacheSettings
+    ) -> None:
+        strategy = ExplicitStrategy()
+        with patch("varco_memcached.cache.aiomcache.Client", return_value=fake_mc):
+            async with MemcachedCache(settings, strategy=strategy) as cache:
+                await cache.set("k", "v")
+                strategy.invalidate("k")
+                result = await cache.get("k")
+                assert result is None
+                # Key must be evicted from Memcached too.
+                assert await fake_mc.get(settings.memcached_key("k")) is None
+
+
+# ── MemcachedCacheConfiguration ─────────────────────────────────────────────────
+
+
+class TestMemcachedCacheConfiguration:
+    async def test_provides_cache_backend(self, fake_mc: FakeMemcached) -> None:
+        from providify import DIContainer
+        from varco_core.cache import CacheBackend
+
+        with patch("varco_memcached.cache.aiomcache.Client", return_value=fake_mc):
+            container = DIContainer()
+            await container.ainstall(MemcachedCacheConfiguration)
+
+            cache = await container.aget(CacheBackend)
+            assert isinstance(cache, MemcachedCache)
+
+            await container.ashutdown()
+
+    async def test_singleton_returns_same_instance(
+        self, fake_mc: FakeMemcached
+    ) -> None:
+        from providify import DIContainer
+        from varco_core.cache import CacheBackend
+
+        with patch("varco_memcached.cache.aiomcache.Client", return_value=fake_mc):
+            container = DIContainer()
+            await container.ainstall(MemcachedCacheConfiguration)
+
+            c1 = await container.aget(CacheBackend)
+            c2 = await container.aget(CacheBackend)
+            assert c1 is c2
+
+            await container.ashutdown()
+
+    async def test_settings_default_to_localhost(self) -> None:
+        # Settings created without arguments must default to localhost:11211 —
+        # verifies the DI configuration provider reads sane defaults from env.
+        s = MemcachedCacheSettings()
+        assert s.host == "localhost"
+        assert s.port == 11211