teatime.reporting package

Submodules

teatime.reporting.issue module

This module contains data structures regarding issues.

class teatime.reporting.issue.Issue(uuid: str = None, title: str = None, description: str = None, severity: teatime.reporting.issue.Severity = None, raw_data: Any = None)

Bases: object

An object describing a vulnerability, weakness, or informational message.

is_complete() → bool

Returns whether the issue is complete.

Returns:A boolean indicating that the issue is complete

is_severe() → bool

Returns whether the issue is considered severe.

Returns:A boolean indicating whether the issue is severe

to_dict() → dict

Converts the issue instance into a Python dict.

Returns:A dict representing the issue

class teatime.reporting.issue.Severity

Bases: enum.Enum

An Enum denoting the severities an issue can have.

CRITICAL = 4

HIGH = 3

LOW = 1

MEDIUM = 2

NONE = 0

teatime.reporting.report module

This module contains the reporting functionality.

class teatime.reporting.report.Report(target, uuid: str = None, issues=None, timestamp: str = None)

Bases: object

A report class holding multiple issues and meta data.

add_issue(issue: teatime.reporting.issue.Issue)

Add an issue to the report.

Parameters:issue – The issue object to add

add_meta(key, value)

Add a meta data key-value pair to the report.

Parameters:

• key – The meta data key name
• value – The meta data key’s value to attach

to_dict() → dict

Convert the report and its issues to a Python dict.

Returns:The report’s representation as a dict

Module contents

This package contains classes related to reports and issues.