finesse.utilities.bug_report.bug_report

finesse.utilities.bug_report.bug_report(title: str | None = None, file: str | Path | None = None, include_source: bool = False)

Generate a markdown bug report, suitable for copy-pasting into chatrooms or GitLab issues. Contains the source code, the triggered exception (if any) and machine and python environment information.

Parameters:

titlestr | None, optional

Title to insert on top of markdown, by default None

filestr | Path | None, optional

Whether to write the report to file. Will silently overwrite existing files, by default None

include_sourcebool, optional

Wether to include the source code that caused the exception (the contents of the Jupyter notebook or Python script file) into the bug report. Be careful when including source with proprietary/confidential information source in bug reports shared in public spaces like Gitlab or the Matrix channel. Defaults to False