status

class Category(*values)

Bases: str, Enum

PASS = 'PASS'

FAIL = 'FAIL'

CANCEL = 'CANCEL'

SKIP = 'SKIP'

NONE = 'NONE'

classmethod factory(arg: Category | str) → Category

rich_color() → str

hex_color() → str

class Outcome(*values)

Bases: IntEnum

NONE = -1

SUCCESS = 0

XDIFF = 10

XFAIL = 11

DIFFED = 64

FAILED = 65

ERROR = 66

BROKEN = 67

TIMEOUT = 68

INVALID = 69

CANCELLED = 70

INTERRUPTED = 71

SKIPPED = 80

BLOCKED = 81

property label: str

classmethod factory(arg: Outcome | str | int) → Outcome

glyph() → str

class Status(category: _canary.status.Category = <Category.NONE: 'NONE'>, outcome: _canary.status.Outcome = <Outcome.NONE: -1>, reason: str | None = None, code: int = -1)

Bases: object

category: Category

outcome: Outcome

reason: str | None

code: int

reset() → None

is_success() → bool

is_failure() → bool

is_skipped() → bool

is_cancelled() → bool

is_unset() → bool

is_terminal() → bool

is_blocked() → bool

is_diffed() → bool

is_failed() → bool

is_error() → bool

is_timeout() → bool

is_xfail() → bool

is_xdiff() → bool

has_code(arg: int) → bool

property returncode: int

set(*, category: Category | str | None = None, outcome: Outcome | str | None = None, reason: str | None = None, code: int = -1) → None

classmethod from_dict(data: MutableMapping[str, Any]) → Status

display_name(*, style: Literal['none', 'rich', 'html'] = 'none', glyph: bool = False) → str

rich_color() → str

hex_color() → str

glyph() → str

classmethod SUCCESS()

classmethod XFAIL()

classmethod XDIFF()

classmethod FAILED(reason: str | None = None, code: int = -1)

classmethod DIFFED(reason: str | None = None, code: int = -1)

classmethod TIMEOUT(code: int = -1)

classmethod ERROR(reason: str | None = None, code: int = -1)

classmethod BROKEN(reason: str | None = None, code: int = -1)

classmethod SKIPPED(reason: str | None = None)

classmethod BLOCKED(reason: str | None = None)

classmethod CANCELLED(reason: str | None = None)

classmethod INTERRUPTED(reason: str | None = None)

get_category(arg: Outcome) → Category

get_possible_outcomes(arg: Category) → tuple[Outcome, ...]

get_default_outcome(arg: Category) → Outcome