Use pathlib in test code.

Author: windelbouwman

examples/wasm/primes.py

@@ -1,25 +1,25 @@
 """
-Example that compiles Python code to WASM, then WASM to PPCI-IR, then to native,
-and run in-process.
+Example that compiles Python code to WASM, then WASM to PPCI-IR,
+then to native, and run in-process.
 """
 
-import os
 import logging
 from io import StringIO
+from pathlib import Path
 from time import perf_counter
 
 from ppci import irutils
-from ppci.api import ir_to_object, get_current_arch
+from ppci.api import get_current_arch, ir_to_object
+from ppci.lang.python import ir_to_python, python_to_wasm
 from ppci.utils import codepage, reporting
-
-from ppci.wasm import wasm_to_ir, export_wasm_example
-from ppci.lang.python import python_to_wasm, ir_to_python
+from ppci.wasm import export_wasm_example, wasm_to_ir
 
 logging.basicConfig(level=logging.DEBUG)
 
 
 # Example Python code
-# A bit silly; they are assumed to be "main functions" so they can return a value
+# A bit silly; they are assumed to be "main functions"
+# so they can return a value
 
 py1 = """
 return 42
@@ -46,7 +46,7 @@
 
 while n < max:
     i = i + 1
-    
+
     if i <= 1:
         continue  # nope
     elif i == 2:
@@ -80,9 +80,9 @@
 # Optimizer fails, or makes it slower ;)
 # optimize(ppci_module, 2)
 
-this_dir = os.path.dirname(os.path.abspath(__file__))
+this_dir = Path(__file__).resolve().parent
 # Generate a report:
-html_report = os.path.join(this_dir, "compilation_report.html")
+html_report = this_dir / "compilation_report.html"
 with reporting.html_reporter(html_report) as reporter:
     # Write IR code
     f = StringIO()
@@ -104,9 +104,7 @@
 print(f"native says {result} in {etime} s")
 
 # Generate html page:
-export_wasm_example(
-    os.path.join(this_dir, "prime_demo_page.html"), py3, wasm_module
-)
+export_wasm_example(this_dir / "prime_demo_page.html", py3, wasm_module)
 
 # Convert PPCI IR to (ugly) Python to skip codegen
 if True:

ppci/common.py

@@ -5,6 +5,7 @@
 """
 
 import logging
+from pathlib import Path
 from .lang.common import SourceLocation
 
 
@@ -34,6 +35,8 @@ def get_file(f, mode="r"):
     if hasattr(f, "read"):
         # Assume this is a file like object
         return f
+    elif isinstance(f, Path):
+        return f.open(mode)
     elif isinstance(f, str):
         return open(f, mode)
     else:

ppci/wasm/util.py

@@ -9,6 +9,7 @@
 import re
 import tempfile
 import struct
+from pathlib import Path
 import subprocess
 import keyword
 from contextlib import suppress
@@ -23,7 +24,7 @@
     "has_node",
 ]
 
-
+this_dir = Path(__file__).resolve().parent
 PAGE_SIZE = 64 * 1024  # 64 KiB
 hex_prog = re.compile(r"-?0x[0-9a-fA-F]+")
 hex_float_prog = re.compile(r"[-+]?0x[0-9a-fA-F]+")
@@ -79,6 +80,11 @@ def make_float(s):
         raise NotImplementedError(str(s))
 
 
+def read_template(name):
+    path = this_dir / name
+    return path.read_text()
+
+
 class SlugTable:
     """A translation table which allows simple ascii characters."""
 
@@ -199,14 +205,8 @@ def export_wasm_example(filename, code, wasm, main_js=""):
     fname = os.path.basename(filename).rsplit(".", 1)[0]
 
     # Read templates
-    src_filename_js = os.path.join(os.path.dirname(__file__), "template.js")
-    src_filename_html = os.path.join(
-        os.path.dirname(__file__), "template.html"
-    )
-    with open(src_filename_js, "rb") as f:
-        js = f.read().decode()
-    with open(src_filename_html, "rb") as f:
-        html = f.read().decode()
+    js = read_template("template.js")
+    html = read_template("template.html")
 
     # Produce HTML
     js = js.replace(
@@ -243,9 +243,7 @@ def run_wasm_in_notebook(wasm):
     wasm_text = str(list(wasm))  # [0, 1, 12, ...]
 
     # Read templates
-    src_filename_js = os.path.join(os.path.dirname(__file__), "template.js")
-    with open(src_filename_js, "rb") as f:
-        js = f.read().decode()
+    js = read_template("template.js")
 
     # Get id
     global _nb_output
@@ -297,9 +295,7 @@ def run_wasm_in_node(wasm, silent=False):
     wasm_text = str(list(wasm))  # [0, 1, 12, ...]
 
     # Read templates
-    src_filename_js = os.path.join(os.path.dirname(__file__), "template.js")
-    with open(src_filename_js, "rb") as f:
-        js = f.read().decode()
+    js = read_template("template.js")
 
     # Produce JS
     js = js.replace("MAIN_JS_PLACEHOLDER", "")

test/helper_util.py

@@ -14,6 +14,7 @@
 # Store testdir for safe switch back to directory:
 testdir = os.path.dirname(os.path.abspath(__file__))
 test_path = Path(testdir)
+examples_path = test_path.parent / "examples"
 logger = logging.getLogger("util")
 
 
@@ -84,13 +85,15 @@ def has_qemu():
             return False
 
 
-def run_qemu(kernel, machine="lm3s811evb", dump_file=None, dump_range=None):
+def run_qemu(
+    kernel: Path, machine="lm3s811evb", dump_file=None, dump_range=None
+):
     """Runs qemu on a given kernel file"""
 
     if not has_qemu():
         return ""
     # Check bin file exists:
-    assert os.path.isfile(kernel)
+    assert kernel.is_file()
 
     logger.debug("Running qemu with machine=%s and image %s", machine, kernel)
 
@@ -107,7 +110,7 @@ def run_qemu(kernel, machine="lm3s811evb", dump_file=None, dump_range=None):
     return qemu(args)
 
 
-def create_qemu_launch_script(filename, qemu_cmd):
+def create_qemu_launch_script(filename: Path, qemu_cmd):
     """Create a shell script for a qemu command.
 
     This can be used to launch qemu manually for a specific test example.
@@ -129,7 +132,7 @@ def create_qemu_launch_script(filename, qemu_cmd):
     if "-nographic" in qemu_cmd:
         qemu_cmd.remove("-nographic")
 
-    with open(filename, "w") as f:
+    with filename.open("w") as f:
         print("#!/bin/bash", file=f)
         print("", file=f)
         print("# *** automatically generated QEMU launch file! ***", file=f)
@@ -141,8 +144,8 @@ def create_qemu_launch_script(filename, qemu_cmd):
         # chmod +x:
         import stat
 
-        st = os.stat(filename)
-        os.chmod(filename, st.st_mode | stat.S_IEXEC)
+        st = filename.stat()
+        filename.chmod(st.st_mode | stat.S_IEXEC)
 
 
 def qemu(args):
@@ -264,22 +267,20 @@ def has_iverilog():
     return hasattr(shutil, "which") and bool(shutil.which(iverilog_app))
 
 
-def run_msp430(pmem):
+def run_msp430(pmem: Path):
     """Run the given memory file in the openmsp430 iverilog project."""
 
     # Make a run file with the same name as the mem file:
-    simv = pmem[:-4] + ".run"
+    simv = pmem.with_suffix(".run")
 
-    if not os.path.exists(simv):
+    if not simv.exists():
         print()
         print("======")
         print("Compiling verilog!")
         print("======")
 
         # compile msp430 bench for this pmem:
-        workdir = relpath(
-            "..", "examples", "msp430", "test_system", "iverilog"
-        )
+        workdir = examples_path / "msp430" / "test_system" / "iverilog"
         cmd = [
             "iverilog",
             "-o",
@@ -313,20 +314,20 @@ def run_msp430(pmem):
     return data
 
 
-def run_picorv32(pmem):
+def run_picorv32(pmem: Path):
     """Run the given memory file in the riscvpicorv32 iverilog project."""
 
     # Make a run file with the same name as the mem file:
-    simv = pmem[:-4] + ".run"
+    simv = pmem.with_suffix(".run")
 
-    if not os.path.exists(simv):
+    if not simv.exists():
         print()
         print("======")
         print("Compiling verilog!")
         print("======")
 
         # compile picorv32 bench for this pmem:
-        workdir = relpath("..", "examples", "riscvpicorv32", "iverilog")
+        workdir = examples_path / "riscvpicorv32" / "iverilog"
         cmd = [
             "iverilog",
             "-o",
@@ -353,11 +354,11 @@ def run_picorv32(pmem):
     return outs
 
 
-avr_emu1 = relpath("..", "examples", "avr", "emu", "build", "emu1")
+avr_emu1 = examples_path / "avr" / "emu" / "build" / "emu1"
 
 
 def has_avr_emulator():
-    return os.path.exists(avr_emu1)
+    return avr_emu1.exists()
 
 
 def run_avr(hexfile):

test/run_profiler.py

@@ -1,10 +1,9 @@
-from cProfile import Profile
-import pstats
 import logging
 import logging.handlers
-import shutil
 import os
-
+import pstats
+import shutil
+from cProfile import Profile
 
 if __name__ == "__main__":
     logging.getLogger().setLevel(logging.DEBUG)

test/samples/sample_helpers.py

@@ -6,7 +6,9 @@
 from ppci.lang.c import COptions
 from ppci.utils.reporting import html_reporter
 
-from ..helper_util import relpath, source_files, test_path
+from ..helper_util import source_files, test_path
+
+librt_path = test_path.parent / "librt"
 
 
 def create_test_function(source: Path, output: Path, lang: str):
@@ -45,7 +47,7 @@ def build_sample_to_ir(src, lang, bsp_c3, march, reporter):
     if lang == "c3":
         ir_modules = [
             api.c3_to_ir(
-                [bsp_c3, relpath("..", "librt", "io.c3"), io.StringIO(src)],
+                [bsp_c3, librt_path / "io.c3", io.StringIO(src)],
                 [],
                 march,
                 reporter=reporter,
@@ -55,11 +57,11 @@ def build_sample_to_ir(src, lang, bsp_c3, march, reporter):
         ir_modules = [api.bf_to_ir(src, march)]
     elif lang == "c":
         coptions = COptions()
-        libc_path = relpath("..", "librt", "libc")
+        libc_path = librt_path / "libc"
         include_path1 = os.path.join(libc_path, "include")
-        lib = relpath("..", "librt", "libc", "lib.c")
+        lib = libc_path / "lib.c"
         coptions.add_include_path(include_path1)
-        with open(lib) as f:
+        with lib.open() as f:
             mod1 = api.c_to_ir(f, march, coptions=coptions, reporter=reporter)
         mod2 = api.c_to_ir(
             io.StringIO(src), march, coptions=coptions, reporter=reporter
@@ -78,7 +80,7 @@ def build_sample_to_ir(src, lang, bsp_c3, march, reporter):
 def build_sample_to_code(src, lang, bsp_c3, opt_level, march, debug, reporter):
     """Turn example sample into code objects."""
     if lang == "c3":
-        srcs = [relpath("..", "librt", "io.c3"), bsp_c3, io.StringIO(src)]
+        srcs = [librt_path / "io.c3", bsp_c3, io.StringIO(src)]
         o2 = api.c3c(
             srcs,
             [],
@@ -95,10 +97,10 @@ def build_sample_to_code(src, lang, bsp_c3, opt_level, march, debug, reporter):
     elif lang == "c":
         o2 = api.c3c([bsp_c3], [], march, reporter=reporter)
         coptions = COptions()
-        libc_path = relpath("..", "librt", "libc")
+        libc_path = librt_path / "libc"
         include_path1 = os.path.join(libc_path, "include")
         coptions.add_include_path(include_path1)
-        with open(relpath("..", "librt", "libc", "lib.c")) as f:
+        with open(libc_path / "lib.c") as f:
             o3 = api.cc(
                 f, march, coptions=coptions, debug=debug, reporter=reporter
             )

test/samples/test_samples_on_arm.py

@@ -1,7 +1,13 @@
 import io
 import unittest
 
-from ..helper_util import do_long_tests, has_qemu, make_filename, qemu, relpath
+from ..helper_util import (
+    do_long_tests,
+    has_qemu,
+    make_filename,
+    qemu,
+    examples_path,
+)
 from .sample_helpers import add_samples, build
 
 
@@ -52,7 +58,7 @@ class TestSamplesOnVexpress(unittest.TestCase):
 
     def do(self, src, expected_output, lang="c3"):
         # Construct binary file from snippet:
-        bsp_c3 = relpath("..", "examples", "realview-pb-a8", "arch.c3")
+        bsp_c3 = examples_path / "realview-pb-a8" / "arch.c3"
         startercode = io.StringIO(self.startercode)
         base_filename = make_filename(self.id())
         build(
@@ -149,7 +155,7 @@ class TestSamplesOnCortexM3O2(unittest.TestCase):
 
     def do(self, src, expected_output, lang="c3"):
         # Construct binary file from snippet:
-        bsp_c3 = relpath("..", "examples", "lm3s6965evb", "bare", "arch.c3")
+        bsp_c3 = examples_path / "lm3s6965evb" / "bare" / "arch.c3"
         startercode = io.StringIO(self.startercode)
         base_filename = make_filename(self.id())
         build(

test/samples/test_samples_on_avr.py

@@ -5,8 +5,8 @@
     do_long_tests,
     has_avr_emulator,
     make_filename,
-    relpath,
     run_avr,
+    examples_path,
 )
 from .sample_helpers import add_samples, build
 
@@ -19,9 +19,9 @@ class TestSamplesOnAvr(unittest.TestCase):
 
     def do(self, src, expected_output, lang="c3"):
         base_filename = make_filename(self.id())
-        bsp_c3 = relpath("..", "examples", "avr", "bsp.c3")
-        crt0 = relpath("..", "examples", "avr", "glue.asm")
-        mmap = relpath("..", "examples", "avr", "avr.mmap")
+        bsp_c3 = examples_path / "avr" / "bsp.c3"
+        crt0 = examples_path / "avr" / "glue.asm"
+        mmap = examples_path / "avr" / "avr.mmap"
         build(
             base_filename,
             src,