wolfhece 2.1.8__py3-none-any.whl → 2.1.9__py3-none-any.whl

wolfhece/apps/version.py

@@ -5,7 +5,7 @@ class WolfVersion():
 
         self.major = 2
         self.minor = 1
-        self.patch = 8
+        self.patch = 9
 
     def __str__(self):
 

wolfhece/report/reporting.py

@@ -0,0 +1,479 @@
+
+from docx import Document
+from docx.shared import Pt
+from docx.oxml.ns import qn
+from docx.shared import Inches
+from docx.shared import RGBColor
+from pathlib import Path
+from typing import Union, List, Tuple,Literal
+from docx.enum.text import WD_PARAGRAPH_ALIGNMENT
+from PIL import Image
+import pandas as pd
+from tempfile import NamedTemporaryFile, TemporaryDirectory
+import logging
+import matplotlib.pyplot as plt
+from matplotlib.figure import Figure
+from datetime import datetime
+import os
+import socket
+import hashlib
+
+from gettext import gettext as _
+
+class RapidReport:
+    """ 
+    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.\nPassage à 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')
+    ```
+
+    """
+
+    def __init__(self, main_title:str, author:str):
+        
+        self._main_title = None
+        self._author = None
+        self._date = None
+
+        self._content = []
+        self._document = Document()
+
+        self._filename = None
+
+        self._idx_figure = 0
+
+        self._styles={}
+        self.define_default_styles()
+
+        self._has_first_page = False
+        self.fill_first_page(main_title, author)
+ 
+    def define_default_styles(self):
+        
+        # Définir le style de titre
+        self._title_style = self._document.styles.add_style('TitleStyle', 1)
+        self._title_style.font.name = 'Arial'
+        self._title_style.font.size = Pt(20)
+        self._title_style.font.bold = True
+        self._title_style._element.rPr.rFonts.set(qn('w:eastAsia'), 'Arial')
+ 
+        # Définir le style de légende
+        self._caption_style = self._document.styles.add_style('CaptionStyle', 1)
+        self._caption_style.font.name = 'Arial'
+        self._caption_style.font.size = Pt(10)
+        self._caption_style.font.italic = True
+        self._caption_style._element.rPr.rFonts.set(qn('w:eastAsia'), 'Arial')
+        self._caption_style.paragraph_format.alignment = WD_PARAGRAPH_ALIGNMENT.CENTER
+ 
+        # Définir le style de corps de texte
+        self._body_text_style = self._document.styles.add_style('BodyTextStyle', 1)
+        self._body_text_style.font.name = 'Arial'
+        self._body_text_style.font.size = Pt(12)
+        self._body_text_style._element.rPr.rFonts.set(qn('w:eastAsia'), 'Arial')
+
+        # Définir le style de liste à puce
+        self._bullet_list_style = self._document.styles.add_style('BulletListStyle', 1)
+        self._bullet_list_style.font.name = 'Arial'
+        self._bullet_list_style.font.size = Pt(12)
+        self._bullet_list_style._element.rPr.rFonts.set(qn('w:eastAsia'), 'Arial')
+        self._bullet_list_style.paragraph_format.alignment = WD_PARAGRAPH_ALIGNMENT.LEFT
+        self._bullet_list_style.paragraph_format.left_indent = Inches(0.25)
+
+        self._table_grid_style = self._document.styles.add_style('TableGrid', 3)
+        self._table_grid_style.font.name = 'Arial'
+        self._table_grid_style.font.size = Pt(10)
+        self._table_grid_style._element.rPr.rFonts.set(qn('w:eastAsia'), 'Arial')
+        self._table_grid_style.paragraph_format.alignment = WD_PARAGRAPH_ALIGNMENT.CENTER
+
+        self._figure_style = self._document.styles.add_style('FigureStyle', 1)
+        self._figure_style.font.name = 'Arial'
+        self._figure_style.font.size = Pt(10)
+        self._figure_style._element.rPr.rFonts.set(qn('w:eastAsia'), 'Arial')
+        self._figure_style.paragraph_format.alignment = WD_PARAGRAPH_ALIGNMENT.CENTER
+
+        self._styles['TitleStyle'] = self._title_style
+        self._styles['CaptionStyle'] = self._caption_style
+        self._styles['BodyTextStyle'] = self._body_text_style
+        self._styles['BulletListStyle'] = self._bullet_list_style
+        self._styles['TableGrid'] = self._table_grid_style
+        self._styles['FigureStyle'] = self._figure_style
+
+    def set_font(self, fontname:str='Arial', fontsize:int=12):
+        """ Définir la police et la taille de la police pour les styles de texte. """
+
+        for style in self._styles.values():
+            style.font.name = fontname
+            style.font.size = Pt(fontsize)
+
+    def fill_first_page(self, main_title:str, author:str):
+        """ 
+        Remplir la première page du document. 
+        
+        Ajouter le titre, l'auteur et la date.
+        
+        """
+
+        # Récupérer le nom de l'utilisateur
+        user_name = os.getlogin()
+
+        # Récupérer le nom de l'ordinateur
+        computer_name = socket.gethostname()
+
+        logo_path = Path(__file__).parent / 'wolf_report.png'
+
+        self._main_title = main_title
+        self._author = author
+        self._date = datetime.now().strftime('%d/%m/%Y')
+
+        self._document.add_heading(self._main_title, level=0)
+        self.add_figure(logo_path,caption=None, width=2.0)
+
+        self.add_paragraph('Ce document a été généré automatiquement par le paquet Python "wolfhece".')
+        self.add_paragraph(' ')
+        self.add_paragraph(f'Auteur : {self._author}')
+        self.add_paragraph(f'Date : {self._date}')
+        self.add_paragraph(' ')
+        self.add_paragraph(f'Utilisateur : {user_name}')
+        self.add_paragraph(f'Ordinateur : {computer_name}')
+        self.add_paragraph(' ')
+
+        chain_hash = hashlib.md5(self._main_title.encode() + 
+                                 self._author.encode() +
+                                 user_name.encode() + 
+                                 computer_name.encode()+
+                                 self._date.encode()).hexdigest()
+        
+        self.add_paragraph('Hash du document : ' + chain_hash)
+
+        self.add_new_page()
+
+        self.add_paragraph('summary')
+
+        self._has_first_page = True
+
+    def add_title(self, title:str, level:int=1):
+        """ Ajoute un titre au document. """
+        
+        self._content.append(('title', title, level))
+
+    def _list_titles(self, level:int=None):
+        """ Renvoie la liste des titres du document. """
+
+        if level is None:
+            return [item[1] for item in self._content if item[0] == 'title']
+        else:
+            return [item[1] for item in self._content if item[0] == 'title' and item[2] == level]
+        
+    def _list_captions(self):
+        """ Renvoie la liste des légendes de figures du document. """
+
+        return [item[2] for item in self._content if item[0] == 'figure' if item[2]]
+
+    def _list_figures(self):
+        """ Renvoie la liste des figures du document. """
+
+        return [item[1] for item in self._content if item[0] == 'figure' if item[1] and item[2]]
+
+    def _list_index(self):
+        """ Renvoie la liste des index de figures du document. """
+
+        return [item[3] for item in self._content if item[0] == 'figure' if item[3]]
+    
+    def fig_exists(self, fig_name:str):
+        """ Vérifie si une figure existe dans le document. """
+
+        return fig_name in self._list_figures()
+    
+    def get_fig_index(self, fig_name_caption:str):
+        """ Renvoie la légende d'une figure. """
+
+        list_figures = self._list_figures()
+        list_captions = self._list_captions()
+
+        if fig_name_caption in list_figures:
+            idx = self._list_figures().index(fig_name_caption)+1
+        elif fig_name_caption in list_captions:
+            idx = self._list_captions().index(fig_name_caption)+1
+        else:
+            idx = None
+
+        return idx
+    
+    def _add_summary(self):
+        """ Ajoute un sommaire au document. """
+
+        titles = self._list_titles()
+        
+        self._document.add_heading(_('Summary'), level=1).style = 'TitleStyle'
+    
+        for cur_title in titles:
+            p = self._document.add_paragraph(cur_title, style='BodyTextStyle')
+            run = p.add_run()
+            run.add_tab()
+            run.bold = True
+            p.style = 'BodyTextStyle'
+        
+        self._document.add_heading(_('List of figures'), level=1).style = 'TitleStyle'
+        figures = self._list_captions()
+        for i, cur_figure in enumerate(figures):
+            p = self._document.add_paragraph(f'Fig. {i+1} : {cur_figure}', style='BodyTextStyle')
+            run = p.add_run()
+            run.add_tab()
+            run.bold = True
+            p.style = 'BodyTextStyle'
+
+        self._document.add_page_break()
+ 
+    def add_paragraph(self, paragraph_text:str, style:str='BodyTextStyle'):
+        """ Ajoute un paragraphe au document. """
+
+        self._content.append(('paragraph', paragraph_text, style))
+ 
+    def add(self, paragraph_text:str, style:str='BodyTextStyle'):
+        """ Ajoute un paragraphe au document. """
+
+        self.add_paragraph(paragraph_text, style=style)
+
+    def __add__(self, paragraph_text:str):
+        """ Surcharge de l'opérateur + pour ajouter un paragraphe. """
+
+        self.add_paragraph(paragraph_text)
+
+        return self
+
+    def add_figure(self, image_path:Union[str,Path,Image.Image], caption:str, width:float=7.0):
+        """ Ajoute une figure au document avec une légende. """
+
+        if caption:
+            self._idx_figure += 1
+        
+        self._content.append(('figure', image_path, caption, width, self._idx_figure))
+
+    def add_bullet_list(self, bullet_list: List[str], style:str='BulletListStyle'):
+        """ Ajoute une liste à puce au document. """
+
+        for item in bullet_list:
+            self.add_paragraph('- ' + item, style=style)
+
+    def add_new_page(self):
+        """ Ajoute une nouvelle page au document. """
+
+        self._content.append(('newpage', '', None))
+    
+    def add_table_from_listoflists(self, data:List[List[str]], style:str='TableGrid'):
+        """ 
+        Ajoute un tableau au document. 
+        
+        :param data: Liste de listes contenant les données du tableau. Chaque liste est une ligne du tableau.
+
+        """
+
+        self._content.append(('table', data, style))
+
+    def add_table_from_dict(self, data:dict, style:str='TableGrid'):
+        """ 
+        Ajoute un tableau au document. 
+        
+        :param data: Dictionnaire contenant les données du tableau. Les clés sont les en-têtes de colonnes.
+
+        """
+
+        table_data = [list(data.keys())]
+        table_data += [list(data.values())]
+        self.add_table_from_listoflists(table_data, style=style)
+
+    def add_table_as_picture(self, data:Union[List[List[str]], dict, pd.DataFrame, Figure], caption:str=None):
+        """ Ajoute un tableau au document sous forme d'image. """
+
+        def fig2img(fig):
+            """Convert a Matplotlib figure to a PIL Image and return it"""
+            import io
+            buf = io.BytesIO()
+            
+            fig.savefig(buf, bbox_inches='tight')
+            buf.seek(0)
+            img = Image.open(buf)
+            return img        
+
+        if isinstance(data, Figure):
+            tmp_image = fig2img(data)
+            self.add_figure(tmp_image, caption)
+            return
+        
+        if isinstance(data, dict):
+            data = pd.DataFrame(data)
+        elif isinstance(data, list):
+            data = pd.DataFrame(data)
+
+        fig, ax = plt.subplots()
+
+        ax.axis('off')
+        ax.table(cellText=data.values, 
+                 colLabels=data.columns, 
+                 loc='center', 
+                 cellLoc='center', 
+                 colColours=['#f3f3f3']*len(data.columns))
+        
+        fig.tight_layout()
+        
+        tmp_image = fig2img(fig)
+
+        self.add_figure(tmp_image, caption, width=4.0)
+
+    def _apply_text_styles(self, paragraph, text):
+        """ Search for bold and italic styles in the text and apply them."""
+
+        def split_bold(text):
+            return text.split('**')
+        
+        def split_italic(text):
+            return text.split('*')
+        
+        splitted_bold = split_bold(text)
+
+        bold = False
+        for cur_text in splitted_bold:
+            if cur_text != '':
+                italic = False
+                spliited_italic = split_italic(cur_text)
+                for cur_text2 in spliited_italic:
+                    if cur_text2 != '':
+                        run = paragraph.add_run(cur_text2)
+                        run.bold = bold
+                        run .italic = italic
+                    
+                    italic = not italic
+            bold = not bold
+ 
+    def parse_content(self):
+        """ Parse le contenu du document et l'ajoute au document Word. """
+
+        # tmp_dir = TemporaryDirectory()
+
+        for item in self._content:
+
+            if item[0] == 'title':
+                self._document.add_heading(item[1], level=item[2]).style = 'TitleStyle'
+            
+            elif item[0] == 'paragraph':
+
+                if item[1] == 'summary':
+                    self._add_summary()
+                    continue
+                else:
+                    p = self._document.add_paragraph()
+                    self._apply_text_styles(p, item[1])
+                    p.style = item[2] if item[2] else 'BodyTextStyle'
+            
+            elif item[0] == 'figure':
+
+                if isinstance(item[1], Image.Image):
+                    
+                    tmp_name = NamedTemporaryFile(suffix='.png').name
+                    item[1].save(tmp_name)
+
+                elif isinstance(item[1], str):
+                    tmp_name = item[1]
+
+                elif isinstance(item[1], Path):
+                    tmp_name = str(item[1])
+
+                if Path(tmp_name).exists():
+                    self._document.add_picture(tmp_name, width=Inches(item[3]) if item[3] else Inches(7.0))
+                    self._document.paragraphs[-1].style = 'FigureStyle'
+                else:
+                    logging.error(f"File {tmp_name} not found.")
+                    p = self._document.add_paragraph()
+                    run = p.add_run(f'Error: Image not found. {tmp_name}')
+                    run.font.color.rgb = RGBColor(255, 0, 0)
+                    p.style = 'BodyTextStyle'
+
+                if item[2]:
+                    caption = self._document.add_paragraph(f'Fig. {item[4]} :' + item[2])
+                    caption.style = 'CaptionStyle'
+
+            elif item[0] == 'table':
+                
+                data = item[1]
+                style = item[2]
+                table = self._document.add_table(rows=len(data), cols=len(data[0]))
+                table.style = style
+
+                for i, row in enumerate(data):
+                    for j, cell in enumerate(row):
+                        table.cell(i, j).text = cell
+
+            elif item[0] == 'newpage':
+                self._document.add_page_break()
+ 
+    def save(self, file_path:Union[str,Path]=None):
+        """ Sauvegarde le document Word. """
+        
+        if file_path is None:
+            file_path = self._filename
+
+        if file_path is None:
+            raise ValueError("Le chemin du fichier n'a pas été spécifié.")
+
+        self.parse_content()
+        try:
+            self._document.save(str(file_path))
+        except Exception as e:
+            logging.error(f"Error saving file: {e}")
+ 
+if __name__ == '__main__':
+
+    # Exemple d'utilisation
+    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.\nPassage à la ligne"
+    rapport.add_figure('/path/to/image.png', 'Légende de la figure.')
+    rapport+=""" 
+Commentraire sur la figure multilignes
+ligne 2
+ligne3"""
+
+    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.add_table_from_dict({'Nom': ['Alice', 'Bob'], 'Âge': ['25', '30']})
+    rapport.add_table_as_picture({'Nom': ['Alice', 'Bob'], 'Âge': ['25', '30']}, caption='Tableau de données')
+
+    rapport.save('rapport.docx')
+
+    assert rapport.get_fig_index('/path/to/image.png') == 1
+    assert rapport.get_fig_index('Tableau de données') == 2
+

{wolfhece-2.1.8.dist-info → wolfhece-2.1.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wolfhece
-Version: 2.1.8
+Version: 2.1.9
 Author-email: Pierre Archambeau <pierre.archambeau@uliege.be>
 License: AGPL-v3 License
 Project-URL: Homepage, https://uee.uliege.be/hece

{wolfhece-2.1.8.dist-info → wolfhece-2.1.9.dist-info}/RECORD

@@ -66,7 +66,7 @@ wolfhece/apps/check_install.py,sha256=jrKR-njqnpIh6ZJqvP6KbDUPVCfwTNQj4glQhcyzs9
 wolfhece/apps/curvedigitizer.py,sha256=avWERHuVxPnJBOD_ibczwW_XG4vAenqWS8W1zjhBox8,4898
 wolfhece/apps/isocurrent.py,sha256=4XnNWPa8mYUK7V4zdDRFrHFIXNG2AN2og3TqWKKcqjY,3811
 wolfhece/apps/splashscreen.py,sha256=LkEVMK0eCc84NeCWD3CGja7fuQ_k1PrZdyqD3GQk_8c,2118
-wolfhece/apps/version.py,sha256=PDHOsWyysK2-MjO9X84FVTmdBAJq_uSXODfI01muO7E,387
+wolfhece/apps/version.py,sha256=FOnRXwi0LTd0u8m3r5Ap-8eX-pLzJQIG3E9iImOCttA,387
 wolfhece/apps/wolf.py,sha256=gqfm-ZaUJqNsfCzmdtemSeqLw-GVdSVix-evg5WArJI,293
 wolfhece/apps/wolf2D.py,sha256=gWD9ee2-1pw_nUxjgRaJMuSe4kUT-RWhOeoTt_Lh1mM,267
 wolfhece/apps/wolf_logo.bmp,sha256=ruJ4MA51CpGO_AYUp_dB4SWKHelvhOvd7Q8NrVOjDJk,3126
@@ -241,6 +241,9 @@ wolfhece/radar/wolfradar.py,sha256=ylyz8hNAGq92WXnMO8hVe6Nk-a7g--fL-xOcjfhFEtk,9
 wolfhece/rem/REMMaker.py,sha256=kffClHHpf8P4ruZpEb9EB__HBzg9rFAkiVCh-GFtIHU,30790
 wolfhece/rem/RasterViz.py,sha256=TDhWyMppcYBL71HfhpZuMgYKhz7faZg-MEOQJo_3Ivo,29128
 wolfhece/rem/__init__.py,sha256=S2-J5uEGK_VaMFjRUYFIdSScJjZyuXH4RmMmnG3OG7I,19
+wolfhece/report/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+wolfhece/report/reporting.py,sha256=ptsObq4hrVc1b_cfu2ISL6oesSsBphk03QtFnr8E9hc,17565
+wolfhece/report/wolf_report.png,sha256=NoSV58LSwb-oxCcZScRiJno-kxDwRdm_bK-fiMsKJdA,592485
 wolfhece/scenario/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wolfhece/scenario/check_scenario.py,sha256=nFiCscEGHyz1YvjmZoKlYrfmW03-nLiDTDdRoeE6MUs,4619
 wolfhece/scenario/config_manager.py,sha256=SValpikuNt_XaJXt8P7kAu6iN_N5YlohyL8ry3iT380,77389
@@ -264,8 +267,8 @@ wolfhece/sounds/sonsw2.wav,sha256=pFLVt6By0_EPQNt_3KfEZ9a1uSuYTgQSX1I_Zurv9Rc,11
 wolfhece/ui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wolfhece/ui/wolf_multiselection_collapsiblepane.py,sha256=yGbU_JsF56jsmms0gh7mxa7tbNQ_SxqhpAZxhm-mTy4,14860
 wolfhece/ui/wolf_times_selection_comparison_models.py,sha256=wCxGRnE3kzEkWlWA6-3X8ADOFux_B0a5QWJ2GnXTgJw,4709
-wolfhece-2.1.8.dist-info/METADATA,sha256=na4Fmpn_XCY_8wAgiMs1m3YfEMKwUNC7mZ33W2JzU70,2281
-wolfhece-2.1.8.dist-info/WHEEL,sha256=cpQTJ5IWu9CdaPViMhC9YzF8gZuS5-vlfoFihTBC86A,91
-wolfhece-2.1.8.dist-info/entry_points.txt,sha256=AIu1KMswrdsqNq_2jPtrRIU4tLjuTnj2dCY-pxIlshw,276
-wolfhece-2.1.8.dist-info/top_level.txt,sha256=EfqZXMVCn7eILUzx9xsEu2oBbSo9liWPFWjIHik0iCI,9
-wolfhece-2.1.8.dist-info/RECORD,,
+wolfhece-2.1.9.dist-info/METADATA,sha256=kTZzCdCRgXrjJ2HsS_7YS8fXP8zYlxvXNigdrYepDqg,2281
+wolfhece-2.1.9.dist-info/WHEEL,sha256=cpQTJ5IWu9CdaPViMhC9YzF8gZuS5-vlfoFihTBC86A,91
+wolfhece-2.1.9.dist-info/entry_points.txt,sha256=AIu1KMswrdsqNq_2jPtrRIU4tLjuTnj2dCY-pxIlshw,276
+wolfhece-2.1.9.dist-info/top_level.txt,sha256=EfqZXMVCn7eILUzx9xsEu2oBbSo9liWPFWjIHik0iCI,9
+wolfhece-2.1.9.dist-info/RECORD,,