Formatter

class sqlcompyre.report.formatters._base.Formatter[source]

Abstract base class for formatters of reports.

Attributes:
file_extension

The file extension to use when this formatter’s output is written to a file.

Methods

format(metadata, sections[, ...])

Format the metadata and the sections from a report.

abstract property file_extension: str

The file extension to use when this formatter’s output is written to a file.

abstractmethod format(metadata: Metadata, sections: list[Section], hide_matching_columns: bool = False) str[source]

Format the metadata and the sections from a report.

Returns:

The formatted string describing the metadata and all sections.