Remove deprecated functions (#1972)

* Use tmpdir for all test_exporters.py tests

* Remove deprecated export functions

* Remove Workplane combineSolids

* Remove Workplane findFace

* Remove Workplane text() deprecated 'cut' parameter

* Remove deprecated Solid.interpPlate

* Fix typo Workplane __truediv__ docstring

Author: lorenzncode

cadquery/cq.py

@@ -342,46 +342,6 @@ def split(self: T, *args, **kwargs) -> T:
 
         return self.newObject(rv)
 
-    @deprecate()
-    def combineSolids(
-        self, otherCQToCombine: Optional["Workplane"] = None
-    ) -> "Workplane":
-        """
-        !!!DEPRECATED!!! use union()
-        Combines all solids on the current stack, and any context object, together
-        into a single object.
-
-        After the operation, the returned solid is also the context solid.
-
-        :param otherCQToCombine: another CadQuery to combine.
-        :return: a CQ object with the resulting combined solid on the stack.
-
-        Most of the time, both objects will contain a single solid, which is
-        combined and returned on the stack of the new object.
-        """
-        # loop through current stack objects, and combine them
-        toCombine = cast(List[Solid], self.solids().vals())
-
-        if otherCQToCombine:
-            otherSolids = cast(List[Solid], otherCQToCombine.solids().vals())
-            for obj in otherSolids:
-                toCombine.append(obj)
-
-        if len(toCombine) < 1:
-            raise ValueError("Cannot Combine: at least one solid required!")
-
-        # get context solid and we don't want to find our own objects
-        ctxSolid = self._findType((Solid,), searchStack=False, searchParents=True)
-        if ctxSolid is None:
-            ctxSolid = toCombine.pop(0)
-
-        # now combine them all. make sure to save a reference to the ctxSolid pointer!
-        s: Shape = ctxSolid
-        if toCombine:
-            s = s.fuse(*_selectShapes(toCombine))
-
-        return self.newObject([s])
-
     def all(self: T) -> List[T]:
         """
         Return a list of all CQ objects on the stack.
@@ -789,25 +749,6 @@ def findSolid(
 
         return found
 
-    @deprecate()
-    def findFace(self, searchStack: bool = True, searchParents: bool = True) -> Face:
-        """
-        Finds the first face object in the chain, searching from the current node
-        backwards through parents until one is found.
-
-        :param searchStack: should objects on the stack be searched first.
-        :param searchParents: should parents be searched?
-        :returns: A face or None if no face is found.
-        """
-
-        found = self._findType((Face,), searchStack, searchParents)
-
-        if found is None:
-            message = "on the stack or " if searchStack else ""
-            raise ValueError("Cannot find a face {}in the parent chain".format(message))
-
-        return found
-
     def _selectObjects(
         self: T,
         objType: Any,
@@ -3553,7 +3494,7 @@ def __mul__(self: T, other: Union["Workplane", Solid, Compound]) -> T:
 
     def __truediv__(self: T, other: Union["Workplane", Solid, Compound]) -> T:
         """
-        Syntactic sugar for intersect.
+        Syntactic sugar for split.
 
         Notice that :code:`r = a / b` is equivalent to :code:`r = a.split(b)`.
 
@@ -4294,14 +4235,12 @@ def clean(self: T) -> T:
 
         return self.newObject(cleanObjects)
 
-    @deprecate_kwarg_name("cut", "combine='cut'")
     def text(
         self: T,
         txt: str,
         fontsize: float,
         distance: float,
-        cut: bool = True,
-        combine: CombineMode = False,
+        combine: CombineMode = "cut",
         clean: bool = True,
         font: str = "Arial",
         fontPath: Optional[str] = None,
@@ -4316,7 +4255,6 @@ def text(
         :param fontsize: size of the font in model units
         :param distance: the distance to extrude or cut, normal to the workplane plane
         :type distance: float, negative means opposite the normal direction
-        :param cut: True to cut the resulting solid from the parent solids if found
         :param combine: True or "a" to combine the resulting solid with parent solids if found,
             "cut" or "s" to remove the resulting solid from the parent solids if found.
             False to keep the resulting solid separated from the parent solids.
@@ -4332,11 +4270,13 @@ def text(
         whether a context solid is already defined:
 
         *  if combine is False, the new value is pushed onto the stack.
-        *  if combine is true, the value is combined with the context solid if it exists,
+        *  if combine is True, "a", "cut" or "s", the value is combined with the context solid if it exists,
            and the resulting solid becomes the new context solid.
 
         Examples::
 
+        Create text::
+
             cq.Workplane().text("CadQuery", 5, 1)
 
         Specify the font (name), and kind to use an installed system font::
@@ -4347,10 +4287,15 @@ def text(
 
             cq.Workplane().text("CadQuery", 5, 1, fontPath="/opt/fonts/texgyrecursor-bold.otf")
 
-        Cutting text into a solid::
+        Cut text from a solid (default behavior when context solid exists and combine is not overridden)::
 
             cq.Workplane().box(8, 8, 8).faces(">Z").workplane().text("Z", 5, -1.0)
 
+        Add text to a solid::
+
+            cq.Workplane().box(8, 8, 8).faces(">Z").workplane().text("Z", 5, 1.0, combine="a")
+
+
         """
         r = Compound.makeText(
             txt,
@@ -4364,9 +4309,6 @@ def text(
             position=self.plane,
         )
 
-        if cut:
-            combine = "cut"
-
         return self._combineWithBase(r, combine, clean)
 
     def section(self: T, height: float = 0.0) -> T:

cadquery/occ_impl/exporters/__init__.py

@@ -134,96 +134,3 @@ def export(
 
     else:
         raise ValueError("Unknown export type")
-
-
-@deprecate()
-def toString(shape, exportType, tolerance=0.1, angularTolerance=0.05):
-    s = StringIO.StringIO()
-    exportShape(shape, exportType, s, tolerance, angularTolerance)
-    return s.getvalue()
-
-
-@deprecate()
-def exportShape(
-    w: Union[Shape, Iterable[Shape]],
-    exportType: ExportLiterals,
-    fileLike: IO,
-    tolerance: float = 0.1,
-    angularTolerance: float = 0.1,
-):
-    """
-    :param shape:  the shape to export. it can be a shape object, or a cadquery object. If a cadquery
-    object, the first value is exported
-    :param exportType: the exportFormat to use
-    :param fileLike: a file like object to which the content will be written.
-    The object should be already open and ready to write. The caller is responsible
-    for closing the object
-    :param tolerance: the linear tolerance, in model units. Default 0.1.
-    :param angularTolerance: the angular tolerance, in radians. Default 0.1.
-    """
-
-    def tessellate(shape, angularTolerance):
-
-        return shape.tessellate(tolerance, angularTolerance)
-
-    shape: Shape
-    if isinstance(w, Shape):
-        shape = w
-    else:
-        shape = compound(*w)
-
-    if exportType == ExportTypes.TJS:
-        tess = tessellate(shape, angularTolerance)
-        mesher = JsonMesh()
-
-        # add vertices
-        for v in tess[0]:
-            mesher.addVertex(v.x, v.y, v.z)
-
-        # add triangles
-        for t in tess[1]:
-            mesher.addTriangleFace(*t)
-
-        fileLike.write(mesher.toJson())
-
-    elif exportType == ExportTypes.SVG:
-        fileLike.write(getSVG(shape))
-    elif exportType == ExportTypes.AMF:
-        tess = tessellate(shape, angularTolerance)
-        aw = AmfWriter(tess)
-        aw.writeAmf(fileLike)
-    elif exportType == ExportTypes.THREEMF:
-        tmfw = ThreeMFWriter(shape, tolerance, angularTolerance)
-        tmfw.write3mf(fileLike)
-    else:
-
-        # all these types required writing to a file and then
-        # re-reading. this is due to the fact that FreeCAD writes these
-        (h, outFileName) = tempfile.mkstemp()
-        # weird, but we need to close this file. the next step is going to write to
-        # it from c code, so it needs to be closed.
-        os.close(h)
-
-        if exportType == ExportTypes.STEP:
-            shape.exportStep(outFileName)
-        elif exportType == ExportTypes.STL:
-            shape.exportStl(outFileName, tolerance, angularTolerance, True)
-        else:
-            raise ValueError("No idea how i got here")
-
-        res = readAndDeleteFile(outFileName)
-        fileLike.write(res)
-
-
-@deprecate()
-def readAndDeleteFile(fileName):
-    """
-    Read data from file provided, and delete it when done
-    return the contents as a string
-    """
-    res = ""
-    with open(fileName, "r") as f:
-        res = "{}".format(f.read())
-
-    os.remove(fileName)
-    return res

cadquery/occ_impl/shapes.py

@@ -3910,92 +3910,6 @@ class Solid(Shape, Mixin3D):
 
     wrapped: TopoDS_Solid
 
-    @classmethod
-    @deprecate()
-    def interpPlate(
-        cls,
-        surf_edges,
-        surf_pts,
-        thickness,
-        degree=3,
-        nbPtsOnCur=15,
-        nbIter=2,
-        anisotropy=False,
-        tol2d=0.00001,
-        tol3d=0.0001,
-        tolAng=0.01,
-        tolCurv=0.1,
-        maxDeg=8,
-        maxSegments=9,
-    ) -> Union["Solid", Face]:
-        """
-        Returns a plate surface that is 'thickness' thick, enclosed by 'surf_edge_pts' points, and going through 'surf_pts' points.
-
-        :param surf_edges:
-            list of [x,y,z] float ordered coordinates
-            or list of ordered or unordered wires
-        :param surf_pts: list of [x,y,z] float coordinates (uses only edges if [])
-        :param thickness: thickness may be negative or positive depending on direction, (returns 2D surface if 0)
-        :param degree: >=2
-        :param nbPtsOnCur: number of points on curve >= 15
-        :param nbIter: number of iterations >= 2
-        :param anisotropy: bool Anisotropy
-        :param tol2d: 2D tolerance >0
-        :param tol3d: 3D tolerance >0
-        :param tolAng: angular tolerance
-        :param tolCurv: tolerance for curvature >0
-        :param maxDeg: highest polynomial degree >= 2
-        :param maxSegments: greatest number of segments >= 2
-        """
-
-        # POINTS CONSTRAINTS: list of (x,y,z) points, optional.
-        pts_array = [gp_Pnt(*pt) for pt in surf_pts]
-
-        # EDGE CONSTRAINTS
-        # If a list of wires is provided, make a closed wire
-        if not isinstance(surf_edges, list):
-            surf_edges = [o.vals()[0] for o in surf_edges.all()]
-            surf_edges = Wire.assembleEdges(surf_edges)
-            w = surf_edges.wrapped
-
-        # If a list of (x,y,z) points provided, build closed polygon
-        if isinstance(surf_edges, list):
-            e_array = [Vector(*e) for e in surf_edges]
-            wire_builder = BRepBuilderAPI_MakePolygon()
-            for e in e_array:  # Create polygon from edges
-                wire_builder.Add(e.toPnt())
-            wire_builder.Close()
-            w = wire_builder.Wire()
-
-        edges = [i for i in Shape(w).Edges()]
-
-        # MAKE SURFACE
-        continuity = GeomAbs_C0  # Fixed, changing to anything else crashes.
-        face = Face.makeNSidedSurface(
-            edges,
-            pts_array,
-            continuity,
-            degree,
-            nbPtsOnCur,
-            nbIter,
-            anisotropy,
-            tol2d,
-            tol3d,
-            tolAng,
-            tolCurv,
-            maxDeg,
-            maxSegments,
-        )
-
-        # THICKEN SURFACE
-        if (
-            abs(thickness) > 0
-        ):  # abs() because negative values are allowed to set direction of thickening
-            return face.thicken(thickness)
-
-        else:  # Return 2D surface only
-            return face
-
     @staticmethod
     def isSolid(obj: Shape) -> bool:
         """

doc/extending.rst

@@ -161,14 +161,13 @@ Plugin Example
 
 This ultra simple plugin makes cubes of the specified size for each stack point.
 
-(The cubes are off-center because the boxes have their lower left corner at the reference points.)
-
 .. cadquery::
 
-        from cadquery.occ_impl.shapes import box
+        import cadquery as cq
+        from cadquery.func import box
 
         def makeCubes(self, length):
-            # self refers to the CQ or Workplane object
+            # self refers to the Workplane object
 
             # inner method that creates a cube
             def _singleCube(loc):
@@ -192,7 +191,7 @@ This ultra simple plugin makes cubes of the specified size for each stack point.
             .rect(4.0, 4.0, forConstruction=True)
             .vertices()
             .makeCubes(1.0)
-            .combineSolids()
+            .combine()
         )
 
 
@@ -214,7 +213,8 @@ Here is the same plugin rewritten using one of those methods.
 
 .. cadquery::
 
-        from cadquery.occ_impl.shapes import box
+        import cadquery as cq
+        from cadquery.func import box
 
         def makeCubes(length):
 
@@ -233,7 +233,7 @@ Here is the same plugin rewritten using one of those methods.
             .rect(4.0, 4.0, forConstruction=True)
             .vertices()
             .invoke(makeCubes(1.0))
-            .combineSolids()
+            .combine()
         )
 
 Such an approach is more friendly for auto-completion and static analysis tools.