_pytest.assertion package

Submodules

• _pytest.assertion.rewrite module
• _pytest.assertion.truncate module
• _pytest.assertion.util module

Module contents

support for presenting detailed information in failing assertions.

pytest_addoption(parser)

register_assert_rewrite(*names) → None

Register one or more module names to be rewritten on import.

This function will make sure that this module or all modules inside the package will get their assert statements rewritten. Thus you should make sure to call this before the module is actually imported, usually in your __init__.py if you are a plugin using a package.

Raises

TypeError – if the given module names are not strings.

class DummyRewriteHook

Bases: object

A no-op import hook for when rewriting is disabled.

mark_rewrite(*names)

class AssertionState(config, mode)

Bases: object

State for the assertion plugin.

install_importhook(config)

Try to install the rewrite hook, raise SystemError if it fails.

pytest_collection(session: Session) → None

for ... in pytest_runtest_protocol(item)

Setup the pytest_assertrepr_compare and pytest_assertion_pass hooks

The newinterpret and rewrite modules will use util._reprcompare if it exists to use custom reporting via the pytest_assertrepr_compare hook. This sets up this custom comparison for the test.

pytest_sessionfinish(session)

pytest_assertrepr_compare(config: _pytest.config.Config, op: str, left: Any, right: Any) → Optional[List[str]]