types

class CanarySubcommand

Bases: object

Canary subcommand used when defining a Canary subcommand plugin hook.

Parameters:

• name – Subcommand name (e.g., canary my-subcommand)

• description – Subcommand description, shown in canary --help

• in_repo – Subcommand should be exected inside a test session folder

• execute – Called when the subcommand is invoked

• setup_parser – Called when the subcommand parser is initialized

• epilog – Epilog printed for canary my-subcommand --help

• add_help – Whether to add subcommand to canary --help

name: str

description: str

epilog: str | None = None

add_help: bool = True

setup_parser(parser: Parser) → None

execute(args: Namespace) → int

class CanaryReporter

Bases: object

Canary reporter class

Parameters:

• type – Report type name (e.g., canary report my-report)

• description – Subcommand description, shown in canary report --help

• execute – Called when the subcommand is invoked

• setup_parser – Called when the subcommand parser is initialized

• multipage – Whether the report is a multi-page report

type: str

description: str

multipage: bool = False

default_output: str = 'report.ext'

setup_parser(parser: Parser) → None

create(**kwargs: Any) → None

not_implemented(**kwargs: Any) → None