_check - Chirp

cli._check

module

chirp check— hypermedia contract validation command.

Resolves an import string to a chirp App and runs contract validation, printing results to stdout. Exits with code 1 if errors are found.

chirp check— hypermedia contract validation command.

Resolves an import string to a chirp App and runs contract validation, printing results to stdout. Exits with code 1 if errors are found.

cli._check

Name	Type	Default	Description
`type`		—
`qualified_name`		—
`element_type`		—
`description`		—
`source_file`		—
`line_number`		—
`is_autodoc`		—
`autodoc_element`		—
`_autodoc_template`		—
`_autodoc_url_path`		—
`_autodoc_page_type`		—
`title`		—
`doc_content_hash`		—

Symbols on this page

function run_check

Validate hypermedia contracts for a chirp app.

Resolvesargs.appto a Chirp App, collects the structured contract result, then applies the established terminal presentation…

function collect_check_result

Return a stable contract payload plus CLI-only presentation metadata.

function _baseline_result

Compare a current structured check with a stored baseline.

run_check

function

def run_check(args: argparse.Namespace) -> None

Validate hypermedia contracts for a chirp app.

Resolvesargs.appto a Chirp App, collects the structured contract result, then applies the established terminal presentation and exit policy.

Parameters

Name	Type	Default	Description
`args`	`argparse.Namespace`	—

collect_check_result

function

def collect_check_result(app_import: str, *, warnings_as_errors: bool = False, coverage: bool = False, deploy: bool = False, json_output: bool = False, baseline: str | None = None, include_info: bool = False) -> InspectionResult

Return a stable contract payload plus CLI-only presentation metadata.

Parameters

Name	Type	Default
`app_import`	`str`	—
`warnings_as_errors`	`bool`	`False`
`coverage`	`bool`	`False`
`deploy`	`bool`	`False`
`json_output`	`bool`	`False`
`baseline`	`str \| None`	`None`
`include_info`	`bool`	`False`

_baseline_result

function

def _baseline_result(current: dict[str, Any], *, baseline: str, json_output: bool, warnings_as_errors: bool) -> InspectionResult

Compare a current structured check with a stored baseline.

Parameters

Name	Type	Default
`current`	`dict[str, Any]`	—
`baseline`	`str`	—
`json_output`	`bool`	—
`warnings_as_errors`	`bool`	—

View source · /home/runner/work/chirp/chirp/site/../src/chirp/cli/_check.py:1