Skip to main content

Minimal demand-driven query framework for incremental computation.

Project description

Cascade Query

cascade-query is a minimal, demand-driven incremental computation framework for Python.

It is designed for compiler-like workloads where you want:

  • lazy pull-based evaluation
  • precise dependency tracking
  • red-green early bailout (backdating)
  • query dedup across concurrent callers
  • snapshot isolation for concurrent reads
  • safe cancellation of obsolete background work
  • side-effect replay on cache hits
  • persistence + graph inspection

Minimal API

from cascade import Engine

engine = Engine()
warnings = engine.accumulator("warnings")

@engine.input
def source(file_id: str) -> str:
    return ""

@engine.query
def parse(file_id: str) -> tuple[str, ...]:
    return tuple(line.strip() for line in source(file_id).splitlines() if line.strip())

@engine.query
def symbols(file_id: str) -> tuple[str, ...]:
    return tuple(row.split("=")[0].strip() for row in parse(file_id))

Primitives

  • engine.input(fn)
    Wraps mutable roots. Use .set(...) to create new revisions.
  • engine.query(fn)
    Wraps pure demand-driven queries with memoization and dependency capture.
  • engine.accumulator(name)
    Creates thread-safe side-effect channels replayed on cache hits.
  • engine.snapshot()
    Captures an immutable read view (Snapshot) for MVCC-like isolation.
  • engine.submit(query, *args, snapshot=...)
    Runs a query in the background with cancellation if inputs mutate.
  • engine.compute_many([(query, args), ...], workers=N)
    Multi-threaded execution with a work-stealing scheduler.
  • engine.inspect_graph() / engine.traces()
    Introspection hooks for diagnostics.
  • engine.save(path) / engine.load(path)
    Persist or recover graph/cached state from SQLite.
  • engine.prune(roots)
    Garbage-collect memoized subgraphs not reachable from roots.

Design Notes

What this framework guarantees

  • Smart recalculation: only stale demand paths recompute.
  • Selective updates: unchanged parents remain green after child backdating.
  • Query deduplication: one in-flight compute serves all identical concurrent requests.
  • Cycle detection: recursive query cycles raise CycleError.
  • Cancellation: stale background queries raise QueryCancelled.

Limitations and enforceability boundaries

  • CPython GIL and CPU-bound work: compute_many and dedup execution are multi-threaded, but true CPU parallel speedup is only guaranteed when query bodies release the GIL (e.g. I/O waits, native extensions). For pure Python CPU-bound loops, overlap exists but throughput may remain effectively single-core.
  • Process-level durability model: persistence is an explicit point-in-time snapshot (save/load), not a transactional WAL-backed MVCC store shared by multiple live processes.
  • Boundary of side-effect replay guarantees: replay is guaranteed only for effects emitted through Accumulator; out-of-band side effects in query bodies (printing, network calls, filesystem writes) are intentionally not replayed.
  • Cycle handling scope: direct and long-chain dynamic query cycles are detected and raised as CycleError; this engine does not implement fixed-point solvers for cyclic dataflow.

What this framework intentionally does not include

To keep API surface minimal, this version does not include:

  • nominal interning APIs (@interned) and tracked structs (@tracked)
  • fixed-point cycle solvers
  • distributed/shared cache protocols

Those can be layered on top without changing the core query model.

Quickstart

from cascade import Engine

engine = Engine()

@engine.input
def text() -> str:
    return ""

@engine.query
def lint_count() -> int:
    value = text()
    return value.count("TODO")

text.set("TODO: one\nTODO: two")
assert lint_count() == 2

# No recompute needed if input did not semantically change.
text.set("TODO: one\nTODO: two")
assert lint_count() == 2

Examples

  • examples/compiler_pipeline.py
    Tiny compiler pipeline (source -> parse -> symbol_names -> typecheck) with warnings accumulator.
  • examples/dynamic_macro_expansion.py
    Runtime macro-expansion query that dynamically changes downstream graph dependencies.

Persistence and inspection

engine.save("state.db")
engine.load("state.db")
print(engine.inspect_graph())
for event in engine.traces():
    print(event.event, event.key, event.detail)

Analysis review of the uploaded notes

Your friend’s notes are largely directionally correct and align with state-of-the-art incremental systems:

  • Correct: pull-based demand, red-green early bailout, dependency graph capture, dedup, MVCC snapshots, cancellation, side-effect replay, tracing, and persistence.
  • Needs qualification in Python: true CPU-bound parallelism is constrained by the GIL unless query bodies release it (I/O/native extensions).
  • Overreach for this minimal implementation: unsafe-pointer lifetime tricks, red/green syntax tree internals, and fixed-point cycle solving are advanced optimizations that are not required for a practical minimal API.

Running tests

python -m pip install -e . pytest
pytest -q

CI best practices included

  • GitHub Actions workflow at .github/workflows/ci.yml.
  • Runs on both pushes and pull requests.
  • Linting with ruff before tests.
  • Separate package-build job (python -m build) to catch packaging regressions early.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

query_cascade-0.1.1.tar.gz (15.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

query_cascade-0.1.1-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file query_cascade-0.1.1.tar.gz.

File metadata

  • Download URL: query_cascade-0.1.1.tar.gz
  • Upload date:
  • Size: 15.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for query_cascade-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c996be76a2fcae9dcf5b75dc3c6412dea97d49805a111c05d70f6acee720da86
MD5 f2f3e1c197dae59ccfa369d0785849f7
BLAKE2b-256 a66f5cb6e389eb140ecdf51163ee7df67d9a276713b06f13c3b9d6cd8fb9ded9

See more details on using hashes here.

Provenance

The following attestation bundles were made for query_cascade-0.1.1.tar.gz:

Publisher: workflow.yml on hmatt1/cascade-query

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file query_cascade-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: query_cascade-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for query_cascade-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dd0a0ee32101f6486c5a816cccb711d92437f76cf2ec4216fc1d61c4c9c84c5d
MD5 882d3c546e59394e1144f48619493b03
BLAKE2b-256 48c7e181b5016924c2d5df919acef75be50076d564e33c56babc09833636fe73

See more details on using hashes here.

Provenance

The following attestation bundles were made for query_cascade-0.1.1-py3-none-any.whl:

Publisher: workflow.yml on hmatt1/cascade-query

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page