Classes
VerifyCheck
4
▼
A single diagnostic check result.
VerifyCheck
4
▼
A single diagnostic check result.
Attributes
| Name | Type | Description |
|---|---|---|
name |
str
|
— |
status |
str
|
— |
message |
str
|
— |
details |
str
|
— |
VerifyReport
8
▼
Aggregated verify report.
VerifyReport
8
▼
Aggregated verify report.
Attributes
| Name | Type | Description |
|---|---|---|
target |
str
|
— |
checks |
tuple[VerifyCheck, ...]
|
— |
Methods
passed
0
int
▼
property
passed
0
int
▼
def passed(self) -> int
Returns
int
warnings
0
int
▼
property
warnings
0
int
▼
def warnings(self) -> int
Returns
int
failures
0
int
▼
property
failures
0
int
▼
def failures(self) -> int
Returns
int
skipped
0
int
▼
property
skipped
0
int
▼
def skipped(self) -> int
Returns
int
exit_code
0
int
▼
property
exit_code
0
int
▼
def exit_code(self) -> int
Returns
int
format
0
str
▼
Render the report for terminal output.
format
0
str
▼
def format(self) -> str
Returns
str
Functions
verify
2
VerifyReport
▼
Run all verify checks against ``target``.
verify
2
VerifyReport
▼
def verify(target: str, *, timeout: float = 5.0) -> VerifyReport
Parameters
| Name | Type | Description |
|---|---|---|
target |
str |
Either a filesystem path ending in |
timeout |
float |
Seconds to wait for the subprocess MCP handshake. Default:5.0
|
Returns
VerifyReport
_load_target
1
tuple[ModuleType | None,…
▼
Import the target and return ``(module, file_path, import_check)``.
``file_pat…
_load_target
1
tuple[ModuleType | None,…
▼
def _load_target(target: str) -> tuple[ModuleType | None, Path | None, VerifyCheck]
Import the target and return(module, file_path, import_check).
file_path is Nonefor module:attr inputs. On failure the first
element isNone and import_checkcarries the diagnosis.
Parameters
| Name | Type | Description |
|---|---|---|
target |
str |
Returns
tuple[ModuleType | None, Path | None, VerifyCheck]
_find_cli_instance
2
CLI | VerifyCheck
▼
Find the CLI instance in ``module``.
For ``module:attr`` targets, look up the …
_find_cli_instance
2
CLI | VerifyCheck
▼
def _find_cli_instance(module: ModuleType, target: str) -> CLI | VerifyCheck
Find the CLI instance inmodule.
Formodule:attrtargets, look up the named attribute. For file-path
targets, scan the module for exactly oneCLIinstance.
Parameters
| Name | Type | Description |
|---|---|---|
module |
ModuleType |
|
target |
str |
Returns
CLI | VerifyCheck
_check_schemas
1
VerifyCheck
▼
Generate schemas for every command; surface docstring coverage gaps.
Coverage …
_check_schemas
1
VerifyCheck
▼
def _check_schemas(command_list: list[tuple[str, Any]]) -> VerifyCheck
Generate schemas for every command; surface docstring coverage gaps.
Coverage gaps come fromfunction_to_schema(..., warn_missing_docs=True)
so verify sees the same undocumented-param judgement as production schema
generation would, were it opted in.
Parameters
| Name | Type | Description |
|---|---|---|
command_list |
list[tuple[str, Any]] |
Returns
VerifyCheck
_check_in_process_mcp
2
VerifyCheck
▼
Call ``_list_tools(cli)`` and validate shape.
_check_in_process_mcp
2
VerifyCheck
▼
def _check_in_process_mcp(cli: CLI, expected_count: int) -> VerifyCheck
Parameters
| Name | Type | Description |
|---|---|---|
cli |
CLI |
|
expected_count |
int |
Returns
VerifyCheck
_check_subprocess_mcp
2
VerifyCheck
▼
Start `python --mcp`, handshake, verify tools/list response.
_check_subprocess_mcp
2
VerifyCheck
▼
def _check_subprocess_mcp(path: Path, *, timeout: float) -> VerifyCheck
Parameters
| Name | Type | Description |
|---|---|---|
path |
Path |
|
timeout |
float |
Returns
VerifyCheck