src.report.report

Classes

Report(**kwargs)

Exceptions

ReportException([message])

exception src.report.report.ReportException(message='')

Author:

Alberto M. Esmoris Pena

Class for exceptions related to report components. See VL3DException.

__init__(message='')

class src.report.report.Report(**kwargs)

Author:

Alberto M. Esmoris Pena

Abstract class providing the interface governing any report.

__init__(**kwargs)

Root initialization for any instance of type Report.

Parameters:

kwargs – The attributes for the report.

to_string()

Wrapper for report.Report.__str__().

to_file(path, out_prefix=None)

Write the report to a file.

Parameters:

• path (str) – Path to the file where the report must be written.

• out_prefix (str) – The output prefix to expand the path (OPTIONAL).

Returns:

Nothing, the output is written to a file.