Reposition README around lint-time checking and coverage gate, refresh benchmarks - #57
Merged
Merged
Conversation
…h benchmarks The checker is mostly used today as a zero-schema linter with a DataFrame coverage threshold for CI (like a test-coverage or bandit gate), not as a schema-definition tool, so the hero example and "Why typedframes?" section now lead with that instead of BaseSchema. Also re-ran the benchmark suite for current tool versions/numbers, fixed a stale --json flag reference (the hidden legacy alias for --output-format=json), and corrected two performance claims (~1ms standalone checker, 10-60x faster ty) that no longer matched measured results.
CI's format-check task lints Python code fenced in README.md too; the extra space before the inline comment tripped it.
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.
Summary
BaseSchemaschema definitions. Schema classes are now framed as a progressive enhancement (cross-file awareness, IDE autocomplete) and moved into Quick Start.benchmarks/benchmark_checkers.py --update-readmefor current tool versions and timings (ruff 0.16.2, ty 0.0.69, pyrefly 1.2.0, mypy 2.3.0; pyright already current).--jsonexample replaced with--output-format=json(the documented flag;--jsonis a hidden legacy alias in the CLI).Test plan
uv run pytest -q— 299 passed#anchorlink in the README resolves to a real heading--flagmentioned in the README exists intypedframes check --helpuv.lockfiles — no change needed there