_pytest.terminal module

terminal reporting of the full testing process.

This is a good source for looking at the various reporting hooks.

_getdimensions() → Tuple[int, int]

get_terminal_width() → int

class MoreQuietAction(option_strings, dest, default=None, required=False, help=None)

Bases: argparse.Action

a modified copy of the argparse count action which counts down and updates the legacy quiet attribute at the same time

used to unify verbosity handling

pytest_addoption(parser)

pytest_configure(config: _pytest.config.Config) → None

getreportopt(config: _pytest.config.Config) → str

pytest_report_teststatus(report: _pytest.reports.TestReport) → Tuple[str, str, str]

class WarningReport(warning: warnings.WarningMessage, when: str, fslocation: Tuple[str, int], nodeid: Optional[str] = None)

Bases: object

Holds information for warnings captured by TerminalReporter.pytest_warning_captured().

warning

The original warning.

when

When the warning was captured, e.g. “config”, “collect”, or “runtest” (see _pytest.hookspec.pytest_warning_captured()).

fslocation

Source of the warning (file system location, see get_location()).

nodeid

Node id that generated the warning (see get_location()).

count_towards_summary = True

message

Formatted warning (the standard way, without trailing newline).

source_line

get_location(config: _pytest.config.Config) → str

Returns the more user-friendly information about the location of a warning.

class TerminalReporter(config: _pytest.config.Config, file=None)

Bases: object

_collect_ignored: Dict[str, List[py.path.local]]

Information about ignored paths (for reporting).

_determine_show_progress_info()

Return True if we should display progress information based on the current config

verbosity

showheader

showfspath

showlongtestinfo

hasopt(char)

write_fspath_result(nodeid, res, **markup)

write_ensure_prefix(prefix, extra='', **kwargs)

ensure_newline()

write(content, **markup)

write_line(line, **markup)

rewrite(line, **markup)

Rewinds the terminal cursor to the beginning and writes the given line.

Parameters

erase – if True, will also add spaces until the full terminal width to ensure previous lines are properly erased.

The rest of the keyword arguments are markup instructions.

write_sep(sep, title=None, **markup)

section(title, sep='=', **kw)

line(msg, **kw)

_add_stats(category: str, items: List) → None

pytest_internalerror(excrepr)

pytest_warning_captured(when: str, warning_message: warnings.WarningMessage, item: _pytest.nodes.Item) → None

pytest_plugin_registered(plugin)

pytest_deselected(items)

pytest_runtest_logstart(nodeid, location)

pytest_runtest_logreport(report: _pytest.reports.TestReport) → None

_is_last_item

pytest_runtest_logfinish() → None

Write progress if past edge.

for ... in pytest_runtestloop() → Generator[None, None, None]

Write final progress indicator.

_get_progress_information_message() → str

_write_progress_information_filling_space()

_width_of_current_line

Return the width of current line, using the superior implementation of py-1.6 when available

pytest_collection() → None

pytest_collectreport(report: _pytest.reports.CollectReport) → None

report_collect(final: bool = False) → None

_verbose_collect_ignored() → List[str]

Get information about ignored files during collection.

pytest_sessionstart(session: _pytest.main.Session) → None

_write_report_lines_from_hooks(lines)

pytest_report_header(config: _pytest.config.Config) → List[str]

for ... in pytest_ignore_collect(path: py._path.local.LocalPath) → Generator[None, pluggy.callers._Result, None]

Register ignored files during collection for reporting.

pytest_collection_finish(session)

_printcollecteditems(items: Sequence[_pytest.nodes.Item]) → None

for ... in pytest_sessionfinish(session: _pytest.main.Session, exitstatus: _pytest.config.ExitCode)

for ... in pytest_terminal_summary()

pytest_keyboard_interrupt(excinfo: _pytest._code.code.ExceptionInfo) → None

pytest_unconfigure()

_report_keyboardinterrupt()

_locationline(nodeid, fspath, lineno, domain)

_getfailureheadline(rep)

_getcrashline(rep)

getreports(name)

summary_warnings() → None

summary_passes()

_get_teardown_reports(nodeid: str) → List[_pytest.reports.TestReport]

_handle_teardown_sections(nodeid: str) → None

print_teardown_sections(rep: _pytest.reports.TestReport) → None

summary_failures()

summary_errors()

_outrep_summary(rep)

summary_stats() → None

short_test_summary() → None

_get_main_color() → Tuple[str, List[str]]

_determine_main_color(unknown_type_seen: bool) → str

_set_main_color() → None

build_summary_stats_line() → Tuple[List[Tuple[str, Dict[str, bool]]], str]

_get_rep_reprcrash(rep: Union[_pytest.reports.CollectReport, _pytest.reports.TestReport], fulltrace: bool) → Optional[_pytest._code.code.ReprFileLocation]

_get_pos(config: _pytest.config.Config, rep: Union[_pytest.reports.CollectReport, _pytest.reports.TestReport]) → str

_get_line_with_reprcrash_message(config: _pytest.config.Config, rep: Union[_pytest.reports.CollectReport, _pytest.reports.TestReport], termwidth: Optional[int]) → str

Get summary line for a report, trying to add reprcrash message.

_folded_skips(skipped)

_make_plural(count, noun)

_plugin_nameversions(plugininfo) → List[str]

format_session_duration(seconds: float) → str

Format the given seconds in a human readable manner to show in the final summary