wolfhece.report.reporting

Author: HECE - University of Liege, Pierre Archambeau Date: 2024

Copyright (c) 2024 University of Liege. All rights reserved.

This script and its content are protected by copyright law. Unauthorized copying or distribution of this file, via any medium, is strictly prohibited.

Module Contents

class wolfhece.report.reporting.RapidReport(main_title: str, author: str)

Class for creating a report ‘quickly’.

It can be used in Jupyter notebooks or in scripts to create a simple report in Word format.

Word document is created with the following structure:

• Main page with title, author, date and hash of the document

• Summary (automatically generated)

• Title

• Paragraph

• Figure (numbered automatically with caption)

• Bullet list

• Table

It is not a full-fledged reporting tool with advanced functionnalities but a simple way to create a report quickly ‘on-the-fly’.

Example:

``` rapport = RapidReport(‘Rapport de Projet’, ‘Alice’)

rapport.add_title(‘Titre Principal’, level=0) rapport.add_paragraph(‘Ceci est un paragraphe introductif avec des mots en italique et en gras.’)

rapport += “Tentative d’ajout de figure vie un lien incorrect.

Passage à la ligne”

rapport.add_figure(‘/path/to/image.png’, ‘Légende de la figure.’)

rapport.add_bullet_list([‘Premier élément’, ‘Deuxième élément’, ‘Troisième élément’])

rapport.add_table_from_listoflists([[‘Nom’, ‘Âge’], [‘Alice’, ‘25’], [‘Bob’, ‘30’]])

rapport.save(‘rapport.docx’) ```

_define_default_styles()

set_font(fontname: str = 'Arial', fontsize: int = 12)

Définir la police et la taille de la police pour les styles de texte.

fill_first_page(main_title: str, author: str)

Remplir la première page du document.

Ajouter le titre, l’auteur et la date.

_insert_title(title: str, level: int = 1, index: int = 0)

Insère un titre dans le document.

_insert_paragraph(paragraph_text: str, style: str = 'BodyTextStyle', index: int = 0)

Insère un paragraphe dans le document.

_insert_figure(image_path: str | pathlib.Path | PIL.Image.Image | matplotlib.figure.Figure, caption: str, width: float = 7.0, index: int = 0)

Insère une figure dans le document.

add_title(title: str, level: int = 1)

Ajoute un titre au document.

_list_titles(level: int = None)

Renvoie la liste des titres du document.

_list_captions()

Renvoie la liste des légendes de figures du document.

_list_figures()

Renvoie la liste des figures du document.

_list_index()

Renvoie la liste des index de figures du document.

fig_exists(fig_name: str)

Vérifie si une figure existe dans le document.

get_fig_index(fig_name_caption: str)

Renvoie la légende d’une figure.

_add_summary()

Ajoute un sommaire au document.

add_paragraph(paragraph_text: str, style: str = 'BodyTextStyle')

Ajoute un paragraphe au document.

add(paragraph_text: str, style: str = 'BodyTextStyle')

Ajoute un paragraphe au document.

add_figure(image_path: str | pathlib.Path | PIL.Image.Image | matplotlib.figure.Figure, caption: str, width: float = 7.0)

Ajoute une figure au document avec une légende.

add_bullet_list(bullet_list: List[str], style: str = 'BulletListStyle')

Ajoute une liste à puce au document.

add_new_page()

Ajoute une nouvelle page au document.

_insert_new_page(index: int = 0)

Insère une nouvelle page au document.

add_table_from_listoflists(data: List[List[str]], style: str = 'TableGrid')

Ajoute un tableau au document.

Parameters:

data – Liste de listes contenant les données du tableau. Chaque liste est une ligne du tableau.

add_table_from_dict(data: dict, style: str = 'TableGrid')

Ajoute un tableau au document.

Parameters:

data – Dictionnaire contenant les données du tableau. Les clés sont les en-têtes de colonnes.

add_table_as_picture(data: List[List[str]] | dict | pandas.DataFrame | matplotlib.figure.Figure, caption: str = None)

Ajoute un tableau au document sous forme d’image.

_apply_text_styles(paragraph, text)

Search for bold and italic styles in the text and apply them.

parse_content()

Parse le contenu du document et l’ajoute au document Word.

save(file_path: str | pathlib.Path = None)

Sauvegarde le document Word.

wolfhece.report.reporting.rapport