Fixing import errors, adding isort, cleaned up regression tests, and …

…added unit tests for new import procedure (mdolab#180)

* Fixing error handling, sorting imports with isort, and standardizing test formats

* Added unit tests for the new import gaurds

* Adding isort to pipeline and fixing imports on dvgeo tests

* Fixing failed tests

* Addressing PR review comments

.github/azure-pipelines.yaml

@@ -15,4 +15,5 @@ extends:
   template: azure/azure_template.yaml@azure_template
   parameters:
     REPO_NAME: pygeo
+    ISORT: true
     COVERAGE: true

doc/conf.py

@@ -1,12 +1,15 @@
+# Standard Python modules
+import os
+import sys
+
+# External modules
 from sphinx_mdolab_theme.config import *
 
 # -- Path setup --------------------------------------------------------------
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
-import os
-import sys
 
 sys.path.insert(0, os.path.abspath("../"))
 sys.path.insert(0, os.path.abspath("../../"))

examples/bwb/bwb.py

@@ -1,7 +1,10 @@
+# External modules
 import numpy as np
-from pygeo import pyGeo
 from pyspline import Curve
 
+# First party modules
+from pygeo import pyGeo
+
 # ==============================================================================
 # Start of Script
 # ==============================================================================

examples/c172_wing/c172.py

@@ -1,4 +1,7 @@
+# External modules
 import numpy as np
+
+# First party modules
 from pygeo import pyGeo
 
 # ==============================================================================

examples/c172_wing/genFFD.py

@@ -1,3 +1,4 @@
+# External modules
 import numpy as np
 
 nstreamwise = 10

examples/c172_wing/runFFDExample.py

@@ -1,7 +1,10 @@
-from pygeo import DVGeometry
+# External modules
 import numpy as np
 from stl import mesh
 
+# First party modules
+from pygeo import DVGeometry
+
 
 def create_fresh_dvgeo():
     # The Plot3D file ffdbox.xyz contains the coordinates of the free-form deformation (FFD) volume

examples/cst/CSTTutorial.py

@@ -1,8 +1,14 @@
-from pygeo import DVGeometryCST
-import numpy as np
-import matplotlib.pyplot as plt
+# Standard Python modules
 import os
 
+# External modules
+import matplotlib.pyplot as plt
+import numpy as np
+
+# First party modules
+from pygeo import DVGeometryCST
+
+
 # rst Plot func (beg)
 def plot_points(points, filename=None):
     fig, ax = plt.subplots(figsize=[10, 3])

examples/deform_geometry/ffd/simple_ffd.py

@@ -1,3 +1,4 @@
+# External modules
 import numpy as np
 
 # Bounding box for root airfoil

examples/deform_geometry/geo/generate_wing.py

@@ -1,5 +1,7 @@
-# rst Imports
+# External modules
 import numpy as np
+
+# First party modules
 from pygeo import pyGeo
 
 # Number of airfoil sections

examples/deform_geometry/runScript.py

@@ -2,10 +2,15 @@
 This script demonstrates the deformation of a geometry object using FFD and
 the process for exporting the geometry as a tecplot or IGES file.
 """
-from pygeo import pyGeo, DVGeometry
-import numpy as np
+# Standard Python modules
 import argparse
 
+# External modules
+import numpy as np
+
+# First party modules
+from pygeo import DVGeometry, pyGeo
+
 input_files = "../../input_files/"
 
 

examples/esp_airfoil/esp_airfoil.py

@@ -1,9 +1,9 @@
-# ======================================================================
-#         Import modules
-# ======================================================================
-from pygeo import DVGeometryESP
+# External modules
 from stl import mesh
 
+# First party modules
+from pygeo import DVGeometryESP
+
 # rst create dvgeo start
 # initialize the DVGeometry object with the csm file
 csm_file = "naca0012.csm"

examples/ffd/generateBWBFFD.py

@@ -1,3 +1,4 @@
+# External modules
 import numpy as np
 
 # rst Dimensions

examples/ffd/generateFFD.py

@@ -1,3 +1,4 @@
+# External modules
 import numpy as np
 
 

examples/ffd/generatec172FFD.py

@@ -1,3 +1,4 @@
+# External modules
 import numpy as np
 
 # rst Dimensions

examples/ffd/generaterectFFD.py

@@ -1,3 +1,4 @@
+# External modules
 import numpy as np
 
 # rst Dimensions

examples/ffd_cylinder/genFFD.py

@@ -1,3 +1,4 @@
+# External modules
 import numpy as np
 
 nffd = 10

examples/ffd_cylinder/runFFDExample.py

@@ -1,6 +1,9 @@
-from pygeo import DVGeometry
-import numpy as np
+# External modules
 import matplotlib.pyplot as plt
+import numpy as np
+
+# First party modules
+from pygeo import DVGeometry
 
 # create a pointset. pointsets are of shape npts by 3 (the second dim is xyz coordinate)
 # we'll generate a cylinder in parametric coordinates

pygeo/__init__.py

@@ -6,20 +6,7 @@
 from .constraints import DVConstraints
 from .parameterization import DVGeometry
 from .parameterization import DVGeometryAxi
-
-try:
-    from .parameterization import DVGeometryCST
-except ImportError:
-    pass
-try:
-    from .parameterization import DVGeometryVSP
-except ImportError:
-    pass
-try:
-    from .parameterization import DVGeometryESP
-except ImportError:
-    pass
-try:
-    from .parameterization import DVGeometryMulti
-except ImportError:
-    pass
+from .parameterization import DVGeometryCST
+from .parameterization import DVGeometryVSP
+from .parameterization import DVGeometryESP
+from .parameterization import DVGeometryMulti

pygeo/constraints/DVCon.py

@@ -1,24 +1,26 @@
-# ======================================================================
-#         Imports
-# ======================================================================
-import numpy as np
-from .. import geo_utils, pyGeo
-from pyspline import Curve
+# Standard Python modules
 from collections import OrderedDict
+
+# External modules
 from baseclasses.utils import Error
-from .baseConstraint import LinearConstraint, GlobalLinearConstraint
-from .thicknessConstraint import ThicknessConstraint, ThicknessToChordConstraint
-from .radiusConstraint import RadiusConstraint
-from .locationConstraint import LocationConstraint
-from .areaConstraint import TriangulatedSurfaceConstraint, SurfaceAreaConstraint, ProjectedAreaConstraint
-from .volumeConstraint import VolumeConstraint, TriangulatedVolumeConstraint, CompositeVolumeConstraint
+import numpy as np
+from pyspline import Curve
+
+# Local modules
+from .. import geo_utils, pyGeo
+from ..geo_utils.file_io import readPlot3DSurfFile
+from ..geo_utils.misc import convertTo2D
+from .areaConstraint import ProjectedAreaConstraint, SurfaceAreaConstraint, TriangulatedSurfaceConstraint
+from .baseConstraint import GlobalLinearConstraint, LinearConstraint
+from .circularityConstraint import CircularityConstraint
 from .colinearityConstraint import ColinearityConstraint
+from .curvatureConstraint import CurvatureConstraint, CurvatureConstraint1D
 from .gearPostConstraint import GearPostConstraint
-from .circularityConstraint import CircularityConstraint
+from .locationConstraint import LocationConstraint
 from .planarityConstraint import PlanarityConstraint
-from .curvatureConstraint import CurvatureConstraint, CurvatureConstraint1D
-from ..geo_utils.misc import convertTo2D
-from ..geo_utils.file_io import readPlot3DSurfFile
+from .radiusConstraint import RadiusConstraint
+from .thicknessConstraint import ThicknessConstraint, ThicknessToChordConstraint
+from .volumeConstraint import CompositeVolumeConstraint, TriangulatedVolumeConstraint, VolumeConstraint
 
 
 class DVConstraints:
@@ -401,6 +403,7 @@ def writeSurfaceSTL(self, fileName, surfaceName="default", fromDVGeo=None):
             Name of the DVGeo object to obtain the surface from (default is 'None')
         """
         try:
+            # External modules
             from stl import mesh
         except ImportError as e:
             raise ImportError("numpy-stl package must be installed") from e

pygeo/constraints/areaConstraint.py

@@ -1,13 +1,14 @@
-# ======================================================================
-#         Imports
-# ======================================================================
+# External modules
+from mpi4py import MPI
 import numpy as np
+
+# Local modules
 from .. import geo_utils
-from mpi4py import MPI
-from .baseConstraint import GeometricConstraint
 from ..geo_utils.polygon import areaTri
+from .baseConstraint import GeometricConstraint
 
 try:
+    # External modules
     from geograd import geograd_parallel  # noqa
 except ImportError:
     geograd_parallel = None

pygeo/constraints/baseConstraint.py

@@ -1,10 +1,10 @@
-# ======================================================================
-#         Imports
-# ======================================================================
+# Standard Python modules
 from abc import ABC, abstractmethod
 from collections import OrderedDict
-import numpy as np
+
+# External modules
 from baseclasses.utils import Error
+import numpy as np
 
 
 class GeometricConstraint(ABC):

pygeo/constraints/circularityConstraint.py

@@ -1,7 +1,7 @@
-# ======================================================================
-#         Imports
-# ======================================================================
+# External modules
 import numpy as np
+
+# Local modules
 from .baseConstraint import GeometricConstraint
 
 

pygeo/constraints/colinearityConstraint.py

@@ -1,7 +1,7 @@
-# ======================================================================
-#         Imports
-# ======================================================================
+# External modules
 import numpy as np
+
+# Local modules
 from .. import geo_utils
 from .baseConstraint import GeometricConstraint
 

pygeo/constraints/curvatureConstraint.py

@@ -1,10 +1,10 @@
-# ======================================================================
-#         Imports
-# ======================================================================
-import numpy as np
+# External modules
+from baseclasses.utils import Error
 from mpi4py import MPI
+import numpy as np
 from scipy.sparse import csr_matrix
-from baseclasses.utils import Error
+
+# Local modules
 from .baseConstraint import GeometricConstraint
 
 

pygeo/constraints/gearPostConstraint.py

@@ -1,7 +1,7 @@
-# ======================================================================
-#         Imports
-# ======================================================================
+# External modules
 import numpy as np
+
+# Local modules
 from .. import geo_utils
 from .baseConstraint import GeometricConstraint
 

pygeo/constraints/locationConstraint.py

@@ -1,7 +1,7 @@
-# ======================================================================
-#         Imports
-# ======================================================================
+# External modules
 import numpy as np
+
+# Local modules
 from .baseConstraint import GeometricConstraint
 
 

pygeo/constraints/planarityConstraint.py

@@ -1,7 +1,7 @@
-# ======================================================================
-#         Imports
-# ======================================================================
+# External modules
 import numpy as np
+
+# Local modules
 from .. import geo_utils
 from .baseConstraint import GeometricConstraint
 

pygeo/constraints/radiusConstraint.py

@@ -1,7 +1,7 @@
-# ======================================================================
-#         Imports
-# ======================================================================
+# External modules
 import numpy as np
+
+# Local modules
 from .. import geo_utils
 from .baseConstraint import GeometricConstraint
 

pygeo/constraints/thicknessConstraint.py

@@ -1,7 +1,7 @@
-# ======================================================================
-#         Imports
-# ======================================================================
+# External modules
 import numpy as np
+
+# Local modules
 from .. import geo_utils
 from .baseConstraint import GeometricConstraint
 

pygeo/constraints/volumeConstraint.py

@@ -1,14 +1,9 @@
-# ======================================================================
-#         Imports
-# ======================================================================
+# External modules
 import numpy as np
+
+# Local modules
+from ..geo_utils.polygon import volumeHex, volumeHex_b, volumeTriangulatedMesh, volumeTriangulatedMesh_b
 from .baseConstraint import GeometricConstraint
-from ..geo_utils.polygon import (
-    volumeHex,
-    volumeHex_b,
-    volumeTriangulatedMesh,
-    volumeTriangulatedMesh_b,
-)
 
 
 class VolumeConstraint(GeometricConstraint):

pygeo/geo_utils/bilinear_map.py

@@ -1,3 +1,4 @@
+# External modules
 import numpy as np