BloqCheckException

qualtran.testing.BloqCheckException

View source on GitHub

An exception raised by the assert_bloq_example_xxx functions in this module.

qualtran.testing.BloqCheckException(
    check_result: qualtran.testing.BloqCheckResult,
    msg: str
)

These exceptions correspond to known failures due to assertion errors, non-applicable checks, or unverified protocols.

Consider using the factory class methods BloqCheckException.{fail, missing, na, unverified} for convenience.

Args

check_result

The BloqCheckResult.

msg

A message providing details for the exception.

Attributes

check_result

The BloqCheckResult.

msg

A message providing details for the exception.

Methods

fail

View source

@classmethod
fail(
    msg: str
) -> 'BloqCheckException'

Create an exception with a FAIL check result.

missing

View source

@classmethod
missing(
    msg: str
) -> 'BloqCheckException'

Create an exception with a MISSING check result.

na

View source

@classmethod
na(
    msg: str
) -> 'BloqCheckException'

Create an exception with a NA check result.

unverified

View source

@classmethod
unverified(
    msg: str
) -> 'BloqCheckException'

Create an exception with an UNVERIFIED check result.