Decorator-first docs and demo; fix review nits from #1 - #2
Merged
eddietejeda merged 1 commit intoJul 22, 2026
Merged
Conversation
- DESIGN.md: split the decorator API into implemented (first cut) vs planned knobs; mark the MaterializedFrame section's implemented subset; tick step 2 in the build order - demo: compare.py now goes through @materialize end to end (evict/flush via get_runtime for benchmark mechanics); Decimals round-trip natively - README: note that frame.sql() needs a persisted entry - decorator: frame.sql() no longer rewrites `this` inside quoted SQL literals/identifiers (review nit); documented the miss-frame .sql() behavior (review nit)
eddietejeda
merged commit Jul 22, 2026
ac5bdf3
into
feat/ci-and-materialize-decorator
2 checks passed
eddietejeda
added a commit
that referenced
this pull request
Jul 22, 2026
Decorator-first docs and demo; fix review nits (re-land #2)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documentation and demo follow-up to #1 — everything now presents the decorator as the way in:
key/ttl/version/background/key_fn) from planned knobs (mode,invalidate_on,index,on_error,from_queryset), so nothing user-facing documents parameters that don't exist. MaterializedFrame section marks the implemented subset; build order ticks step 2.compare.pyexercises@materializeend to end instead of hand-rolling the primitives — the benchmark now tests exactly what the README tells users to write. Verified live: Q1 hit 82 ms (16.3×), parts hit 153 ms (12.8×), perceived miss ≈ direct on both. Decimals round-trip natively now (previously normalized to floats).frame.sql()no longer rewritesthisinside quoted string literals/identifiers (with a regression test), and the miss-frame.sql()behavior is documented in the README and docstring.Tests
68 passing; mypy and flake8 clean.
Stacked on #1 (base branch:
feat/ci-and-materialize-decorator).