Merge pull request #264 from e10harvey/issue263

Fixes PowerpointShape._pptx_inches

Author: jehsharp

opencsp/common/lib/render/lib/PowerpointImage.py

@@ -249,6 +249,7 @@ def dims_pptx(self):
             The dimensions of the image in inches.
         """
         # ChatGPT 4o-mini assisted with generating this doc string
+        assert self.has_dims()
         return self._pptx_inches(self.dims)
 
     @staticmethod

opencsp/common/lib/render/lib/PowerpointShape.py

@@ -44,7 +44,7 @@ def _pptx_inches(self, vals: int | float | Iterable):
         # Parameters
         # ----------
         # vals : int, float, or Iterable
-        #    The value(s) to convert to inches. Can be a single value or an iterable of values.
+        #    The value(s) to convert to inches. Can be a single value or an iterable of values. Iterable will be a list
         #
         # Returns
         # -------
@@ -55,13 +55,22 @@ def _pptx_inches(self, vals: int | float | Iterable):
         # -----
         # If a single value is provided, it returns a single integer. If an iterable is provided, it returns a list of integers.
         # "ChatGPT 4o" assisted with generating this doc
-        try:
-            ret = []
-            for val in vals:
-                ret.append(pptx.util.Inches(val))
-            return ret
-        except:
-            return pptx.util.Inches(val)
+        if isinstance(vals, int) or isinstance(vals, float):
+            return pptx.util.Inches(vals)
+        elif isinstance(vals, list) or isinstance(vals, tuple):
+            if all(isinstance(x, (int, float)) for x in vals):
+                ret = []
+                for val in vals:
+                    ret.append(pptx.util.Inches(val))
+                return ret
+            else:
+                for x in vals:
+                    if not isinstance(x, (int, float)):
+                        print(f"Element '{x}' is of type '{type(x).__name__}'")
+                raise TypeError(f"\"vals\" must contain only int or float values.")
+        else:
+            vals_type = type(vals).__name__
+            raise TypeError(f"\"vals\" of type \"{vals_type}\" is not supported.")
 
     def cell_dims_pptx(self):
         """Returns the PowerPoint-style inches that bound this shape (left, top, width, height).

opencsp/common/lib/render/lib/PowerpointText.py

@@ -30,7 +30,7 @@ class PowerpointText(pps.PowerpointShape):
     def __init__(
         self,
         val: str = None,
-        dims: tuple[float, float, float, float] = None,
+        dims: tuple[float, float, float, float] = (1.0, 1.0, 1.0, 1.0),
         cell_dims: tuple[float, float, float, float] = None,
         is_title=False,
         parent_slide=None,

opencsp/common/lib/render/test/test_PowerpointShape.py

@@ -0,0 +1,142 @@
+import inspect
+import pptx
+import unittest
+from typing import Iterable, overload
+from opencsp.common.lib.render.lib.PowerpointShape import PowerpointShape
+
+
+class test_PowerpointShape(unittest.TestCase):
+    # Test of a single integer value
+    def test_pptx_inches_single_integer(self):
+        ppt_shape_instance = PowerpointShape()
+        result = ppt_shape_instance._pptx_inches(vals=3)
+        assert result == pptx.util.Inches(3)
+
+    # Test of a single float value
+    def test_pptx_inches_single_float(self):
+        ppt_shape_instance = PowerpointShape()
+        result = ppt_shape_instance._pptx_inches(vals=6.0)
+        assert result == pptx.util.Inches(6.0)
+
+    # Test for a None value
+    def test_pptx_inches_none(self):
+        ppt_shape_instance = PowerpointShape()
+        with self.assertRaises(TypeError):
+            ppt_shape_instance._pptx_inches(None)
+
+    # Test for a list of integer values
+    def test_pptx_inches_list_of_integers(self):
+        ppt_shape_instance = PowerpointShape()
+        result = ppt_shape_instance._pptx_inches(vals=[1, 2, 3, 4, 5])
+        expected = [
+            pptx.util.Inches(1),
+            pptx.util.Inches(2),
+            pptx.util.Inches(3),
+            pptx.util.Inches(4),
+            pptx.util.Inches(5),
+        ]
+        assert expected == result
+
+    # Test for a list of float values
+    def test_pptx_inches_list_of_floats(self):
+        ppt_shape_instance = PowerpointShape()
+        result = ppt_shape_instance._pptx_inches(vals=[1.0, 1.1, 1.2, 1.3, 1.4])
+        expected = [
+            pptx.util.Inches(1.0),
+            pptx.util.Inches(1.1),
+            pptx.util.Inches(1.2),
+            pptx.util.Inches(1.3),
+            pptx.util.Inches(1.4),
+        ]
+        assert expected == result
+
+    # Test for a tuple of integers
+    def test_pptx_inches_tuple_of_integers(self):
+        ppt_shape_instance = PowerpointShape()
+        result = ppt_shape_instance._pptx_inches(vals=(1, 2, 3, 4, 5))
+        expected = [
+            pptx.util.Inches(1),
+            pptx.util.Inches(2),
+            pptx.util.Inches(3),
+            pptx.util.Inches(4),
+            pptx.util.Inches(5),
+        ]
+        assert expected == result
+
+    # Test for a tuple of floats
+    def test_pptx_inches_tuple_of_floats(self):
+        ppt_shape_instance = PowerpointShape()
+        result = ppt_shape_instance._pptx_inches(vals=(1.0, 1.1, 1.2, 1.3, 1.4))
+        expected = [
+            pptx.util.Inches(1.0),
+            pptx.util.Inches(1.1),
+            pptx.util.Inches(1.2),
+            pptx.util.Inches(1.3),
+            pptx.util.Inches(1.4),
+        ]
+        assert expected == result
+
+    # Test for a tuple of integers
+    def test_pptx_inches_tuple_of_integers(self):
+        ppt_shape_instance = PowerpointShape()
+        with self.assertRaises(TypeError):
+            ppt_shape_instance._pptx_inches(vals=(1, 2, "random string", 4, 5))
+
+    # Test for an empty list
+    def test_pptx_inches_empty_list(self):
+        ppt_shape_instance = PowerpointShape()
+        result = ppt_shape_instance._pptx_inches(vals=[])
+        expected = []
+        assert expected == result
+
+    # Test for a set, not supported
+    def test_unsupported_type_set(self):
+        ppt_shape_instance = PowerpointShape()
+        with self.assertRaises(TypeError):
+            ppt_shape_instance._pptx_inches({1, 2, 3})
+
+    # Test for a string, not supported
+    def test_bad_string(self):
+        ppt_shape_instance = PowerpointShape()
+        with self.assertRaises(TypeError):
+            ppt_shape_instance._pptx_inches("some string")
+
+    # Test for a dictionary, not supported
+    def test_unsupported_type_dictionary(self):
+        ppt_shape_instance = PowerpointShape()
+        with self.assertRaises(TypeError):
+            ppt_shape_instance._pptx_inches({1: 3, 2: 4, 3: 5})
+
+    # Test for a list of strings, not supported
+    def test_unsupported_type_list_of_strings(self):
+        ppt_shape_instance = PowerpointShape()
+        with self.assertRaises(TypeError):
+            ppt_shape_instance._pptx_inches(["unit", "test", "for", "string", "list"])
+
+    # Test for a None value
+    def test_dims_to_str_with_none(self):
+        ppt_shape_instance = PowerpointShape()
+        result = ppt_shape_instance._dims_to_str(dims=None)
+        expected = None
+        assert expected == result
+
+    # Test converting tuple to string (csv)
+    def test_dims_to_str_with_tuple(self):
+        ppt_shape_instance = PowerpointShape()
+        result = ppt_shape_instance._dims_to_str(dims=(5.1, 4.2, 3.3, 2.4, 1.5))
+        expected = "5.1,4.2,3.3,2.4,1.5"
+        assert expected == result
+
+    # Test converting a csv string to a tuple of floats
+    def test_str_to_dims_with_tuple(self):
+        ppt_shape_instance = PowerpointShape()
+        result = ppt_shape_instance._str_to_dims(sval="1.1,2.2,3.3,4.4,5.5")
+        expected = (1.1, 2.2, 3.3, 4.4, 5.5)
+        assert expected == result
+
+    # Test with sval equal to None
+    def test_str_to_dims_with_none(self):
+        ppt_shape_instance = PowerpointShape()
+        result = ppt_shape_instance._str_to_dims(sval=None)
+        expected = None
+        assert expected == result

opencsp/common/lib/render/test/test_PowerpointText.py

@@ -0,0 +1,66 @@
+import os, unittest
+
+import opencsp.common.lib.opencsp_path.opencsp_root_path as orp
+import opencsp.common.lib.render.lib.PowerpointShape as pps
+import opencsp.common.lib.tool.file_tools as ft
+import opencsp.common.lib.tool.log_tools as lt
+from opencsp.common.lib.render.lib.PowerpointText import PowerpointText
+
+
+class test_PowerpointText(unittest.TestCase):
+    def test_has_val_with_content(self):
+        ppt_text_instance = PowerpointText(val="example text written for pytest")
+        assert ppt_text_instance.has_val() == True
+
+    def test_has_val_with_no_content(self):
+        ppt_text_instance = PowerpointText(val=None)
+        assert ppt_text_instance.has_val() == False
+
+    def test_has_val_with_empty_string(self):
+        ppt_text_instance = PowerpointText(val="")
+        assert ppt_text_instance.has_val() == True
+
+    def test_get_val_with_content(self):
+        ppt_text_instance = PowerpointText(val="test get val")
+        assert ppt_text_instance.get_val() == "test get val"
+
+    def test_get_val_with_no_content(self):
+        ppt_text_instance = PowerpointText(val=None)
+        assert ppt_text_instance.get_val() == None
+
+    def test_set_val(self):
+        val = "test_set_val test"
+        ppt_text_instance = PowerpointText(val)
+        ppt_text_instance.set_val(val)
+        assert ppt_text_instance._val == val
+
+    def test_set_val_none(self):
+        val = "test_set_val test"
+        ppt_text_instance = PowerpointText(val)
+        ppt_text_instance.set_val(val)
+        assert ppt_text_instance._saved_name_ext == None
+
+    def test_has_dims(self):
+        ppt_text_instance = PowerpointText()
+        assert ppt_text_instance.has_dims() == True
+
+    def test_dims_pptx(self):
+        powerpoint_var = [914400, 914400, 914400, 914400]  # when dims are 1 the direct powerpoint equivalent is 914400
+        ppt_text_instance = PowerpointText(dims=(1.0, 1.0, 1.0, 1.0))
+        assert ppt_text_instance.dims_pptx() == powerpoint_var
+
+    def test_compute_height(self):
+        test_font_pnt = 10
+        test_nlines = 1
+        value_should_be = 0.20666666666666667
+
+        ppt_text_instance = PowerpointText()
+        assert ppt_text_instance.compute_height(test_font_pnt, test_nlines) == value_should_be
+
+    def test_compute_and_assign_height(self):
+        font_pnt = 10
+        value_should_be = (1.0, 1.0, 1.0, 0.20666666666666667)
+        ppt_text_instance = PowerpointText(dims=(1.0, 1.0, 1.0, 1.0))
+        ppt_text_instance.compute_and_assign_height(font_pnt)
+
+        assert ppt_text_instance.dims == value_should_be