Changes to use pathlib

Author: davecom

Brainfuck/brainfuck.py

@@ -13,8 +13,11 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+from pathlib import Path
+
+
 class Brainfuck:
-    def __init__(self, file_name: str):
+    def __init__(self, file_name: str | Path):
         # Open text file and store in instance variable
         with open(file_name, "r") as text_file:
             self.source_code: str = text_file.read()

KNN/knn.py

@@ -13,6 +13,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+from pathlib import Path
 import csv
 from typing import Protocol, Self
 from collections import Counter
@@ -29,14 +30,14 @@ def distance(self, other: Self) -> float: ...
 
 
 class KNN[DP: DataPoint]:
-    def __init__(self, data_point_type: type[DP], file_path: str,
+    def __init__(self, data_point_type: type[DP], file_path: str | Path,
                  has_header: bool = True) -> None:
         self.data_point_type = data_point_type
         self.data_points = []
         self._read_csv(file_path, has_header)
 
     # Read a CSV file and return a list of data points
-    def _read_csv(self, file_path: str, has_header: bool) -> None:
+    def _read_csv(self, file_path: str | Path, has_header: bool) -> None:
         with open(file_path, 'r') as f:
             reader = csv.reader(f)
             if has_header:

NESEmulator/rom.py

@@ -13,6 +13,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+from pathlib import Path
 from struct import unpack
 from collections import namedtuple
 from array import array
@@ -27,8 +28,8 @@
 
 
 class ROM:
-    def __init__(self, filename: str):
-        with open(filename, "rb") as file:
+    def __init__(self, file_name: str | Path):
+        with open(file_name, "rb") as file:
             # Read Header and Check Signature "NES"
             self.header = Header._make(unpack("!LBBBBBBB5s",
                                               file.read(HEADER_SIZE)))

NanoBASIC/executioner.py

@@ -13,12 +13,13 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+from pathlib import Path
 from NanoBASIC.tokenizer import tokenize
 from NanoBASIC.parser import Parser
 from NanoBASIC.interpreter import Interpreter
 
 
-def execute(file_name: str):
+def execute(file_name: str | Path):
     # Load the text file from the argument
     # Tokenize, parse, and execute it
     with open(file_name, "r") as text_file:

tests/test_brainfuck.py

@@ -19,15 +19,14 @@
 # output against the expected output.
 import unittest
 import sys
-import os
 from pathlib import Path
 from io import StringIO
 from Brainfuck.brainfuck import Brainfuck
 
 
 # Tokenizes, parses, and interprets a Brainfuck
 # program; stores the output in a string and returns it
-def run(file_name: str) -> str:
+def run(file_name: str | Path) -> str:
     output_holder = StringIO()
     sys.stdout = output_holder
     Brainfuck(file_name).execute()
@@ -36,28 +35,27 @@ def run(file_name: str) -> str:
 
 class BrainfuckTestCase(unittest.TestCase):
     def setUp(self) -> None:
-        # Change working directory to this file so we can easily access
-        # the Examples directory where the test Brainfuck code resides
-        os.chdir(Path(__file__).resolve().parent)
+        self.example_folder = (Path(__file__).resolve().parent.parent
+                               / 'Brainfuck' / 'Examples')
 
     def test_hello_world(self):
-        program_output = run("../Brainfuck/Examples/hello_world_verbose.bf")
+        program_output = run(self.example_folder / "hello_world_verbose.bf")
         expected = "Hello World!\n"
         self.assertEqual(program_output, expected)
 
     def test_fibonacci(self):
-        program_output = run("../Brainfuck/Examples/fibonacci.bf")
+        program_output = run(self.example_folder / "fibonacci.bf")
         expected = "1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89"
         self.assertEqual(program_output, expected)
 
     def test_cell_size(self):
-        program_output = run("../Brainfuck/Examples/cell_size.bf")
+        program_output = run(self.example_folder / "cell_size.bf")
         expected = "8 bit cells\n"
         self.assertEqual(program_output, expected)
 
     def test_beer(self):
-        program_output = run("../Brainfuck/Examples/beer.bf")
-        with open("../Brainfuck/Examples/beer.out", "r") as text_file:
+        program_output = run(self.example_folder / "beer.bf")
+        with open(self.example_folder / "beer.out", "r") as text_file:
             expected = text_file.read()
             self.assertEqual(program_output, expected)
 

tests/test_knn.py

@@ -17,22 +17,21 @@
 # DESCRIPTION
 # Tries running multiple different tests to verify the correctness of our KNN implementation.
 import unittest
-import os
-import csv
 from pathlib import Path
+import csv
 from KNN.knn import KNN
 from KNN.fish import Fish
 from KNN.digit import Digit
 
 
 class FishTestCase(unittest.TestCase):
     def setUp(self) -> None:
-        # Change working directory to this file to get datasets
-        os.chdir(Path(__file__).resolve().parent)
+        self.data_file = (Path(__file__).resolve().parent.parent
+                          / "KNN" / "datasets" / "fish" / "fish.csv")
 
     def test_nearest(self):
         k: int = 3
-        fish_knn = KNN(Fish, '../KNN/datasets/fish/fish.csv')
+        fish_knn = KNN(Fish, str(self.data_file))
         test_fish: Fish = Fish("", 0.0, 30.0, 32.5, 38.0, 12.0, 5.0)
         nearest_fish: list[Fish] = fish_knn.nearest(k, test_fish)
         self.assertEqual(len(nearest_fish), k)
@@ -43,30 +42,31 @@ def test_nearest(self):
 
     def test_classify(self):
         k: int = 5
-        fish_knn = KNN(Fish, '../KNN/datasets/fish/fish.csv')
+        fish_knn = KNN(Fish, str(self.data_file))
         test_fish: Fish = Fish("", 0.0, 20.0, 23.5, 24.0, 10.0, 4.0)
         classify_fish: str = fish_knn.classify(k, test_fish)
         self.assertEqual(classify_fish, "Parkki")
 
     def test_predict(self):
         k: int = 5
-        fish_knn = KNN(Fish, '../KNN/datasets/fish/fish.csv')
+        fish_knn = KNN(Fish, self.data_file)
         test_fish: Fish = Fish("", 0.0, 20.0, 23.5, 24.0, 10.0, 4.0)
         predict_fish: float = fish_knn.predict(k, test_fish, "weight")
         self.assertEqual(predict_fish, 165.0)
 
 
 class DigitsTestCase(unittest.TestCase):
     def setUp(self) -> None:
-        # Change working directory to this file to get datasets
-        os.chdir(os.path.dirname(os.path.abspath(__file__)))
+        self.data_file = (Path(__file__).resolve().parent.parent
+                          / "KNN" / "datasets" / "digits" / "digits.csv")
+        self.test_file = (Path(__file__).resolve().parent.parent
+                          / "KNN" / "datasets" / "digits" / "digits_test.csv")
 
     def test_digits_test_set(self):
         k: int = 1
-        digits_knn = KNN(Digit, '../KNN/datasets/digits/digits.csv',
-                         has_header=False)
+        digits_knn = KNN(Digit, self.data_file, has_header=False)
         test_data_points: list[Digit] = []
-        with open('../KNN/datasets/digits/digits_test.csv', 'r') as f:
+        with open(self.test_file, 'r') as f:
             reader = csv.reader(f)
             for row in reader:
                 test_data_points.append(Digit.from_string_data(row))

tests/test_nanobasic.py

@@ -19,15 +19,14 @@
 # output against the expected output.
 import unittest
 import sys
-import os
 from pathlib import Path
 from io import StringIO
 from NanoBASIC.executioner import execute
 
 
 # Tokenizes, parses, and interprets a NanoBASIC
 # program; stores the output in a string and returns it
-def run(file_name: str) -> str:
+def run(file_name: str | Path) -> str:
     output_holder = StringIO()
     sys.stdout = output_holder
     execute(file_name)
@@ -36,62 +35,61 @@ def run(file_name: str) -> str:
 
 class NanoBASICTestCase(unittest.TestCase):
     def setUp(self) -> None:
-        # Change working directory to this file so we can easily access
-        # the Examples directory where the test NanoBASIC code resides
-        os.chdir(Path(__file__).resolve().parent)
+        self.example_folder = (Path(__file__).resolve().parent.parent
+                               / 'NanoBASIC' / 'Examples')
 
     def test_print1(self):
-        program_output = run("../NanoBASIC/Examples/print1.bas")
+        program_output = run(self.example_folder / "print1.bas")
         expected = "Hello World\n"
         self.assertEqual(program_output, expected)
 
     def test_print2(self):
-        program_output = run("../NanoBASIC/Examples/print2.bas")
+        program_output = run(self.example_folder / "print2.bas")
         expected = "4\n12\n30\n7\n100\t9\n"
         self.assertEqual(program_output, expected)
 
     def test_print3(self):
-        program_output = run("../NanoBASIC/Examples/print3.bas")
+        program_output = run(self.example_folder / "print3.bas")
         expected = "E is\t-31\n"
         self.assertEqual(program_output, expected)
 
     def test_variables(self):
-        program_output = run("../NanoBASIC/Examples/variables.bas")
+        program_output = run(self.example_folder / "variables.bas")
         expected = "15\n"
         self.assertEqual(program_output, expected)
 
     def test_goto(self):
-        program_output = run("../NanoBASIC/Examples/goto.bas")
+        program_output = run(self.example_folder / "goto.bas")
         expected = "Josh\nDave\nNanoBASIC ROCKS\n"
         self.assertEqual(program_output, expected)
 
     def test_gosub(self):
-        program_output = run("../NanoBASIC/Examples/gosub.bas")
+        program_output = run(self.example_folder / "gosub.bas")
         expected = "10\n"
         self.assertEqual(program_output, expected)
 
     def test_if1(self):
-        program_output = run("../NanoBASIC/Examples/if1.bas")
+        program_output = run(self.example_folder / "if1.bas")
         expected = "10\n40\n50\n60\n70\n100\n"
         self.assertEqual(program_output, expected)
 
     def test_if2(self):
-        program_output = run("../NanoBASIC/Examples/if2.bas")
+        program_output = run(self.example_folder / "if2.bas")
         expected = "GOOD\n"
         self.assertEqual(program_output, expected)
 
     def test_fib(self):
-        program_output = run("../NanoBASIC/Examples/fib.bas")
+        program_output = run(self.example_folder / "fib.bas")
         expected = "0\n1\n1\n2\n3\n5\n8\n13\n21\n34\n55\n89\n"
         self.assertEqual(program_output, expected)
 
     def test_factorial(self):
-        program_output = run("../NanoBASIC/Examples/factorial.bas")
+        program_output = run(self.example_folder / "factorial.bas")
         expected = "120\n"
         self.assertEqual(program_output, expected)
 
     def test_gcd(self):
-        program_output = run("../NanoBASIC/Examples/gcd.bas")
+        program_output = run(self.example_folder / "gcd.bas")
         expected = "7\n"
         self.assertEqual(program_output, expected)