feat: set the __file__ variable for scripts loaded from files

Author: justbuchanan

src/cq_cli/main.py

@@ -123,7 +123,11 @@ def get_script_from_infile(infile, outfile, errfile):
         script_str = infile
     else:
         with open(infile, "r") as file:
-            script_str = file.read()
+            # prepend an assignment for the __file__ variable so the model
+            # script knows its path and can potentially load resources relative
+            # to that path.
+            script_str = f"__file__ = '{os.path.abspath(infile)}'\n"
+            script_str += file.read()
 
     return script_str
 

tests/test_cli.py

@@ -544,3 +544,26 @@ def test_multiple_outfiles():
     ]
     out, err, exitcode = helpers.cli_call(command)
     assert exitcode == 0
+
+def test_file_variable_is_set():
+    """
+    Tests that cq-cli sets the __file__ variable for the model script.
+    """
+    test_file = helpers.get_test_file_location("file_var.py")
+
+    temp_dir = tempfile.gettempdir()
+    out_path = os.path.join(temp_dir, "temp_test_file_variable.stl")
+
+    command = [
+        "python",
+        "src/cq_cli/main.py",
+        "--codec",
+        "stl",
+        "--infile",
+        test_file,
+        "--outfile",
+        out_path,
+    ]
+    out, err, exitcode = helpers.cli_call(command)
+    assert exitcode == 0
+    assert("__file__=" in out.decode())

tests/testdata/file_var.py

@@ -0,0 +1,11 @@
+import cadquery as cq
+
+# print info about the __file__ variable to stdout so the test can check it
+if '__file__' in locals():
+    print(f"__file__={__file__}")
+else:
+    print("__FILE__ not set")
+
+# render a simple shape so the cq-cli invocation succeeds
+b = cq.Workplane("XY").rect(10, 10).extrude(10)
+show_object(b)