Exception handler refactoring (#909)

* created new pyaedt_function_handler

* replaced @aedt_exception_handler with @pyaedt_function_handler()

* black check

* - added @pyaedt_function_handler() to primitives methods.
- fixed test_81_edb_with_dxf

* - added @pyaedt_function_handler() to DataHandlers.py methods

* code clean up

Author: Alberto-DM

_unittest/test_00_EDB.py

@@ -709,6 +709,7 @@ def test_80_create_rectangle_in_pad(self):
         edb_padstacks.close_edb()
 
     def test_81_edb_with_dxf(self):
-        edb3 = Edb(os.path.join(local_path, "example_models", "edb_test_82.dxf"), edbversion=desktop_version)
+        dxf_file = self.local_scratch.copyfile(os.path.join(local_path, "example_models", "edb_test_82.dxf"))
+        edb3 = Edb(dxf_file, edbversion=desktop_version)
         edb3.close_edb()
         del edb3

doc/source/Resources/Code_Guidelines.rst

@@ -755,14 +755,14 @@ These examples demonstrate how to to write messages only to the log file:
 Exception Handling
 ~~~~~~~~~~~~~~~~~~
 PyAEDT uses a specific decorator,  
-``@aedt_exception_handler``, to handle exceptions caused by
+``@pyaedt_function_handler``, to handle exceptions caused by
 methods and by the AEDT API. This exception handler decorator 
 makes PyAEDT fault tolerant to errors that can occur in any method. 
 For example:
 
 .. code:: python
 
-   @aedt_exception_handler
+   @pyaedt_function_handler()
    def my_method(self, var):
        pass
 

pyaedt/__init__.py

@@ -11,7 +11,7 @@
 
 from pyaedt.generic.general_methods import settings
 from pyaedt.generic import constants
-from pyaedt.generic.general_methods import aedt_exception_handler, generate_unique_name, _retry_ntimes
+from pyaedt.generic.general_methods import pyaedt_function_handler, generate_unique_name, _retry_ntimes
 from pyaedt.generic.general_methods import is_ironpython, _pythonver, inside_desktop, convert_remote_object
 from pyaedt.aedt_logger import AedtLogger
 

pyaedt/application/AEDT_File_Management.py

@@ -3,10 +3,10 @@
 import re
 import shutil
 
-from pyaedt.generic.general_methods import aedt_exception_handler
+from pyaedt.generic.general_methods import pyaedt_function_handler
 
 
-@aedt_exception_handler
+@pyaedt_function_handler()
 def read_info_fromcsv(projdir, name):
     """Read information from a CSV file and return a list.
 
@@ -32,7 +32,7 @@ def read_info_fromcsv(projdir, name):
     return listmcad
 
 
-@aedt_exception_handler
+@pyaedt_function_handler()
 def clean_proj_folder(dir, name):
     """Delete all project name-related folders.
 
@@ -54,7 +54,7 @@ def clean_proj_folder(dir, name):
     return True
 
 
-@aedt_exception_handler
+@pyaedt_function_handler()
 def create_output_folder(ProjectDir):
     """Create the output folders starting from the project directory.
 
@@ -88,7 +88,7 @@ def create_output_folder(ProjectDir):
     return PicturePath, ResultsPath
 
 
-@aedt_exception_handler
+@pyaedt_function_handler()
 def change_objects_visibility(origfile, solid_list):
     """Edit the project file to make only the solids that are specified visible.
 
@@ -134,7 +134,7 @@ def change_objects_visibility(origfile, solid_list):
         print("change_objects_visibility: Project %s is still locked." % origfile)
 
 
-@aedt_exception_handler
+@pyaedt_function_handler()
 def change_model_orientation(origfile, bottom_dir):
     """Edit the project file to change the model orientation.
 

pyaedt/application/Analysis.py

@@ -12,7 +12,7 @@
 import warnings
 from collections import OrderedDict
 
-from pyaedt.generic.general_methods import aedt_exception_handler, generate_unique_name, filter_tuple
+from pyaedt.generic.general_methods import pyaedt_function_handler, generate_unique_name, filter_tuple
 from pyaedt.generic.constants import (
     AXIS,
     PLANE,
@@ -505,7 +505,7 @@ def excitations(self):
         except:
             return []
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def get_excitations_name(self):
         """Get all excitation names.
 
@@ -526,7 +526,7 @@ def get_excitations_name(self):
         warnings.warn("`get_excitations_name` is deprecated. Use `excitations` property instead.", DeprecationWarning)
         return self.excitations
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def get_traces_for_plot(
         self,
         get_self_terms=True,
@@ -585,7 +585,7 @@ def get_traces_for_plot(
                             list_output.append(value)
         return list_output
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def analyze_all(self):
         """Analyze all setups in a design.
 
@@ -597,7 +597,7 @@ def analyze_all(self):
         self.odesign.AnalyzeAll()
         return True
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def list_of_variations(self, setup_name=None, sweep_name=None):
         """Retrieve a list of active variations for input setup.
 
@@ -642,7 +642,7 @@ def list_of_variations(self, setup_name=None, sweep_name=None):
             except:
                 return [""]
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def export_results(self, analyze=False, export_folder=None):
         """Export all available reports to a file, including sNp, profile, and convergence.
 
@@ -775,7 +775,7 @@ def export_results(self, analyze=False, export_folder=None):
                                 self.logger.warning("Export SnP failed: no solutions found")
         return exported_files
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def export_convergence(self, setup_name, variation_string="", file_path=None):
         """Export a solution convergence to a file.
 
@@ -806,7 +806,7 @@ def export_convergence(self, setup_name, variation_string="", file_path=None):
         self.logger.info("Export Convergence to  %s", file_path)
         return file_path
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def _get_native_data(self):
         """Retrieve Native Components data."""
         boundaries = []
@@ -868,7 +868,7 @@ def variables(self):
             """
             return [i for i in self._app.variable_manager.independent_variables]
 
-        @aedt_exception_handler
+        @pyaedt_function_handler()
         def variations(self, setup_sweep=None):
             """Variations.
 
@@ -904,7 +904,7 @@ def variations(self, setup_sweep=None):
                 families.append(family)
             return families
 
-        @aedt_exception_handler
+        @pyaedt_function_handler()
         def get_variation_strings(self, setup_sweep=None):
             """Return variation strings.
 
@@ -1002,7 +1002,7 @@ class AxisDir(object):
 
         (XNeg, YNeg, ZNeg, XPos, YPos, ZPos) = range(0, 6)
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def get_setups(self):
         """Retrieve setups.
 
@@ -1019,7 +1019,7 @@ def get_setups(self):
         setups = self.oanalysis.GetSetups()
         return list(setups)
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def get_nominal_variation(self):
         """Retrieve the nominal variation.
 
@@ -1030,7 +1030,7 @@ def get_nominal_variation(self):
         """
         return self.available_variations.nominal
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def get_sweeps(self, name):
         """Retrieve all sweeps for a setup.
 
@@ -1052,7 +1052,7 @@ def get_sweeps(self, name):
         sweeps = self.oanalysis.GetSweeps(name)
         return list(sweeps)
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def export_parametric_results(self, sweepname, filename, exportunits=True):
         """Export a list of all parametric variations solved for a sweep to a CSV file.
 
@@ -1080,7 +1080,7 @@ def export_parametric_results(self, sweepname, filename, exportunits=True):
         self.ooptimetrics.ExportParametricResults(sweepname, filename, exportunits)
         return True
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def analyze_from_initial_mesh(self):
         """Revert the solution to the initial mesh and re-run the solve.
 
@@ -1099,7 +1099,7 @@ def analyze_from_initial_mesh(self):
         self.analyze_nominal()
         return True
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def analyse_nominal(self):
         """Solve the nominal design.
 
@@ -1109,7 +1109,7 @@ def analyse_nominal(self):
         warnings.warn("`analyse_nominal` is deprecated. Use `analyze_nominal` instead.", DeprecationWarning)
         self.analyze_nominal()
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def analyze_nominal(self, num_cores=None, num_tasks=None, num_gpu=None, acf_file=None):
         """Solve the nominal design.
 
@@ -1137,7 +1137,7 @@ def analyze_nominal(self, num_cores=None, num_tasks=None, num_gpu=None, acf_file
 
         return self.analyze_setup(self.analysis_setup, num_cores, num_tasks, num_gpu, acf_file)
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def generate_unique_setup_name(self, setup_name=None):
         """Generate a new setup with an unique name.
 
@@ -1160,7 +1160,7 @@ def generate_unique_setup_name(self, setup_name=None):
             index += 1
         return setup_name
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def create_setup(self, setupname="MySetupAuto", setuptype=None, props={}):
         """Create a setup.
 
@@ -1229,7 +1229,7 @@ def create_setup(self, setupname="MySetupAuto", setuptype=None, props={}):
         self.setups.append(setup)
         return setup
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def delete_setup(self, setupname):
         """Delete a setup.
 
@@ -1267,7 +1267,7 @@ def delete_setup(self, setupname):
             return True
         return False
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def edit_setup(self, setupname, properties_dict):
         """Modify a setup.
 
@@ -1294,7 +1294,7 @@ def edit_setup(self, setupname, properties_dict):
         self.analysis_setup = setupname
         return setup
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def get_setup(self, setupname):
         """Get the setup from the current design.
 
@@ -1315,7 +1315,7 @@ def get_setup(self, setupname):
             self.analysis_setup = setupname
         return setup
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def create_output_variable(self, variable, expression):
         """Create or modify an output variable.
 
@@ -1346,7 +1346,7 @@ def create_output_variable(self, variable, expression):
             oModule.CreateOutputVariable(variable, expression, self.existing_analysis_sweeps[0], self.solution_type, [])
         return True
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def get_output_variable(self, variable):
         """Retrieve the value of the output variable.
 
@@ -1375,7 +1375,7 @@ def get_output_variable(self, variable):
 
         return value
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def get_object_material_properties(self, object_list=None, prop_names=None):
         """Retrieve the material properties for a list of objects and return them in a dictionary.
 
@@ -1417,7 +1417,7 @@ def get_object_material_properties(self, object_list=None, prop_names=None):
                     dict[entry][prop_name] = mat_props._props[prop_name]
         return dict
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def analyze_setup(self, name, num_cores=None, num_tasks=None, num_gpu=None, acf_file=None):
         """Analyze a design setup.
 
@@ -1506,7 +1506,7 @@ def analyze_setup(self, name, num_cores=None, num_tasks=None, num_gpu=None, acf_
         self.logger.info("Design setup %s solved correctly", name)
         return True
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def solve_in_batch(self, filename=None, machine="local", run_in_thread=False):
         """Analyze a design setup in batch mode.
 
@@ -1568,7 +1568,7 @@ def thread_run():
         self.logger.info("Batch job finished.")
         return True
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def submit_job(
         self, clustername, aedt_full_exe_path=None, numnodes=1, numcores=32, wait_for_license=True, setting_file=None
     ):

pyaedt/application/Analysis2D.py

@@ -3,7 +3,7 @@
 from pyaedt.application.Analysis import Analysis
 from pyaedt.modeler.Model2D import Modeler2D
 from pyaedt.modules.Mesh import Mesh
-from pyaedt.generic.general_methods import aedt_exception_handler, is_ironpython
+from pyaedt.generic.general_methods import pyaedt_function_handler, is_ironpython
 
 if is_ironpython:
     from pyaedt.modules.PostProcessor import PostProcessor
@@ -131,7 +131,7 @@ def mesh(self):
         """
         return self._mesh
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def plot(
         self,
         objects=None,
@@ -187,7 +187,7 @@ def plot(
                 clean_files=clean_files,
             )
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def export_mesh_stats(self, setup_name, variation_string="", mesh_path=None):
         """Export mesh statistics to a file.
 
@@ -216,7 +216,7 @@ def export_mesh_stats(self, setup_name, variation_string="", mesh_path=None):
         self.odesign.ExportMeshStats(setup_name, variation_string, mesh_path)
         return mesh_path
 
-    @aedt_exception_handler
+    @pyaedt_function_handler()
     def assign_material(self, obj, mat):
         """Assign a material to one or more objects.