Merge branch 'master' into cachelib-class-integration

Author: northernSage

.github/workflows/tests.yml

@@ -25,9 +25,9 @@ jobs:
         include:
           - {name: Linux, python: '3.9', os: ubuntu-latest, tox: py39}
           - {name: '3.8', python: '3.8', os: ubuntu-latest, tox: py38}
-          - {name: '3.7', python: '3.7', os: ubuntu-latest, tox: py37}
           - {name: '3.10', python: '3.10', os: ubuntu-latest, tox: py310}
-          - {name: 'PyPy', python: pypy-3.7, os: ubuntu-latest, tox: pypy37}
+          - {name: '3.11', python: '3.11', os: ubuntu-latest, tox: py311}
+          - {name: 'PyPy', python: pypy-3.8, os: ubuntu-latest, tox: pypy38}
           - {name: 'mypy', python: '3.9', os: ubuntu-latest, tox: typing}
     steps:
     - uses: actions/checkout@v2

.pre-commit-config.yaml

@@ -2,29 +2,29 @@ ci:
   autoupdate_schedule: monthly
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.32.0
+    rev: v3.15.2
     hooks:
       - id: pyupgrade
-        args: ["--py36-plus"]
+        args: ["--py38-plus"]
   - repo: https://github.com/asottile/reorder_python_imports
-    rev: v3.0.1
+    rev: v3.12.0
     hooks:
       - id: reorder-python-imports
         args: ["--application-directories", "src"]
-  - repo: https://github.com/psf/black
-    rev: 22.3.0
-    hooks:
-      - id: black
   - repo: https://github.com/PyCQA/flake8
-    rev: 4.0.1
+    rev: 7.0.0
     hooks:
       - id: flake8
         additional_dependencies:
           - flake8-bugbear
           - flake8-implicit-str-concat
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
+    rev: v4.6.0
     hooks:
       - id: fix-byte-order-marker
       - id: trailing-whitespace
       - id: end-of-file-fixer
+  - repo: https://github.com/psf/black
+    rev: 24.4.2
+    hooks:
+      - id: black

.readthedocs.yaml

@@ -19,4 +19,4 @@ sphinx:
 # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 # python:
 #   install:
-#   - requirements: docs/requirements.txt
+#   - requirements: docs/requirements.txt

CHANGES.rst

@@ -1,7 +1,24 @@
 Changelog
 =========
 
-Version 2.1.0 
+
+Version 2.3.0
+-------------
+
+Released 2024-05-04
+
+- Added ``response_hit_indication`` flag to ``Cache.cached`` decorator for appending 'hit_cache' headers to responses, indicating cache hits.
+
+
+Version 2.2.0
+-------------
+
+- Drop python 3.7 support
+- python 3.11 officially supported
+- Fix issue causing `args_to_ignore` to not work with `flask_caching.Cache.memoize` decorator when keyword arguments were used in the decorated function call
+
+
+Version 2.1.0
 -------------
 
 Released 2024-10-08
@@ -10,6 +27,7 @@ Released 2024-10-08
 - Added docs and example for make_cache_key
 - support Flask 3
 
+
 Version 2.0.2
 -------------
 

docs/index.rst

@@ -143,7 +143,7 @@ from other parameters in a request. An example usecase would be for caching POST
 Where the cache key should be derived from the data in that request, rather than just the
 route/view itself.
 
-``make_cache_key`` can be used to specify such a function. The function should return a 
+``make_cache_key`` can be used to specify such a function. The function should return a
 string which should act like the key to the required value that is being cached::
 
    def make_key():
@@ -406,8 +406,8 @@ The following configuration values exist for Flask-Caching:
                                 deletion process will be ignored. However, if
                                 it is set to ``False`` it will stop on the
                                 first error. This option is only relevant for
-                                the backends **filesystem** and **simple**.
-                                Defaults to ``False``.
+                                the backends **FileSystemCache** and
+                                **SimpleCache**. Defaults to ``False``.
 ``CACHE_THRESHOLD``             The maximum number of items the cache
                                 will store before it starts deleting
                                 some. Used only for SimpleCache and

requirements/dev.txt

@@ -1,159 +1,158 @@
 #
-# This file is autogenerated by pip-compile with python 3.7
-# To update, run:
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
 #
 #    pip-compile dev.in
 #
-alabaster==0.7.12
+alabaster==0.7.16
     # via sphinx
-asgiref==3.7.2
+asgiref==3.8.1
     # via -r tests.in
-babel==2.10.3
+babel==2.15.0
     # via sphinx
-build==0.8.0
+blinker==1.8.2
+    # via flask
+build==1.2.1
     # via pip-tools
-cachelib==0.10.2
+cachelib==0.13.0
     # via -r tests.in
-cachetools==5.3.1
+cachetools==5.3.3
     # via tox
-certifi==2023.7.22
+certifi==2024.2.2
     # via requests
-cfgv==3.3.1
+cfgv==3.4.0
     # via pre-commit
 chardet==5.2.0
     # via tox
-charset-normalizer==2.1.0
+charset-normalizer==3.3.2
     # via requests
-click==8.1.3
+click==8.1.7
     # via
     #   flask
     #   pip-tools
 colorama==0.4.6
     # via tox
-distlib==0.3.7
+distlib==0.3.8
     # via virtualenv
-docutils==0.18.1
+docutils==0.21.2
     # via
     #   sphinx
     #   sphinx-tabs
-filelock==3.12.3
+filelock==3.14.0
     # via
     #   tox
     #   virtualenv
-flask==2.2.5
+flask==3.0.3
     # via -r tests.in
-identify==2.5.2
+identify==2.5.36
     # via pre-commit
-idna==3.3
+idna==3.7
     # via requests
 imagesize==1.4.1
     # via sphinx
-iniconfig==1.1.1
+iniconfig==2.0.0
     # via pytest
-itsdangerous==2.1.2
+itsdangerous==2.2.0
     # via flask
-jinja2==3.1.2
+jinja2==3.1.4
     # via
     #   flask
     #   sphinx
-markupsafe==2.1.1
+markupsafe==2.1.5
     # via
     #   jinja2
     #   werkzeug
-nodeenv==1.7.0
+nodeenv==1.8.0
     # via pre-commit
-packaging==23.1
+packaging==24.0
     # via
     #   build
     #   pallets-sphinx-themes
     #   pyproject-api
     #   pytest
     #   sphinx
     #   tox
-pallets-sphinx-themes==2.0.3
+pallets-sphinx-themes==2.1.3
     # via -r docs.in
-pep517==0.13.0
-    # via build
-pip-tools==7.3.0
+pip-tools==7.4.1
     # via -r dev.in
-platformdirs==3.10.0
+platformdirs==4.2.2
     # via
     #   tox
     #   virtualenv
-pluggy==1.3.0
+pluggy==1.5.0
     # via
     #   pytest
     #   tox
-pre-commit==3.2.2
+pre-commit==3.7.1
     # via -r dev.in
-psutil==5.9.1
-    # via pytest-xprocess
-py==1.11.0
+psutil==5.9.8
     # via pytest-xprocess
-pygments==2.15.0
+pygments==2.18.0
     # via
     #   sphinx
     #   sphinx-tabs
 pylibmc==1.6.3
     # via -r tests.in
 pyproject-api==1.6.1
     # via tox
-pytest==7.3.1
+pyproject-hooks==1.1.0
+    # via
+    #   build
+    #   pip-tools
+pytest==8.2.0
     # via
     #   -r tests.in
     #   pytest-asyncio
     #   pytest-xprocess
-pytest-asyncio==0.21.1
+pytest-asyncio==0.23.7
     # via -r tests.in
-pytest-xprocess==0.22.2
+pytest-xprocess==1.0.2
     # via -r tests.in
-pytz==2022.1
-    # via babel
-pyyaml==6.0
+pyyaml==6.0.1
     # via pre-commit
-redis==5.0.0
+redis==5.0.4
     # via -r tests.in
 requests==2.31.0
     # via sphinx
 snowballstemmer==2.2.0
     # via sphinx
-sphinx==7.2.6
+sphinx==7.3.7
     # via
     #   -r docs.in
     #   pallets-sphinx-themes
     #   sphinx-issues
     #   sphinx-tabs
     #   sphinxcontrib-log-cabinet
-    #   sphinxcontrib-serializinghtml
-sphinx-issues==3.0.1
+sphinx-issues==4.1.0
     # via -r docs.in
-sphinx-tabs==3.4.1
+sphinx-tabs==3.4.5
     # via -r docs.in
-sphinxcontrib-applehelp==1.0.2
+sphinxcontrib-applehelp==1.0.8
     # via sphinx
-sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-devhelp==1.0.6
     # via sphinx
-sphinxcontrib-htmlhelp==2.0.0
+sphinxcontrib-htmlhelp==2.0.5
     # via sphinx
 sphinxcontrib-jsmath==1.0.1
     # via sphinx
 sphinxcontrib-log-cabinet==1.0.1
     # via -r docs.in
-sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-qthelp==1.0.7
     # via sphinx
-sphinxcontrib-serializinghtml==1.1.9
+sphinxcontrib-serializinghtml==1.1.10
     # via sphinx
-tox==4.11.0
+tox==4.15.0
     # via -r dev.in
-urllib3==1.26.17
+urllib3==2.2.1
     # via requests
-virtualenv==20.24.4
+virtualenv==20.26.2
     # via
     #   pre-commit
     #   tox
-werkzeug==2.2.3
+werkzeug==3.0.3
     # via flask
-wheel==0.38.1
+wheel==0.43.0
     # via pip-tools
 
 # The following packages are considered to be unsafe in a requirements file: