Merge pull request #9 from datarootsio/expose_cache_info

Expose cache_info

.github/workflows/publish.yml

@@ -76,14 +76,14 @@ jobs:
     runs-on: ubuntu-latest
     needs: [get-new-tag, publish]
     env:
-      POETRY_VERSION: 1.1.7
+      POETRY_VERSION: 1.8.2
     steps:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0
       - uses: actions/setup-python@v2
         with:
-          python-version: 3.7
+          python-version: 3.10
       - name: Install dependencies
         run: |
           pip install poetry==${{ env.POETRY_VERSION }}

.github/workflows/tests.yml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9, "3.10"]
+        python-version: [3.9, "3.10", "3.11", "3.12"]
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}
@@ -15,7 +15,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          pip install poetry==1.1.7
+          pip install poetry==1.8.2
           poetry config virtualenvs.create false
           poetry install --no-interaction --no-ansi
       - name: QA with flake8, black, isort and mypy

.pre-commit-config.yaml

@@ -7,21 +7,12 @@ repos:
       - id: end-of-file-fixer
         exclude: "LICENSE"
       - id: trailing-whitespace
-  - repo: https://github.com/psf/black
-    rev: 22.6.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.3.3
     hooks:
-      - id: black
-  - repo: https://github.com/pycqa/isort
-    rev: 5.10.1
-    hooks:
-      - id: isort
-  - repo: https://github.com/pycqa/flake8
-    rev: 4.0.1
-    hooks:
-      - id: flake8
-        additional_dependencies:
-        - flake8-docstrings==1.6.0
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.942
-    hooks:
-      - id: mypy
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format

expiring_lru_cache/__init__.py

@@ -1,4 +1,5 @@
 """Core functionality."""
+
 import functools
 import logging
 from datetime import datetime, timedelta
@@ -39,7 +40,7 @@ def _expired(cached_func: Callable) -> bool:
 def lru_cache(
     expires_after: Optional[int] = None,
     *args: Union[int, bool],
-    **kwargs: Union[int, bool]
+    **kwargs: Union[int, bool],
 ) -> Callable:
     """
     LRU caching with expiration period.
@@ -65,6 +66,7 @@ def wrapper(*args: Union[int, bool], **kwargs: Union[int, bool]) -> Callable:
                 cached_func = _init_cache(func, expires_after, *args, **kwargs)
             return cached_func(*args, **kwargs)
 
+        wrapper.cache_info = lambda: cached_func.cache_info()
         return wrapper
 
     return decorate

expiring_lru_cache/version.py

@@ -1,2 +1,3 @@
 """Package version information - this file is dynamically overwritten in CI."""
+
 __version__ = "0.0.0-dev"

tests/test_basic.py

@@ -1,4 +1,5 @@
 """Basic testing."""
+
 from datetime import datetime
 from functools import partial
 from time import sleep
@@ -28,3 +29,11 @@ def test_expiration_basic() -> None:
     p = partial(lru_cache(expires_after=2)(lambda: datetime.now()))
     res = call_every_x_secs(p, 4)
     assert any(el != res[0] for el in res)
+
+
+def test_has_cache_info() -> None:
+    """Test if cache has info."""
+    cf = lru_cache()(lambda: 1)
+    for _ in range(3):
+        cf()
+    assert cf.cache_info().hits != 0

tests/test_version.py

@@ -1,4 +1,5 @@
 """Test versioning mechanism."""
+
 import expiring_lru_cache