calkit-python 0.48.2__tar.gz → 0.49.0__tar.gz

{calkit_python-0.48.2 → calkit_python-0.49.0}/.pre-commit-config.yaml

@@ -85,10 +85,10 @@ repos:
         # the pipeline changes. Prettier and ruamel disagree about where a
         # long 'desc:' value goes, so formatting it here just means the two
         # take turns reformatting the same file.
-        # Likewise results files, here and in the example projects, which
-        # are stage outputs and have to match what the stage wrote byte for
-        # byte.
-        exclude: calkit|^hub/|(^|/)dvc\.yaml$|^(examples/.*/)?results/
+        # Likewise results files, here, in the example projects, and in
+        # decisions, which are stage outputs and have to match what the stage
+        # wrote byte for byte.
+        exclude: calkit|^hub/|(^|/)dvc\.yaml$|^((examples/.*|decisions)/)?results/
 
   - repo: local
     hooks:

{calkit_python-0.48.2 → calkit_python-0.49.0}/AGENTS.md

@@ -25,6 +25,9 @@ To run tests, use `uv run pytest`.
 
 To sync the docs and format all the code, run `make format`.
 
+Before pushing a pull request, run `make pr`, which also runs the project's
+pipeline and pushes its outputs, so the pipeline check passes.
+
 Before finishing a change, type-check it. The CLI gate is mypy
 (`uv run mypy <changed files>`, or `make check` for the full suite), and the
 VS Code editor uses Pylance (Pyright). Keep new code clean under both, and do

{calkit_python-0.48.2 → calkit_python-0.49.0}/Makefile

@@ -28,6 +28,23 @@ format: ## Automatically format files and regenerate what's generated.
 	@echo "🚀 Linting code with pre-commit"
 	@uv run pre-commit run -a
 
+.PHONY: pr
+pr: ## Get a pull request ready to pass: format, and run the pipeline.
+	@echo "🚀 Formatting, then checking it's done"
+	@uv run pre-commit run -a > /dev/null || uv run pre-commit run -a
+	@echo "🚀 Pulling the pipeline's outputs, so only what changed reruns"
+	@uv run calkit dvc pull || true
+	@echo "🚀 Running the pipeline"
+	@uv run calkit run
+	@echo "🚀 Pushing the pipeline's outputs"
+	@uv run calkit dvc push
+	@echo "🚀 Checking the run left nothing to format or rerun"
+	@files="$$(git diff --name-only)"; \
+		[ -z "$$files" ] || uv run pre-commit run --files $$files
+	@uv run calkit status --json | uv run python -c \
+		"import json, sys; sys.exit(json.load(sys.stdin)['pipeline']['is_stale'])" \
+		|| (echo "The pipeline is stale; see 'calkit status'" && exit 1)
+
 .PHONY: check
 check: format ## Run code quality tools.
 	@echo "🚀 Checking lock file consistency with 'pyproject.toml'"

{calkit_python-0.48.2 → calkit_python-0.49.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: calkit-python
-Version: 0.48.2
+Version: 0.49.0
 Summary: Reproducibility simplified.
 Project-URL: Homepage, https://calkit.org
 Project-URL: Issues, https://github.com/calkit/calkit/issues
@@ -29,6 +29,7 @@ Requires-Dist: docx2pdf
 Requires-Dist: dulwich>=1.2.5
 Requires-Dist: dvc[all]==3.67.1
 Requires-Dist: fastapi
+Requires-Dist: filelock
 Requires-Dist: fsspec>=2026.4.0
 Requires-Dist: gitpython
 Requires-Dist: json2latex>=0.0.3
@@ -47,12 +48,13 @@ Requires-Dist: python-dotenv>=1
 Requires-Dist: pywin32; platform_system == 'Windows'
 Requires-Dist: requests
 Requires-Dist: rich
+Requires-Dist: ruamel-yaml-clib>=0.2.15; platform_python_implementation == 'CPython' and python_version < '3.15' and (sys_platform == 'darwin' or (sys_platform == 'linux' and (platform_machine == 'x86_64' or platform_machine == 'aarch64' or platform_machine == 'i686')) or (sys_platform == 'win32' and (platform_machine == 'AMD64' or platform_machine == 'x86')))
 Requires-Dist: ruamel-yaml<0.20,>=0.19.1
 Requires-Dist: sqlitedict>=2.1.0
 Requires-Dist: texsoup>=0.3.3
 Requires-Dist: toml>=0.10.2
 Requires-Dist: tqdm>=4.67.1
-Requires-Dist: typer==0.27.2
+Requires-Dist: typer==0.27.3
 Requires-Dist: uvicorn
 Provides-Extra: data
 Requires-Dist: pandas>=2.2.3; extra == 'data'
@@ -549,7 +551,7 @@ calkit status
 ```
 --------------------------- Questions ----------------------------
 1 question, 1 with stale evidence
-Run 'calkit check questions' for detail.
+Run 'calkit check questions' for details.
 
 ---------------------------- Pipeline ----------------------------
 Stale stages:

{calkit_python-0.48.2 → calkit_python-0.49.0}/README.md

@@ -486,7 +486,7 @@ calkit status
 ```
 --------------------------- Questions ----------------------------
 1 question, 1 with stale evidence
-Run 'calkit check questions' for detail.
+Run 'calkit check questions' for details.
 
 ---------------------------- Pipeline ----------------------------
 Stale stages:

{calkit_python-0.48.2 → calkit_python-0.49.0}/calkit/calc.py

@@ -4,14 +4,20 @@ from __future__ import annotations
 
 from typing import Annotated, Literal
 
-from pydantic import BaseModel, Discriminator, model_validator
+from pydantic import BaseModel, ConfigDict, Discriminator, model_validator
 
 DTYPES = {"int": int, "float": float, "str": str}
 DEFAULT_IN_TYPE = "float"
 DEFAULT_OUT_TYPE = "float"
 
 
-class Input(BaseModel):
+class _Model(BaseModel):
+    # As calkit.models.base.Model, which importing here would import
+    # calkit.models, which imports this
+    model_config = ConfigDict(defer_build=True)
+
+
+class Input(_Model):
     name: str
     description: str | None = None
     dtype: Literal["int", "float", "str"] = DEFAULT_IN_TYPE
@@ -19,14 +25,14 @@ class Input(BaseModel):
     max: int | float | None = None
 
 
-class Output(BaseModel):
+class Output(_Model):
     name: str
     description: str | None = None
     dtype: Literal["int", "float", "str"] = DEFAULT_OUT_TYPE
     template: str | None = None
 
 
-class Calculation(BaseModel):
+class Calculation(_Model):
     kind: str
     params: dict = {}
     name: str | None = None
@@ -124,7 +130,7 @@ class Calculation(BaseModel):
         return template.format(**(inputs | {out_name: res}))
 
 
-class FormulaParams(BaseModel):
+class FormulaParams(_Model):
     formula: str
 
 
@@ -139,7 +145,7 @@ class Formula(Calculation):
         return arithmetic_eval.evaluate(self.params.formula, inputs)
 
 
-class LinearParams(BaseModel):
+class LinearParams(_Model):
     coeffs: dict[str, float]
     offset: float = 0.0
 
@@ -163,7 +169,7 @@ class Linear(Calculation):
         return val
 
 
-class LookupTableParams(BaseModel):
+class LookupTableParams(_Model):
     x_values: list[float]
     y_values: list[float]
     method: Literal["floor", "ceil", "round", "interpolate"] = "interpolate"
@@ -176,7 +182,7 @@ class LookupTable(Calculation):
     params: LookupTableParams
 
 
-class HttpRequestParams(BaseModel):
+class HttpRequestParams(_Model):
     url: str
     inputs_as_params: bool = True  # Otherwise, use body
     method: Literal["get", "post", "put"] = "get"
@@ -210,7 +216,7 @@ class HttpRequest(Calculation):
             return resp.text
 
 
-class XGBoostModelParams(BaseModel):
+class XGBoostModelParams(_Model):
     path: str
     type: Literal["classifier", "regressor"]
 

calkit_python-0.49.0/calkit/cli/__init__.py

@@ -0,0 +1,117 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from .core import *  # noqa: F403
+
+if TYPE_CHECKING:
+    import typer
+
+
+def run() -> None:
+    import os
+    import sys
+
+    # Intercept ``--use-version`` before Typer/Click parses argv: Click
+    # processes eager options like ``--help`` and ``--version`` (and the
+    # group's ``no_args_is_help``) ahead of the callback body, so an
+    # invocation like ``calkit --use-version 0.1.1 -- --help`` would
+    # otherwise print the *current* CLI's help instead of re-execing
+    # under the requested version.
+    _maybe_exec_with_version()
+    from .main import app
+
+    # Completion lists commands, so needs them all
+    if any(k.startswith("_") and k.endswith("_COMPLETE") for k in os.environ):
+        app()
+    else:
+        _only_invoked(app, sys.argv[1:])()
+
+
+def _only_invoked(
+    app: typer.Typer, args: list[str], top: bool = True
+) -> typer.Typer:
+    """Narrow ``app`` to the command or group ``args`` invoke.
+
+    Typer builds every command's options before running one, which for all
+    of Calkit's takes a few tenths of a second, so this leaves out the ones
+    that won't run. Anything else, e.g., ``--help`` or a misspelled command,
+    keeps them all, so help and suggestions list everything.
+    decisions/calkit.yaml has a question on how much that saves.
+    """
+    import copy
+    import re
+
+    from typer.main import get_command_name, solve_typer_info_defaults
+
+    from .main.core import APP_OPTIONS_WITH_VALUES
+
+    # Find the command name, skipping the top level's options
+    takes_value = {
+        flag for flags in APP_OPTIONS_WITH_VALUES.values() for flag in flags
+    }
+    i = 0
+    while i < len(args) and args[i].startswith("-") and top:
+        i += 2 if args[i] in takes_value else 1
+    if i >= len(args) or args[i].startswith("-"):
+        return app
+    name, rest = args[i], args[i + 1 :]
+
+    def names(spec: str | None) -> list[str]:
+        return re.split(r" ?[,|] ?", spec) if spec else []
+
+    narrowed = copy.copy(app)
+    for cmd in app.registered_commands:
+        default = cmd.callback and get_command_name(cmd.callback.__name__)
+        if name in names(cmd.name or default):
+            narrowed.registered_commands = [cmd]
+            narrowed.registered_groups = []
+            return narrowed
+    for group in app.registered_groups:
+        sub_app = group.typer_instance
+        if sub_app and name in names(solve_typer_info_defaults(group).name):
+            group = copy.copy(group)
+            group.typer_instance = _only_invoked(sub_app, rest, top=False)
+            narrowed.registered_commands = []
+            narrowed.registered_groups = [group]
+            return narrowed
+    return app
+
+
+def _maybe_exec_with_version() -> None:
+    import sys
+
+    # Only scan the group's option region -- the tokens before the first
+    # subcommand (or the ``--`` end-of-options marker). A ``--use-version``
+    # buried in a forwarded arg (e.g. ``calkit xenv -- some-tool
+    # --use-version 1.0``) must not trigger a re-exec.
+    argv = sys.argv[1:]
+    version_spec: str | None = None
+    i = 0
+    while i < len(argv):
+        a = argv[i]
+        if a == "--":
+            break
+        if not a.startswith("-"):
+            # First non-option token is the subcommand name; stop here.
+            break
+        if a == "--use-version" and i + 1 < len(argv):
+            version_spec = argv[i + 1]
+            break
+        if a.startswith("--use-version="):
+            version_spec = a.split("=", 1)[1]
+            break
+        # Skip past an option's value when it takes one (heuristic: a
+        # following token that doesn't itself look like a flag). Worst
+        # case we treat a flag-with-no-value as one with one, which only
+        # affects where the loop terminates -- the outer ``break``s above
+        # still fire first if --use-version is present.
+        if i + 1 < len(argv) and not argv[i + 1].startswith("-"):
+            i += 2
+        else:
+            i += 1
+    if not version_spec:
+        return
+    from .main.core import _exec_with_version
+
+    _exec_with_version(version_spec)