check#

canary_addcommand(parser: Parser) None#
class Action(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)#

Bases: Action

class Check#

Bases: CanarySubcommand

name: str = 'check'#
description: str = "Run canary's internal checks"#
add_help: bool = False#
setup_parser(parser: Parser) None#
execute(args: Namespace) int#
static find_pyt_files(top: str) list[str]#
format_code(args: Namespace)#
lint_check_code(args: Namespace)#
security_check(args: Namespace)#
type_check_code(args: Namespace)#
run_tests(args: Namespace)#
make_docs(args: Namespace)#
make(*args: str, **kwargs: Any) CompletedProcess#
ruff(*args: str, **kwargs: Any) CompletedProcess#
ruff_check(*paths: str, **kwargs) CompletedProcess#
bandit(*args: str, **kwargs: Any) CompletedProcess#
typecheck(*args: str, **kwargs: Any) CompletedProcess#
pytest(*args: str, **kwargs: Any) CompletedProcess#
class PytestResult(path: str, returncode: int, stdout: str, stderr: str, elapsed_s: float)#

Bases: object

path: str#
returncode: int#
stdout: str#
stderr: str#
elapsed_s: float#
property ok: bool#
run_pytest_one(root: str, relpath: str, pytest_args: tuple[str, ...] = ()) PytestResult#
run_pytests_parallel(root: Path, test_paths: tuple[str, ...], *, max_workers: int | None = None, pytest_args: tuple[str, ...] = ()) list[PytestResult]#
coverage(*args: str, **kwargs: Any) CompletedProcess#