checkpointer 1.2.0__tar.gz → 2.0.1__tar.gz

checkpointer-2.0.1/PKG-INFO

@@ -0,0 +1,270 @@
+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/README.md

@@ -0,0 +1,253 @@
+# 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/checkpointer/__init__.py

@@ -0,0 +1,9 @@
+from .checkpoint import Checkpointer, CheckpointFn, CheckpointError
+from .types import Storage
+from .function_body import get_function_hash
+import tempfile
+
+create_checkpointer = Checkpointer
+checkpoint = Checkpointer()
+memory_checkpoint = Checkpointer(format="memory")
+tmp_checkpoint = Checkpointer(root_path=tempfile.gettempdir() + "/checkpoints")

checkpointer-2.0.1/checkpointer/checkpoint.py

@@ -0,0 +1,114 @@
+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 pathlib import Path
+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 .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"]
+  root_path: Path | str | None
+  when: bool
+  verbosity: Literal[0, 1]
+  path: Callable[..., str] | None
+  should_expire: Callable[[datetime], bool] | None
+
+class Checkpointer:
+  def __init__(self, **opts: Unpack[CheckpointerOpts]):
+    self.format = opts.get("format", "pickle")
+    self.root_path = Path(opts.get("root_path", DEFAULT_DIR) or ".")
+    self.when = opts.get("when", True)
+    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
+
+  @overload
+  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]"]:
+    if override_opts:
+      opts = CheckpointerOpts(**{**self.__dict__, **override_opts})
+      return Checkpointer(**opts)(fn)
+
+    return CheckpointFn(self, fn) if callable(fn) else self
+
+class CheckpointFn(Generic[Fn]):
+  def __init__(self, checkpointer: Checkpointer, fn: Fn):
+    wrapped = unwrap_fn(fn)
+    file_name = Path(wrapped.__code__.co_filename).name
+    update_wrapper(cast(Callable, self), wrapped)
+    self.checkpointer = checkpointer
+    self.fn = fn
+    self.fn_hash = get_function_hash(wrapped)
+    self.fn_id = f"{file_name}/{wrapped.__name__}"
+    self.is_async = inspect.iscoroutinefunction(wrapped)
+
+  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])}"
+    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)}")
+    return checkpoint_id
+
+  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
+    refresh = rerun \
+      or not storage.exists(checkpoint_path) \
+      or (self.checkpointer.should_expire and self.checkpointer.should_expire(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)
+      return data
+
+    try:
+      data = 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)
+      return await self._store_on_demand(args, kw, rerun)
+
+  def _call(self, args: tuple, kw: dict, rerun=False):
+    if not self.checkpointer.when:
+      return self.fn(*args, **kw)
+    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:
+    checkpoint_path = self.checkpointer.root_path / self.get_checkpoint_id(args, kw)
+    storage = self.checkpointer.get_storage()
+    try:
+      return storage.load(checkpoint_path)
+    except:
+      raise CheckpointError("Could not load checkpoint")

checkpointer-2.0.1/checkpointer/function_body.py

@@ -0,0 +1,46 @@
+import inspect
+import relib.hashing as hashing
+from collections.abc import Callable
+from types import FunctionType, CodeType
+from pathlib import Path
+from .utils import unwrap_fn
+
+cwd = Path.cwd()
+
+def get_fn_path(fn: Callable) -> Path:
+  return Path(inspect.getfile(fn)).resolve()
+
+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_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 is_user_fn(candidate_fn, cleared_fns: set[Callable]) -> bool:
+  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)