[Python] Remove hard dependecy to tqdm if progress bar are not needed (#108)

Co-authored-by: erik pernod <erik.pernod@gmail.com>

Author: fredroy

SofaRegressionProgram.py

@@ -3,8 +3,6 @@
 import sys
 import numpy as np
 
-from tqdm import tqdm
-
 if "SOFA_ROOT" not in os.environ:
     print('SOFA_ROOT environment variable has not been detected, quitting.')
     exit(1)
@@ -15,6 +13,7 @@
 import Sofa
 import SofaRuntime # importing SofaRuntime will add the py3 loader to the scene loaders
 import tools.RegressionSceneList as RegressionSceneList
+from tools import ProgressBarHandler as pbh
 
 regression_file_extension = ".regression-tests"
 
@@ -60,15 +59,17 @@ def write_sets_references(self, id_set=0):
 
     def write_all_sets_references(self):
         nbr_sets = len(self.scene_sets)
-        pbar_sets = tqdm(total=nbr_sets, disable=self.disable_progress_bar)
+
+        pbar_sets = pbh.ProgressBarHandler(total=self.nbr_sets, disable=args.disable_progress_bar)
         pbar_sets.set_description("Write All sets")
 
         nbr_scenes = 0
         for i in range(0, nbr_sets):
             nbr_scenes = nbr_scenes + self.write_sets_references(i)
             pbar_sets.update(1)
 
-        pbar_sets.close()
+        if not self.disable_progress_bar:
+            pbar_sets.close()
 
         return nbr_scenes
 
@@ -80,7 +81,7 @@ def compare_sets_references(self, id_set=0):
 
     def compare_all_sets_references(self):
         nbr_sets = len(self.scene_sets)
-        pbar_sets = tqdm(total=nbr_sets, disable=self.disable_progress_bar)
+        pbar_sets = pbh.ProgressBarHandler(total=nbr_sets, disable=self.disable_progress_bar)
         pbar_sets.set_description("Compare All sets")
 
         nbr_scenes = 0

tools/ProgressBarHandler.py

@@ -0,0 +1,26 @@
+
+class ProgressBarHandler:
+    def __init__(self, total, disable = False):
+        self.enable_progress_bar = not disable
+        self.description = ""
+
+        if self.enable_progress_bar:
+            try:
+                from tqdm import tqdm
+                self.tqdm_object = tqdm(total=total)
+            except ModuleNotFoundError:
+                print('warning: tqdm is needed if you want to enable progress bars.')
+                self.enable_progress_bar = False
+                self.tqdm_object = None
+
+    def set_description(self, description):
+        if self.enable_progress_bar:
+            self.tqdm_object.set_description(description)
+
+    def update(self, nb_step):
+        if self.enable_progress_bar:
+            self.tqdm_object.update(nb_step)
+
+    def close(self):
+        if self.enable_progress_bar:
+            self.tqdm_object.close()

tools/RegressionSceneData.py

@@ -1,13 +1,14 @@
 import time
-
-from tqdm import tqdm
 import numpy as np
 import pathlib
 
 import tools.ReferenceFileIO as reference_io
 import tools.RegressionHelper as helper
 import Sofa
 
+from tools import ProgressBarHandler as pbh
+
+
 def is_simulated(node):
     if node.hasODESolver():
         return True
@@ -173,7 +174,7 @@ def load_scene(self, format = "JSON"):
 
 
     def write_references(self, format = "JSON"):
-        pbar_simu = tqdm(total=self.steps, disable=self.disable_progress_bar)
+        pbar_simu = pbh.ProgressBarHandler(total=self.steps, disable=self.disable_progress_bar)
         pbar_simu.set_description("Simulate: " + self.file_scene_path)
 
         # compute stepping parameters for the simulation
@@ -231,7 +232,7 @@ def write_references(self, format = "JSON"):
 
 
     def compare_references(self, format = "JSON"):
-        pbar_simu = tqdm(total=float(self.steps), disable=self.disable_progress_bar)
+        pbar_simu = pbh.ProgressBarHandler(total=float(self.steps), disable=self.disable_progress_bar)
         pbar_simu.set_description("compare_references: " + self.file_scene_path)
 
         nbr_meca = len(self.meca_objs)
@@ -382,7 +383,7 @@ def compare_references(self, format = "JSON"):
 
 
     def compare_legacy_references(self):
-        pbar_simu = tqdm(total=float(self.steps), disable=self.disable_progress_bar)
+        pbar_simu = pbh.ProgressBarHandler(total=float(self.steps), disable=self.disable_progress_bar)
         pbar_simu.set_description("compare_legacy_references: " + self.file_scene_path)
 
         nbr_meca = len(self.meca_objs)

tools/RegressionSceneList.py

@@ -1,9 +1,9 @@
 import os
 import tools.RegressionSceneData as RegressionSceneData
 import tools.RegressionHelper as helper
-from tqdm import tqdm
-import re
+from tools import ProgressBarHandler as pbh
 
+import re
 
 ## This class is responsible for loading a file.regression-tests to gather the list of scene to test with all arguments
 ## It will provide the API to launch the tests or write refs on all scenes contained in this file
@@ -108,12 +108,14 @@ def write_references(self, id_scene, print_log = False):
 
     def write_all_references(self):
         nbr_scenes = len(self.scenes_data_sets)
-        pbar_scenes = tqdm(total=nbr_scenes, disable=self.disable_progress_bar)
+
+        pbar_scenes = pbh.ProgressBarHandler(total=self.nbr_scenes, disable=self.disable_progress_bar)
         pbar_scenes.set_description("Write all scenes from: " + self.file_path)
 
         for i in range(0, nbr_scenes):
             self.write_references(i)
             pbar_scenes.update(1)
+
         pbar_scenes.close()
 
         return nbr_scenes
@@ -140,7 +142,7 @@ def compare_references(self, id_scene):
 
     def compare_all_references(self):
         nbr_scenes = len(self.scenes_data_sets)
-        pbar_scenes = tqdm(total=nbr_scenes, disable=self.disable_progress_bar)
+        pbar_scenes = pbh.ProgressBarHandler(total=nbr_scenes, disable=self.disable_progress_bar)
         pbar_scenes.set_description("Compare all scenes from: " + self.file_path)
 
         for i in range(0, nbr_scenes):