Merge pull request #777 from tpaviot/review/qa

Review/qa

Author: tpaviot

INSTALL.md

@@ -19,12 +19,12 @@ Requirements
 pythonOCC needs the following libraries or programs to be installed before you
 can compile/use it :
 
-- the python programming language (http://www.python.org). Python 3.x is required. Python 2
+*   the python programming language (<http://www.python.org>). Python 3.x is required. Python 2
 is officially dropped since the release 7.4.0.
 
-- OpenCascade 7.4.0 (https://dev.opencascade.org),
+*   OpenCascade 7.4.0 (<https://dev.opencascade.org>),
 
-- SWIG 3.0.11 or higher (http://www.swig.org),
+*   SWIG 3.0.11 or higher (<http://www.swig.org>),
 
 Create a local copy of the repository
 -------------------------------------
@@ -47,7 +47,6 @@ installation, you have to set OCE_INCLUDE_PATH and OCE_LIB_PATH:
 
     cmake -DOCE_INCLUDE_PATH=/your_oce_headers -DOCE_LIB_PATH=/your_lib_dir ..
 
-
 And launch the build process
 
     make
@@ -76,4 +75,4 @@ In order to check that everything is ok, run the pythonocc unittest suite:
 
 demos
 -----
-Download/test demos available at https://github.com/tpaviot/pythonocc-demos
+Download/test demos available at <https://github.com/tpaviot/pythonocc-demos>

README.md

@@ -17,7 +17,6 @@ CAD/PDM/PLM applications.
 
 Latest release : [pythonocc-core 7.4.0rc1 (december 2019)](https://github.com/tpaviot/pythonocc-core/releases/tag/7.4.0rc1)
 
-
 Build from source
 -----------------
 
@@ -40,31 +39,31 @@ Conda packages are provided for python 3.6 and 3.7.
 Other pythonocc related resources
 ---------------------------------
 
-* Demos: python examples, as well as jupyter notebooks https://github.com/tpaviot/pythonocc-demos
+*   Demos: python examples, as well as jupyter notebooks <https://github.com/tpaviot/pythonocc-demos>
 
-* Docker, binderhub: docker and online jupyter notebooks https://github.com/tpaviot/pythonocc-binderhub
+*   Docker, binderhub: docker and online jupyter notebooks <https://github.com/tpaviot/pythonocc-binderhub>
 
-* Documentation: https://github.com/tpaviot/pythonocc-documentation
+*   Documentation: <https://github.com/tpaviot/pythonocc-documentation>
 
 Online resources for development
 --------------------------------
 
 We use the following online resources:
 
-* Homepage: http://www.pythonocc.org
+*   Homepage: <http://www.pythonocc.org>
 
-* Mailing list: http://groups.google.com/group/pythonocc
+*   Mailing list: <http://groups.google.com/group/pythonocc>
 
-* Twitter : https://twitter.com/pythonocc
+*   Twitter : <https://twitter.com/pythonocc>
 
-* LGTM code quality review: https://lgtm.com/projects/g/tpaviot/honocc-core/
+*   LGTM code quality review: <https://lgtm.com/projects/g/tpaviot/honocc-core/>
 
-* Codacy quality checker: https://app.codacy.com/app/tpaviot/pythonocc-core
+*   Codacy quality checker: <https://app.codacy.com/app/tpaviot/pythonocc-core>
 
 pythonocc, oce and opencascade dependencies
 -------------------------------------------
 
-From release 7.4.0, pythonocc-core depends on the official OpenCascade-7.4.0 library (https://dev.opencascade.org)
+From release 7.4.0, pythonocc-core depends on the official OpenCascade-7.4.0 library (<https://dev.opencascade.org>)
 
 Former releases rely on oce (OpenCascade Community Edition), available at  
 [oce C++ library / CAD kernel](https://github.com/tpaviot/oce).

ci/conda/build.sh

@@ -24,8 +24,8 @@ ninja
 ninja install
 
 # fix rpaths
-if [ `uname` == Darwin ]; then
-    for lib in `ls $SP_DIR/OCC/_*.so`; do
+if [ $(uname) == Darwin ]; then
+    for lib in $(ls $SP_DIR/OCC/_*.so); do
       install_name_tool -rpath $PREFIX/lib @loader_path/../../../ $lib
     done
 fi

src/Addons/Font3d.cpp

@@ -26,8 +26,6 @@ TopoDS_Shape text_to_brep(const char* aText,
                           bool anIsCompositeCurve)
 {
 
-  Standard_Integer anArgIt = 1;
-
   Font_BRepFont           aFont;
   TCollection_AsciiString aFontName (aName);
   gp_Ax3                  aPenAx3    (gp::XOY());

src/Extend/DataExchange.py

@@ -38,8 +38,8 @@
 from OCC.Core.TopLoc import TopLoc_Location
 from OCC.Core.BRepBuilderAPI import BRepBuilderAPI_Transform
 
-from OCC.Extend.TopologyUtils import (TopologyExplorer, discretize_edge,
-                                      get_sorted_hlr_edges, list_of_shapes_to_compound)
+from OCC.Extend.TopologyUtils import (discretize_edge, get_sorted_hlr_edges,
+                                      list_of_shapes_to_compound)
 
 try:
     import svgwrite
@@ -74,9 +74,9 @@ def read_step_file(filename, as_compound=True, verbosity=True):
         _nbs = step_reader.NbShapes()
         if _nbs == 0:
             raise AssertionError("No shape to transfer.")
-        if _nbs == 1:  # most cases
+        elif _nbs == 1:  # most cases
             return step_reader.Shape(1)
-        elif _nbs > 1 :
+        elif _nbs > 1:
             print("Number of shapes:", _nbs)
             shps = []
             # loop over root shapes
@@ -94,6 +94,7 @@ def read_step_file(filename, as_compound=True, verbosity=True):
                 return shps
     else:
         raise AssertionError("Error: can't read file.")
+    return None
 
 
 def write_step_file(a_shape, filename, application_protocol="AP203"):
@@ -256,7 +257,7 @@ def _get_sub_shapes(lab, loc):
                 if (color_tool.GetColor(lab, 0, c) or
                         color_tool.GetColor(lab, 1, c) or
                         color_tool.GetColor(lab, 2, c)):
-                    
+
                     color_tool.SetInstanceColor(shape, 0, c)
                     color_tool.SetInstanceColor(shape, 1, c)
                     color_tool.SetInstanceColor(shape, 2, c)
@@ -392,7 +393,7 @@ def read_iges_file(filename, return_as_shapes=False, verbosity=False, visible_on
             iges_reader.PrintCheckTransfer(failsonly, IFSelect_ItemsByEntity)
         iges_reader.TransferRoots()
         nbr = iges_reader.NbRootsForTransfer()
-        for n in range(1, nbr+1):
+        for _ in range(1, nbr+1):
             nbs = iges_reader.NbShapes()
             if nbs == 0:
                 print("At least one shape in IGES cannot be transfered")
@@ -450,9 +451,9 @@ def edge_to_svg_polyline(topods_edge, tol=0.1, unit="mm"):
     """
     unit_factor = 1  # by default
 
-    if unit=="mm":
+    if unit == "mm":
         unit_factor = 1
-    elif unit=="m":
+    elif unit == "m":
         unit_factor = 1e3
 
     points_3d = discretize_edge(topods_edge, tol)
@@ -465,7 +466,7 @@ def edge_to_svg_polyline(topods_edge, tol=0.1, unit="mm"):
         y_p = point[1] * unit_factor
         box2d.Add(gp_Pnt2d(x_p, y_p))
         points_2d.append((x_p, y_p))
-    
+
     return svgwrite.shapes.Polyline(points_2d, fill="none"), box2d
 
 def export_shape_to_svg(shape, filename=None,
@@ -543,34 +544,3 @@ def export_shape_to_svg(shape, filename=None,
         print("Shape successfully exported to %s" % filename)
         return True
     return dwg.tostring()
-
-
-if __name__ == "__main__":
-    from OCC.Core.BRepPrimAPI import BRepPrimAPI_MakeSphere, BRepPrimAPI_MakeBox
-    sphere_shape = BRepPrimAPI_MakeSphere(30.).Shape()
-    write_step_file(sphere_shape, "s_203.stp", application_protocol="AP203")
-    write_step_file(sphere_shape, "s_214.stp", application_protocol="AP214IS")
-    read_step_file("s_203.stp")
-    read_step_file("s_214.stp")
-    read_step_file("s_214.stp", return_as_shapes=True)
-    write_stl_file(sphere_shape, "s_stl_ascii.stl")
-    write_stl_file(sphere_shape, "s_stl_binary.stl", mode="binary")
-    read_stl_file("s_stl_ascii.stl")
-    read_stl_file("s_stl_binary.stl")
-    # improve the precision by a factor 2
-    write_stl_file(sphere_shape, "s_stl_precise_ascii.stl", linear_deflection=0.1, angular_deflection=0.2)
-    read_stl_file("s_stl_precise_ascii.stl")
-    # iges test
-    write_iges_file(sphere_shape, "s_iges.igs")
-    # write IGES with special character
-    write_iges_file(sphere_shape, "sphère.igs")
-    read_iges_file("sphère.igs")
-    read_iges_file("s_iges.igs")
-    read_iges_file("s_iges.igs", return_as_shapes=True)
-    # test step with colors
-    read_step_file_with_names_colors("s_214.stp")
-    # create a box
-    box_shp = BRepPrimAPI_MakeBox(10, 50, 300).Shape()
-    get_sorted_hlr_edges(box_shp)
-    export_shape_to_svg(box_shp, filename="box.svg", width="297mm", height="210mm",
-                        export_hidden_edges=False)

src/Extend/TopologyUtils.py

@@ -43,7 +43,8 @@ class WireExplorer:
     Wire traversal
     '''
     def __init__(self, wire):
-        assert isinstance(wire, TopoDS_Wire), 'not a TopoDS_Wire'
+        if not isinstance(wire, TopoDS_Wire):
+            raise AsssertionError('not a TopoDS_Wire')
         self.wire = wire
         self.wire_explorer = BRepTools_WireExplorer(self.wire)
         self.done = False
@@ -148,7 +149,8 @@ def _loop_topo(self, topologyType, topologicalEntity=None, topologyTypeToAvoid=N
                      TopAbs_COMPOUND: TopoDS_Compound,
                      TopAbs_COMPSOLID: TopoDS_CompSolid}
 
-        assert topologyType in topoTypes.keys(), '%s not one of %s' % (topologyType, topoTypes.keys())
+        if topologyType not in topoTypes.keys():
+            raise AssertionError("%s not one of %s" % (topologyType, topoTypes.keys()))
         # use self.myShape if nothing is specified
         if topologicalEntity is None and topologyTypeToAvoid is None:
             self.topExp.Init(self.myShape, topologyType)
@@ -191,7 +193,7 @@ def faces(self):
 
     def _number_of_topo(self, iterable):
         n = 0
-        for i in iterable:
+        for _ in iterable:
             n += 1
         return n
 
@@ -366,7 +368,7 @@ def edges_from_face(self, face):
 
     def number_of_edges_from_face(self, face):
         cnt = 0
-        for i in self._loop_topo(TopAbs_EDGE, face):
+        for _ in self._loop_topo(TopAbs_EDGE, face):
             cnt += 1
         return cnt
 

test/core_extend_topology_unittest.py

@@ -118,20 +118,9 @@ def test_edge_wire(self):
 
 
     def test_vertex_edge(self):
-        vert = next(topo.vertices())
         edge = next(topo.edges())
         verts_from_edge = [i for i in topo.vertices_from_edge(edge)]
         self.assertEqual(len(verts_from_edge), topo.number_of_vertices_from_edge(edge))
-        # following test is commented out. Moving up to occt7.4.0
-        # introduced a regression in this test:
-        #Traceback (most recent call last):
-        #File "core_extend_topology_unittest.py", line 126, in test_vertex_edge
-        #self.assertEqual(len(edges_from_vert), topo.number_of_edges_from_vertex(vert))
-        #AssertionError: 3 != 6
-        # not sure this is really ap pythonocc bug
-        # commented out for now, let's see later if the issue comes up
-        edges_from_vert = [i for i in topo.edges_from_vertex(vert)]
-        #self.assertEqual(len(edges_from_vert), topo.number_of_edges_from_vertex(vert))
 
 
     def test_vertex_face(self):

test/core_geometry_unittest.py

@@ -17,8 +17,6 @@
 ##You should have received a copy of the GNU Lesser General Public License
 ##along with pythonOCC.  If not, see <http://www.gnu.org/licenses/>.
 
-from __future__ import print_function
-
 import unittest
 
 from OCC.Core.gp import (gp_Pnt, gp_Pnt2d, gp_Ax3, gp_Vec, gp_Pln,
@@ -184,6 +182,7 @@ def test_point_from_projections(self):
                 Q = PPS.Point(i)
                 distance = PPS.Distance(i)
                 pstring = "Q" + repr(i) + ": at Distance :" + repr(PPS.Distance(i))
+                print(pstring)
 
     def test_points_from_intersection(self):
         '''Test: points from intersection'''
@@ -237,7 +236,7 @@ def test_axis(self):
         AXDirection = A.XDirection()
         self.assertIsInstance(AXDirection, gp_Dir)
         AYDirection = A.YDirection()
-        self.assertIsInstance(AXDirection, gp_Dir)
+        self.assertIsInstance(AYDirection, gp_Dir)
         P2 = gp_Pnt(5, 3, 4)
         A2 = gp_Ax3(P2, D)
         A2.YReverse()