ab-cache 0.1.1__tar.gz

ab_cache-0.1.1/.gitignore

@@ -0,0 +1,195 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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
+.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

ab_cache-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Matthew Coulter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ab_cache-0.1.1/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: ab-cache
+Version: 0.1.1
+Author-email: Matthew Coulter <53892067+mattcoulter7@users.noreply.github.com>
+License-File: LICENSE
+Requires-Python: <4,>=3.12
+Requires-Dist: ab-dependency
+Requires-Dist: diskcache<6,>=5.6.3
+Requires-Dist: orjson<4,>=3.11.2
+Requires-Dist: pydantic<3,>=2.11.7
+Requires-Dist: slugify<0.0.2,>=0.0.1
+Requires-Dist: sqlmodel<0.0.25,>=0.0.24
+Requires-Dist: uuid7<0.2,>=0.1.0
+Provides-Extra: all
+Requires-Dist: redis<7,>=6.4.0; extra == 'all'
+Provides-Extra: redis-async
+Requires-Dist: redis<7,>=6.4.0; extra == 'redis-async'
+Provides-Extra: redis-sync
+Requires-Dist: redis<7,>=6.4.0; extra == 'redis-sync'
+Description-Content-Type: text/markdown
+
+# Open Banking, Opened | Database
+
+Database Package for Open Banking, Opened API packages.

ab_cache-0.1.1/README.md

@@ -0,0 +1,3 @@
+# Open Banking, Opened | Database
+
+Database Package for Open Banking, Opened API packages.

ab_cache-0.1.1/pyproject.toml

@@ -0,0 +1,82 @@
+[build-system]
+build-backend = "hatchling.build"
+requires = ["hatchling"]
+
+[dependency-groups]
+dev = [
+  "debugpy>=1.8.14,<2",
+  "isort>=6.0.1,<7",
+  "ab-test-fixtures",
+  "pre-commit>=4.2.0,<5",
+  "pytest-asyncio>=1.0.0,<2",
+  "pytest-cov>=6.2.1,<7",
+  "pytest>=8.4.1,<9",
+  "ruff>=0.12.3,<0.13",
+  "tox>=4.27.0,<5"
+]
+
+[project]
+authors = [{email = "53892067+mattcoulter7@users.noreply.github.com", name = "Matthew Coulter"}]
+dependencies = [
+  "diskcache>=5.6.3,<6",
+  "ab-dependency",
+  "orjson>=3.11.2,<4",
+  "pydantic>=2.11.7,<3",
+  "slugify>=0.0.1,<0.0.2",
+  "sqlmodel>=0.0.24,<0.0.25",
+  "uuid7>=0.1.0,<0.2"
+]
+description = ""
+name = "ab-cache"
+readme = "README.md"
+requires-python = ">=3.12, <4"
+version = "0.1.1"
+
+[tool.uv.sources]
+ab-dependency = { git = "https://github.com/auth-broker/package-dependency", tag= "0.1.2" }
+ab-test-fixtures  = { git = "https://@github.com/auth-broker/package-test-fixtures", tag= "0.1.1" }
+
+[project.optional-dependencies]
+all = ["redis>=6.4.0,<7"]
+redis-async = ["redis>=6.4.0,<7"]
+redis-sync = ["redis>=6.4.0,<7"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/ab_core"]
+
+[tool.hatch.build.targets.wheel]
+include = ["src/ab_core"]
+
+[tool.hatch.build.targets.wheel.sources]
+"src/ab_core" = "ab_core"
+
+[tool.pytest.ini_options]
+asyncio_default_fixture_loop_scope = "session"
+asyncio_mode = "auto"
+markers = [
+  "integration: Assigns the test to the integration test suite.",
+  "regression: Assigns the test to the regression test suite"
+]
+
+[tool.ruff]
+line-length = 120
+src = ["src"]
+target-version = "py312"
+
+[tool.ruff.lint]
+exclude = [".git", ".venv", "__pycache__", "proto"]
+fixable = ["ALL"]
+ignore = [
+  "D104" # missing docstring in public package
+]
+select = [
+  "ARG001", # unused arguments
+  "B", # flake8-bugbear
+  "C4", # flake8-comprehensions
+  "D", # pydocstyle (docstring checks)
+  "E", # pycodestyle errors
+  "F", # pyflakes
+  "I", # isort
+  "UP", # pyupgrade
+  "W" # pycodestyle warnings
+]

ab_cache-0.1.1/src/ab_core/cache/caches/__init__.py

@@ -0,0 +1,10 @@
+from typing import Annotated, Union
+
+from pydantic import Discriminator
+
+from .disk import DiskCache
+from .inmemory import InMemoryCache
+from .redis import RedisCache
+from .template import TemplateCache
+
+Cache = Annotated[Union[RedisCache, TemplateCache, InMemoryCache, DiskCache], Discriminator("type")]

ab_cache-0.1.1/src/ab_core/cache/caches/base.py

@@ -0,0 +1,134 @@
+from abc import ABC, abstractmethod
+from typing import (
+    Any,
+    AsyncContextManager,
+    ContextManager,
+    Generic,
+    Optional,
+    Self,
+    TypeVar,
+)
+
+from pydantic import BaseModel, Field
+
+from ab_core.cache.namespace import CacheNamespace
+
+
+class CacheSession(BaseModel, ABC):
+    namespace: CacheNamespace = Field(
+        default_factory=CacheNamespace,
+    )
+
+    @abstractmethod
+    def get(self, key: str): ...
+
+    @abstractmethod
+    def set(self, key: str, value, expiry: Optional[int] = None) -> bool: ...
+
+    @abstractmethod
+    def set_if_not_exists(self, key: str, value, expiry: Optional[int] = None) -> bool: ...
+
+    @abstractmethod
+    def delete(self, key: str) -> int: ...
+
+    @abstractmethod
+    def increment(
+        self,
+        key: str,
+        *,
+        increment_by: int = 1,
+        initial_value: Optional[int] = None,
+        expiry: Optional[int] = None,
+    ) -> int: ...
+
+    @abstractmethod
+    def get_keys(self, pattern: str = "*"): ...
+
+    @abstractmethod
+    def delete_keys(self, pattern: str = "*") -> int: ...
+
+    @abstractmethod
+    def get_ttl(self, key: str) -> int: ...
+
+    @abstractmethod
+    def expire(self, key: str, ttl: int) -> bool: ...
+
+    @abstractmethod
+    def close(self) -> None: ...
+
+    def __enter__(self: Self) -> Self:
+        return self
+
+    def __exit__(self, type_: Any, value: Any, traceback: Any) -> None:
+        self.close()
+
+
+class CacheAsyncSession(BaseModel, ABC):
+    namespace: CacheNamespace = Field(
+        default_factory=CacheNamespace,
+    )
+
+    @abstractmethod
+    async def get(self, key: str): ...
+
+    @abstractmethod
+    async def set(self, key: str, value, expiry: Optional[int] = None) -> bool: ...
+
+    @abstractmethod
+    async def set_if_not_exists(self, key: str, value, expiry: Optional[int] = None) -> bool: ...
+
+    @abstractmethod
+    async def delete(self, key: str) -> int: ...
+
+    @abstractmethod
+    async def increment(
+        self,
+        key: str,
+        *,
+        increment_by: int = 1,
+        initial_value: Optional[int] = None,
+        expiry: Optional[int] = None,
+    ) -> int: ...
+
+    @abstractmethod
+    async def get_keys(self, pattern: str = "*"): ...
+
+    @abstractmethod
+    async def delete_keys(self, pattern: str = "*") -> int: ...
+
+    @abstractmethod
+    async def get_ttl(self, key: str) -> int: ...
+
+    @abstractmethod
+    async def expire(self, key: str, ttl: int) -> bool: ...
+
+    @abstractmethod
+    async def close(self) -> None: ...
+
+    async def __aenter__(self: Self) -> Self:
+        return self
+
+    async def __aexit__(self, type_: Any, value: Any, traceback: Any) -> None:
+        await self.close()
+
+
+SYNC_SESSION = TypeVar("SYNC_SESSION", bound=CacheSession)
+ASYNC_SESSION = TypeVar("ASYNC_SESSION", bound=CacheAsyncSession)
+
+
+class CacheBase(BaseModel, Generic[SYNC_SESSION, ASYNC_SESSION], ABC):
+    namespace: CacheNamespace = Field(default_factory=CacheNamespace)
+
+    @abstractmethod
+    def sync_session(
+        self,
+        *,
+        current_session: Optional[SYNC_SESSION] = None,
+    ) -> ContextManager[SYNC_SESSION]: ...
+
+    @abstractmethod
+    async def async_session(
+        self,
+        *,
+        current_session: Optional[ASYNC_SESSION] = None,
+    ) -> AsyncContextManager[ASYNC_SESSION]: ...