Fix #29: improve JSON handling and keys

app.py

@@ -7,7 +7,7 @@ import os
 import pathlib
 import random
 import tempfile
-from typing import List
+from typing import List, Union
 
 import json5
 import streamlit as st
@@ -240,7 +240,9 @@ def set_up_chat_ui():
         progress_bar.progress(1.0, text='Done!')
 
         st.chat_message('ai').code(response, language='json')
-        _display_download_button(path)
+
+        if path:
+            _display_download_button(path)
 
         logger.info(
             '#messages in history / 2: %d',
@@ -248,15 +250,38 @@ def set_up_chat_ui():
         )
 
 
-def generate_slide_deck(json_str: str) -> pathlib.Path:
+def generate_slide_deck(json_str: str) -> Union[pathlib.Path, None]:
     """
     Create a slide deck and return the file path. In case there is any error creating the slide
     deck, the path may be to an empty file.
 
     :param json_str: The content in *valid* JSON format.
-    :return: The file of the .pptx file.
+    :return: The path to the .pptx file or `None` in case of error.
     """
 
+    try:
+        parsed_data = json5.loads(json_str)
+    except ValueError:
+        st.error(
+            'Encountered error while parsing JSON...will fix it and retry'
+        )
+        logger.error(
+            'Caught ValueError: trying again after repairing JSON...'
+        )
+        try:
+            parsed_data = json5.loads(text_helper.fix_malformed_json(json_str))
+        except ValueError:
+            st.error(
+                'Encountered an error again while fixing JSON...'
+                'the slide deck cannot be created, unfortunately ☹'
+                '\nPlease try again later.'
+            )
+            logger.error(
+                'Caught ValueError: failed to repair JSON!'
+            )
+
+            return None
+
     if DOWNLOAD_FILE_KEY in st.session_state:
         path = pathlib.Path(st.session_state[DOWNLOAD_FILE_KEY])
     else:
@@ -267,24 +292,10 @@ def generate_slide_deck(json_str: str) -> pathlib.Path:
         if temp:
             temp.close()
 
-    logger.debug('Creating PPTX file: %s...', st.session_state[DOWNLOAD_FILE_KEY])
-
     try:
+        logger.debug('Creating PPTX file: %s...', st.session_state[DOWNLOAD_FILE_KEY])
         pptx_helper.generate_powerpoint_presentation(
-            json_str,
-            slides_template=pptx_template,
-            output_file_path=path
-        )
-    except ValueError:
-        st.error(
-            'Encountered error while parsing JSON...will fix it and retry'
-        )
-        logger.error(
-            'Caught ValueError: trying again after repairing JSON...'
-        )
-
-        pptx_helper.generate_powerpoint_presentation(
-            text_helper.fix_malformed_json(json_str),
+            parsed_data,
             slides_template=pptx_template,
             output_file_path=path
         )

helpers/pptx_helper.py

@@ -82,21 +82,19 @@ def remove_slide_number_from_heading(header: str) -> str:
 
 
 def generate_powerpoint_presentation(
-        structured_data: str,
+        parsed_data: dict,
         slides_template: str,
         output_file_path: pathlib.Path
 ) -> List:
     """
     Create and save a PowerPoint presentation file containing the content in JSON format.
 
-    :param structured_data: The presentation contents as "JSON" (may contain trailing commas).
+    :param parsed_data: The presentation content as parsed JSON data.
     :param slides_template: The PPTX template to use.
     :param output_file_path: The path of the PPTX file to save as.
     :return: A list of presentation title and slides headers.
     """
 
-    # The structured "JSON" might contain trailing commas, so using json5
-    parsed_data = json5.loads(structured_data)
     presentation = pptx.Presentation(GlobalConfig.PPTX_TEMPLATE_FILES[slides_template]['file'])
     slide_width_inch, slide_height_inch = _get_slide_width_height_inches(presentation)
 
@@ -237,21 +235,22 @@ def _handle_default_display(
 
     status = False
 
-    if random.random() < IMAGE_DISPLAY_PROBABILITY:
-        if random.random() < FOREGROUND_IMAGE_PROBABILITY:
-            status = _handle_display_image__in_foreground(
-                presentation,
-                slide_json,
-                slide_width_inch,
-                slide_height_inch
-            )
-        else:
-            status = _handle_display_image__in_background(
-                presentation,
-                slide_json,
-                slide_width_inch,
-                slide_height_inch
-            )
+    if 'img_keywords' in slide_json:
+        if random.random() < IMAGE_DISPLAY_PROBABILITY:
+            if random.random() < FOREGROUND_IMAGE_PROBABILITY:
+                status = _handle_display_image__in_foreground(
+                    presentation,
+                    slide_json,
+                    slide_width_inch,
+                    slide_height_inch
+                )
+            else:
+                status = _handle_display_image__in_background(
+                    presentation,
+                    slide_json,
+                    slide_width_inch,
+                    slide_height_inch
+                )
 
     if status:
         return
@@ -301,7 +300,8 @@ def _handle_display_image__in_foreground(
         slide_height_inch: float
 ) -> bool:
     """
-    Create a slide with text and image using a picture placeholder layout.
+    Create a slide with text and image using a picture placeholder layout. If not image keyword is
+    available, it will add only text to the slide.
 
     :param presentation: The presentation object.
     :param slide_json: The content of the slide as JSON data.
@@ -386,7 +386,8 @@ def _handle_display_image__in_background(
 ) -> bool:
     """
     Add a slide with text and an image in the background. It works just like
-    `_handle_default_display()` but with a background image added.
+    `_handle_default_display()` but with a background image added. If not image keyword is
+    available, it will add only text to the slide.
 
     :param presentation: The presentation object.
     :param slide_json: The content of the slide as JSON data.
@@ -566,6 +567,14 @@ def _handle_icons_ideas(
                 for run in paragraph.runs:
                     run.font.color.theme_color = pptx.enum.dml.MSO_THEME_COLOR.TEXT_2
 
+            _add_text_at_bottom(
+                slide=slide,
+                slide_width_inch=slide_width_inch,
+                slide_height_inch=slide_height_inch,
+                text='More icons available in the SlideDeck AI repository',
+                hyperlink='https://github.com/barun-saha/slide-deck-ai/tree/main/icons/png128'
+            )
+
         return True
 
     return False
@@ -928,7 +937,6 @@ if __name__ == '__main__':
         "AI for predicting student performance and dropout rates"
       ],
       "key_message": "AI is personalizing education and improving student outcomes",
-      "img_keywords": "education, personalized learning, intelligent tutoring, student performance"
     },
     {
       "heading": "Step-by-Step: AI Development Process",
@@ -940,7 +948,7 @@ if __name__ == '__main__':
         ">> Deploy and monitor the AI system"
       ],
       "key_message": "Developing AI involves a structured process from problem definition to deployment",
-      "img_keywords": "AI development process, problem definition, data collection, model training"
+      "img_keywords": ""
     },
     {
       "heading": "AI Icons: Key Aspects",
@@ -974,7 +982,7 @@ if __name__ == '__main__':
     generate_powerpoint_presentation(
         json5.loads(_JSON_DATA),
         output_file_path=path,
-        slides_template='Minimalist Sales Pitch'
+        slides_template='Basic'
     )
     print(f'File path: {path}')