sieve.cache 0.0.1__tar.gz

sieve_cache-0.0.1/.coveragerc

@@ -0,0 +1,19 @@
+[run]
+branch = True
+source = sieve_cache
+omit =
+    __init__.py
+concurrency = multiprocessing,thread
+[report]
+ignore_errors = True
+exclude_lines =
+    pragma: no cover
+    def __repr__
+    if self.debug:
+    if settings.DEBUG
+    raise AssertionError
+    raise NotImplementedError
+    if 0:
+    if __name__ == .__main__.:
+    class .*\bProtocol\):
+    @(abc\.)?abstractmethod

sieve_cache-0.0.1/.github/workflows/python-ci.yml

@@ -0,0 +1,35 @@
+name: Python CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  tox:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Install tox
+        run: uv tool install tox --with tox-uv
+
+      - name: Run tox (tests + lint)
+        run: tox -e py3,pep8

sieve_cache-0.0.1/.github/workflows/release-pypi.yml

@@ -0,0 +1,53 @@
+name: Release to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build distribution artifacts
+        run: |
+          python -m pip install build
+          python -m build
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  upload-to-pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/sieve.cache
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true
+          verify-metadata: false
+          verbose: true
+          packages-dir: dist/

sieve_cache-0.0.1/.gitignore

@@ -0,0 +1,161 @@
+### Python template
+# 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
+
+# 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
+
+# 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/#use-with-ide
+.pdm.toml
+
+# 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/

sieve_cache-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: 3298ddab3c13dd77d6ce1fc0baf97691430d84b0 # v4.3.0
+  hooks:
+    - id: trailing-whitespace
+    # Replaces or checks mixed line ending
+    - id: mixed-line-ending
+      args: ['--fix', 'lf']
+      exclude: '.*\.(svg)$'
+    - id: end-of-file-fixer
+    # Forbid files which have a UTF-8 byte-order marker
+    - id: check-byte-order-marker
+    # Checks that non-binary executables have a proper shebang
+    - id: check-executables-have-shebangs
+    # Check for files that contain merge conflict strings.
+    - id: check-merge-conflict
+    - id: debug-statements
+    - id: check-yaml
+      files: .*\.(yaml|yml)$
+    - id: check-added-large-files
+- repo: local
+  hooks:
+    - id: flake8
+      name: flake8
+      additional_dependencies:
+        - hacking>=3.1.0,<3.2.0
+      language: python
+      entry: flake8
+      files: '^.*\.py$'
+      exclude: '^(doc|releasenotes|tools)/.*$'
+      args: ['--config=setup.cfg']

sieve_cache-0.0.1/.stestr.conf

@@ -0,0 +1,3 @@
+[DEFAULT]
+test_path=${OS_TEST_PATH:-./sieve_cache/tests}
+top_dir=./

sieve_cache-0.0.1/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: sieve.cache
+Version: 0.0.1
+Summary: A simple implementation of SIEVE caching algorithm
+Author-email: Pham Le Gia Dai <daipham.3213@gmail.com>
+License: Apache-2.0
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.10
+Requires-Dist: dogpile-cache>=1.3.0
+Requires-Dist: iso8601>=2.1.0
+Requires-Dist: stevedore>=5.1.0
+Provides-Extra: redis
+Requires-Dist: redis; extra == 'redis'
+Description-Content-Type: text/markdown
+
+# sieve.cache
+
+`sieve.cache` is a lightweight Python cache utility that implements the
+SIEVE eviction algorithm on top of `dogpile.cache` backends.
+
+## Project Summary
+
+- Implements a `Sieve` cache with a decorator-based API.
+- Uses a doubly linked list (`head`, `tail`, `hand`) to track entries.
+- Applies SIEVE eviction using a `visited` bit on each node.
+- Integrates with `dogpile.cache` regions and key generation.
+- Includes an in-memory backend adapter (`sieve_cache.memory`).
+
+## How It Works
+
+When a decorated function is called:
+
+1. A cache key is generated from function arguments.
+2. If the key exists, the node is marked as visited and returned.
+3. On a miss, the function is executed and result cached.
+4. If cache size reaches `max_size`, an item is evicted by SIEVE.
+
+The eviction pointer (`hand`) scans backward, clears `visited=True` nodes,
+and removes the first unvisited candidate.
+
+## Installation
+
+Install from source:
+
+```bash
+pip install sieve-cache
+```
+
+## Quick Usage
+
+```python
+import sieve_cache
+
+cache = sieve_cache.create_sieve(backend="sieve_cache.memory")
+
+@cache.cache(max_size=128)
+def expensive_call(x: int) -> int:
+    return x * x
+
+print(expensive_call(5))
+print(expensive_call(5))  # cached
+```
+
+## Project Layout
+
+- `sieve_cache/sieve.py`: Core SIEVE cache implementation and decorator.
+- `sieve_cache/node.py`: Cache node model used by linked-list structure.
+- `sieve_cache/backends/memory.py`: In-memory `dogpile.cache` backend.
+- `sieve_cache/__init__.py`: Region/backend configuration and factory helpers.
+
+## References
+
+- [SIEVE is Simpler than LRU: an Efficient Turn-Key Eviction Algorithm for Web Caches](https://cachemon.github.io/SIEVE-website/)

sieve_cache-0.0.1/README.md

@@ -0,0 +1,58 @@
+# sieve.cache
+
+`sieve.cache` is a lightweight Python cache utility that implements the
+SIEVE eviction algorithm on top of `dogpile.cache` backends.
+
+## Project Summary
+
+- Implements a `Sieve` cache with a decorator-based API.
+- Uses a doubly linked list (`head`, `tail`, `hand`) to track entries.
+- Applies SIEVE eviction using a `visited` bit on each node.
+- Integrates with `dogpile.cache` regions and key generation.
+- Includes an in-memory backend adapter (`sieve_cache.memory`).
+
+## How It Works
+
+When a decorated function is called:
+
+1. A cache key is generated from function arguments.
+2. If the key exists, the node is marked as visited and returned.
+3. On a miss, the function is executed and result cached.
+4. If cache size reaches `max_size`, an item is evicted by SIEVE.
+
+The eviction pointer (`hand`) scans backward, clears `visited=True` nodes,
+and removes the first unvisited candidate.
+
+## Installation
+
+Install from source:
+
+```bash
+pip install sieve-cache
+```
+
+## Quick Usage
+
+```python
+import sieve_cache
+
+cache = sieve_cache.create_sieve(backend="sieve_cache.memory")
+
+@cache.cache(max_size=128)
+def expensive_call(x: int) -> int:
+    return x * x
+
+print(expensive_call(5))
+print(expensive_call(5))  # cached
+```
+
+## Project Layout
+
+- `sieve_cache/sieve.py`: Core SIEVE cache implementation and decorator.
+- `sieve_cache/node.py`: Cache node model used by linked-list structure.
+- `sieve_cache/backends/memory.py`: In-memory `dogpile.cache` backend.
+- `sieve_cache/__init__.py`: Region/backend configuration and factory helpers.
+
+## References
+
+- [SIEVE is Simpler than LRU: an Efficient Turn-Key Eviction Algorithm for Web Caches](https://cachemon.github.io/SIEVE-website/)

sieve_cache-0.0.1/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs", "hatch-requirements-txt"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sieve.cache"
+dynamic = ["version", "dependencies"]
+description = "A simple implementation of SIEVE caching algorithm"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "Apache-2.0" }
+authors = [
+  { name = "Pham Le Gia Dai", email = "daipham.3213@gmail.com" },
+]
+classifiers = [
+  "Intended Audience :: Information Technology",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+]
+
+[project.optional-dependencies]
+redis = ["redis"]
+
+[project.entry-points."dogpile.cache"]
+"sieve_cache.memory" = "sieve_cache.backends.memory:InMemoryDriver"
+
+[tool.hatch.build.targets.wheel]
+packages = ["sieve_cache"]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.metadata.hooks.requirements_txt]
+files = ["requirements.txt"]
+
+[tool.ruff]
+line-length = 79
+
+[tool.ruff.format]
+docstring-code-format = true

sieve_cache-0.0.1/requirements.txt

@@ -0,0 +1,15 @@
+#  Licensed under the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License. You may obtain
+#  a copy of the License at
+#  #
+#          http://www.apache.org/licenses/LICENSE-2.0
+#  #
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#  License for the specific language governing permissions and limitations
+#  under the License.
+
+stevedore>=5.1.0
+dogpile.cache>=1.3.0
+iso8601>=2.1.0