Merge pull request #2640 from shbhmexe/bugfix/su2py-correctness-tools

fix: Python 3 correctness and PEP 8 compliance improvements

Author: pcarruscag

SU2_PY/SU2/io/data.py

@@ -196,7 +196,7 @@ def save_data(
                 core_name=core_name,
             )
             # check for keys not in new data
-            for key, value in data_dict_old.iteritems():
+            for key, value in data_dict_old.items():
                 if not (key in data_dict):
                     data_dict[key] = value
             #: for each dict item
@@ -418,7 +418,7 @@ def append_nestdict(base_dict, add_dict):
     for key in add_dict.keys():
 
         # ensure base_dict key exists and is a list
-        if not base_dict.has_key(key):
+        if key not in base_dict:
             if isinstance(add_dict[key], dict):
                 base_dict[key] = {}
             else:

SU2_PY/SU2/io/state.py

@@ -111,7 +111,7 @@ def State_Factory(state=None, config=None):
         config = state
         state = None
 
-    if not state is None:
+    if state is not None:
         assert isinstance(state, State), "input is must be a state instance"
         return state
 

SU2_PY/SU2/io/tools.py

@@ -45,18 +45,17 @@ def read_gradients(Grad_filename, scale=1.0):
     """
 
     # open file and skip first line
-    gradfile = open(Grad_filename)
-    gradfile.readline()
-
-    # read values
-    grad_vals = []
-    for line in gradfile:
-        line = line.strip()
-        if len(line) == 0:
-            break
-        grad_vals.append(float(line) * scale)
-    #: for each line
-
+    with open(Grad_filename) as gradfile:
+        gradfile.readline()
+
+        # read values
+        grad_vals = []
+        for line in gradfile:
+            line = line.strip()
+            if len(line) == 0:
+                break
+            grad_vals.append(float(line) * scale)
+    # done
     return grad_vals
 
 
@@ -387,7 +386,7 @@ def read_aerodynamics(
                 Func_Values[key] = history_data["TAVG_" + key][-1]
     else:
         # in steady cases take only last value.
-        for key, value in Func_Values.iteritems():
+        for key, value in Func_Values.items():
             if not history_data.get(key):
                 raise KeyError(
                     "Key "
@@ -641,7 +640,7 @@ def get_dvID(kindName):
     try:
         return id_map[kindName]
     except KeyError:
-        raise Exception("Unrecognized Design Variable Name: %s", kindName)
+        raise Exception("Unrecognized Design Variable Name: %s" % kindName)
 
 
 #: def get_dvID()
@@ -652,7 +651,10 @@ def get_dvID(kindName):
 # -------------------------------------------------------------------
 
 
-def get_gradFileFormat(grad_type, plot_format, kindID, special_cases=[]):
+def get_gradFileFormat(grad_type, plot_format, kindID, special_cases=None):
+
+    if special_cases is None:
+        special_cases = []
 
     # start header, build a list of strings and join at the end
     header = []
@@ -731,7 +733,7 @@ def get_gradFileFormat(grad_type, plot_format, kindID, special_cases=[]):
         write_format.append(r", %s, %s, %s")
     elif kindID == "CST":
         header.append(r',"Up/Down","Kulfan number", "Total Kulfan numbers"')
-        write_format.append(r", %s, %s", "%s")
+        write_format.append(r", %s, %s, %s")
     elif kindID == "FAIRING":
         header.append(r',"ControlPoint_Index","Theta_Disp","R_Disp"')
         write_format.append(r", %s, %s, %s")
@@ -1170,8 +1172,8 @@ def make_link(src, dst):
             os.symlink(src, dst)
 
 
-def restart2solution(config, state={}):
-    """restart2solution(config,state={})
+def restart2solution(config, state=None):
+    """restart2solution(config, state=None)
     moves restart file to solution file,
     optionally updates state
     direct or adjoint is read from config

SU2_PY/SU2/run/interface.py

@@ -56,9 +56,9 @@
     mpi_Command = os.environ["SU2_MPI_COMMAND"]
 elif slurm_job:
     mpi_Command = "srun -n %i %s"
-elif not which("mpirun") is None:
+elif which("mpirun") is not None:
     mpi_Command = "mpirun -n %i %s"
-elif not which("mpiexec") is None:
+elif which("mpiexec") is not None:
     mpi_Command = "mpiexec -n %i %s"
 else:
     mpi_Command = ""

SU2_PY/SU2/run/projection.py

@@ -41,7 +41,7 @@
 # ----------------------------------------------------------------------
 
 
-def projection(config, state={}, step=1e-3):
+def projection(config, state=None, step=1e-3):
     """info = SU2.run.projection(config,state,step=1e-3)
 
     Runs an gradient projection with:
@@ -54,7 +54,7 @@ def projection(config, state={}, step=1e-3):
 
     Inputs:
         config - an SU2 config
-        state  - only required when using external custom DV
+        state  - accepted for API compatibility; currently unused by this function
         step   - a float or list of floats for geometry sensitivity
                  finite difference step
 

SU2_PY/SU2/util/plot.py

@@ -88,9 +88,9 @@ def write_plot(filename, plot_format, data_plot, keys_plot=None):
     return
 
 
-def tecplot(filename, data_plot, keys_plot=[]):
+def tecplot(filename, data_plot, keys_plot=None):
     write_plot(filename, "TECPLOT", data_plot, keys_plot)
 
 
-def paraview(filename, data_plot, keys_plot=[]):
+def paraview(filename, data_plot, keys_plot=None):
     write_plot(filename, "CSV", data_plot, keys_plot)

SU2_PY/topology_optimization.py

@@ -120,11 +120,9 @@ def obj_val(self, x):
         # write inputs
         self._write_input(x)
 
-        # clear previous output and run direct solver
-        try:
+        # clear previous output if present and run direct solver
+        if os.path.exists(self._objValFile):
             os.remove(self._objValFile)
-        except OSError:
-            pass  # Ignore error if file does not exist
 
         try:
             sp.call(self._objValCommand, shell=True)
@@ -147,11 +145,9 @@ def obj_val(self, x):
     def obj_der(self, x):
         # inputs written in obj_val_driver
 
-        # clear previous output and run direct solver
-        try:
+        # clear previous output if present and run direct solver
+        if os.path.exists(self._objDerFile):
             os.remove(self._objDerFile)
-        except OSError:
-            pass  # Ignore error if file does not exist
         N = x.shape[0]
         y = np.ndarray((N,))
 
@@ -197,11 +193,9 @@ def con_val(self, x):
     def con_der(self, x):
         # inputs written in obj_val_driver
 
-        # clear previous output and run solver
-        try:
+        # clear previous output if present and run solver
+        if os.path.exists(self._conDerFile):
             os.remove(self._conDerFile)
-        except OSError:
-            pass  # Ignore error if file does not exist
         N = x.shape[0]
         y = np.ndarray((N,))