checkpointer 2.0.1__py3-none-any.whl → 2.1.0__py3-none-any.whl

checkpointer/__init__.py

@@ -5,5 +5,6 @@ import tempfile
 
 create_checkpointer = Checkpointer
 checkpoint = Checkpointer()
-memory_checkpoint = Checkpointer(format="memory")
+capture_checkpoint = Checkpointer(capture=True)
+memory_checkpoint = Checkpointer(format="memory", verbosity=0)
 tmp_checkpoint = Checkpointer(root_path=tempfile.gettempdir() + "/checkpoints")

checkpointer/checkpoint.py

@@ -1,32 +1,31 @@
+from __future__ import annotations
 import inspect
 import relib.hashing as hashing
-from typing import Generic, TypeVar, TypedDict, Callable, Unpack, Literal, Union, Any, cast, overload
-from datetime import datetime
+from typing import Generic, TypeVar, Type, TypedDict, Callable, Unpack, Literal, Any, cast, overload
 from pathlib import Path
+from datetime import datetime
 from functools import update_wrapper
 from .types import Storage
 from .function_body import get_function_hash
-from .utils import unwrap_fn, sync_resolve_coroutine
-from .storages.pickle_storage import PickleStorage
-from .storages.memory_storage import MemoryStorage
-from .storages.bcolz_storage import BcolzStorage
+from .utils import unwrap_fn, sync_resolve_coroutine, resolved_awaitable
+from .storages import STORAGE_MAP
 from .print_checkpoint import print_checkpoint
 
 Fn = TypeVar("Fn", bound=Callable)
 
 DEFAULT_DIR = Path.home() / ".cache/checkpoints"
-STORAGE_MAP = {"memory": MemoryStorage, "pickle": PickleStorage, "bcolz": BcolzStorage}
 
 class CheckpointError(Exception):
   pass
 
 class CheckpointerOpts(TypedDict, total=False):
-  format: Storage | Literal["pickle", "memory", "bcolz"]
+  format: Type[Storage] | Literal["pickle", "memory", "bcolz"]
   root_path: Path | str | None
   when: bool
   verbosity: Literal[0, 1]
   path: Callable[..., str] | None
   should_expire: Callable[[datetime], bool] | None
+  capture: bool
 
 class Checkpointer:
   def __init__(self, **opts: Unpack[CheckpointerOpts]):
@@ -36,15 +35,13 @@ class Checkpointer:
     self.verbosity = opts.get("verbosity", 1)
     self.path = opts.get("path")
     self.should_expire = opts.get("should_expire")
-
-  def get_storage(self) -> Storage:
-    return STORAGE_MAP[self.format] if isinstance(self.format, str) else self.format
+    self.capture = opts.get("capture", False)
 
   @overload
-  def __call__(self, fn: Fn, **override_opts: Unpack[CheckpointerOpts]) -> "CheckpointFn[Fn]": ...
+  def __call__(self, fn: Fn, **override_opts: Unpack[CheckpointerOpts]) -> CheckpointFn[Fn]: ...
   @overload
-  def __call__(self, fn: None=None, **override_opts: Unpack[CheckpointerOpts]) -> "Checkpointer": ...
-  def __call__(self, fn: Fn | None=None, **override_opts: Unpack[CheckpointerOpts]) -> Union["Checkpointer", "CheckpointFn[Fn]"]:
+  def __call__(self, fn: None=None, **override_opts: Unpack[CheckpointerOpts]) -> Checkpointer: ...
+  def __call__(self, fn: Fn | None=None, **override_opts: Unpack[CheckpointerOpts]) -> Checkpointer | CheckpointFn[Fn]:
     if override_opts:
       opts = CheckpointerOpts(**{**self.__dict__, **override_opts})
       return Checkpointer(**opts)(fn)
@@ -56,15 +53,19 @@ class CheckpointFn(Generic[Fn]):
     wrapped = unwrap_fn(fn)
     file_name = Path(wrapped.__code__.co_filename).name
     update_wrapper(cast(Callable, self), wrapped)
+    storage = STORAGE_MAP[checkpointer.format] if isinstance(checkpointer.format, str) else checkpointer.format
     self.checkpointer = checkpointer
     self.fn = fn
-    self.fn_hash = get_function_hash(wrapped)
+    self.fn_hash, self.depends = get_function_hash(wrapped, self.checkpointer.capture)
     self.fn_id = f"{file_name}/{wrapped.__name__}"
     self.is_async = inspect.iscoroutinefunction(wrapped)
+    self.storage = storage(checkpointer)
 
   def get_checkpoint_id(self, args: tuple, kw: dict) -> str:
     if not callable(self.checkpointer.path):
-      return f"{self.fn_id}/{hashing.hash([self.fn_hash, args, kw or 0])}"
+      # TODO: use digest size before digesting instead of truncating the hash
+      call_hash = hashing.hash((self.fn_hash, args, kw), "blake2b")[:32]
+      return f"{self.fn_id}/{call_hash}"
     checkpoint_id = self.checkpointer.path(*args, **kw)
     if not isinstance(checkpoint_id, str):
       raise CheckpointError(f"path function must return a string, got {type(checkpoint_id)}")
@@ -73,27 +74,26 @@ class CheckpointFn(Generic[Fn]):
   async def _store_on_demand(self, args: tuple, kw: dict, rerun: bool):
     checkpoint_id = self.get_checkpoint_id(args, kw)
     checkpoint_path = self.checkpointer.root_path / checkpoint_id
-    storage = self.checkpointer.get_storage()
-    should_log = storage is not MemoryStorage and self.checkpointer.verbosity > 0
+    should_log = self.checkpointer.verbosity > 0
     refresh = rerun \
-      or not storage.exists(checkpoint_path) \
-      or (self.checkpointer.should_expire and self.checkpointer.should_expire(storage.checkpoint_date(checkpoint_path)))
+      or not self.storage.exists(checkpoint_path) \
+      or (self.checkpointer.should_expire and self.checkpointer.should_expire(self.storage.checkpoint_date(checkpoint_path)))
 
     if refresh:
       print_checkpoint(should_log, "MEMORIZING", checkpoint_id, "blue")
       data = self.fn(*args, **kw)
       if inspect.iscoroutine(data):
         data = await data
-      storage.store(checkpoint_path, data)
+      self.storage.store(checkpoint_path, data)
       return data
 
     try:
-      data = storage.load(checkpoint_path)
+      data = self.storage.load(checkpoint_path)
       print_checkpoint(should_log, "REMEMBERED", checkpoint_id, "green")
       return data
     except (EOFError, FileNotFoundError):
       print_checkpoint(should_log, "CORRUPTED", checkpoint_id, "yellow")
-      storage.delete(checkpoint_path)
+      self.storage.delete(checkpoint_path)
       return await self._store_on_demand(args, kw, rerun)
 
   def _call(self, args: tuple, kw: dict, rerun=False):
@@ -102,13 +102,17 @@ class CheckpointFn(Generic[Fn]):
     coroutine = self._store_on_demand(args, kw, rerun)
     return coroutine if self.is_async else sync_resolve_coroutine(coroutine)
 
-  __call__: Fn = cast(Fn, lambda self, *args, **kw: self._call(args, kw))
-  rerun: Fn = cast(Fn, lambda self, *args, **kw: self._call(args, kw, True))
-
-  def get(self, *args, **kw) -> Any:
+  def _get(self, args, kw) -> Any:
     checkpoint_path = self.checkpointer.root_path / self.get_checkpoint_id(args, kw)
-    storage = self.checkpointer.get_storage()
     try:
-      return storage.load(checkpoint_path)
+      val = self.storage.load(checkpoint_path)
+      return resolved_awaitable(val) if self.is_async else val
     except:
       raise CheckpointError("Could not load checkpoint")
+
+  def exists(self, *args: tuple, **kw: dict) -> bool:
+    return self.storage.exists(self.checkpointer.root_path / self.get_checkpoint_id(args, kw))
+
+  __call__: Fn = cast(Fn, lambda self, *args, **kw: self._call(args, kw))
+  rerun: Fn = cast(Fn, lambda self, *args, **kw: self._call(args, kw, True))
+  get: Fn = cast(Fn, lambda self, *args, **kw: self._get(args, kw))

checkpointer/function_body.py

@@ -1,46 +1,80 @@
+from __future__ import annotations
+import dis
 import inspect
-import relib.hashing as hashing
+import tokenize
+from io import StringIO
 from collections.abc import Callable
-from types import FunctionType, CodeType
+from itertools import chain, takewhile
+from operator import itemgetter
 from pathlib import Path
-from .utils import unwrap_fn
+from typing import Any, TypeGuard, TYPE_CHECKING
+from types import CodeType, FunctionType
+from relib import transpose, hashing, merge_dicts, drop_none
+from .utils import unwrap_fn, iterate_and_upcoming, get_cell_contents, AttrDict, get_at_attr
+
+if TYPE_CHECKING:
+  from .checkpoint import CheckpointFn
 
 cwd = Path.cwd()
 
-def get_fn_path(fn: Callable) -> Path:
-  return Path(inspect.getfile(fn)).resolve()
+def extract_scope_values(code: CodeType, scope_vars: dict[str, Any], closure = False) -> dict[tuple[str, ...], Any]:
+  opname = "LOAD_GLOBAL" if not closure else "LOAD_DEREF"
+  scope_values_by_path: dict[tuple[str, ...], Any] = {}
+  instructions = list(dis.get_instructions(code))
+
+  for instr, upcoming_instrs in iterate_and_upcoming(instructions):
+    if instr.opname == opname:
+      name = instr.argval
+      attrs = takewhile(lambda instr: instr.opname == "LOAD_ATTR", upcoming_instrs)
+      attr_path = (name, *(instr.argval for instr in attrs))
+      scope_values_by_path[attr_path] = get_at_attr(scope_vars, attr_path)
+
+  children = (extract_scope_values(const, scope_vars, closure) for const in code.co_consts if isinstance(const, CodeType))
+  return merge_dicts(scope_values_by_path, *children)
 
-def get_function_body(fn: Callable) -> str:
-  # TODO: Strip comments
-  lines = inspect.getsourcelines(fn)[0]
-  lines = [line.rstrip() for line in lines]
-  lines = [line for line in lines if line]
-  return "\n".join(lines)
+def get_fn_captured_vals(fn: Callable) -> list[Any]:
+  closure_scope = {k: get_cell_contents(v) for k, v in zip(fn.__code__.co_freevars, fn.__closure__ or [])}
+  global_vals = extract_scope_values(fn.__code__, AttrDict(fn.__globals__), closure=False)
+  closure_vals = extract_scope_values(fn.__code__, AttrDict(closure_scope), closure=True)
+  sorted_items = chain(sorted(global_vals.items()), sorted(closure_vals.items()))
+  return drop_none(map(itemgetter(1), sorted_items))
 
-def get_code_children(code: CodeType) -> list[str]:
-  consts = [const for const in code.co_consts if isinstance(const, CodeType)]
-  children = [child for const in consts for child in get_code_children(const)]
-  return list(code.co_names) + children
+def get_fn_body(fn: Callable) -> str:
+  source = "".join(inspect.getsourcelines(fn)[0])
+  tokens = tokenize.generate_tokens(StringIO(source).readline)
+  ignore_types = (tokenize.COMMENT, tokenize.NL)
+  return "".join("\0" + token.string for token in tokens if token.type not in ignore_types)
 
-def is_user_fn(candidate_fn, cleared_fns: set[Callable]) -> bool:
+def get_fn_path(fn: Callable) -> Path:
+  return Path(inspect.getfile(fn)).resolve()
+
+def is_user_fn(candidate_fn) -> TypeGuard[Callable]:
   return isinstance(candidate_fn, FunctionType) \
-    and candidate_fn not in cleared_fns \
     and cwd in get_fn_path(candidate_fn).parents
 
-def append_fn_children(cleared_fns: set[Callable], fn: Callable) -> None:
-  code_children = get_code_children(fn.__code__)
-  fn_children = [unwrap_fn(fn.__globals__.get(co_name, None)) for co_name in code_children]
-  fn_children = [child for child in fn_children if is_user_fn(child, cleared_fns)]
-  cleared_fns.update(fn_children)
-  for child_fn in fn_children:
-    append_fn_children(cleared_fns, child_fn)
-
-def get_fn_children(fn: Callable) -> list[Callable]:
-  cleared_fns: set[Callable] = set()
-  append_fn_children(cleared_fns, fn)
-  return sorted(cleared_fns, key=lambda fn: fn.__name__)
-
-def get_function_hash(fn: Callable) -> str:
-  fns = [fn] + get_fn_children(fn)
-  fn_bodies = list(map(get_function_body, fns))
-  return hashing.hash(fn_bodies)
+def append_fn_depends(checkpoint_fns: set[CheckpointFn], captured_vals_by_fn: dict[Callable, list[Any]], fn: Callable, capture: bool) -> None:
+  from .checkpoint import CheckpointFn
+  captured_vals = get_fn_captured_vals(fn)
+  captured_vals_by_fn[fn] = [v for v in captured_vals if capture and not callable(v)]
+  callables = [unwrap_fn(val, checkpoint_fn=True) for val in captured_vals if callable(val)]
+  depends = {val for val in callables if is_user_fn(val)}
+  checkpoint_fns.update({val for val in callables if isinstance(val, CheckpointFn)})
+  not_appended = depends - captured_vals_by_fn.keys()
+  captured_vals_by_fn.update({fn: [] for fn in not_appended})
+  for child_fn in not_appended:
+    append_fn_depends(checkpoint_fns, captured_vals_by_fn, child_fn, capture)
+
+def get_depend_fns(fn: Callable, capture: bool) -> tuple[set[CheckpointFn], dict[Callable, list[Any]]]:
+  checkpoint_fns: set[CheckpointFn] = set()
+  captured_vals_by_fn: dict[Callable, list[Any]] = {}
+  append_fn_depends(checkpoint_fns, captured_vals_by_fn, fn, capture)
+  return checkpoint_fns, captured_vals_by_fn
+
+def get_function_hash(fn: Callable, capture: bool) -> tuple[str, list[Callable]]:
+  checkpoint_fns, captured_vals_by_fn = get_depend_fns(fn, capture)
+  checkpoint_fns = sorted(checkpoint_fns, key=lambda fn: unwrap_fn(fn).__qualname__)
+  checkpoint_hashes = [check.fn_hash for check in checkpoint_fns]
+  depend_fns, depend_captured_vals = transpose(sorted(captured_vals_by_fn.items(), key=lambda x: x[0].__qualname__), 2)
+  fn_bodies = list(map(get_fn_body, [fn] + depend_fns))
+  fn_hash = hashing.hash((fn_bodies, depend_captured_vals, checkpoint_hashes), "blake2b")
+  return fn_hash, checkpoint_fns + depend_fns

checkpointer/storages/__init__.py

@@ -0,0 +1,11 @@
+from typing import Type
+from ..types import Storage
+from .pickle_storage import PickleStorage
+from .memory_storage import MemoryStorage
+from .bcolz_storage import BcolzStorage
+
+STORAGE_MAP: dict[str, Type[Storage]] = {
+  "pickle": PickleStorage,
+  "memory": MemoryStorage,
+  "bcolz": BcolzStorage,
+}

checkpointer/storages/bcolz_storage.py

@@ -24,16 +24,13 @@ def insert_data(path: Path, data):
   c.flush()
 
 class BcolzStorage(Storage):
-  @staticmethod
-  def exists(path):
+  def exists(self, path):
     return path.exists()
 
-  @staticmethod
-  def checkpoint_date(path):
+  def checkpoint_date(self, path):
     return datetime.fromtimestamp(path.stat().st_mtime)
 
-  @staticmethod
-  def store(path, data):
+  def store(self, path, data):
     metapath = get_metapath(path)
     path.parent.mkdir(parents=True, exist_ok=True)
     data_type_str = get_data_type_str(data)
@@ -48,12 +45,11 @@ class BcolzStorage(Storage):
     if data_type_str in ["tuple", "dict"]:
       for i in range(len(fields)):
         child_path = Path(f"{path} ({i})")
-        BcolzStorage.store(child_path, data[fields[i]])
+        self.store(child_path, data[fields[i]])
     else:
       insert_data(path, data)
 
-  @staticmethod
-  def load(path):
+  def load(self, path):
     import bcolz
     metapath = get_metapath(path)
     meta_data = bcolz.open(metapath)[:][0]
@@ -61,7 +57,7 @@ class BcolzStorage(Storage):
     if data_type_str in ["tuple", "dict"]:
       fields = meta_data["fields"]
       partitions = range(len(fields))
-      data = [BcolzStorage.load(Path(f"{path} ({i})")) for i in partitions]
+      data = [self.load(Path(f"{path} ({i})")) for i in partitions]
       if data_type_str == "tuple":
         return tuple(data)
       else:
@@ -75,8 +71,7 @@ class BcolzStorage(Storage):
       else:
         return data[:]
 
-  @staticmethod
-  def delete(path):
+  def delete(self, path):
     # NOTE: Not recursive
     metapath = get_metapath(path)
     try:

checkpointer/storages/memory_storage.py

@@ -1,28 +1,25 @@
+from typing import Any
+from pathlib import Path
 from datetime import datetime
 from ..types import Storage
 
-store = {}
-date_stored = {}
+item_map: dict[str, tuple[datetime, Any]] = {}
 
 class MemoryStorage(Storage):
-  @staticmethod
-  def exists(path):
-    return str(path) in store
+  def get_short_path(self, path: Path):
+    return str(path.relative_to(self.checkpointer.root_path))
 
-  @staticmethod
-  def checkpoint_date(path):
-    return date_stored[str(path)]
+  def exists(self, path):
+    return self.get_short_path(path) in item_map
 
-  @staticmethod
-  def store(path, data):
-    store[str(path)] = data
-    date_stored[str(path)] = datetime.now()
+  def checkpoint_date(self, path):
+    return item_map[self.get_short_path(path)][0]
 
-  @staticmethod
-  def load(path):
-    return store[str(path)]
+  def store(self, path, data):
+    item_map[self.get_short_path(path)] = (datetime.now(), data)
 
-  @staticmethod
-  def delete(path):
-    del store[str(path)]
-    del date_stored[str(path)]
+  def load(self, path):
+    return item_map[self.get_short_path(path)][1]
+
+  def delete(self, path):
+    del item_map[self.get_short_path(path)]

checkpointer/storages/pickle_storage.py

@@ -7,29 +7,24 @@ def get_path(path: Path):
   return path.with_name(f"{path.name}.pkl")
 
 class PickleStorage(Storage):
-  @staticmethod
-  def exists(path):
+  def exists(self, path):
     return get_path(path).exists()
 
-  @staticmethod
-  def checkpoint_date(path):
+  def checkpoint_date(self, path):
     return datetime.fromtimestamp(get_path(path).stat().st_mtime)
 
-  @staticmethod
-  def store(path, data):
+  def store(self, path, data):
     full_path = get_path(path)
     full_path.parent.mkdir(parents=True, exist_ok=True)
     with full_path.open("wb") as file:
       pickle.dump(data, file, -1)
 
-  @staticmethod
-  def load(path):
+  def load(self, path):
     full_path = get_path(path)
     with full_path.open("rb") as file:
       return pickle.load(file)
 
-  @staticmethod
-  def delete(path):
+  def delete(self, path):
     try:
       get_path(path).unlink()
     except FileNotFoundError:

checkpointer/types.py

@@ -1,19 +1,23 @@
-from typing import Protocol, Any
+from __future__ import annotations
+from typing import Any, TYPE_CHECKING
 from pathlib import Path
 from datetime import datetime
 
-class Storage(Protocol):
-  @staticmethod
-  def exists(path: Path) -> bool: ...
+if TYPE_CHECKING:
+  from .checkpoint import Checkpointer
 
-  @staticmethod
-  def checkpoint_date(path: Path) -> datetime: ...
+class Storage:
+  checkpointer: Checkpointer
 
-  @staticmethod
-  def store(path: Path, data: Any) -> None: ...
+  def __init__(self, checkpointer: Checkpointer):
+    self.checkpointer = checkpointer
 
-  @staticmethod
-  def load(path: Path) -> Any: ...
+  def exists(self, path: Path) -> bool: ...
 
-  @staticmethod
-  def delete(path: Path) -> None: ...
+  def checkpoint_date(self, path: Path) -> datetime: ...
+
+  def store(self, path: Path, data: Any) -> None: ...
+
+  def load(self, path: Path) -> Any: ...
+
+  def delete(self, path: Path) -> None: ...

checkpointer/utils.py

@@ -1,17 +1,52 @@
-import types
+from typing import Generator, Coroutine, Iterable, Any, cast
+from types import CellType, coroutine
+from itertools import islice
 
-def unwrap_fn[T](fn: T) -> T:
+class AttrDict(dict):
+  def __init__(self, *args, **kwargs):
+    super(AttrDict, self).__init__(*args, **kwargs)
+    self.__dict__ = self
+
+  def __getattribute__(self, name: str) -> Any:
+    return super().__getattribute__(name)
+
+def unwrap_fn[T](fn: T, checkpoint_fn=False) -> T:
+  from .checkpoint import CheckpointFn
   while hasattr(fn, "__wrapped__"):
+    if checkpoint_fn and isinstance(fn, CheckpointFn):
+      return fn
     fn = getattr(fn, "__wrapped__")
   return fn
 
-@types.coroutine
-def coroutine_as_generator(coroutine):
+@coroutine
+def coroutine_as_generator[T](coroutine: Coroutine[None, None, T]) -> Generator[None, None, T]:
   val = yield from coroutine
   return val
 
-def sync_resolve_coroutine(coroutine):
+def sync_resolve_coroutine[T](coroutine: Coroutine[None, None, T]) -> T:
+  gen = cast(Generator, coroutine_as_generator(coroutine))
   try:
-    next(coroutine_as_generator(coroutine))
+    while True: next(gen)
   except StopIteration as ex:
     return ex.value
+
+async def resolved_awaitable[T](value: T) -> T:
+  return value
+
+def iterate_and_upcoming[T](l: list[T]) -> Iterable[tuple[T, Iterable[T]]]:
+  for i, item in enumerate(l):
+    yield item, islice(l, i + 1, None)
+
+def get_at_attr(d: dict, keys: tuple[str, ...]) -> Any:
+  try:
+    for key in keys:
+      d = getattr(d, key)
+  except AttributeError:
+    return None
+  return d
+
+def get_cell_contents(cell: CellType) -> Any:
+  try:
+    return cell.cell_contents
+  except ValueError:
+    return None

checkpointer-2.1.0.dist-info/METADATA

@@ -0,0 +1,248 @@
+Metadata-Version: 2.3
+Name: checkpointer
+Version: 2.1.0
+Summary: A Python library for memoizing function results with support for multiple storage backends, async runtimes, and automatic cache invalidation
+Project-URL: Repository, https://github.com/Reddan/checkpointer.git
+Author: Hampus Hallman
+License: Copyright 2024 Hampus Hallman
+        
+        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.
+Requires-Python: >=3.12
+Requires-Dist: relib
+Description-Content-Type: text/markdown
+
+# checkpointer · [![License](https://img.shields.io/badge/license-MIT-blue)](https://github.com/Reddan/checkpointer/blob/master/LICENSE) [![pypi](https://img.shields.io/pypi/v/checkpointer)](https://pypi.org/project/checkpointer/) [![Python 3.12](https://img.shields.io/badge/python-3.12-blue)](https://pypi.org/project/checkpointer/)
+
+`checkpointer` is a Python library for memoizing function results. It provides a decorator-based API with support for multiple storage backends. Use it for computationally expensive operations where caching can save time, or during development to avoid waiting for redundant computations.
+
+Adding or removing `@checkpoint` doesn't change how your code works. You can apply it to any function, including ones you've already written, without altering their behavior or introducing side effects. The original function remains unchanged and can still be called directly when needed.
+
+### Key Features:
+- 🗂️ **Multiple Storage Backends**: Built-in support for in-memory and pickle-based storage, or create your own.
+- 🎯 **Simple Decorator API**: Apply `@checkpoint` to functions without boilerplate.
+- 🔄 **Async and Sync Compatibility**: Works with synchronous functions and any Python async runtime (e.g., `asyncio`, `Trio`, `Curio`).
+- ⏲️ **Custom Expiration Logic**: Automatically invalidate old checkpoints.
+- 📂 **Flexible Path Configuration**: Control where checkpoints are stored.
+- 📦 **Captured Variables Handling**: Optionally include captured variables in cache invalidation.
+
+---
+
+## Installation
+
+```bash
+pip install checkpointer
+```
+
+---
+
+## Quick Start 🚀
+
+```python
+from checkpointer import checkpoint
+
+@checkpoint
+def expensive_function(x: int) -> int:
+    print("Computing...")
+    return x ** 2
+
+result = expensive_function(4)  # Computes and stores the result
+result = expensive_function(4)  # Loads from the cache
+```
+
+---
+
+## How It Works
+
+When you use `@checkpoint`, the function's **arguments** (`args`, `kwargs`) are hashed to create a unique identifier for each call. This identifier is used to store and retrieve cached results. If the same arguments are passed again, `checkpointer` loads the cached result instead of recomputing.
+
+Additionally, `checkpointer` ensures that caches are invalidated when a function's implementation or any of its dependencies change. Each function is assigned a hash based on:
+
+1. **Its source code**: Changes to the function's code update its hash.
+2. **Dependent functions**: If a function calls others, changes in those dependencies will also update the hash.
+3. **Captured variables**: (Optional) If `capture=True`, changes to captured variables and global variables will also update the hash.
+
+### Example: Cache Invalidation
+
+```python
+def multiply(a, b):
+    return a * b
+
+@checkpoint
+def helper(x):
+    return multiply(x + 1, 2)
+
+@checkpoint
+def compute(a, b):
+    return helper(a) + helper(b)
+```
+
+If you modify `multiply`, caches for both `helper` and `compute` are invalidated and recomputed.
+
+---
+
+## Parameterization
+
+### Custom Configuration
+
+Set up a `Checkpointer` instance with custom settings, and extend it by calling itself with overrides:
+
+```python
+from checkpointer import checkpoint
+
+IS_DEVELOPMENT = True  # Toggle based on your environment
+
+tmp_checkpoint = checkpoint(root_path="/tmp/checkpoints")
+dev_checkpoint = tmp_checkpoint(when=IS_DEVELOPMENT)  # Adds development-specific behavior
+```
+
+### Per-Function Customization & Layered Caching
+
+Layer caches by stacking checkpoints:
+
+```python
+@checkpoint(format="memory")  # Always use memory storage
+@dev_checkpoint  # Adds caching during development
+def some_expensive_function():
+    print("Performing a time-consuming operation...")
+    return sum(i * i for i in range(10**6))
+```
+
+- **In development**: Both `dev_checkpoint` and `memory` caches are active.
+- **In production**: Only the `memory` cache is active.
+
+---
+
+## Usage
+
+### Basic Invocation and Caching
+
+Call the decorated function as usual. On the first call, the result is computed and stored in the cache. Subsequent calls with the same arguments load the result from the cache:
+
+```python
+result = expensive_function(4)  # Computes and stores the result
+result = expensive_function(4)  # Loads the result from the cache
+```
+
+### Force Recalculation
+
+Force a recalculation and overwrite the stored checkpoint:
+
+```python
+result = expensive_function.rerun(4)
+```
+
+### Call the Original Function
+
+Use `fn` to directly call the original, undecorated function:
+
+```python
+result = expensive_function.fn(4)
+```
+
+This is especially useful **inside recursive functions** to avoid redundant caching of intermediate steps while still caching the final result.
+
+### Retrieve Stored Checkpoints
+
+Access cached results without recalculating:
+
+```python
+stored_result = expensive_function.get(4)
+```
+
+---
+
+## Storage Backends
+
+`checkpointer` works with both built-in and custom storage backends, so you can use what's provided or roll your own as needed.
+
+### Built-In Backends
+
+1. **PickleStorage**: Stores checkpoints on disk using Python's `pickle`.
+2. **MemoryStorage**: Keeps checkpoints in memory for non-persistent, fast caching.
+
+You can specify a storage backend using either its name (`"pickle"` or `"memory"`) or its corresponding class (`PickleStorage` or `MemoryStorage`) in the `format` parameter:
+
+```python
+from checkpointer import checkpoint, PickleStorage, MemoryStorage
+
+@checkpoint(format="pickle")  # Short for format=PickleStorage
+def disk_cached(x: int) -> int:
+    return x ** 2
+
+@checkpoint(format="memory")  # Short for format=MemoryStorage
+def memory_cached(x: int) -> int:
+    return x * 10
+```
+
+### Custom Storage Backends
+
+Create a custom storage backend by inheriting from the `Storage` class and implementing its methods. Access configuration options through the `self.checkpointer` attribute, an instance of `Checkpointer`.
+
+#### Example: Custom Storage Backend
+
+```python
+from checkpointer import checkpoint, Storage
+from datetime import datetime
+
+class CustomStorage(Storage):
+    def exists(self, path) -> bool: ...  # Check if a checkpoint exists at the given path
+    def checkpoint_date(self, path) -> datetime: ...  # Return the date the checkpoint was created
+    def store(self, path, data): ...  # Save the checkpoint data
+    def load(self, path): ...  # Return the checkpoint data
+    def delete(self, path): ...  # Delete the checkpoint
+
+@checkpoint(format=CustomStorage)
+def custom_cached(x: int):
+    return x ** 2
+```
+
+Using a custom backend lets you tailor storage to your application, whether it involves databases, cloud storage, or custom file formats.
+
+---
+
+## Configuration Options ⚙️
+
+| Option          | Type                              | Default              | Description                                    |
+|-----------------|-----------------------------------|----------------------|------------------------------------------------|
+| `capture`       | `bool`                            | `False`              | Include captured variables in function hashes. |
+| `format`        | `"pickle"`, `"memory"`, `Storage` | `"pickle"`           | Storage backend format.                        |
+| `root_path`     | `Path`, `str`, or `None`          | ~/.cache/checkpoints | Root directory for storing checkpoints.        |
+| `when`          | `bool`                            | `True`               | Enable or disable checkpointing.               |
+| `verbosity`     | `0` or `1`                        | `1`                  | Logging verbosity.                             |
+| `path`          | `Callable[..., str]`              | `None`               | Custom path for checkpoint storage.            |
+| `should_expire` | `Callable[[datetime], bool]`      | `None`               | Custom expiration logic.                       |
+
+---
+
+## Full Example 🛠️
+
+```python
+import asyncio
+from checkpointer import checkpoint
+
+@checkpoint
+def compute_square(n: int) -> int:
+    print(f"Computing {n}^2...")
+    return n ** 2
+
+@checkpoint(format="memory")
+async def async_compute_sum(a: int, b: int) -> int:
+    await asyncio.sleep(1)
+    return a + b
+
+async def main():
+    result1 = compute_square(5)
+    print(result1)  # Outputs 25
+
+    result2 = await async_compute_sum(3, 7)
+    print(result2)  # Outputs 10
+
+    result3 = await async_compute_sum.get(3, 7)
+    print(result3)  # Outputs 10
+
+asyncio.run(main())
+```

checkpointer-2.1.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+checkpointer/__init__.py,sha256=t-dv0hIfgJHFx2M8tjCUMC9DlucPM8hvJOwGv86owUo,411
+checkpointer/checkpoint.py,sha256=NHY_63EzlY3X6eqbOBE-dIprMZ_-X_GRC-nhy6cI1QQ,4990
+checkpointer/function_body.py,sha256=DAq5fj1MMgb3az_Pfdxzqg6woJ6esFgvaqkkKqogJBY,4074
+checkpointer/print_checkpoint.py,sha256=21aeqgM9CMjNAJyScqFmXCWWfh3jBIn7o7i5zJkZGaA,1369
+checkpointer/types.py,sha256=SslunQTXxovFuGOR_VKfL7z5Vif9RD1PPx0J1FQdGLw,564
+checkpointer/utils.py,sha256=qT7pk3o6GkX-1ylfi6I-DJO5fdVOIHMuaEK8dTEAoVw,1465
+checkpointer/storages/__init__.py,sha256=G7JrOAyCGITd1wOz-u6_4RZVgxzxGLVLHPwBuW1sx1U,300
+checkpointer/storages/bcolz_storage.py,sha256=UoeREc3oS8skFClu9sULpgpqbIVcp3tVd8CeYfAe5yM,2220
+checkpointer/storages/memory_storage.py,sha256=RQ4WTVapxJGVPv1DNlb9VFTifxtyQy8YVo8fwaRLfdk,692
+checkpointer/storages/pickle_storage.py,sha256=nyrBWLXKnyzXgZIMwrpWUOAGRozpX3jL9pCyCV29e4E,787
+checkpointer-2.1.0.dist-info/METADATA,sha256=tdpLxisGi4Wx3gvs_W52t1SQqRwgDuke26pkfzHVuKY,9926
+checkpointer-2.1.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+checkpointer-2.1.0.dist-info/licenses/LICENSE,sha256=0cmUKqBotzbBcysIexd52AhjwbphhlGYiWbvg5l2QAU,1054
+checkpointer-2.1.0.dist-info/RECORD,,

checkpointer-2.0.1.dist-info/METADATA

@@ -1,270 +0,0 @@
-Metadata-Version: 2.3
-Name: checkpointer
-Version: 2.0.1
-Summary: A Python library for memoizing function results with support for multiple storage backends, async runtimes, and automatic cache invalidation
-Project-URL: Repository, https://github.com/Reddan/checkpointer.git
-Author: Hampus Hallman
-License: Copyright 2024 Hampus Hallman
-        
-        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.
-Requires-Python: >=3.12
-Requires-Dist: relib
-Description-Content-Type: text/markdown
-
-# checkpointer · [![License](https://img.shields.io/badge/license-MIT-blue)](https://github.com/Reddan/checkpointer/blob/master/LICENSE) [![pypi](https://img.shields.io/pypi/v/checkpointer)](https://pypi.org/project/checkpointer/) [![Python 3.12](https://img.shields.io/badge/python-3.12-blue)](https://pypi.org/project/checkpointer/)
-
-`checkpointer` is a Python library for memoizing function results. It simplifies caching by providing a decorator-based API and supports various storage backends. It's designed for computationally expensive operations where caching can save time, or during development to avoid waiting for redundant computations. ⚡️
-
-Adding or removing `@checkpoint` doesn't change how your code works, and it can be applied to any function, including ones you've already written, without altering their behavior or introducing side effects. The original function remains unchanged and can still be called directly when needed.
-
-### Key Features:
-- 🗂️ **Multiple Storage Backends**: Supports in-memory, pickle, or your own custom storage.
-- 🎯 **Simple Decorator API**: Apply `@checkpoint` to functions.
-- 🔄 **Async and Sync Compatibility**: Works with synchronous functions and any Python async runtime (e.g., `asyncio`, `Trio`, `Curio`).
-- ⏲️ **Custom Expiration Logic**: Automatically invalidate old checkpoints.
-- 📂 **Flexible Path Configuration**: Control where checkpoints are stored.
-
----
-
-## Installation
-
-```bash
-pip install checkpointer
-```
-
----
-
-## Quick Start 🚀
-
-```python
-from checkpointer import checkpoint
-
-@checkpoint
-def expensive_function(x: int) -> int:
-    print("Computing...")
-    return x ** 2
-
-result = expensive_function(4)  # Computes and stores result
-result = expensive_function(4)  # Loads from checkpoint
-```
-
----
-
-## How It Works
-
-When you use `@checkpoint`, the function's **arguments** (`args`, `kwargs`) are hashed to create a unique identifier for each call. This identifier is used to store and retrieve cached results. If the same arguments are passed again, `checkpointer` will return the cached result instead of recomputing.
-
-Additionally, `checkpointer` ensures that caches are invalidated when a function’s implementation or any of its dependencies change. Each function is assigned a hash based on:
-1. **Its source code**: Changes to the function’s code update its hash.
-2. **Dependent functions**: If a function calls others, changes to those will also update the hash.
-
-### Example: Cache Invalidation by Function Dependencies
-
-```python
-def multiply(a, b):
-    return a * b
-
-@checkpoint
-def helper(x):
-    return multiply(x + 1, 2)
-
-@checkpoint
-def compute(a, b):
-    return helper(a) + helper(b)
-```
-
-If you change `multiply`, the checkpoints for both `helper` and `compute` will be invalidated and recomputed.
-
----
-
-## Parameterization
-
-### Global Configuration
-
-You can configure a custom `Checkpointer`:
-
-```python
-from checkpointer import checkpoint
-
-checkpoint = checkpoint(format="memory", root_path="/tmp/checkpoints")
-```
-
-Extend this configuration by calling itself again:
-
-```python
-extended_checkpoint = checkpoint(format="pickle", verbosity=0)
-```
-
-### Per-Function Customization
-
-```python
-@checkpoint(format="pickle", verbosity=0)
-def my_function(x, y):
-    return x + y
-```
-
-### Combining Configurations
-
-```python
-checkpoint = checkpoint(format="memory", verbosity=1)
-quiet_checkpoint = checkpoint(verbosity=0)
-pickle_checkpoint = checkpoint(format="pickle", root_path="/tmp/pickle_checkpoints")
-
-@checkpoint
-def compute_square(n: int) -> int:
-    return n ** 2
-
-@quiet_checkpoint
-def compute_quietly(n: int) -> int:
-    return n ** 3
-
-@pickle_checkpoint
-def compute_sum(a: int, b: int) -> int:
-    return a + b
-```
-
-### Layered Caching
-
-```python
-IS_DEVELOPMENT = True  # Toggle based on environment
-
-dev_checkpoint = checkpoint(when=IS_DEVELOPMENT)
-
-@checkpoint(format="memory")
-@dev_checkpoint
-def some_expensive_function():
-    print("Performing a time-consuming operation...")
-    return sum(i * i for i in range(10**6))
-```
-
-- In development: Both `dev_checkpoint` and `memory` caches are active.
-- In production: Only the `memory` cache is active.
-
----
-
-## Usage
-
-### Force Recalculation
-Use `rerun` to force a recalculation and overwrite the stored checkpoint:
-
-```python
-result = expensive_function.rerun(4)
-```
-
-### Bypass Checkpointer
-Use `fn` to directly call the original, undecorated function:
-
-```python
-result = expensive_function.fn(4)
-```
-
-This is especially useful **inside recursive functions**. By using `.fn` within the function itself, you avoid redundant caching of intermediate recursive calls while still caching the final result at the top level.
-
-### Retrieve Stored Checkpoints
-Access stored results without recalculating:
-
-```python
-stored_result = expensive_function.get(4)
-```
-
----
-
-## Storage Backends
-
-`checkpointer` supports flexible storage backends, including built-in options and custom implementations.
-
-### Built-In Backends
-
-1. **PickleStorage**: Saves checkpoints to disk using Python's `pickle` module.
-2. **MemoryStorage**: Caches checkpoints in memory for fast, non-persistent use.
-
-To use these backends, pass either `"pickle"` or `PickleStorage` (and similarly for `"memory"` or `MemoryStorage`) to the `format` parameter:
-```python
-from checkpointer import checkpoint, PickleStorage, MemoryStorage
-
-@checkpoint(format="pickle")  # Equivalent to format=PickleStorage
-def disk_cached(x: int) -> int:
-    return x ** 2
-
-@checkpoint(format="memory")  # Equivalent to format=MemoryStorage
-def memory_cached(x: int) -> int:
-    return x * 10
-```
-
-### Custom Storage Backends
-
-Create custom storage backends by implementing methods for storing, loading, and managing checkpoints. For example, a custom storage backend might use a database, cloud storage, or a specialized format.
-
-Example usage:
-```python
-from checkpointer import checkpoint, Storage
-from typing import Any
-from pathlib import Path
-from datetime import datetime
-
-class CustomStorage(Storage):  # Optional for type hinting
-    @staticmethod
-    def exists(path: Path) -> bool: ...
-    @staticmethod
-    def checkpoint_date(path: Path) -> datetime: ...
-    @staticmethod
-    def store(path: Path, data: Any) -> None: ...
-    @staticmethod
-    def load(path: Path) -> Any: ...
-    @staticmethod
-    def delete(path: Path) -> None: ...
-
-@checkpoint(format=CustomStorage)
-def custom_cached(x: int):
-    return x ** 2
-```
-
-This flexibility allows you to adapt `checkpointer` to meet any storage requirement, whether persistent or in-memory.
-
----
-
-## Configuration Options ⚙️
-
-| Option         | Type                                | Default     | Description                                 |
-|----------------|-------------------------------------|-------------|---------------------------------------------|
-| `format`       | `"pickle"`, `"memory"`, `Storage`   | `"pickle"`  | Storage backend format.                     |
-| `root_path`    | `Path`, `str`, or `None`            | User Cache  | Root directory for storing checkpoints.     |
-| `when`         | `bool`                              | `True`      | Enable or disable checkpointing.            |
-| `verbosity`    | `0` or `1`                          | `1`         | Logging verbosity.                          |
-| `path`         | `Callable[..., str]`                | `None`      | Custom path for checkpoint storage.         |
-| `should_expire`| `Callable[[datetime], bool]`        | `None`      | Custom expiration logic.                    |
-
----
-
-## Full Example 🛠️
-
-```python
-import asyncio
-from checkpointer import checkpoint
-
-@checkpoint
-def compute_square(n: int) -> int:
-    print(f"Computing {n}^2...")
-    return n ** 2
-
-@checkpoint(format="memory")
-async def async_compute_sum(a: int, b: int) -> int:
-    await asyncio.sleep(1)
-    return a + b
-
-async def main():
-    result1 = compute_square(5)
-    print(result1)
-
-    result2 = await async_compute_sum(3, 7)
-    print(result2)
-
-    result3 = async_compute_sum.get(3, 7)
-    print(result3)
-
-asyncio.run(main())
-```

checkpointer-2.0.1.dist-info/RECORD

@@ -1,13 +0,0 @@
-checkpointer/__init__.py,sha256=2o-pOMXC_wVcjDtyjyapAdeTh6jyYwKYE0--C5XsKdc,350
-checkpointer/checkpoint.py,sha256=-09sz8sZdYFwxfb8_O3L2PmdCN_lDXdcwKKTkFlOAtw,4715
-checkpointer/function_body.py,sha256=92mnTY9d_JhKnKugeySYRP6qhU4fH6F6zesb7h2pEi0,1720
-checkpointer/print_checkpoint.py,sha256=21aeqgM9CMjNAJyScqFmXCWWfh3jBIn7o7i5zJkZGaA,1369
-checkpointer/types.py,sha256=n1AspKywTQhurCy7V_3t1HKIxYm0T6qOwuoDYfamO0E,408
-checkpointer/utils.py,sha256=UrQt689UHUjl7kXpTbUCGkHUgQZllByX2rbuvZdt9vk,368
-checkpointer/storages/bcolz_storage.py,sha256=F1JahTAgYmSpeE5mL1kPcANWTVxDgvb2YY8fgWRxt2U,2286
-checkpointer/storages/memory_storage.py,sha256=EmXwscJ2D31Sekr4n0ONNaeiQWMf7SHfpHoVwRb1Ec8,534
-checkpointer/storages/pickle_storage.py,sha256=YOndlnUdCaRUDWkzvQrU79j6FkGyp44WrSjl4kIs8RA,837
-checkpointer-2.0.1.dist-info/METADATA,sha256=yHkb_PR1Js26cqT5UW1g2rmar_RnRabNjw4cE59tSlA,9568
-checkpointer-2.0.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-checkpointer-2.0.1.dist-info/licenses/LICENSE,sha256=0cmUKqBotzbBcysIexd52AhjwbphhlGYiWbvg5l2QAU,1054
-checkpointer-2.0.1.dist-info/RECORD,,