cachier 3.0.0__py3-none-any.whl → 3.0.1__py3-none-any.whl

cachier/__main__.py

@@ -7,7 +7,7 @@ from cachier.core import _set_max_workers
 
 @click.group()
 def cli():
-    """A command-line interface for cachier."""
+    """A command-line interface for cachier."""  # noqa: D401
 
 
 @cli.command("Limits the number of worker threads used by cachier.")

cachier/config.py

@@ -17,6 +17,8 @@ def _default_hash_func(args, kwds):
 
 
 class Params(TypedDict):
+    """Type definition for cachier parameters."""
+
     caching_enabled: bool
     hash_func: HashFunc
     backend: Backend

cachier/core.py

@@ -118,7 +118,7 @@ def cachier(
     wait_for_calc_timeout: Optional[int] = None,
     allow_none: Optional[bool] = None,
 ):
-    """A persistent, stale-free memoization decorator.
+    """Wrap as a persistent, stale-free memoization decorator.
 
     The positional and keyword arguments to the wrapped function must be
     hashable (i.e. Python's immutable built-in objects, not mutable
@@ -127,13 +127,14 @@ def cachier(
     value is their id), equal objects across different sessions will not yield
     identical keys.
 
-    Arguments
+    Arguments:
     ---------
     hash_func : callable, optional
         A callable that gets the args and kwargs from the decorated function
         and returns a hash key for them. This parameter can be used to enable
         the use of cachier with functions that get arguments that are not
         automatically hashable by Python.
+    hash_params : callable, optional
     backend : str, optional
         The name of the backend to use. Valid options currently include
         'pickle', 'mongo' and 'memory'. If not provided, defaults to
@@ -244,8 +245,12 @@ def cachier(
             if verbose:
                 _print = print
             if ignore_cache or not _default_params["caching_enabled"]:
-                return func(**kwargs)
-            key, entry = core.get_entry(tuple(), kwargs)
+                return (
+                    func(args[0], **kwargs)
+                    if core.func_is_method
+                    else func(**kwargs)
+                )
+            key, entry = core.get_entry((), kwargs)
             if overwrite_cache:
                 return _calc_entry(core, key, func, args, kwds)
             if entry is None:
@@ -294,17 +299,17 @@ def cachier(
             core.clear_cache()
 
         def _clear_being_calculated():
-            """Marks all entries in this cache as not being calculated."""
+            """Mark all entries in this cache as not being calculated."""
             core.clear_being_calculated()
 
         def _cache_dpath():
-            """Returns the path to the cache dir, if exists; None if not."""
+            """Return the path to the cache dir, if exists; None if not."""
             return getattr(core, "cache_dir", None)
 
-        def _precache_value(*args, value_to_cache, **kwds):
+        def _precache_value(*args, value_to_cache, **kwds):  # noqa: D417
             """Add an initial value to the cache.
 
-            Arguments
+            Arguments:
             ---------
             value_to_cache : any
                 entry to be written into the cache
@@ -314,7 +319,7 @@ def cachier(
             kwargs = _convert_args_kwargs(
                 func, _is_method=core.func_is_method, args=args, kwds=kwds
             )
-            return core.precache_value(tuple(), kwargs, value_to_cache)
+            return core.precache_value((), kwargs, value_to_cache)
 
         func_wrapper.clear_cache = _clear_cache
         func_wrapper.clear_being_calculated = _clear_being_calculated

cachier/cores/base.py

@@ -16,6 +16,8 @@ from ..config import _update_with_defaults
 
 
 class RecalculationNeeded(Exception):
+    """Exception raised when a recalculation is needed."""
+
     pass
 
 
@@ -32,7 +34,7 @@ class _BaseCore:
         self.lock = threading.RLock()
 
     def set_func(self, func):
-        """Sets the function this core will use.
+        """Set the function this core will use.
 
         This has to be set before any method is called. Also determine if the
         function is an object method.
@@ -46,17 +48,21 @@ class _BaseCore:
         self.func = func
 
     def get_key(self, args, kwds):
-        """Returns a unique key based on the arguments provided."""
+        """Return a unique key based on the arguments provided."""
         return self.hash_func(args, kwds)
 
     def get_entry(self, args, kwds):
-        """Returns the result mapped to the given arguments in this core's
-        cache, if such a mapping exists."""
+        """Get entry based on given arguments.
+
+        Return the result mapped to the given arguments in this core's cache,
+        if such a mapping exists.
+
+        """
         key = self.get_key(args, kwds)
         return self.get_entry_by_key(key)
 
     def precache_value(self, args, kwds, value_to_cache):
-        """Writes a precomputed value into the cache."""
+        """Write a precomputed value into the cache."""
         key = self.get_key(args, kwds)
         self.set_entry(key, value_to_cache)
         return value_to_cache
@@ -71,30 +77,33 @@ class _BaseCore:
 
     @abc.abstractmethod
     def get_entry_by_key(self, key):
-        """Returns the result mapped to the given key in this core's cache, if
-        such a mapping exists."""
+        """Get entry based on given key.
+
+        Return the result mapped to the given key in this core's cache, if such
+        a mapping exists.
+
+        """
 
     @abc.abstractmethod
     def set_entry(self, key, func_res):
-        """Maps the given result to the given key in this core's cache."""
+        """Map the given result to the given key in this core's cache."""
 
     @abc.abstractmethod
     def mark_entry_being_calculated(self, key):
-        """Marks the entry mapped by the given key as being calculated."""
+        """Mark the entry mapped by the given key as being calculated."""
 
     @abc.abstractmethod
     def mark_entry_not_calculated(self, key):
-        """Marks the entry mapped by the given key as not being calculated."""
+        """Mark the entry mapped by the given key as not being calculated."""
 
     @abc.abstractmethod
     def wait_on_entry_calc(self, key):
-        """Waits on the entry mapped by key being calculated and returns
-        result."""
+        """Wait on the entry with keys being calculated and returns result."""
 
     @abc.abstractmethod
     def clear_cache(self):
-        """Clears the cache of this core."""
+        """Clear the cache of this core."""
 
     @abc.abstractmethod
     def clear_being_calculated(self):
-        """Marks all entries in this cache as not being calculated."""
+        """Mark all entries in this cache as not being calculated."""

cachier/cores/mongo.py

@@ -41,8 +41,9 @@ class _MongoCore(_BaseCore):
     ):
         if "pymongo" not in sys.modules:
             warnings.warn(
-                "Cachier warning: pymongo was not found. "
-                "MongoDB cores will not function."
+                "`pymongo` was not found. MongoDB cores will not function.",
+                ImportWarning,
+                stacklevel=2,
             )  # pragma: no cover
 
         super().__init__(hash_func, wait_for_calc_timeout)

cachier/cores/pickle.py

@@ -62,11 +62,11 @@ class _PickleCore(_BaseCore):
                 self.observer.stop()
 
         def on_created(self, event):
-            """A Watchdog Event Handler method."""
+            """A Watchdog Event Handler method."""  # noqa: D401
             self._check_calculation()  # pragma: no cover
 
         def on_modified(self, event):
-            """A Watchdog Event Handler method."""
+            """A Watchdog Event Handler method."""  # noqa: D401
             self._check_calculation()
 
     def __init__(
@@ -115,9 +115,9 @@ class _PickleCore(_BaseCore):
                 self._reload_cache()
             return self.cache
 
-    def _get_cache_by_key(self, key=None, hash=None):
+    def _get_cache_by_key(self, key=None, hash_str=None):
         fpath = self.cache_fpath
-        fpath += f"_{key}" if hash is None else f"_{hash}"
+        fpath += f"_{hash_str or key}"
         try:
             with portalocker.Lock(fpath, mode="rb") as cache_file:
                 return pickle.load(cache_file)  # noqa: S301
@@ -134,17 +134,17 @@ class _PickleCore(_BaseCore):
         path, name = os.path.split(self.cache_fpath)
         for subpath in os.listdir(path):
             if subpath.startswith(name):
-                entry = self._get_cache_by_key(hash=subpath.split("_")[-1])
+                entry = self._get_cache_by_key(hash_str=subpath.split("_")[-1])
                 if entry is not None:
                     entry["being_calculated"] = False
-                    self._save_cache(entry, hash=subpath.split("_")[-1])
+                    self._save_cache(entry, hash_str=subpath.split("_")[-1])
 
-    def _save_cache(self, cache, key=None, hash=None):
+    def _save_cache(self, cache, key=None, hash_str=None):
         fpath = self.cache_fpath
         if key is not None:
             fpath += f"_{key}"
-        elif hash is not None:
-            fpath += f"_{hash}"
+        elif hash_str is not None:
+            fpath += f"_{hash_str}"
         with self.lock:
             self.cache = cache
             with portalocker.Lock(fpath, mode="wb") as cache_file:

cachier/version.info

@@ -1 +1 @@
-3.0.0
+3.0.1

{cachier-3.0.0.dist-info → cachier-3.0.1.dist-info}/METADATA

@@ -1,33 +1,50 @@
 Metadata-Version: 2.1
 Name: cachier
-Version: 3.0.0
+Version: 3.0.1
 Summary: Persistent, stale-free, local and cross-machine caching for Python functions.
-Home-page: https://github.com/python-cachier/cachier
-Author: Shay Palachy & al.
-Author-email: shay.palachy@gmail.com
-License: MIT
-Keywords: cache,persistence,mongo,memoization,decorator
-Platform: linux
-Platform: osx
-Platform: windows
+Author-email: Shay Palachy Affek <shay.palachy@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2016 Shay Palachy
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Source, https://github.com/python-cachier/cachier
+Keywords: cache,caching,cross-machine,decorator,local,memoization,mongo,persistent
 Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
 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: Programming Language :: Python :: 3.12
+Classifier: Topic :: Other/Nonlisted Topic
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Utilities
-Classifier: Topic :: Other/Nonlisted Topic
-Classifier: Intended Audience :: Developers
+Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: watchdog >=2.3.1
-Requires-Dist: portalocker >=2.3.2
-Requires-Dist: setuptools >=67.6.0
+Requires-Dist: portalocker>=2.3.2
+Requires-Dist: watchdog>=2.3.1
 
 Cachier
 #######
@@ -492,8 +509,8 @@ Notable bugfixers:
 .. |PyPI-Versions| image:: https://img.shields.io/pypi/pyversions/cachier.svg
    :target: https://pypi.python.org/pypi/cachier
 
-.. |Build-Status| image:: https://github.com/python-cachier/cachier/actions/workflows/test.yml/badge.svg
-  :target: https://github.com/python-cachier/cachier/actions/workflows/test.yml
+.. |Build-Status| image:: https://github.com/python-cachier/cachier/actions/workflows/ci-test.yml/badge.svg
+  :target: https://github.com/python-cachier/cachier/actions/workflows/ci-test.yml
 
 .. |LICENCE| image:: https://img.shields.io/pypi/l/cachier.svg
   :target: https://pypi.python.org/pypi/cachier

cachier-3.0.1.dist-info/RECORD

@@ -0,0 +1,19 @@
+cachier/__init__.py,sha256=6i43oFM_ZTp47b6R8Ws2vvf2JXLvbn-TKzWESwBDb-M,304
+cachier/__main__.py,sha256=upg-TlHs1vngKYvkjoPpl3Pvl6xOx4ut-M1mElMiAo0,443
+cachier/_types.py,sha256=EGJMiw-oCIC_cDLyzw7YC40lfo8jnD3zMmoJpA9Y8Iw,238
+cachier/_version.py,sha256=yE6UYwvdoIRpw3HmNifiGwV3fqVea5PwZj_EvyosiZ8,1079
+cachier/config.py,sha256=JJutAeOlNjDobNWKteTvcvdj_Pfemk6_dMKIGFtW6UM,2754
+cachier/core.py,sha256=x0I-Ot2dt7wThu2j8iLXPYvv8exwp4xXMUQIQyImr64,13261
+cachier/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cachier/version.info,sha256=BuP-SnoYhNINgcxwZcqM_Uw5TsYCxNGA3cObvU99pSE,6
+cachier/cores/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cachier/cores/base.py,sha256=i6xlR3Em_s6rVER5Uyf1kK86KcaWtb84iKwS9bgDZGI,3465
+cachier/cores/memory.py,sha256=JFXnXBAeP0nOXOf_vNgpcEuRNjxre8WQjiUBa7yEYmY,3128
+cachier/cores/mongo.py,sha256=Ez3SNZzAzELO9c_SrGlOX855-5UEPBViabWPjkQnFc0,4917
+cachier/cores/pickle.py,sha256=fVajLzlhUkQ9ochLWAZnDQQZJPXj0lWl7mgalI-z2x0,8903
+cachier-3.0.1.dist-info/LICENSE,sha256=-2WrMJkIa0gVP6YQHXXDT7ws-S3M2NEVEF4XF3K8qrY,1069
+cachier-3.0.1.dist-info/METADATA,sha256=JZCfPStwVwwhYrdvT_Vkmm2FrfqYc2rUGtExGh86DGI,20102
+cachier-3.0.1.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+cachier-3.0.1.dist-info/entry_points.txt,sha256=x4Y7t6Y0Qev_3fgG-Jv7TrsvVdJty3FnGAdkT8-_5mY,49
+cachier-3.0.1.dist-info/top_level.txt,sha256=_rW_HiJumDCch67YT-WAgzcyvKg5RiYDMZq9d-0ZpaE,8
+cachier-3.0.1.dist-info/RECORD,,

{cachier-3.0.0.dist-info → cachier-3.0.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (72.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

cachier-3.0.1.dist-info/entry_points.txt

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

cachier-3.0.0.dist-info/RECORD

@@ -1,19 +0,0 @@
-cachier/__init__.py,sha256=6i43oFM_ZTp47b6R8Ws2vvf2JXLvbn-TKzWESwBDb-M,304
-cachier/__main__.py,sha256=g8dgovKdDgOMgNIpnmzVRuI5Dj5xODTav45TpZlH_iA,429
-cachier/_types.py,sha256=EGJMiw-oCIC_cDLyzw7YC40lfo8jnD3zMmoJpA9Y8Iw,238
-cachier/_version.py,sha256=yE6UYwvdoIRpw3HmNifiGwV3fqVea5PwZj_EvyosiZ8,1079
-cachier/config.py,sha256=xEWpt_BeaqtrdDdZPnvZN_O3Wp4h6X9_6FfBpMeQZPw,2703
-cachier/core.py,sha256=IdLT2sfguDSvtCyX1EJfgCQnbEDECil1U2JhO5wBP5U,13080
-cachier/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cachier/version.info,sha256=KYW-iyjTrehY6Nj7S8IvVlsb9gIN_5gtzhQfdyG5mZw,6
-cachier/cores/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cachier/cores/base.py,sha256=cxtcDfRttGU6YBtq7aO9mAqzEza2y7KhHDZhRbv-aOU,3324
-cachier/cores/memory.py,sha256=JFXnXBAeP0nOXOf_vNgpcEuRNjxre8WQjiUBa7yEYmY,3128
-cachier/cores/mongo.py,sha256=jOcqxIU8wqF2jS2lOfp-VFk5iyVMKHm6AzhFGkxGm0k,4889
-cachier/cores/pickle.py,sha256=dZXUBv7xZKg39IaUERnjPEAcjpDS8sBuObrnxMTqMmk,8871
-cachier-3.0.0.dist-info/LICENSE,sha256=-2WrMJkIa0gVP6YQHXXDT7ws-S3M2NEVEF4XF3K8qrY,1069
-cachier-3.0.0.dist-info/METADATA,sha256=-hfKZSKXrKC7m102SRmJjpcelAZDtD6DoS0gSgm_wv8,18871
-cachier-3.0.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-cachier-3.0.0.dist-info/entry_points.txt,sha256=16JU8wc6a62BLuOXVNjAiXJRp0AB5LtEwiKGYMjZjv0,49
-cachier-3.0.0.dist-info/top_level.txt,sha256=_rW_HiJumDCch67YT-WAgzcyvKg5RiYDMZq9d-0ZpaE,8
-cachier-3.0.0.dist-info/RECORD,,

cachier-3.0.0.dist-info/entry_points.txt

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