testplan.testing.multitest.entries.stdout package

Submodules

testplan.testing.multitest.entries.stdout.assertions module

Loggers for assertion objects

class testplan.testing.multitest.entries.stdout.assertions.ApproximateEqualityAssertionRenderer

Bases: AssertionRenderer

get_assertion_details(entry)

Use a format like 99 ~= 100 (with rel_tol=0.1, abs_tol=0.0), highlighting failing comparisons in red.

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.AssertionRenderer

Bases: BaseRenderer

Default assertion logger. Renders simple details (file & line no), and assertion name/description and pass/fail status as header.

get_assertion_details(entry)

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.ColumnContainRenderer

Bases: AssertionRenderer

get_assertion_details(entry)

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.DictCheckRenderer

Bases: AssertionRenderer

get_assertion_details(entry)

Return has_keys & absent_keys context

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.DictMatchAllRenderer

Bases: AssertionRenderer

get_assertion_details(entry)

Return fix and dict match_all result representations

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.DictMatchRenderer

Bases: AssertionRenderer

get_assertion_details(entry)

Return fix and dict match result representations

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.EqualExcludeSlicesRenderer

Bases: AssertionRenderer

Display excluded indexes, compared indexes, actual and expected iterables.

get_assertion_details(entry)

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.EqualSlicesRenderer

Bases: AssertionRenderer

Display slice, comparison indexes, mismatch indexes, actual and expected iterables.

Sample output:

Equal Slices - Pass

slice(2, 4, None)

Actual: [3, 4] Expected: [3, 4]

slice(5, 7, None)

Actual: [‘d’, ‘e’] Expected: [6, 7]

get_assertion_details(entry)

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.ExceptionRaisedRenderer

Bases: AssertionRenderer

get_assertion_details(entry)

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.FailRenderer

Bases: AssertionRenderer

get_assertion_details(entry)

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.FunctionAssertionRenderer

Bases: AssertionRenderer

get_assertion_details(entry)

Use a format like 1 == 2, highlighting failing comparisons in red.

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.LineDiffRenderer

Bases: AssertionRenderer

Display 2 blocks of textual content, truncate them if too long, also display the difference between them if found.

get_assertion_details(entry)

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.LogfileMatchRender

Bases: AssertionRenderer

get_assertion_details(entry: LogfileMatch)

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.MembershipRenderer

Bases: AssertionRenderer

get_assertion_details(entry)

Return the member and container representations

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.RegexFindIterRenderer

Bases: RegexMatchRenderer

get_assertion_details(entry)

Render condition attribute as well, if it exists

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

highlight_color = 'green'

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.RegexMatchLineRenderer

Bases: AssertionRenderer

get_assertion_details(entry)

RegexMatchLine returns line indexes along with begin/end character indexes per matched line. Note: pattern & string (despite the name) could be bytes

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.RegexMatchRenderer

Bases: AssertionRenderer

get_assertion_details(entry)

Return highlighted patterns within the string, if there is a match. Note that pattern & string (despite the name) could be bytes

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

highlight_color = 'green'

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.RegexNotMatchRenderer

Bases: RegexMatchRenderer

get_assertion_details(entry)

Return highlighted patterns within the string, if there is a match. Note that pattern & string (despite the name) could be bytes

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

highlight_color = 'red'

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.TableMatchRenderer

Bases: AssertionRenderer

Renders tabular data in ASCII table format

Sample output:

age	name
32 == 32 24 == 24 67 == 67	Bob == Bob Susan == Susan Rick != David

get_assertion_details(entry)

Return row by row match results in tabular format

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

get_row_data(row_comparison, columns, include_columns=None, exclude_columns=None, display_index=False)

Return single row data to be printed

pass_label(entry)

class testplan.testing.multitest.entries.stdout.assertions.XMLCheckRenderer

Bases: AssertionRenderer

Renderer for XMLCheck

get_assertion_details(entry)

Render the message if there is any, then render XMLTagComparison items.

get_default_header(entry)

get_details(entry)

Return file & line no (failing entries only), along with the extra info returned by get_assertion_details.

get_header(entry)

get_header_text(entry)

pass_label(entry)

testplan.testing.multitest.entries.stdout.assertions.add_printable_dict_comparison(result, row)

Stdout representation of fix/dict match rows.

testplan.testing.multitest.entries.stdout.base module

Stdout renderers for assertion/entry objects.

Unlike exporters, stdout renderers receive native entry objects, instead of their serialized (dict) versions.

class testplan.testing.multitest.entries.stdout.base.AttachmentRenderer

Bases: BaseRenderer

get_default_header(entry)

get_details(entry)

get_header(entry)

get_header_text(entry)

class testplan.testing.multitest.entries.stdout.base.BaseRenderer

Bases: object

Absolute fallback for all entries.

get_default_header(entry)

get_details(entry)

get_header(entry)

get_header_text(entry)

class testplan.testing.multitest.entries.stdout.base.DictLogRenderer

Bases: BaseRenderer

get_default_header(entry)

get_details(entry)

get_header(entry)

get_header_text(entry)

class testplan.testing.multitest.entries.stdout.base.DirectoryRenderer

Bases: BaseRenderer

get_default_header(entry)

get_details(entry)

get_header(entry)

get_header_text(entry)

class testplan.testing.multitest.entries.stdout.base.GroupRenderer

Bases: object

get_header(entry)

class testplan.testing.multitest.entries.stdout.base.LogRenderer

Bases: BaseRenderer

get_default_header(entry)

get_details(entry)

get_header(entry)

get_header_text(entry)

class testplan.testing.multitest.entries.stdout.base.MatPlotRenderer

Bases: BaseRenderer

get_default_header(entry)

get_details(entry)

get_header(entry)

get_header_text(entry)

class testplan.testing.multitest.entries.stdout.base.PlotlyRenderer

Bases: BaseRenderer

get_default_header(entry)

get_details(entry)

get_header(entry)

get_header_text(entry)

class testplan.testing.multitest.entries.stdout.base.StdOutRegistry

Bases: Registry

bind(*classes)

Decorator for binding one or more classes to another.

Parameters:

classes – One or more classes that will be bound to the decorated class.

bind_default(category=None)

Decorator for binding a class as category based or absolute default.

Parameters:

category – (optional) If provided, the decorated class will be the default for the given category, otherwise it will be the absolute default.

property default

get_category(obj)

Override this to define logic for generating the category key from the object instance.

get_lookup_key(obj)

This method is used for generating the key when do a lookup from the registry. Object class is used by default.

get_record_key(obj)

This method is used for generating the key when we bind an object (possibly a class) via the registry.

indented_msg(msg, indent)

log_entry(entry, stdout_style)

property logger: TestplanLogger

logger object

class testplan.testing.multitest.entries.stdout.base.TableLogRenderer

Bases: BaseRenderer

get_default_header(entry)

get_details(entry: TableLog) → str

This method converts the entire input table into a string using AsciiTable.

Parameters:

entry – the TableLog object we want to convert

Returns:

rows of the input table joined into a single string with newline characters

get_header(entry)

get_header_text(entry)

Module contents

This module contains logic for printing out assertion details as tests run.