Refactoring (finally removing the 'dest' parameter from the Pageset class).

This revealed a bug: if an image failed to be exported we'd been completely removing them from the page set when we should have been recording the filename for the purposes of the OBZ.

This bug was present in the regression tests (it only appeared for the arabic pageset) and so we had to update the test targets.

Author: joereddington

main.py

@@ -14,8 +14,7 @@
     if (len(sys.argv) > 2):
         parser.gridSize = int(sys.argv[3])
     obf_dest='templates/data/'
-    pageset = Pageset(filename, obf_dest, parser.gridSize) #TODO: dest shouldn't appear here
+    pageset = Pageset(filename, parser.gridSize) #TODO: dest shouldn't appear here
 
-    pageset.extract_and_label_images(obf_dest) #TODO - shouldn't be here at all. 
     parser.write_to_obz(pageset.grids, obf_dest)
 

pagesetparser/grid.py

@@ -194,6 +194,12 @@ def create_obf_button(self,col,row):
             button["label"]=button['id']
         return button
 
+    def make_imagepaths(self):
+        images = self.create_image_grid()
+        for (x, y) in images: 
+            self.imagepaths[x][y] = "images/" + create_icon_name(x, y, self.labels, self.links, self.slide_number)
+
+
 
 
     def export_images(self, dest_folder, SAVE=True): 

pagesetparser/pageset.py

@@ -9,7 +9,7 @@ class Pageset:
 
     # TODO: should throw error if filename doesn't create a useable pageset
 
-    def __init__(self, filename, dest, grid_size, saveimages=True):  #TODO: dest needs to go, it's needed for output NOT input
+    def __init__(self, filename, grid_size, saveimages=True):  #TODO: dest needs to go, it's needed for output NOT input
         try: 
             self.prs = Presentation(filename)
         except:
@@ -19,7 +19,7 @@ def __init__(self, filename, dest, grid_size, saveimages=True):  #TODO: dest nee
         self.grid_size=grid_size #TODO: we might NOT need to store this internally
         self.feedback = []
         self.split_pageset_into_grids()
-        self.extract_and_label_images(dest, False) #This has to run to get the names right. TODO Call from somewhere else
+        self.get_image_names() #This has to run to get the names right. TODO Call from somewhere else
 
     def addfeedback(self, feedelement):
         self.feedback.append(feedelement)
@@ -34,9 +34,9 @@ def split_pageset_into_grids(self):
         for grid in self.grids:
             grid.update_links(self.grids) # We can only run this after every other page knows their own tag. 
 
-    def extract_and_label_images(self, dest, SAVE=True):  #TODO: this should only be called from one of the proper export files.
+    def get_image_names(self):  #TODO: this should only be called from one of the proper export files.
         for i in range(len(self.grids)):
-            self.grids[i].export_images(dest, SAVE)
+            self.grids[i].make_imagepaths()
 
     def to_json(self):  #TODO: put in pageset and then put the inner loop in grid 
         # Start the JSON output.

pagesetparser/pagesetparser.py

@@ -38,9 +38,11 @@ def get_obf_manifest(root,boards_names_dic, image_names_dic):
 
 
 def write_to_obz(grids, dest): #TODO  these three files should definately be moved into pageset.py
+     
     owd = os.getcwd()
     image_names_dic = {}
     for grid in grids: 
+        grid.export_images(dest)
         grid.write_obf_file(dest) 
         for path in grid.get_image_paths():
             image_names_dic[path]=path
@@ -57,4 +59,5 @@ def write_to_obz(grids, dest): #TODO  these three files should definately be mov
                 w.write(x) 
     except FileNotFoundError: #The try-except block is here so that we always change back to the right directly if there is an error. 
         print("Error 23024982342 on file {}".format(x))
+        print(x)
     os.chdir(owd)

tests/regressions/generate_regressions.py

@@ -34,8 +34,7 @@ def generate_obz(filename,gridSize):
             os.makedirs(obf_dest)
         if not os.path.exists(obf_dest+"boards/"):
             os.makedirs(obf_dest+"boards/")
-        pageset = Pageset(filename,obf_dest, gridSize)
-        pageset.extract_and_label_images(obf_dest)
+        pageset = Pageset(filename, gridSize)
         parser.write_to_obz(pageset.grids, obf_dest)
 
 def generate(filename, gridSize):

tests/regressions/regression_tests_size_5/CK20V2_ara_regession.pptx

@@ -190,7 +190,7 @@
       "background_color": "rgb(250,250,250)",
       "border_color": "rgb(68,68,68)",
       "id": "44",
-      "image_id": "",
+      "image_id": "images/S8X4Y4\u0637\u064e\u0639\u064e\u0627\u0645\u0645\u064f\u0641\u064e\u0636\u064e\u0651\u0644.png",
       "label": "\u0637\u064e\u0639\u064e\u0627\u0645 \u0645\u064f\u0641\u064e\u0636\u064e\u0651\u0644"
     }
   ],
@@ -377,6 +377,13 @@
       "id": "images/S8X3Y4\u062f\u064e\u0631\u062f\u064e\u0634\u064e\u0629\u062d\u064e\u0648\u0644\u064e\u0627\u0644\u0637\u0651\u064e\u0639\u0627\u0645.png",
       "path": "images/S8X3Y4\u062f\u064e\u0631\u062f\u064e\u0634\u064e\u0629\u062d\u064e\u0648\u0644\u064e\u0627\u0644\u0637\u0651\u064e\u0639\u0627\u0645.png",
       "width": 300
+    },
+    {
+      "content_type": "image/png",
+      "height": 300,
+      "id": "images/S8X4Y4\u0637\u064e\u0639\u064e\u0627\u0645\u0645\u064f\u0641\u064e\u0636\u064e\u0651\u0644.png",
+      "path": "images/S8X4Y4\u0637\u064e\u0639\u064e\u0627\u0645\u0645\u064f\u0641\u064e\u0636\u064e\u0651\u0644.png",
+      "width": 300
     }
   ],
   "locale": "en",

tests/regressions/regression_tests_size_5/CK20V2_ara_regession.pptx.obz.target/boards/food.obf

@@ -105,7 +105,7 @@
       "background_color": "rgb(250,250,250)",
       "border_color": "rgb(68,68,68)",
       "id": "13",
-      "image_id": "",
+      "image_id": "images/S5X1Y3\u0623\u064a\u0651\u0627\u064b\u0643\u0627\u0646.png",
       "label": "\u0623\u064a\u0651\u0627\u064b \u0643\u0627\u0646"
     },
     {
@@ -265,6 +265,13 @@
       "path": "images/S5X0Y3\u0623\u0646\u062a\u062a\u064f\u0632\u0639\u0650\u062c\u064f\u0646\u064a.png",
       "width": 300
     },
+    {
+      "content_type": "image/png",
+      "height": 300,
+      "id": "images/S5X1Y3\u0623\u064a\u0651\u0627\u064b\u0643\u0627\u0646.png",
+      "path": "images/S5X1Y3\u0623\u064a\u0651\u0627\u064b\u0643\u0627\u0646.png",
+      "width": 300
+    },
     {
       "content_type": "image/png",
       "height": 300,

tests/regressions/regression_tests_size_5/CK20V2_ara_regession.pptx.obz.target/boards/wml.obf

@@ -37,7 +37,7 @@ def get_singleton_CK20(self):
         if not self.CK20:
            # prs = Presentation("tests/CK20V2cutdown.pptx")
             pagesetparser.gridSize=5
-            self.CK20 = pagesetparser.Pageset("tests/testinputs/CK20V2cutdown.pptx","",pagesetparser.gridSize, False)
+            self.CK20 = pagesetparser.Pageset("tests/testinputs/CK20V2cutdown.pptx",pagesetparser.gridSize, False)
 
         return self.CK20