sos.reporting — Reporting Interface

This provides a restricted tag language to define the sosreport index/report

class sos.reporting.Alert(content)

Bases: sos.reporting.Leaf

ADDS_TO = 'alerts'

class sos.reporting.Command(name, return_code, href)

Bases: sos.reporting.Leaf

ADDS_TO = 'commands'

class sos.reporting.CopiedFile(name, href)

Bases: sos.reporting.Leaf

ADDS_TO = 'copied_files'

class sos.reporting.CreatedFile(name)

Bases: sos.reporting.Leaf

ADDS_TO = 'created_files'

class sos.reporting.Leaf

Bases: sos.reporting.Node

Marker class that can be added to a Section node

class sos.reporting.Node

Bases: object

can_add(node)

class sos.reporting.Note(content)

Bases: sos.reporting.Leaf

ADDS_TO = 'notes'

class sos.reporting.PlainTextReport(report_node)

Bases: object

Will generate a plain text report from a top_level Report object

ALERT = ' ! %s'

DIVIDER = '========================================================================'

LEAF = ' * %(name)s'

NOTE = ' * %s'

line_buf = []

process_subsection(section, key, header, format_)

subsections = ((<class 'sos.reporting.Command'>, ' * %(name)s', '- commands executed:'), (<class 'sos.reporting.CopiedFile'>, ' * %(name)s', '- files copied:'), (<class 'sos.reporting.CreatedFile'>, ' * %(name)s', '- files created:'), (<class 'sos.reporting.Alert'>, ' ! %s', '- alerts:'), (<class 'sos.reporting.Note'>, ' * %s', '- notes:'))

unicode()

class sos.reporting.Report

Bases: sos.reporting.Node

The root element of a report. This is a container for sections.

add(*nodes)

can_add(node)

class sos.reporting.Section(name)

Bases: sos.reporting.Node

A section is a container for leaf elements. Sections may be nested inside of Report objects only.

add(*nodes)

can_add(node)

sos.reporting.ends_bs(string)

Return True if ‘string’ ends with a backslash, and False otherwise.

Define this as a named function for no other reason than that pep8 now forbids binding of a lambda expression to a name:

‘E731 do not assign a lambda expression, use a def’