maintain the option for users to use string representations of paths

Author: greyltc

cadquery/assembly.py

@@ -48,7 +48,6 @@
 
 PATH_DELIM = "/"
 
-
 # entity selector grammar definition
 def _define_grammar():
 
@@ -509,7 +508,7 @@ def solve(self, verbosity: int = 0) -> Self:
     @deprecate()
     def save(
         self,
-        path: Path,
+        path: Path | str,
         exportType: Optional[ExportLiterals] = None,
         mode: STEPExportModeLiterals = "default",
         tolerance: float = 0.1,
@@ -530,13 +529,16 @@ def save(
         :type ascii: bool
         """
 
+        if isinstance(path, str):
+            path = Path(path)
+
         return self.export(
             path, exportType, mode, tolerance, angularTolerance, **kwargs
         )
 
     def export(
         self,
-        path: Path,
+        path: Path | str,
         exportType: Optional[ExportLiterals] = None,
         mode: STEPExportModeLiterals = "default",
         tolerance: float = 0.1,
@@ -557,6 +559,9 @@ def export(
         :type ascii: bool
         """
 
+        if isinstance(path, str):
+            path = Path(path)
+
         # Make sure the export mode setting is correct
         if mode not in get_args(STEPExportModeLiterals):
             raise ValueError(f"Unknown assembly export mode {mode} for STEP")
@@ -593,22 +598,30 @@ def export(
         return self
 
     @classmethod
-    def importStep(cls, path: Path) -> Self:
+    def importStep(cls, path: Path | str) -> Self:
         """
         Reads an assembly from a STEP file.
 
         :param path: Path and filename for reading.
         :return: An Assembly object.
         """
 
+        if isinstance(path, str):
+            path = Path(path)
+
         return cls.load(path, importType="STEP")
 
     @classmethod
-    def load(cls, path: Path, importType: Optional[ImportLiterals] = None,) -> Self:
+    def load(
+        cls, path: Path | str, importType: Optional[ImportLiterals] = None,
+    ) -> Self:
         """
         Load step, xbf or xml.
         """
 
+        if isinstance(path, str):
+            path = Path(path)
+
         if importType is None:
             t = path.suffix.upper().lstrip(".")
             if t in ("STEP", "XML", "XBF"):

cadquery/cq.py

@@ -4305,7 +4305,7 @@ def text(
         combine: CombineMode = False,
         clean: bool = True,
         font: str = "Arial",
-        fontPath: Optional[str] = None,
+        fontPath: Optional[Path | str] = None,
         kind: Literal["regular", "bold", "italic"] = "regular",
         halign: Literal["center", "left", "right"] = "center",
         valign: Literal["center", "top", "bottom"] = "center",
@@ -4353,6 +4353,10 @@ def text(
             cq.Workplane().box(8, 8, 8).faces(">Z").workplane().text("Z", 5, -1.0)
 
         """
+
+        if isinstance(fontPath, str):
+            fontPath = Path(fontPath)
+
         r = Compound.makeText(
             txt,
             fontsize,
@@ -4583,7 +4587,7 @@ def invoke(
 
     def export(
         self: T,
-        fname: Path,
+        fname: Path | str,
         tolerance: float = 0.1,
         angularTolerance: float = 0.1,
         opt: Optional[Dict[str, Any]] = None,
@@ -4598,6 +4602,9 @@ def export(
         :return: Self.
         """
 
+        if isinstance(fname, str):
+            fname = Path(fname)
+
         export(
             self, fname, tolerance=tolerance, angularTolerance=angularTolerance, opt=opt
         )

cadquery/occ_impl/exporters/__init__.py

@@ -40,7 +40,7 @@ class ExportTypes:
 
 def export(
     w: Union[Shape, Iterable[Shape]],
-    fname: Path,
+    fname: Path | str,
     exportType: Optional[ExportLiterals] = None,
     tolerance: float = 0.1,
     angularTolerance: float = 0.1,
@@ -57,6 +57,9 @@ def export(
     :param opt: additional options passed to the specific exporter. Default None.
     """
 
+    if isinstance(fname, str):
+        fname = Path(fname)
+
     shape: Shape
     f: IO
 
@@ -200,14 +203,15 @@ def tessellate(shape, angularTolerance):
         # 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()
+        outFileName = Path(outFileName)  # type: ignore
         # 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(Path(outFileName))
+            shape.exportStep(outFileName)
         elif exportType == ExportTypes.STL:
-            shape.exportStl(Path(outFileName), tolerance, angularTolerance, True)
+            shape.exportStl(outFileName, tolerance, angularTolerance, True)
         else:
             raise ValueError("No idea how i got here")
 
@@ -216,7 +220,7 @@ def tessellate(shape, angularTolerance):
 
 
 @deprecate()
-def readAndDeleteFile(fileName):
+def readAndDeleteFile(fileName: Path):
     """
     Read data from file provided, and delete it when done
     return the contents as a string
@@ -225,5 +229,5 @@ def readAndDeleteFile(fileName):
     with open(fileName, "r") as f:
         res = "{}".format(f.read())
 
-    os.remove(fileName)
+    fileName.unlink()
     return res

cadquery/occ_impl/exporters/assembly.py

@@ -50,7 +50,7 @@ class ExportModes:
 
 def exportAssembly(
     assy: AssemblyProtocol,
-    path: Path,
+    path: Path | str,
     mode: STEPExportModeLiterals = "default",
     **kwargs,
 ) -> bool:
@@ -78,6 +78,9 @@ def exportAssembly(
     :type precision_mode: int
     """
 
+    if isinstance(path, str):
+        path = Path(path)
+
     # Handle the extra settings for the STEP export
     pcurves = 1
     if "write_pcurves" in kwargs and not kwargs["write_pcurves"]:
@@ -109,7 +112,7 @@ def exportAssembly(
 
 def exportStepMeta(
     assy: AssemblyProtocol,
-    path: Path,
+    path: Path | str,
     write_pcurves: bool = True,
     precision_mode: int = 0,
 ) -> bool:
@@ -129,6 +132,9 @@ def exportStepMeta(
         See OCCT documentation.
     """
 
+    if isinstance(path, str):
+        path = Path(path)
+
     pcurves = 1
     if not write_pcurves:
         pcurves = 0
@@ -275,11 +281,14 @@ def _process_assembly(
     return status == IFSelect_ReturnStatus.IFSelect_RetDone
 
 
-def exportCAF(assy: AssemblyProtocol, path: Path, binary: bool = False) -> bool:
+def exportCAF(assy: AssemblyProtocol, path: Path | str, binary: bool = False) -> bool:
     """
     Export an assembly to an XCAF xml or xbf file (internal OCCT formats).
     """
 
+    if isinstance(path, str):
+        path = Path(path)
+
     folder = path.parent
     fname = path.name
     name = path.stem
@@ -338,11 +347,14 @@ def _vtkRenderWindow(
     return renderWindow
 
 
-def exportVTKJS(assy: AssemblyProtocol, path: Path):
+def exportVTKJS(assy: AssemblyProtocol, path: Path | str):
     """
     Export an assembly to a zipped vtkjs. NB: .zip extensions is added to path.
     """
 
+    if isinstance(path, str):
+        path = Path(path)
+
     renderWindow = _vtkRenderWindow(assy)
 
     with TemporaryDirectory() as tmpdir:
@@ -356,14 +368,17 @@ def exportVTKJS(assy: AssemblyProtocol, path: Path):
 
 def exportVRML(
     assy: AssemblyProtocol,
-    path: Path,
+    path: Path | str,
     tolerance: float = 1e-3,
     angularTolerance: float = 0.1,
 ):
     """
     Export an assembly to a vrml file using vtk.
     """
 
+    if isinstance(path, str):
+        path = Path(path)
+
     exporter = vtkVRMLExporter()
     exporter.SetFileName(str(path))
     exporter.SetRenderWindow(_vtkRenderWindow(assy, tolerance, angularTolerance))
@@ -372,7 +387,7 @@ def exportVRML(
 
 def exportGLTF(
     assy: AssemblyProtocol,
-    path: Path,
+    path: Path | str,
     binary: Optional[bool] = None,
     tolerance: float = 1e-3,
     angularTolerance: float = 0.1,
@@ -381,6 +396,9 @@ def exportGLTF(
     Export an assembly to a gltf file.
     """
 
+    if isinstance(path, str):
+        path = Path(path)
+
     # If the caller specified the binary option, respect it
     if binary is None:
         # Handle the binary option for GLTF export based on file extension

cadquery/occ_impl/exporters/dxf.py

@@ -367,7 +367,7 @@ def _dxf_spline(cls, edge: Edge, plane: Plane) -> DxfEntityAttributes:
 
 def exportDXF(
     w: Union[WorkplaneLike, Shape, Iterable[Shape]],
-    fname: Path,
+    fname: Path | str,
     approx: Optional[ApproxOptions] = None,
     tolerance: float = 1e-3,
     *,
@@ -385,6 +385,9 @@ def exportDXF(
     :param doc_units: ezdxf document/modelspace :doc:`units <ezdxf-stable:concepts/units>` (in. = ``1``, mm = ``4``).
     """
 
+    if isinstance(fname, str):
+        fname = Path(fname)
+
     dxf = DxfDocument(approx=approx, tolerance=tolerance, doc_units=doc_units)
 
     if isinstance(w, (WorkplaneLike, Shape)):

cadquery/occ_impl/exporters/threemf.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from os import PathLike
+from pathlib import Path
 import xml.etree.cElementTree as ET
 from typing import IO, List, Literal, Tuple, Union
 from zipfile import ZipFile, ZIP_DEFLATED, ZIP_STORED
@@ -46,7 +46,7 @@ def __init__(
         self.tessellations = [t for t in tessellations if all(t)]
 
     def write3mf(
-        self, outfile: Union[PathLike, str, IO[bytes]],
+        self, outfile: Union[Path, str, IO[bytes]],
     ):
         """
         Write to the given file.

cadquery/occ_impl/exporters/vtk.py

@@ -4,8 +4,13 @@
 
 
 def exportVTP(
-    shape: Shape, fname: Path, tolerance: float = 0.1, angularTolerance: float = 0.1
+    shape: Shape,
+    fname: Path | str,
+    tolerance: float = 0.1,
+    angularTolerance: float = 0.1,
 ):
+    if isinstance(fname, str):
+        fname = Path(fname)
 
     writer = vtkXMLPolyDataWriter()
     writer.SetFileName(str(fname))