buhtzology.report._GenericDocumentOutput

class documentation

class _GenericDocumentOutput: (source)

Known subclasses: buhtzology.report.DocxDocument, buhtzology.report.MarkdownDocument, buhtzology.report.XlsxDocument

Constructor: _GenericDocumentOutput(file_path, tags_allowed, tags_excluded)

View In Hierarchy

Base class for the different output file types.

Method __init__ Undocumented
Method show Open the document with the associated application.
Instance Variable file_path Path to the file.
Instance Variable tags_allowed List of tags for elements that are allowed.
Instance Variable tags_excluded List of tags for elements that are excluded.
Method _not_implemented Handle not implemented elements and throws a warning.
def __init__(self, file_path: pathlib.Path, tags_allowed: list[str] | str = None, tags_excluded: list[str] | str = None): (source)
overridden in buhtzology.report.DocxDocument, buhtzology.report.MarkdownDocument, buhtzology.report.XlsxDocument

Undocumented

def show(self): (source)

Open the document with the associated application.

On Linux xdg-open and on Windows start is used.

file_path = (source)
overridden in buhtzology.report.DocxDocument

Path to the file.

tags_allowed = (source)

List of tags for elements that are allowed.

tags_excluded = (source)

List of tags for elements that are excluded.

def _not_implemented(self, *args, **kwargs): (source)

Handle not implemented elements and throws a warning.