Refactor a bit

python · markshannon · Dec 8, 2023 · Nov 26, 2023 · Nov 26, 2023 · Nov 26, 2023
commit 3204e55d295f15d89cc3d32fbe9a570375adb1b7
@@ -1,7 +1,19 @@
 from pathlib import Path
+from typing import TextIO
 
 ROOT = Path(__file__).parent.parent.parent
 DEFAULT_INPUT = (ROOT / "Python/bytecodes.c").absolute()
 
+
 def root_relative_path(filename: str) -> str:
     return Path(filename).relative_to(ROOT).as_posix()
+
+
+def write_header(generator: str, source: str, outfile: TextIO) -> None:
+    outfile.write(
+        f"""// This file is generated by {root_relative_path(generator)}
+// from:
+//   {source}
+// Do not edit!
+"""
+    )
diff --git a/Tools/cases_generator/opcode_generator.py b/Tools/cases_generator/opcode_generator.py
@@ -20,34 +20,19 @@
 from generators_common import (
     DEFAULT_INPUT,
     ROOT,
-    root_relative_path,
+    write_header,
 )
 from cwriter import CWriter
 from typing import TextIO, Iterator
 from lexer import Token
 from stack import StackOffset
 
-THIS = root_relative_path(__file__)
 
-DEFAULT_OUTPUT = (ROOT / "Include/opcode_ids.h")
+DEFAULT_OUTPUT = ROOT / "Include/opcode_ids.h"
 
 
-def write_header(filename: str, outfile: TextIO) -> None:
-    outfile.write(
-        f"""// This file is generated by {THIS}
-// from:
-//   {filename}
-// Do not edit!
-"""
-    )
-
-
-def generate_opcode_header(
-    filenames: str, analysis: Analysis, outfile: TextIO
-) -> None:
-
-
-    write_header(filenames, outfile)
+def generate_opcode_header(filenames: str, analysis: Analysis, outfile: TextIO) -> None:
+    write_header(__file__, filenames, outfile)
     out = CWriter(outfile, 0, False)
     out.emit("\n")
     instmap: dict[str, int] = {}
@@ -63,7 +48,9 @@ def generate_opcode_header(
     instmap["RESUME"] = 149
     instmap["INSTRUMENTED_LINE"] = 254
 
-    instrumented = [name for name in analysis.instructions if name.startswith("INSTRUMENTED")]
+    instrumented = [
+        name for name in analysis.instructions if name.startswith("INSTRUMENTED")
+    ]
 
     # Special case: this instruction is implemented in ceval.c
     # rather than bytecodes.c, so we need to add it explicitly
@@ -100,7 +87,7 @@ def generate_opcode_header(
     def add_instruction(name: str) -> None:
         nonlocal next_opcode
         if name in instmap:
-            return # Pre-defined name
+            return  # Pre-defined name
         while next_opcode in instmap.values():
             next_opcode += 1
         instmap[name] = next_opcode
@@ -120,24 +107,26 @@ def add_instruction(name: str) -> None:
 
     for op, name in enumerate(sorted(analysis.pseudos), 256):
         instmap[name] = op
-
-    assert 255 not in instmap.values() 
 
-    out.emit("""#ifndef Py_OPCODE_IDS_H
+    assert 255 not in instmap.values()
+
+    out.emit(
+        """#ifndef Py_OPCODE_IDS_H
 #define Py_OPCODE_IDS_H
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /* Instruction opcodes for compiled code */
-""")
+"""
+    )
 
-    def write_define(name:str, op: int) -> None:
-        out.emit(f'#define {name:<38} {op:>3}\n')
+    def write_define(name: str, op: int) -> None:
+        out.emit(f"#define {name:<38} {op:>3}\n")
 
     for op, name in sorted([(op, name) for (name, op) in instmap.items()]):
         write_define(name, op)
-        
+
     out.emit("\n")
     write_define("HAVE_ARGUMENT", len(no_arg))
     write_define("MIN_INSTRUMENTED_OPCODE", min_instrumented)
@@ -149,7 +138,6 @@ def write_define(name:str, op: int) -> None:
     out.emit("#endif /* !Py_OPCODE_IDS_H */\n")
 
 
-
 arg_parser = argparse.ArgumentParser(
     description="Generate the header file with all opcode IDs.",
     formatter_class=argparse.ArgumentDefaultsHelpFormatter,
@@ -159,7 +147,6 @@ def write_define(name:str, op: int) -> None:
     "-o", "--output", type=str, help="Generated code", default=DEFAULT_OUTPUT
 )
 
-
 arg_parser.add_argument(
     "input", nargs=argparse.REMAINDER, help="Instruction definition file(s)"
 )

@@ -20,32 +20,15 @@
 from generators_common import (
     DEFAULT_INPUT,
     ROOT,
-    root_relative_path,
+    write_header,
 )
 from cwriter import CWriter
 from typing import TextIO, Iterator
 from lexer import Token
 from stack import StackOffset
 
 
-THIS = root_relative_path(__file__)
-
-DEFAULT_OUTPUT = (ROOT / "Python/generated_cases.c.h")
-
-
-def write_header(filename: str, outfile: TextIO) -> None:
-    outfile.write(
-        f"""// This file is generated by {THIS}
-// from:
-//   {filename}
-// Do not edit!
-
-#ifdef TIER_TWO
-    #error "This file is for Tier 1 only"
-#endif
-#define TIER_ONE 1
-"""
-    )
+DEFAULT_OUTPUT = ROOT / "Python/generated_cases.c.h"
 
 
 FOOTER = "#undef TIER_ONE\n"
@@ -353,7 +336,15 @@ def uses_this(inst: Instruction) -> bool:
 def generate_tier1(
     filenames: str, analysis: Analysis, outfile: TextIO, lines: bool
 ) -> None:
-    write_header(filenames, outfile)
+    write_header(__file__, filenames, outfile)
+    outfile.write(
+        """
+#ifdef TIER_TWO
+    #error "This file is for Tier 1 only"
+#endif
+#define TIER_ONE 1
+"""
+    )
     out = CWriter(outfile, 2, lines)
     out.emit("\n")
     for name, inst in sorted(analysis.instructions.items()):