cachier 2.3.0__tar.gz → 3.0.1__tar.gz

{cachier-2.3.0 → cachier-3.0.1}/MANIFEST.in

@@ -1,9 +1,9 @@
 # Manifest syntax https://docs.python.org/2/distutils/sourcedist.html
 graft wheelhouse
 
-recursive-exclude __pycache__  *.py[cod] *.orig
-include cachier/version.info
+recursive-include src *.info
 include README.rst
-include requirements.txt
+include LICENSE
 
+prune __pycache__
 prune tests

{cachier-2.3.0/cachier.egg-info → cachier-3.0.1}/PKG-INFO

@@ -1,33 +1,50 @@
 Metadata-Version: 2.1
 Name: cachier
-Version: 2.3.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: watchdog>=2.3.1
 
 Cachier
 #######
@@ -267,7 +284,7 @@ Cachier also accepts several keyword arguments in the calls of the function it w
 Ignore Cache
 ~~~~~~~~~~~~
 
-You can have ``cachier`` ignore any existing cache for a specific function call by passing ``ignore_cache=True`` to the function call. The cache will neither be checked nor updated with the new return value.
+You can have ``cachier`` ignore any existing cache for a specific function call by passing ``cachier__skip_cache=True`` to the function call. The cache will neither be checked nor updated with the new return value.
 
 .. code-block:: python
 
@@ -276,17 +293,17 @@ You can have ``cachier`` ignore any existing cache for a specific function call
     return first_num + second_num
 
   def main():
-    print(sum(5, 3, ignore_cache=True))
+    print(sum(5, 3, cachier__skip_cache=True))
 
 Overwrite Cache
 ~~~~~~~~~~~~~~~
 
-You can have ``cachier`` overwrite an existing cache entry - if one exists - for a specific function call by passing ``overwrite_cache=True`` to the function call. The cache will not be checked but will be updated with the new return value.
+You can have ``cachier`` overwrite an existing cache entry - if one exists - for a specific function call by passing ``cachier__overwrite_cache=True`` to the function call. The cache will not be checked but will be updated with the new return value.
 
 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.
+You can have ``cachier`` print out a detailed explanation of the logic of a specific call by passing ``cachier__verbose=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
 ~~~~~~~~~~~~~~~~~~~
@@ -435,7 +452,7 @@ To run all tests EXCEPT memory core AND MongoDB core related tests, use:
 Running MongoDB tests against a live MongoDB instance
 -----------------------------------------------------
 
-**Note to developers:** By default, all MongoDB tests are run against a mocked MongoDB instance, provided by the ``pymongo_inmemory`` package. To run them against a live MongoDB instance, the ``CACHIER_TEST_VS_LIVE_MONGO`` environment variable is set to ``True`` in the ``test`` environment of this repository (and additional environment variables are populated with the appropriate credentials), used by the GitHub Action running tests on every commit and pull request.
+**Note to developers:** By default, all MongoDB tests are run against a mocked MongoDB instance, provided by the ``pymongo_inmemory`` package. To run them against a live MongoDB instance, the ``CACHIER_TEST_VS_DOCKERIZED_MONGO`` environment variable is set to ``True`` in the ``test`` environment of this repository (and additional environment variables are populated with the appropriate credentials), used by the GitHub Action running tests on every commit and pull request.
 
 Contributors are not expected to run these tests against a live MongoDB instance when developing, as credentials for the testing instance used will NOT be shared, but rather use the testing against the in-memory MongoDB instance as a good proxy.
 
@@ -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-2.3.0 → cachier-3.0.1}/README.rst

@@ -236,7 +236,7 @@ Cachier also accepts several keyword arguments in the calls of the function it w
 Ignore Cache
 ~~~~~~~~~~~~
 
-You can have ``cachier`` ignore any existing cache for a specific function call by passing ``ignore_cache=True`` to the function call. The cache will neither be checked nor updated with the new return value.
+You can have ``cachier`` ignore any existing cache for a specific function call by passing ``cachier__skip_cache=True`` to the function call. The cache will neither be checked nor updated with the new return value.
 
 .. code-block:: python
 
@@ -245,17 +245,17 @@ You can have ``cachier`` ignore any existing cache for a specific function call
     return first_num + second_num
 
   def main():
-    print(sum(5, 3, ignore_cache=True))
+    print(sum(5, 3, cachier__skip_cache=True))
 
 Overwrite Cache
 ~~~~~~~~~~~~~~~
 
-You can have ``cachier`` overwrite an existing cache entry - if one exists - for a specific function call by passing ``overwrite_cache=True`` to the function call. The cache will not be checked but will be updated with the new return value.
+You can have ``cachier`` overwrite an existing cache entry - if one exists - for a specific function call by passing ``cachier__overwrite_cache=True`` to the function call. The cache will not be checked but will be updated with the new return value.
 
 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.
+You can have ``cachier`` print out a detailed explanation of the logic of a specific call by passing ``cachier__verbose=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
 ~~~~~~~~~~~~~~~~~~~
@@ -404,7 +404,7 @@ To run all tests EXCEPT memory core AND MongoDB core related tests, use:
 Running MongoDB tests against a live MongoDB instance
 -----------------------------------------------------
 
-**Note to developers:** By default, all MongoDB tests are run against a mocked MongoDB instance, provided by the ``pymongo_inmemory`` package. To run them against a live MongoDB instance, the ``CACHIER_TEST_VS_LIVE_MONGO`` environment variable is set to ``True`` in the ``test`` environment of this repository (and additional environment variables are populated with the appropriate credentials), used by the GitHub Action running tests on every commit and pull request.
+**Note to developers:** By default, all MongoDB tests are run against a mocked MongoDB instance, provided by the ``pymongo_inmemory`` package. To run them against a live MongoDB instance, the ``CACHIER_TEST_VS_DOCKERIZED_MONGO`` environment variable is set to ``True`` in the ``test`` environment of this repository (and additional environment variables are populated with the appropriate credentials), used by the GitHub Action running tests on every commit and pull request.
 
 Contributors are not expected to run these tests against a live MongoDB instance when developing, as credentials for the testing instance used will NOT be shared, but rather use the testing against the in-memory MongoDB instance as a good proxy.
 
@@ -461,8 +461,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/pyproject.toml

@@ -0,0 +1,176 @@
+[build-system]
+requires = [
+  "setuptools",
+  "wheel",
+]
+
+[project]
+name = "cachier"
+description = "Persistent, stale-free, local and cross-machine caching for Python functions."
+readme = "README.rst"
+keywords = [
+  "cache",
+  "caching",
+  "cross-machine",
+  "decorator",
+  "local",
+  "memoization",
+  "mongo",
+  "persistent",
+]
+license = { file = "LICENSE" }
+authors = [
+  { name = "Shay Palachy Affek", email = 'shay.palachy@gmail.com' },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Other/Nonlisted Topic",
+  "Topic :: Software Development :: Libraries",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Topic :: Utilities",
+]
+dynamic = [
+  "version",
+]
+dependencies = [
+  "portalocker>=2.3.2",
+  "watchdog>=2.3.1",
+]
+urls.Source = "https://github.com/python-cachier/cachier"
+scripts.cachier = "cachier.__main__:cli"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.dynamic]
+version = { attr = "cachier._version.__version__" }
+
+[tool.setuptools.packages.find]
+where = [
+  "src",
+] # list of folders that contain the packages (["."] by default)
+include = [
+  "cachier*",
+] # package names should match these glob patterns (["*"] by default)
+namespaces = false # to disable scanning PEP 420 namespaces (true by default)
+
+[tool.ruff]
+target-version = "py38"
+line-length = 79
+# Exclude a variety of commonly ignored directories.
+exclude = [
+  ".eggs",
+  ".git",
+  ".ruff_cache",
+  "__pypackages__",
+  "_build",
+  "build",
+  "dist",
+]
+# Enable Pyflakes `E` and `F` codes by default.
+lint.select = [
+  "D",      # see: https://pypi.org/project/pydocstyle
+  "E",
+  "F",      # see: https://pypi.org/project/pyflakes
+  "I",      #see: https://pypi.org/project/isort/
+  "RUF100", # alternative to yesqa
+  #"N", # see: https://pypi.org/project/pep8-naming
+  "S",   # see: https://pypi.org/project/flake8-bandit
+  "SIM",
+  "W",   # see: https://pypi.org/project/pycodestyle
+]
+lint.extend-select = [
+  "A",  # see: https://pypi.org/project/flake8-builtins
+  "B",  # see: https://pypi.org/project/flake8-bugbear
+  "C4", # see: https://pypi.org/project/flake8-comprehensions
+]
+lint.ignore = [
+  "C901",
+  "E203",
+]
+lint.per-file-ignores."src/**/__init__.py" = [
+  "D104",
+]
+lint.per-file-ignores."src/cachier/config.py" = [
+  "D100",
+]
+lint.per-file-ignores."tests/**" = [
+  "D100",
+  "D101",
+  "D103",
+  "D104",
+  "D401",
+  "S101",
+  "S105",
+  "S311",
+  "S603",
+]
+lint.unfixable = [
+  "F401",
+]
+
+#[tool.ruff.pydocstyle]
+## Use Google-style docstrings.
+#convention = "google"
+#[tool.ruff.pycodestyle]
+#ignore-overlong-task-comments = true
+# Unlike Flake8, default to a complexity level of 10.
+lint.mccabe.max-complexity = 10
+
+[tool.docformatter]
+recursive = true
+# some docstring start with r"""
+wrap-summaries = 79
+wrap-descriptions = 79
+blank = true
+
+[tool.pytest.ini_options]
+testpaths = [
+  "cachier",
+  "tests",
+]
+norecursedirs = [
+  "dist",
+  "build",
+]
+addopts = [
+  "--color=yes",
+  "--cov=cachier",
+  "--cov-report=term",
+  "--cov-report=xml:cov.xml",
+  "-r a",
+  "-v",
+  "-s",
+]
+markers = [
+  "mongo: test the MongoDB core",
+  "memory: test the memory core",
+  "pickle: test the pickle core",
+]
+
+[tool.coverage.run]
+branch = true
+dynamic_context = "test_function"
+omit = [
+  "tests/*",
+  "cachier/_version.py",
+  "cachier/__init__.py",
+  "**/scripts/**",
+]
+[tool.coverage.report]
+show_missing = true
+# Regexes for lines to exclude from consideration
+exclude_lines = [
+  "pragma: no cover",          # Have to re-enable the standard pragma
+  "raise NotImplementedError", # Don't complain if tests don't hit defensive assertion code:
+  "if TYPE_CHECKING:",         # Is only true when running mypy, not tests
+]

{cachier-2.3.0 → cachier-3.0.1/src}/cachier/__init__.py

@@ -1,11 +1,11 @@
 from ._version import *  # noqa: F403
-from .core import (
-    cachier,
+from .config import (
     disable_caching,
     enable_caching,
     get_default_params,
     set_default_params,
 )
+from .core import cachier
 
 __all__ = [
     "cachier",

{cachier-2.3.0 → cachier-3.0.1/src}/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-3.0.1/src/cachier/_types.py

@@ -0,0 +1,9 @@
+from typing import TYPE_CHECKING, Callable, Literal
+
+if TYPE_CHECKING:
+    import pymongo.collection
+
+
+HashFunc = Callable[..., str]
+Mongetter = Callable[[], "pymongo.collection.Collection"]
+Backend = Literal["pickle", "mongo", "memory"]

cachier-3.0.1/src/cachier/config.py

@@ -0,0 +1,103 @@
+import datetime
+import hashlib
+import os
+import pickle
+from typing import Optional, TypedDict, Union
+
+from ._types import Backend, HashFunc, Mongetter
+
+
+def _default_hash_func(args, kwds):
+    # Sort the kwargs to ensure consistent ordering
+    sorted_kwargs = sorted(kwds.items())
+    # Serialize args and sorted_kwargs using pickle or similar
+    serialized = pickle.dumps((args, sorted_kwargs))
+    # Create a hash of the serialized data
+    return hashlib.sha256(serialized).hexdigest()
+
+
+class Params(TypedDict):
+    """Type definition for cachier parameters."""
+
+    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",
+    "mongetter": None,
+    "stale_after": datetime.timedelta.max,
+    "next_time": False,
+    "cache_dir": "~/.cachier/",
+    "pickle_reload": True,
+    "separate_files": False,
+    "wait_for_calc_timeout": 0,
+    "allow_none": False,
+}
+
+
+def _update_with_defaults(
+    param, name: str, func_kwargs: Optional[dict] = None
+):
+    import cachier
+
+    if func_kwargs:
+        kw_name = f"cachier__{name}"
+        if kw_name in func_kwargs:
+            return func_kwargs.pop(kw_name)
+    if param is None:
+        return cachier.config._default_params[name]
+    return param
+
+
+def set_default_params(**params):
+    """Configure global parameters applicable to all memoized functions.
+
+    This function takes the same keyword parameters as the ones defined in the
+    decorator, which can be passed all at once or with multiple calls.
+    Parameters given directly to a decorator take precedence over any values
+    set by this function.
+
+    Only 'stale_after', 'next_time', and 'wait_for_calc_timeout' can be changed
+    after the memoization decorator has been applied. Other parameters will
+    only have an effect on decorators applied after this function is run.
+
+    """
+    import cachier
+
+    valid_params = (
+        p for p in params.items() if p[0] in cachier.config._default_params
+    )
+    _default_params.update(valid_params)
+
+
+def get_default_params():
+    """Get current set of default parameters."""
+    import cachier
+
+    return cachier.config._default_params
+
+
+def enable_caching():
+    """Enable caching globally."""
+    import cachier
+
+    cachier.config._default_params["caching_enabled"] = True
+
+
+def disable_caching():
+    """Disable caching globally."""
+    import cachier
+
+    cachier.config._default_params["caching_enabled"] = False