use Path from pathlib everywhere. drop path dep #1909

greyltc · 2025-10-07T14:41:37Z

No description provided.

codecov · 2025-10-07T18:29:31Z

Codecov Report

❌ Patch coverage is 68.38235% with 43 lines in your changes missing coverage. Please review.
✅ Project coverage is 95.28%. Comparing base (18b15d6) to head (c9c3f67).
⚠️ Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
cadquery/occ_impl/exporters/assembly.py	57.14%	6 Missing and 6 partials ⚠️
cadquery/occ_impl/shapes.py	66.66%	6 Missing and 5 partials ⚠️
cadquery/occ_impl/importers/__init__.py	46.66%	4 Missing and 4 partials ⚠️
cadquery/occ_impl/importers/assembly.py	60.00%	3 Missing and 3 partials ⚠️
cadquery/assembly.py	71.42%	2 Missing and 2 partials ⚠️
cadquery/occ_impl/exporters/vtk.py	50.00%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1909      +/-   ##
==========================================
- Coverage   95.74%   95.28%   -0.47%     
==========================================
  Files          29       29              
  Lines        7827     7911      +84     
  Branches     1179     1214      +35     
==========================================
+ Hits         7494     7538      +44     
- Misses        192      212      +20     
- Partials      141      161      +20

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

jmwright · 2025-10-08T11:02:17Z

tests/test_exporters.py

        self._exportBox(exporters.ExportTypes.SVG, ["<svg", "<g transform"])

-        exporters.export(self._box(), "out.svg")
+        exporters.export(self._box(), Path("out.svg"))


@greyltc Will users have to import pathlib in their scripts now to be able to use exporters.export? If so, that will break existing user-facing behavior.

Yes! This change means that everything that points to a place on disk goes through pathlib.Path, no more strings for that.

Luckily pathlib is built in (in python's standard library) though.

If there are some API/user facing functions you'd like me to switch back to taking string inputs for file locations, let me know and I can switch them back.

Hey, all path arguments shall be strings. So this change cannot change any interface. +1 getting rid of the external dep.

all path arguments shall be strings

Where?

Of course the calls to the underlying opencascade library need to be strings (otherwise none of the tests in this PR would have passed). But is your statement here meant to mandate that the paths in the python code be strings everywhere as well?

Before this PR: some of the python path objects were str, some were pathlib.Path and some were path.Path.

After this PR: every path object is pathlib.Path, except for right as they get passed to the OCP lib calls, they get converted to str, just for those calls.

I mean: the current API shall not change (i.e. not change to function/method signatures). What happens in the function/method bodies is a different story of course.

Ok. So those 6 functions listed here (plus Assembly.save) are the ones that need to remain as path string input objects, correct?

Would it be alright if I change them so they can take both str and pathlib.Path path object type inputs?

I think more (Shape.exportStep, ....), essentially I expect no (backward incompatible) signature change from this pr.

Sure, you could annotate it as Path | str

adam-urbanczyk · 2025-10-21T05:35:18Z

cadquery/assembly.py

+        if isinstance(path, str):
+            path = Path(path)


Suggested change

if isinstance(path, str):

path = Path(path)

path = Path(path)

or

Suggested change

if isinstance(path, str):

path = Path(path)

path = Path(path) if isinstance(path, str) else path

adam-urbanczyk · 2025-10-21T05:36:16Z

cadquery/assembly.py

        if self.obj:
-            yield self.obj if isinstance(self.obj, Shape) else Compound.makeCompound(
-                s for s in self.obj.vals() if isinstance(s, Shape)
+            yield (


Why is this changed?

adam-urbanczyk · 2025-10-21T05:37:44Z

cadquery/occ_impl/exporters/__init__.py


 @deprecate()
-def readAndDeleteFile(fileName):
+def readAndDeleteFile(fileName: Path):


Is this really needed? No changes to legacy functions please.

adam-urbanczyk · 2025-10-21T05:38:09Z

cadquery/occ_impl/exporters/assembly.py

-                if isinstance(child.obj, Shape)
-                else Compound.makeCompound(
-                    s for s in child.obj.vals() if isinstance(s, Shape)
+                (


Again, why is this changed?

adam-urbanczyk · 2025-10-21T05:40:23Z

cadquery/occ_impl/exporters/threemf.py


    def write3mf(
-        self, outfile: Union[PathLike, str, IO[bytes]],
+        self, outfile: Union[Path, str, IO[bytes]],


Looking at this, shouldn't everything be typed as PathLike | str?

adam-urbanczyk · 2025-10-21T05:43:13Z

tests/test_cadquery.py

        # verify that the number of solids is correct
        self.assertEqual(len(obj4.solids().vals()), 5)

+        obj4point5 = (


I assume that you are smoke testing something here. Maybe add a comment

adam-urbanczyk · 2025-10-21T05:43:55Z

tests/test_free_functions.py

 # %% export
 def test_export():

+    filename = Path("box.brep")


This is unnecessary

adam-urbanczyk · 2025-10-21T05:45:37Z

tests/test_vis.py

    # smoke test for now
-    with tmpdir:
-        show(wp, interact=False, screenshot="img.png", trihedron=False, gradient=False)
+    filename = tmpdir / "img.png"


Please revert the change. AFAIK pathlib supports with

greyltc force-pushed the use-pathlib branch 4 times, most recently from 7a0b6cc to 3bc82aa Compare October 7, 2025 18:42

jmwright reviewed Oct 8, 2025

View reviewed changes

use Path from pathlib everywhere. drop path dep

36eafbc

greyltc force-pushed the use-pathlib branch 5 times, most recently from 1ca0aba to 80476cb Compare October 12, 2025 18:40

maintain the option for users to use string representations of paths

c9c3f67

greyltc force-pushed the use-pathlib branch from 80476cb to c9c3f67 Compare October 12, 2025 19:03

adam-urbanczyk reviewed Oct 21, 2025

View reviewed changes

	if isinstance(path, str):
	path = Path(path)
	path = Path(path) if isinstance(path, str) else path

use Path from pathlib everywhere. drop path dep #1909

Are you sure you want to change the base?

use Path from pathlib everywhere. drop path dep #1909

Uh oh!

Conversation

greyltc commented Oct 7, 2025

Uh oh!

codecov bot commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

greyltc Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

greyltc Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

greyltc Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Oct 7, 2025 •

edited

Loading

greyltc Oct 8, 2025 •

edited

Loading

greyltc Oct 8, 2025 •

edited

Loading

greyltc Oct 8, 2025 •

edited

Loading