Merge pull request #4696 from Repiteo/pathlike

Allow parsing Nodes as `PathLike`

Author: bdbaddog

CHANGES.txt

@@ -34,6 +34,9 @@ RELEASE 4.9.1 -  Thu, 27 Mar 2025 11:40:20 -0700
     - Fixed a hang in `wait_for_process_to_die()` on Windows, affecting
       clean-up of the SCons daemon used for Ninja builds.
 
+  From Thaddeus Crews:
+    - Nodes are now treated as PathLike objects.
+
   From Mats Wichmann:
     - Fix typos in CCFLAGS test. Didn't affect the test itself, but
       didn't correctly apply the DefaultEnvironment speedup.

RELEASE.txt

@@ -29,6 +29,8 @@ CHANGED/ENHANCED EXISTING FUNCTIONALITY
 - List modifications to existing features, where the previous behavior
   wouldn't actually be considered a bug
 
+- Nodes are now treated as PathLike objects.
+
 FIXES
 -----
 

SCons/Builder.py

@@ -114,6 +114,7 @@
 from SCons.Debug import logInstanceCreation
 from SCons.Errors import InternalError, UserError
 from SCons.Executor import Executor
+from SCons.Node import Node
 
 class _Null:
     pass
@@ -487,10 +488,11 @@ def _adjustixes(self, files, pre, suf, ensure_suffix: bool=False):
             # fspath() is to catch PathLike paths. We avoid the simpler
             # str(f) so as not to "lose" files that are already Nodes:
             # TypeError: expected str, bytes or os.PathLike object, not File
-            with suppress(TypeError):
-                f = os.fspath(f)
-            if SCons.Util.is_String(f):
-                f = SCons.Util.adjustixes(f, pre, suf, ensure_suffix)
+            if not isinstance(f, Node):
+                with suppress(TypeError):
+                    f = os.fspath(f)
+                if SCons.Util.is_String(f):
+                    f = SCons.Util.adjustixes(f, pre, suf, ensure_suffix)
             result.append(f)
         return result
 

SCons/BuilderTests.py

@@ -702,7 +702,7 @@ def test_single_source(self) -> None:
         """Test Builder with single_source flag set"""
         def func(target, source, env) -> None:
             """create the file"""
-            with open(str(target[0]), "w"):
+            with open(target[0], "w"):
                 pass
             if len(source) == 1 and len(target) == 1:
                 env['CNT'][0] = env['CNT'][0] + 1
@@ -759,7 +759,7 @@ def test_lists(self) -> None:
         """Testing handling lists of targets and source"""
         def function2(target, source, env, tlist = [outfile, outfile2], **kw) -> int:
             for t in target:
-                with open(str(t), 'w') as f:
+                with open(t, 'w') as f:
                     f.write("function2\n")
             for t in tlist:
                 if t not in list(map(str, target)):
@@ -790,7 +790,7 @@ def function2(target, source, env, tlist = [outfile, outfile2], **kw) -> int:
 
         def function3(target, source, env, tlist = [sub1_out, sub2_out]) -> int:
             for t in target:
-                with open(str(t), 'w') as f:
+                with open(t, 'w') as f:
                     f.write("function3\n")
             for t in tlist:
                 if t not in list(map(str, target)):

SCons/Environment.xml

@@ -1248,7 +1248,7 @@ env.Command(
 
 import os
 def rename(env, target, source):
-    os.rename('.tmp', str(target[0]))
+    os.rename('.tmp', target[0])
 
 
 env.Command(
@@ -3626,7 +3626,7 @@ def create(target, source, env):
 
     Writes 'prefix=$SOURCE' into the file name given as $TARGET.
     """
-    with open(str(target[0]), 'wb') as f:
+    with open(target[0], 'wb') as f:
         f.write(b'prefix=' + source[0].get_contents() + b'\n')
 
 # Fetch the prefix= argument, if any, from the command line.

SCons/Node/__init__.py

@@ -622,6 +622,9 @@ def __init__(self) -> None:
         # what line in what file created the node, for example).
         Annotate(self)
 
+    def __fspath__(self) -> str:
+        return str(self)
+
     def disambiguate(self, must_exist: bool = False):
         return self
 

SCons/SConfTests.py

@@ -295,7 +295,7 @@ def test_TryAction(self) -> None:
         """Test SConf.TryAction
         """
         def actionOK(target, source, env):
-            with open(str(target[0]), "w") as f:
+            with open(target[0], "w") as f:
                 f.write("RUN OK\n")
             return None
         def actionFAIL(target, source, env) -> int:

bin/SConsExamples.py

@@ -547,7 +547,7 @@ def process(source_file, ofp):
                 elif line[:11] != "STRIP CCCOM":
                     ofp.write(line)
 
-    with open(str(target[0]), "w") as fp:
+    with open(target[0], "w") as fp:
         for src in map(str, source):
             process(src, fp)
             fp.write('debug = ' + ARGUMENTS.get('debug', '0') + '\\n')

test/Actions/append.py

@@ -45,13 +45,13 @@
 env=Environment()
 
 def before(env, target, source):
-    with open(str(target[0]), "wb") as f:
+    with open(target[0], "wb") as f:
         f.write(b"Foo\\n")
     with open("before.txt", "wb") as f:
         f.write(b"Bar\\n")
 
 def after(env, target, source):
-    with open(str(target[0]), "rb") as fin, open("after%s", "wb") as fout:
+    with open(target[0], "rb") as fin, open("after%s", "wb") as fout:
         fout.write(fin.read())
 
 env.Prepend(LINKCOM=Action(before))

test/Actions/exitstatfunc.py

@@ -38,7 +38,7 @@ def always_succeed(s):
     return 0
 
 def copy_fail(target, source, env):
-    with open(str(source[0]), 'rb') as infp, open(str(target[0]), 'wb') as f:
+    with open(source[0], 'rb') as infp, open(target[0], 'wb') as f:
         f.write(infp.read())
     return 2