now can add image in ods and xlsx

Author: cyrilus

README.md

@@ -947,7 +947,7 @@ The principle is exactly the same as for LibreOffice Calc exept for the creation
 |-------------------------|----------|----------|----------|------|-----------|-----|-----|-------|
 | text variables support  | ✅        | ✅        | ✅        | ✅    | ✅         | ✅   | ✅   | ❌     |
 | dynamic tables support  | ✅        | ✅       | ✅       | ✅    | ✅         | ✅   | ❌   | ❌     |
-| image variables support | ✅        | ❌        | ❌        | ✅    | ✅         | ❌   | ❌   | ❌     |
+| image variables support | ✅        | ✅        | ✅        | ✅    | ✅         | ❌   | ❌   | ❌     |
 
 ### Export
 For Writer

lotemplate/CalcTemplate.py

@@ -13,12 +13,12 @@
 
 
 from . import errors
-
+from sorcery import dict_of
 from lotemplate.Statement.CalcTableStatement import CalcTableStatement
 from .Template import Template
 from lotemplate.Statement.CalcSearchStatement import CalcTextStatement
+from lotemplate.Statement.CalcImageStatement import CalcImageStatement
 from jsondiff import diff
-
 class CalcTemplate(Template):
     formats = {
             "ods": "calc8",
@@ -68,14 +68,29 @@ def scan(self, **kwargs) -> dict[str: dict[str, Union[str, list[str]]]]:
         """
 
         #should_close = kwargs.get("should_close", False)
-        texts = {} 
+        texts = {}
+        images = {}
         #(Pdb) self.doc.getSheets().getElementNames()
         for sheet in self.doc.getSheets():
             texts = texts | CalcTextStatement.scan(sheet)
+            images = images | CalcImageStatement.scan_image(sheet)
         tables=CalcTableStatement.scan(self.doc)
-        #texts = CalcTextStatement.scan_Document_text(self.doc)
-        #pdb.set_trace()
-        return texts | tables 
+        variables_list = list(texts.keys()) + list(tables.keys()) + list(images.keys())
+        duplicates = [variable for variable in variables_list if variables_list.count(variable) > 1]
+
+        if duplicates:
+            first_type = "text" if duplicates[0] in texts.keys() else "image"
+            second_type = "table" if duplicates[0] in tables.keys() else "image"
+            self.close()
+            raise errors.TemplateError(
+                'duplicated_variable',
+                f"The variable {duplicates[0]!r} is mentioned two times, but "
+                f"for two different types: {first_type!r}, and {second_type!r}",
+                dict_of(first_type, second_type, variable=duplicates[0])
+            )
+
+
+        return texts | tables | images
 
 
     def search_error(self, json_vars: dict[str, dict[str, Union[str, list[str]]]]) -> None:
@@ -132,6 +147,9 @@ def fill(self, variables: dict[str, dict[str, Union[str, list[str]]]]) -> None:
             if details['type'] == 'text':
                 for sheet in self.doc.getSheets():
                     CalcTextStatement.fill(sheet, "$" + var, details['value'])
+            elif details['type'] == 'image':
+                   for sheet in self.doc.getSheets():
+                     CalcImageStatement.image_fill(sheet,self.cnx.graphic_provider,"$" + var, details['value'])
             elif details['type'] == "object" and  CalcTableStatement.isTableVar(var) :
                     objects[var]=details
         for  var, details in objects.items():

lotemplate/Statement/CalcImageStatement.py

@@ -0,0 +1,53 @@
+from com.sun.star.beans import PropertyValue
+from com.sun.star.lang import XComponent
+import regex
+from urllib import request
+from PIL import Image
+from lotemplate.utils import get_file_url, is_network_based
+from com.sun.star.awt import Size
+class CalcImageStatement:
+    image_regex = regex.compile(r'\$\w+')
+
+    def scan_image(doc: XComponent) -> dict[str, dict[str, str]]:
+        """
+        scan for images in the given doc
+
+        :param doc: the document to scan
+        :return: the scanned variables
+        """
+        imgs = {}
+        for img in doc.getDrawPage():
+            if CalcImageStatement.image_regex.fullmatch(img.LinkDisplayName): 
+                imgs[CalcImageStatement.image_regex.match(img.LinkDisplayName).group(0)[1:]] = {'type': 'image', 'value': ''}
+            elif CalcImageStatement.image_regex.fullmatch(img.Description):
+                imgs[CalcImageStatement.image_regex.match(img.Description).group(0)[1:]] = {'type': 'image', 'value': ''}
+        return imgs
+
+    def image_fill(doc: XComponent,graphic_provider ,variable: str, path: str, should_resize=True) -> None:
+        """
+        Fills all the image-related content
+
+        :param should_resize: specify if the image should be resized to keep his original size ratio
+        :param doc: the document to fill
+        :param variable: the variable to search
+        :param path: the path of the image to replace with
+        :return: None
+        """
+        if not path:
+            return
+
+        for graphic_object in doc.getDrawPage():
+            if graphic_object.LinkDisplayName != variable and graphic_object.Description != variable :
+                continue
+
+            new_image = graphic_provider.queryGraphic((PropertyValue('URL', 0, get_file_url(path), 0),))
+
+            if should_resize:
+                with Image.open(request.urlopen(path) if is_network_based(path) else path) as image:
+                    ratio = image.width / image.height
+                new_size = Size()
+                new_size.Height = graphic_object.Size.Height
+                new_size.Width = graphic_object.Size.Height * ratio
+                graphic_object.setSize(new_size)
+
+            graphic_object.Graphic = new_image

lotemplate/unittest/files/content/image_ods.json

@@ -0,0 +1 @@
+{"toto": {"type": "text", "value": "HELO"}, "image": {"type": "image", "value": "lotemplate/unittest/files/jsons/Yami_Yugi.png"}}

lotemplate/unittest/files/content/image_ods.ods

@@ -0,0 +1 @@
+{"toto": {"type": "text", "value": "HELO"}, "image1": {"type": "image", "value": "lotemplate/unittest/files/jsons/Yami_Yugi.png"}}

lotemplate/unittest/files/content/image_xlsx.json

@@ -5,6 +5,7 @@
 
 import lotemplate as ot
 from lotemplate.unittest.test_function import compare_files_html 
+from lotemplate.unittest.test_function import compare_image
 
 cnx = ot.start_multi_office()
 
@@ -27,5 +28,13 @@ def test_var(self):
     def test_table(self):
         self.assertTrue(compare_files_html('calc_table',cnx))
 
+class Test_Calc_Images(unittest.TestCase):
+
+    def test_image_xlsx(self):
+        self.assertTrue(compare_image('image_xlsx',cnx))
+
+    def test_image_ods(self):
+        self.assertTrue(compare_image('image_ods',cnx))
+
 
 

lotemplate/unittest/files/content/image_xlsx.xlsx

@@ -10,7 +10,6 @@
 from pypdf import PdfReader
 import glob
 
-
 def file_to_dict(file_path: str) -> dict:
         with open(file_path) as f:
             return json.loads(f.read())
@@ -24,10 +23,11 @@ def compare_image(name: str, cnx) :
     base_path = 'lotemplate/unittest/files/content'
     def get_filename(ext: str):
         return base_path + '/' + name + '.' + ext
-
     temp = None
     if os.path.isfile(get_filename('ods')):
         temp = ot.TemplateFromExt(get_filename('ods'), ot.randomConnexion(cnx), True)
+    if os.path.isfile(get_filename('xlsx')):
+        temp = ot.TemplateFromExt(get_filename('xlsx'), ot.randomConnexion(cnx), True)
     if os.path.isfile(get_filename('odt')):
         temp = ot.TemplateFromExt(get_filename('odt'), ot.randomConnexion(cnx), True)
     if os.path.isfile(get_filename('docx')):