cachier 2.1.1__tar.gz → 2.2.1__tar.gz

{cachier-2.1.1 → cachier-2.2.1}/.coveragerc

@@ -15,3 +15,6 @@ exclude_lines =
 
     # Don't complain if tests don't hit defensive assertion code:
     raise NotImplementedError
+
+    # Is only true when running mypy, not tests
+    if TYPE_CHECKING:

{cachier-2.1.1 → cachier-2.2.1}/.github/workflows/lint.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.10']
+        python-version: ["3.10"]
         os: [ubuntu-latest]
 
     steps:
@@ -22,15 +22,17 @@ jobs:
       - name: set up python '3.10'
         uses: actions/setup-python@v4.5.0
         with:
-          python-version: '3.10'
+          python-version: "3.10"
 
       # Install your linters here
-      - name: Install flake8
+      - name: Install linters
         run: |
-          python -m pip install flake8
+          python -m pip install -e ".[test]"
+
       - name: Run linters
         uses: wearerequired/lint-action@v2.3.0
         with:
           flake8: true
+          mypy: true
           continue_on_error: false
           # Enable your linters here

{cachier-2.1.1 → cachier-2.2.1}/.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.7, 3.8, 3.9, '3.10']
+        python-version: [3.8, 3.9, '3.10', '3.11']
         os: [ubuntu-latest, macOS-latest, windows-latest]
 
     steps:
@@ -35,6 +35,6 @@ jobs:
         run: |
           pytest
       - name: "Upload coverage to Codecov"
-        uses: codecov/codecov-action@v3.1.1
+        uses: codecov/codecov-action@v3
         with:
           fail_ci_if_error: true

{cachier-2.1.1 → cachier-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cachier
-Version: 2.1.1
+Version: 2.2.1
 Summary: Persistent, stale-free, local and cross-machine caching for Python functions.
 Home-page: https://github.com/python-cachier/cachier
 Author: Shay Palachy
@@ -14,10 +14,10 @@ Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Utilities
@@ -72,7 +72,7 @@ Features
 ========
 
 * Pure Python.
-* Compatible with Python 3.5+ (and Python 2.7 up until version 1.2.8).
+* Compatible with Python 3.8+ (Python 2.7 was discontinued in version 1.2.8).
 * Supported and `tested on Linux, OS X and Windows <https://travis-ci.org/shaypal5/cachier>`_.
 * A simple interface.
 * Defining "shelf life" for cached values.
@@ -167,6 +167,7 @@ The following parameters will only be applied to decorators defined after `set_d
 
 These parameters can be changed at any time and they will apply to all decorators:
 
+*  `allow_none`
 *  `caching_enabled`
 *  `stale_after`
 *  `next_time`
@@ -284,6 +285,10 @@ Verbose Cache Call
 
 You can have ``cachier`` print out a detailed explanation of the logic of a specific call by passing ``verbose_cache=True`` to the function call. This can be useful if you are not sure why a certain function result is, or is not, returned.
 
+Cache `None` Values
+~~~~~~~~~~~~~~~~~~~
+
+By default, ``cachier`` does not cache ``None`` values. You can override this behaviour by passing ``allow_none=True`` to the function call.
 
 
 Cachier Cores
@@ -492,5 +497,3 @@ Notable bugfixers:
 .. links:
 .. _pymongo: https://api.mongodb.com/python/current/
 .. _watchdog: https://github.com/gorakhargosh/watchdog
-
-

{cachier-2.1.1 → cachier-2.2.1}/README.rst

@@ -44,7 +44,7 @@ Features
 ========
 
 * Pure Python.
-* Compatible with Python 3.5+ (and Python 2.7 up until version 1.2.8).
+* Compatible with Python 3.8+ (Python 2.7 was discontinued in version 1.2.8).
 * Supported and `tested on Linux, OS X and Windows <https://travis-ci.org/shaypal5/cachier>`_.
 * A simple interface.
 * Defining "shelf life" for cached values.
@@ -139,6 +139,7 @@ The following parameters will only be applied to decorators defined after `set_d
 
 These parameters can be changed at any time and they will apply to all decorators:
 
+*  `allow_none`
 *  `caching_enabled`
 *  `stale_after`
 *  `next_time`
@@ -256,6 +257,10 @@ Verbose Cache Call
 
 You can have ``cachier`` print out a detailed explanation of the logic of a specific call by passing ``verbose_cache=True`` to the function call. This can be useful if you are not sure why a certain function result is, or is not, returned.
 
+Cache `None` Values
+~~~~~~~~~~~~~~~~~~~
+
+By default, ``cachier`` does not cache ``None`` values. You can override this behaviour by passing ``allow_none=True`` to the function call.
 
 
 Cachier Cores

{cachier-2.1.1 → cachier-2.2.1}/cachier/_version.py

@@ -11,8 +11,8 @@ version_json = '''
 {
  "dirty": false,
  "error": null,
- "full-revisionid": "7bd2c7797bad62a6fc4ba4ddc04289426ea1115c",
- "version": "2.1.1"
+ "full-revisionid": "5776ee8d63c8a5719ccd3737f0f504bc1a7eb679",
+ "version": "2.2.1"
 }
 '''  # END VERSION_JSON
 

{cachier-2.1.1 → cachier-2.2.1}/cachier/core.py

@@ -8,24 +8,25 @@
 # Copyright (c) 2016, Shay Palachy <shaypal5@gmail.com>
 
 # python 2 compatibility
-from __future__ import absolute_import
-from __future__ import division
-from __future__ import print_function
-
-import os
-from functools import wraps
-from warnings import warn
+from __future__ import absolute_import, division, print_function
 
 import datetime
 import functools
 import hashlib
+import os
 import pickle
 from concurrent.futures import ThreadPoolExecutor
+from functools import wraps
+from typing import TYPE_CHECKING, Callable, Literal, Optional, TypedDict, Union
+from warnings import warn
 
-from .base_core import RecalculationNeeded
-from .pickle_core import _PickleCore
-from .mongo_core import _MongoCore
+from .base_core import RecalculationNeeded, _BaseCore
 from .memory_core import _MemoryCore
+from .mongo_core import _MongoCore
+from .pickle_core import _PickleCore
+
+if TYPE_CHECKING:
+    import pymongo.collection
 
 
 MAX_WORKERS_ENVAR_NAME = 'CACHIER_MAX_WORKERS'
@@ -92,7 +93,26 @@ class MissingMongetter(ValueError):
     """Thrown when the mongetter keyword argument is missing."""
 
 
-_default_params = {
+HashFunc = Callable[..., str]
+Mongetter = Callable[[], "pymongo.collection.Collection"]
+Backend = Literal["pickle", "mongo", "memory"]
+
+
+class Params(TypedDict):
+    caching_enabled: bool
+    hash_func: HashFunc
+    backend: Backend
+    mongetter: Optional[Mongetter]
+    stale_after: datetime.timedelta
+    next_time: bool
+    cache_dir: Union[str, os.PathLike]
+    pickle_reload: bool
+    separate_files: bool
+    wait_for_calc_timeout: int
+    allow_none: bool
+
+
+_default_params: Params = {
     'caching_enabled': True,
     'hash_func': _default_hash_func,
     'backend': 'pickle',
@@ -103,20 +123,22 @@ _default_params = {
     'pickle_reload': True,
     'separate_files': False,
     'wait_for_calc_timeout': 0,
+    'allow_none': False,
 }
 
 
 def cachier(
-    hash_func=None,
-    hash_params=None,
-    backend=None,
-    mongetter=None,
-    stale_after=None,
-    next_time=None,
-    cache_dir=None,
-    pickle_reload=None,
-    separate_files=None,
-    wait_for_calc_timeout=None,
+    hash_func: Optional[HashFunc] = None,
+    hash_params: Optional[HashFunc] = None,
+    backend: Optional[Backend] = None,
+    mongetter: Optional[Mongetter] = None,
+    stale_after: Optional[datetime.timedelta] = None,
+    next_time: Optional[bool] = None,
+    cache_dir: Optional[Union[str, os.PathLike]] = None,
+    pickle_reload: Optional[bool] = None,
+    separate_files: Optional[bool] = None,
+    wait_for_calc_timeout: Optional[int] = None,
+    allow_none: Optional[bool] = None,
 ):
     """A persistent, stale-free memoization decorator.
 
@@ -170,6 +192,9 @@ def cachier(
         True, any process trying to read the same entry will wait a maximum of
         seconds specified in this parameter. 0 means wait forever.
         Once the timeout expires the calculation will be triggered.
+    allow_none: bool, optional
+        Allows storing None values in the cache. If False, functions returning
+        None will not be cached and are recalculated every call.
     """
     # Check for deprecated parameters
     if hash_params is not None:
@@ -184,6 +209,7 @@ def cachier(
         backend = 'mongo'
     if backend is None:
         backend = _default_params['backend']
+    core: _BaseCore
     if backend == 'pickle':
         core = _PickleCore(  # pylint: disable=R0204
             hash_func=hash_func,
@@ -208,11 +234,6 @@ def cachier(
             hash_func=hash_func,
             default_params=_default_params,
         )
-    elif backend == 'redis':
-        raise NotImplementedError(
-            'A Redis backend has not yet been implemented. '
-            'Please see https://github.com/python-cachier/cachier/issues/4'
-        )
     else:
         raise ValueError('specified an invalid core: {}'.format(backend))
 
@@ -221,6 +242,12 @@ def cachier(
 
         @wraps(func)
         def func_wrapper(*args, **kwds):  # pylint: disable=C0111,R0911
+            nonlocal allow_none
+            _allow_none = (
+                allow_none
+                if allow_none is not None else
+                _default_params['allow_none']
+            )
             # print('Inside general wrapper for {}.'.format(func.__name__))
             ignore_cache = kwds.pop('ignore_cache', False)
             overwrite_cache = kwds.pop('overwrite_cache', False)
@@ -238,7 +265,7 @@ def cachier(
                 return _calc_entry(core, key, func, args, kwds)
             if entry is not None:  # pylint: disable=R0101
                 _print('Entry found.')
-                if entry.get('value', None) is not None:
+                if (_allow_none or entry.get('value', None) is not None):
                     _print('Cached result found.')
                     local_stale_after = stale_after if stale_after is not None else _default_params['stale_after']  # noqa: E501
                     local_next_time = next_time if next_time is not None else _default_params['next_time']  # noqa: E501

{cachier-2.1.1 → cachier-2.2.1}/cachier.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cachier
-Version: 2.1.1
+Version: 2.2.1
 Summary: Persistent, stale-free, local and cross-machine caching for Python functions.
 Home-page: https://github.com/python-cachier/cachier
 Author: Shay Palachy
@@ -14,10 +14,10 @@ Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Utilities
@@ -72,7 +72,7 @@ Features
 ========
 
 * Pure Python.
-* Compatible with Python 3.5+ (and Python 2.7 up until version 1.2.8).
+* Compatible with Python 3.8+ (Python 2.7 was discontinued in version 1.2.8).
 * Supported and `tested on Linux, OS X and Windows <https://travis-ci.org/shaypal5/cachier>`_.
 * A simple interface.
 * Defining "shelf life" for cached values.
@@ -167,6 +167,7 @@ The following parameters will only be applied to decorators defined after `set_d
 
 These parameters can be changed at any time and they will apply to all decorators:
 
+*  `allow_none`
 *  `caching_enabled`
 *  `stale_after`
 *  `next_time`
@@ -284,6 +285,10 @@ Verbose Cache Call
 
 You can have ``cachier`` print out a detailed explanation of the logic of a specific call by passing ``verbose_cache=True`` to the function call. This can be useful if you are not sure why a certain function result is, or is not, returned.
 
+Cache `None` Values
+~~~~~~~~~~~~~~~~~~~
+
+By default, ``cachier`` does not cache ``None`` values. You can override this behaviour by passing ``allow_none=True`` to the function call.
 
 
 Cachier Cores
@@ -492,5 +497,3 @@ Notable bugfixers:
 .. links:
 .. _pymongo: https://api.mongodb.com/python/current/
 .. _watchdog: https://github.com/gorakhargosh/watchdog
-
-

{cachier-2.1.1 → cachier-2.2.1}/cachier.egg-info/SOURCES.txt

@@ -10,6 +10,7 @@
 LICENSE
 MANIFEST.in
 README.rst
+mypy.ini
 pytest.ini
 setup.cfg
 setup.py
@@ -24,6 +25,7 @@ cachier/core.py
 cachier/memory_core.py
 cachier/mongo_core.py
 cachier/pickle_core.py
+cachier/py.typed
 cachier.egg-info/PKG-INFO
 cachier.egg-info/SOURCES.txt
 cachier.egg-info/dependency_links.txt

cachier-2.2.1/cachier.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+cachier = cachier.scripts.cli:cli

{cachier-2.1.1 → cachier-2.2.1}/cachier.egg-info/requires.txt

@@ -11,6 +11,9 @@ bandit
 flake8
 pylint
 safety
+mypy
+types-setuptools
+pandas-stubs
 pymongo
 dnspython
 pymongo-inmemory

cachier-2.2.1/mypy.ini

@@ -0,0 +1,11 @@
+[mypy]
+show_column_numbers=true
+show_error_codes=true
+strict_equality=true
+warn_unused_ignores=true
+warn_redundant_casts=true
+warn_unreachable=true
+warn_return_any=false
+
+[mypy-pymongo_inmemory.*]
+ignore_missing_imports = True

{cachier-2.1.1 → cachier-2.2.1}/setup.py

@@ -10,16 +10,17 @@
 try:
     from setuptools import setup
 except ImportError:
-    from distutils.core import setup
+    from distutils.core import setup  # type: ignore
 
 import versioneer
 
-
 TEST_REQUIRES = [
     # tests and coverages
     'pytest', 'coverage', 'pytest-cov',
     # linting and code quality
     'bandit', 'flake8', 'pylint', 'safety',
+    # type checking
+    'mypy', 'types-setuptools', 'pandas-stubs',
     # to connect to the test mongodb server
     'pymongo', 'dnspython', 'pymongo-inmemory',
     # to test pandas dataframe as-param hashing with mongodb core
@@ -66,10 +67,10 @@ setup(
         'License :: OSI Approved :: MIT License',
         'Programming Language :: Python',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
         'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
         'Topic :: Software Development :: Libraries',
         'Topic :: Software Development :: Libraries :: Python Modules',
         'Topic :: Utilities',

{cachier-2.1.1 → cachier-2.2.1}/tests/test_core_lookup.py

@@ -7,6 +7,7 @@ from cachier.core import MissingMongetter
 def test_get_default_params():
     params = get_default_params()
     assert tuple(sorted(params)) == (
+        'allow_none',
         'backend',
         'cache_dir',
         'caching_enabled',

{cachier-2.1.1 → cachier-2.2.1}/tests/test_defaults.py

@@ -1,16 +1,15 @@
 import datetime
 import os
-import pytest
 import queue
 import random
 import tempfile
 import threading
 import time
 
-import cachier
-
-from tests.test_mongo_core import _test_mongetter, MONGO_DELTA
+import pytest
 
+import cachier
+from tests.test_mongo_core import MONGO_DELTA, _test_mongetter
 
 _default_params = cachier.get_default_params().copy()
 
@@ -125,6 +124,40 @@ def test_separate_files_default_param():
     assert len(os.listdir(cache_dir_2)) == 1
 
 
+def test_allow_none_default_param():
+    cachier.set_default_params(
+        allow_none=True,
+        separate_files=True,
+        verbose_cache=True,
+    )
+    allow_count = 0
+    disallow_count = 0
+
+    @cachier.cachier(cache_dir=tempfile.mkdtemp())
+    def allow_none():
+        nonlocal allow_count
+        allow_count += 1
+        return None
+
+    @cachier.cachier(cache_dir=tempfile.mkdtemp(), allow_none=False)
+    def disallow_none():
+        nonlocal disallow_count
+        disallow_count += 1
+        return None
+
+    allow_none.clear_cache()
+    assert allow_count == 0
+    allow_none()
+    allow_none()
+    assert allow_count == 1
+
+    disallow_none.clear_cache()
+    assert disallow_count == 0
+    disallow_none()
+    disallow_none()
+    assert disallow_count == 2
+
+
 parametrize_keys = 'backend,mongetter'
 parametrize_values = [
     pytest.param('pickle', None, marks=pytest.mark.pickle),

{cachier-2.1.1 → cachier-2.2.1}/tests/test_general.py

@@ -1,6 +1,7 @@
 """Non-core-specific tests for cachier."""
 
 from __future__ import print_function
+
 import functools
 import os
 import queue
@@ -8,18 +9,20 @@ import subprocess  # nosec: B404
 import threading
 from random import random
 from time import sleep, time
+
 import pytest
+
 import cachier
 from cachier.core import (
-    MAX_WORKERS_ENVAR_NAME,
     DEFAULT_MAX_WORKERS,
+    MAX_WORKERS_ENVAR_NAME,
+    _get_executor,
     _max_workers,
     _set_max_workers,
-    _get_executor
 )
 from tests.test_mongo_core import (
-    _test_mongetter,
     MONGO_DELTA_LONG,
+    _test_mongetter,
 )
 
 
@@ -240,3 +243,35 @@ def test_global_disable():
     result_4 = get_random()
     assert result_1 == result_2 == result_4
     assert result_1 != result_3
+
+
+def test_none_not_cached_by_default():
+    count = 0
+
+    @cachier.cachier()
+    def do_operation():
+        nonlocal count
+        count += 1
+        return None
+
+    do_operation.clear_cache()
+    assert count == 0
+    do_operation()
+    do_operation()
+    assert count == 2
+
+
+def test_allow_caching_none():
+    count = 0
+
+    @cachier.cachier(allow_none=True)
+    def do_operation():
+        nonlocal count
+        count += 1
+        return None
+
+    do_operation.clear_cache()
+    assert count == 0
+    do_operation()
+    do_operation()
+    assert count == 1

{cachier-2.1.1 → cachier-2.2.1}/tests/test_mongo_core.py

@@ -1,27 +1,25 @@
 """Testing the MongoDB core of cachier."""
 
-import sys
-import platform
 import datetime
+import hashlib
+import platform
+import queue
+import sys
+import threading
 from datetime import timedelta
 from random import random
 from time import sleep
-import threading
-import queue
 
-import pytest
-import pymongo
-import hashlib
 import pandas as pd
+import pymongo
+import pytest
 from pymongo.errors import OperationFailure
+from pymongo_inmemory import MongoClient
 
 from cachier import cachier
 from cachier.base_core import RecalculationNeeded
 from cachier.mongo_core import _MongoCore
 
-from pymongo_inmemory import MongoClient
-
-
 _COLLECTION_NAME = 'cachier_test_{}_{}.{}.{}'.format(
     platform.system(), sys.version_info[0], sys.version_info[1],
     sys.version_info[2])

{cachier-2.1.1 → cachier-2.2.1}/tests/test_pickle_core.py

@@ -13,22 +13,20 @@
 # )
 import os
 import pickle
-from time import (
-    time,
-    sleep
-)
+import threading
 from datetime import timedelta
 from random import random
-import threading
+from time import sleep, time
 
 import pytest
 
 try:
     import queue
 except ImportError:  # python 2
-    import Queue as queue
+    import Queue as queue  # type: ignore
 
 import hashlib
+
 import pandas as pd
 
 from cachier import cachier
@@ -376,7 +374,7 @@ def _helper_bad_cache_file(sleeptime, separate_files):
     if not isinstance(res1, float):
         return False
     res2 = res_queue.get()
-    if not (res2 is None) or isinstance(res2, KeyError):
+    if res2 is not None or isinstance(res2, KeyError):
         return False
     return True
 

{cachier-2.1.1 → cachier-2.2.1}/versioneer.py

@@ -349,10 +349,11 @@ https://creativecommons.org/publicdomain/zero/1.0/ .
 """
 
 from __future__ import print_function
+
 try:
     import configparser
 except ImportError:
-    import ConfigParser as configparser
+    import ConfigParser as configparser  # type: ignore
 import errno
 import json
 import os
@@ -1547,7 +1548,7 @@ def get_cmdclass():
     cmds["build_py"] = cmd_build_py
 
     if "cx_Freeze" in sys.modules:  # cx_freeze enabled?
-        from cx_Freeze.dist import build_exe as _build_exe
+        from cx_Freeze.dist import build_exe as _build_exe  # type: ignore[import]
 
         class cmd_build_exe(_build_exe):
             def run(self):

cachier-2.1.1/cachier.egg-info/entry_points.txt

@@ -1,4 +0,0 @@
-
-        [console_scripts]
-        cachier=cachier.scripts.cli:cli
-