cachier 2.1.1__py2.py3-none-any.whl → 2.2.1__py2.py3-none-any.whl

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/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.dist-info → cachier-2.2.1.dist-info}/METADATA

@@ -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
@@ -36,6 +36,9 @@ Requires-Dist: bandit ; extra == 'test'
 Requires-Dist: flake8 ; extra == 'test'
 Requires-Dist: pylint ; extra == 'test'
 Requires-Dist: safety ; extra == 'test'
+Requires-Dist: mypy ; extra == 'test'
+Requires-Dist: types-setuptools ; extra == 'test'
+Requires-Dist: pandas-stubs ; extra == 'test'
 Requires-Dist: pymongo ; extra == 'test'
 Requires-Dist: dnspython ; extra == 'test'
 Requires-Dist: pymongo-inmemory ; extra == 'test'
@@ -89,7 +92,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.
@@ -184,6 +187,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`
@@ -301,6 +305,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
@@ -509,5 +517,3 @@ Notable bugfixers:
 .. links:
 .. _pymongo: https://api.mongodb.com/python/current/
 .. _watchdog: https://github.com/gorakhargosh/watchdog
-
-

{cachier-2.1.1.dist-info → cachier-2.2.1.dist-info}/RECORD

@@ -1,15 +1,15 @@
 cachier/__init__.py,sha256=CQhNw1mPDRcR8x5E-rJX0shNQ_j-1MHkY4VdHI0PWSo,232
-cachier/_version.py,sha256=EMoBzs1Tjbo8HerKxp1Oc4S68qE-T_A5YNaLdjma_wU,471
+cachier/_version.py,sha256=53-w9yvhnJKzEivGwM-rvu3FtmFtPgfHpCpO_S55v2c,471
 cachier/base_core.py,sha256=D0czuggU8oKUyTKx3R7dwhEDeOSlvnkojYfHPMpN_dI,3062
-cachier/core.py,sha256=83cm3uRcVppHY-yfkbISqxUU1whHIvTcEjKM5o6Euso,13492
+cachier/core.py,sha256=m8F5GdgukhLDzmsZb-13cC-M_eadh_GkQ_doSHi8038,14548
 cachier/memory_core.py,sha256=u19-9IIYL8Y_9bDZ9cC3k9bE_-QezzLA1qrd_abpIes,2846
 cachier/mongo_core.py,sha256=eur37BnMg8aO_-UA26jDEj2VNSZl352B0U2IWIf72Hc,5022
 cachier/pickle_core.py,sha256=pteQZ1IYaEL7tKagaxt3eeueGXy58weAi4hmMfmbM5A,10068
 cachier/scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cachier/scripts/cli.py,sha256=tMwq1IaD_lxhcc8WMgWh4P0gpi5l6-twCS2YeAKAM98,429
-cachier-2.1.1.dist-info/LICENSE,sha256=-2WrMJkIa0gVP6YQHXXDT7ws-S3M2NEVEF4XF3K8qrY,1069
-cachier-2.1.1.dist-info/METADATA,sha256=8RFpbcb3vVc_V6uUbC1xjlmtWubzBdEXW5iKA-ZG_4M,17955
-cachier-2.1.1.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
-cachier-2.1.1.dist-info/entry_points.txt,sha256=HZPL3TEoT-aieCOvQvsLEDBAuPBSbDNrIjMiDA8h6zE,71
-cachier-2.1.1.dist-info/top_level.txt,sha256=_rW_HiJumDCch67YT-WAgzcyvKg5RiYDMZq9d-0ZpaE,8
-cachier-2.1.1.dist-info/RECORD,,
+cachier-2.2.1.dist-info/LICENSE,sha256=-2WrMJkIa0gVP6YQHXXDT7ws-S3M2NEVEF4XF3K8qrY,1069
+cachier-2.2.1.dist-info/METADATA,sha256=aTiRMVMZ1L5YGl_6Lqwj1tyiDhl-v2TiPRs-YTQenJk,18293
+cachier-2.2.1.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
+cachier-2.2.1.dist-info/entry_points.txt,sha256=lX3uoizHLFaUndwv_d_B-feK3mI2Z3uejU9kufZLcW0,52
+cachier-2.2.1.dist-info/top_level.txt,sha256=_rW_HiJumDCch67YT-WAgzcyvKg5RiYDMZq9d-0ZpaE,8
+cachier-2.2.1.dist-info/RECORD,,

cachier-2.2.1.dist-info/entry_points.txt

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

cachier-2.1.1.dist-info/entry_points.txt

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