Move cast from Path to str into finder.find()

Pennycook · Pennycook · commit f7e6b024c986 · 2024-08-26T08:39:57.000+01:00
finder.find() expects a string for compatibility with legacy interfaces.
Performing the cast inside of the function is less error-prone, and will
mean fewer updates later when all of the strings are replaced with
Paths.

Signed-off-by: John Pennycook &lt;john.pennycook@intel.com&gt;
diff --git a/codebasin/finder.py b/codebasin/finder.py
@@ -8,6 +8,7 @@
 import collections
 import logging
 import os
+from pathlib import Path
 
 from codebasin import file_parser, platform, preprocessor, util
 from codebasin.language import FileLanguage
@@ -140,6 +141,11 @@ def find(
     lines to platforms.
     """
 
+    # Ensure rootdir is a string for compatibility with legacy code.
+    # TODO: Remove this once all other functionality is ported to Path.
+    if isinstance(rootdir, Path):
+        rootdir = str(rootdir)
+
     # Build a tree for each unique file for all platforms.
     state = ParserState(summarize_only)
     for f in codebase:
diff --git a/tests/basic_asm/test_basic_asm.py b/tests/basic_asm/test_basic_asm.py
@@ -34,7 +34,7 @@ def test_yaml(self):
                 },
             )
         configuration = {"CPU": entries}
-        state = finder.find(str(self.rootdir), codebase, configuration)
+        state = finder.find(self.rootdir, codebase, configuration)
         mapper = PlatformMapper(codebase)
         setmap = mapper.walk(state)
         self.assertDictEqual(
@@ -56,7 +56,7 @@ def test_ptx(self):
         self.assertRaises(
             RuntimeError,
             finder.find,
-            str(self.rootdir),
+            self.rootdir,
             codebase,
             configuration,
         )
diff --git a/tests/basic_fortran/test_basic_fortran.py b/tests/basic_fortran/test_basic_fortran.py
@@ -45,7 +45,7 @@ def test_yaml(self):
                 },
             ],
         }
-        state = finder.find(str(self.rootdir), codebase, configuration)
+        state = finder.find(self.rootdir, codebase, configuration)
         mapper = PlatformMapper(codebase)
         setmap = mapper.walk(state)
         self.assertDictEqual(
diff --git a/tests/build-dir/test_build_dir.py b/tests/build-dir/test_build_dir.py
@@ -63,7 +63,7 @@ def test_absolute_paths(self):
 
         expected_setmap = {frozenset(["one", "two"]): 1}
 
-        state = finder.find(str(self.rootdir), codebase, configuration)
+        state = finder.find(self.rootdir, codebase, configuration)
         mapper = PlatformMapper(codebase)
         setmap = mapper.walk(state)
         self.assertDictEqual(setmap, expected_setmap, "Mismatch in setmap")
diff --git a/tests/commented_directive/test_commented_directive.py b/tests/commented_directive/test_commented_directive.py
@@ -49,7 +49,7 @@ def test_yaml(self):
                 },
             ],
         }
-        state = finder.find(str(self.rootdir), codebase, configuration)
+        state = finder.find(self.rootdir, codebase, configuration)
         mapper = PlatformMapper(codebase)
         setmap = mapper.walk(state)
 
diff --git a/tests/define/test_define.py b/tests/define/test_define.py
@@ -44,7 +44,7 @@ def test_yaml(self):
                 },
             ],
         }
-        state = finder.find(str(self.rootdir), codebase, configuration)
+        state = finder.find(self.rootdir, codebase, configuration)
         mapper = PlatformMapper(codebase)
         setmap = mapper.walk(state)
         self.assertDictEqual(
diff --git a/tests/disjoint/test_disjoint.py b/tests/disjoint/test_disjoint.py
@@ -43,7 +43,7 @@ def test_yaml(self):
                 },
             ],
         }
-        state = finder.find(str(self.rootdir), codebase, configuration)
+        state = finder.find(self.rootdir, codebase, configuration)
         mapper = PlatformMapper(codebase)
         setmap = mapper.walk(state)
         self.assertDictEqual(
diff --git a/tests/duplicates/test_duplicates.py b/tests/duplicates/test_duplicates.py
@@ -47,7 +47,7 @@ def test_duplicates(self):
 
         expected_setmap = {frozenset(["cpu"]): 1, frozenset(["gpu"]): 1}
 
-        state = finder.find(str(self.rootdir), codebase, configuration)
+        state = finder.find(self.rootdir, codebase, configuration)
         mapper = PlatformMapper(codebase)
         setmap = mapper.walk(state)
         self.assertDictEqual(setmap, expected_setmap, "Mismatch in setmap")
diff --git a/tests/exclude/test_exclude.py b/tests/exclude/test_exclude.py
@@ -27,7 +27,7 @@ def _get_setmap(self, excludes):
         configuration = {
             "test": config.load_database(str(dbpath), str(self.rootdir)),
         }
-        state = finder.find(str(self.rootdir), codebase, configuration)
+        state = finder.find(self.rootdir, codebase, configuration)
         mapper = PlatformMapper(codebase)
         setmap = mapper.walk(state)
         return setmap
diff --git a/tests/include/test_include.py b/tests/include/test_include.py
@@ -36,7 +36,7 @@ def test_include(self):
             "GPU": config.load_database(str(gpu_path), str(self.rootdir)),
         }
 
-        state = finder.find(str(self.rootdir), codebase, configuration)
+        state = finder.find(self.rootdir, codebase, configuration)
         mapper = PlatformMapper(codebase)
         setmap = mapper.walk(state)
         self.assertDictEqual(
diff --git a/tests/literals/test_literals.py b/tests/literals/test_literals.py
@@ -42,7 +42,7 @@ def test_literals(self):
                 },
             ],
         }
-        state = finder.find(str(self.rootdir), codebase, configuration)
+        state = finder.find(self.rootdir, codebase, configuration)
         mapper = PlatformMapper(codebase)
         setmap = mapper.walk(state)
         self.assertDictEqual(
diff --git a/tests/macro_expansion/test_macro_expansion.py b/tests/macro_expansion/test_macro_expansion.py
@@ -51,7 +51,7 @@ def test_macro_expansion(self):
             "CPU": cpu_entries,
             "GPU": gpu_entries,
         }
-        state = finder.find(str(self.rootdir), codebase, configuration)
+        state = finder.find(self.rootdir, codebase, configuration)
         mapper = PlatformMapper(codebase)
         setmap = mapper.walk(state)
         self.assertDictEqual(
diff --git a/tests/multi_line/test_multi_line.py b/tests/multi_line/test_multi_line.py
@@ -44,7 +44,7 @@ def test_yaml(self):
                 },
             ],
         }
-        state = finder.find(str(self.rootdir), codebase, configuration)
+        state = finder.find(self.rootdir, codebase, configuration)
         mapper = PlatformMapper(codebase)
         setmap = mapper.walk(state)
         self.assertDictEqual(
diff --git a/tests/nesting/test_nesting.py b/tests/nesting/test_nesting.py
@@ -45,7 +45,7 @@ def test_yaml(self):
                 },
             ],
         }
-        state = finder.find(str(self.rootdir), codebase, configuration)
+        state = finder.find(self.rootdir, codebase, configuration)
         mapper = PlatformMapper(codebase)
         setmap = mapper.walk(state)
         self.assertDictEqual(
diff --git a/tests/once/test_once.py b/tests/once/test_once.py
@@ -44,7 +44,7 @@ def test_yaml(self):
                 },
             ],
         }
-        state = finder.find(str(self.rootdir), codebase, configuration)
+        state = finder.find(self.rootdir, codebase, configuration)
         mapper = PlatformMapper(codebase)
         setmap = mapper.walk(state)
         self.assertDictEqual(
diff --git a/tests/operators/test_operators.py b/tests/operators/test_operators.py
@@ -42,7 +42,7 @@ def test_operators(self):
                 },
             ],
         }
-        state = finder.find(str(self.rootdir), codebase, configuration)
+        state = finder.find(self.rootdir, codebase, configuration)
         mapper = PlatformMapper(codebase)
         setmap = mapper.walk(state)
         self.assertDictEqual(

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ def test_yaml(self):`
`45`	`45`	`},`
`46`	`46`	`],`
`47`	`47`	`}`
`48`		`- state = finder.find(str(self.rootdir), codebase, configuration)`
	`48`	`+ state = finder.find(self.rootdir, codebase, configuration)`
`49`	`49`	`mapper = PlatformMapper(codebase)`
`50`	`50`	`setmap = mapper.walk(state)`
`51`	`51`	`self.assertDictEqual(`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ def test_yaml(self):`
`49`	`49`	`},`
`50`	`50`	`],`
`51`	`51`	`}`
`52`		`- state = finder.find(str(self.rootdir), codebase, configuration)`
	`52`	`+ state = finder.find(self.rootdir, codebase, configuration)`
`53`	`53`	`mapper = PlatformMapper(codebase)`
`54`	`54`	`setmap = mapper.walk(state)`
`55`	`55`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ def test_yaml(self):`
`44`	`44`	`},`
`45`	`45`	`],`
`46`	`46`	`}`
`47`		`- state = finder.find(str(self.rootdir), codebase, configuration)`
	`47`	`+ state = finder.find(self.rootdir, codebase, configuration)`
`48`	`48`	`mapper = PlatformMapper(codebase)`
`49`	`49`	`setmap = mapper.walk(state)`
`50`	`50`	`self.assertDictEqual(`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ def test_yaml(self):`
`43`	`43`	`},`
`44`	`44`	`],`
`45`	`45`	`}`
`46`		`- state = finder.find(str(self.rootdir), codebase, configuration)`
	`46`	`+ state = finder.find(self.rootdir, codebase, configuration)`
`47`	`47`	`mapper = PlatformMapper(codebase)`
`48`	`48`	`setmap = mapper.walk(state)`
`49`	`49`	`self.assertDictEqual(`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ def _get_setmap(self, excludes):`
`27`	`27`	`configuration = {`
`28`	`28`	`"test": config.load_database(str(dbpath), str(self.rootdir)),`
`29`	`29`	`}`
`30`		`- state = finder.find(str(self.rootdir), codebase, configuration)`
	`30`	`+ state = finder.find(self.rootdir, codebase, configuration)`
`31`	`31`	`mapper = PlatformMapper(codebase)`
`32`	`32`	`setmap = mapper.walk(state)`
`33`	`33`	`return setmap`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ def test_include(self):`
`36`	`36`	`"GPU": config.load_database(str(gpu_path), str(self.rootdir)),`
`37`	`37`	`}`
`38`	`38`
`39`		`- state = finder.find(str(self.rootdir), codebase, configuration)`
	`39`	`+ state = finder.find(self.rootdir, codebase, configuration)`
`40`	`40`	`mapper = PlatformMapper(codebase)`
`41`	`41`	`setmap = mapper.walk(state)`
`42`	`42`	`self.assertDictEqual(`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ def test_literals(self):`
`42`	`42`	`},`
`43`	`43`	`],`
`44`	`44`	`}`
`45`		`- state = finder.find(str(self.rootdir), codebase, configuration)`
	`45`	`+ state = finder.find(self.rootdir, codebase, configuration)`
`46`	`46`	`mapper = PlatformMapper(codebase)`
`47`	`47`	`setmap = mapper.walk(state)`
`48`	`48`	`self.assertDictEqual(`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ def test_macro_expansion(self):`
`51`	`51`	`"CPU": cpu_entries,`
`52`	`52`	`"GPU": gpu_entries,`
`53`	`53`	`}`
`54`		`- state = finder.find(str(self.rootdir), codebase, configuration)`
	`54`	`+ state = finder.find(self.rootdir, codebase, configuration)`
`55`	`55`	`mapper = PlatformMapper(codebase)`
`56`	`56`	`setmap = mapper.walk(state)`
`57`	`57`	`self.assertDictEqual(`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ def test_operators(self):`
`42`	`42`	`},`
`43`	`43`	`],`
`44`	`44`	`}`
`45`		`- state = finder.find(str(self.rootdir), codebase, configuration)`
	`45`	`+ state = finder.find(self.rootdir, codebase, configuration)`
`46`	`46`	`mapper = PlatformMapper(codebase)`
`47`	`47`	`setmap = mapper.walk(state)`
`48`	`48`	`self.assertDictEqual(`