geomancy.checks.Result#

class geomancy.checks.Result(status: str = 'pending', _allowed_re: ~typing.Pattern[str] = re.compile('^(passed|failed|pending)( \\([^\\n]+\\))?$'), msg: str = '', condition: ~typing.Callable = <built-in function all>, children: ~typing.List[~geomancy.checks.base.Result | ~typing.Awaitable[~geomancy.checks.base.Result]] = <factory>)#

A Check’s result with awareness of concurrent.futures and rich functionality

__init__(status: str = 'pending', _allowed_re: ~typing.Pattern[str] = re.compile('^(passed|failed|pending)( \\([^\\n]+\\))?$'), msg: str = '', condition: ~typing.Callable = <built-in function all>, children: ~typing.List[~geomancy.checks.base.Result | ~typing.Awaitable[~geomancy.checks.base.Result]] = <factory>) None#

Methods

__init__([status, _allowed_re, msg, ...])

rich_table([table, warning, level])

Generate a table with rich to display this result and child results

Attributes

status

Result's status--e.g.

msg

Result message used when displaying the result.

condition

The pass condition for children checks and their passed property values

children

The flat list of Results or Futures from children checks

done

Whether the check that generated this result and children checks are done

finished

Return a flat list of currently finished results

passed

Whether the check that generated this result passed.