saftig.evaluation.report_generation
===================================

.. py:module:: saftig.evaluation.report_generation

.. autoapi-nested-parse::

   Tooling to generate pdf reports through latex



Classes
-------

.. autoapisummary::

   saftig.evaluation.report_generation.ReportElement
   saftig.evaluation.report_generation.ReportFigure
   saftig.evaluation.report_generation.ReportTable
   saftig.evaluation.report_generation.Report


Module Contents
---------------

.. py:class:: ReportElement

   Bases: :py:obj:`abc.ABC`


   Parent class for elements placed in a report object that generate latex code


   .. py:method:: latex()
      :abstractmethod:


      Generate latex code



.. py:class:: ReportFigure(image_path, caption = None, width = 1.0)

   Bases: :py:obj:`ReportElement`


   Figure element for reports


   .. py:attribute:: image_path


   .. py:attribute:: caption
      :value: None



   .. py:attribute:: width
      :value: 1.0



   .. py:method:: latex()

      Generate latex code



.. py:class:: ReportTable(table_content, header = None, caption = None, cell_format = None, horizontal_separator = ' ')

   Bases: :py:obj:`ReportElement`


   Table element for reports


   .. py:attribute:: table_content


   .. py:attribute:: caption
      :value: None



   .. py:attribute:: format
      :value: None



   .. py:method:: latex()

      Generate latex code



.. py:class:: Report

   Bases: :py:obj:`dict`


   Latex code generator


   .. py:attribute:: block_start
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """\documentclass[12pt, a4paper]{report}
         \usepackage[top=3cm, bottom=3cm, left = 2cm, right = 2cm]{geometry}
         \usepackage[utf8]{inputenc}
         \usepackage{float}
         \usepackage{caption}
         \usepackage{graphicx}
         \begin{document}
         """

      .. raw:: html

         </details>




   .. py:attribute:: block_end
      :value: '\\end{document}'



   .. py:attribute:: sectioning_commands
      :value: ['chapter', 'section', 'subsection', 'subsubsection', 'paragraph', 'subparagraph']



   .. py:method:: _generate_entry(entry)
      :staticmethod:


      Generate latex code for the given entry



   .. py:method:: generate(structure = None, level = 0)

      Generate latex code



   .. py:method:: save(fname)

      Save latex code to file



   .. py:method:: compile(fname)

      Compile report using pdflatex
      If not present, the required .pdf and .tex suffixes are added as needed.

      returns the path of the generated pdf file