Merge pull request #675 from boriel/refact/code_cleanup

refact: code clean up in the peephole parser

Author: boriel

pyproject.toml

@@ -78,3 +78,6 @@ norecursedirs = ["test_*tmp", "runtime"]
 
 [tool.isort]
 profile = "black"
+
+[tool.mypy]
+enable_recursive_aliases = true

src/arch/z80/peephole/parser.py

@@ -1,17 +1,19 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-
 import re
 import sys
 from collections import defaultdict
-from typing import Any, Dict, List, NamedTuple, Optional, Tuple, Union
+from types import MappingProxyType
+from typing import Any, Final, NamedTuple
+
+from src.api import errmsg, global_
 
-import src.api.global_
-from src.arch.z80.peephole import evaluator, pattern
+from . import pattern
+from .evaluator import BINARY, FN, OPERS, UNARY, Evaluator
 
-TreeType = List[Union[str, List[Any]]]
+TreeType = list[str | list["TreeType"]]
 
-COMMENT = ";;"
+COMMENT: Final[str] = ";;"
 RE_REGION = re.compile(r"([_a-zA-Z][a-zA-Z0-9]*)[ \t]*{{")
 RE_DEF = re.compile(r"([_a-zA-Z][a-zA-Z0-9]*)[ \t]*:[ \t]*(.*)")
 RE_IFPARSE = re.compile(r'"(""|[^"])*"|[(),]|\b[_a-zA-Z]+\b|[^," \t()]+')
@@ -27,19 +29,21 @@
 O_FLAG = "OFLAG"
 
 # Operators : priority (lower number -> highest priority)
-IF_OPERATORS = {
-    evaluator.FN.OP_NMUL: 3,
-    evaluator.FN.OP_NDIV: 3,
-    evaluator.FN.OP_PLUS: 5,
-    evaluator.FN.OP_NPLUS: 5,
-    evaluator.FN.OP_NSUB: 5,
-    evaluator.FN.OP_NE: 10,
-    evaluator.FN.OP_EQ: 10,
-    evaluator.FN.OP_AND: 15,
-    evaluator.FN.OP_OR: 20,
-    evaluator.FN.OP_IN: 25,
-    evaluator.FN.OP_COMMA: 30,
-}
+IF_OPERATORS: Final[MappingProxyType[FN, int]] = MappingProxyType(
+    {
+        FN.OP_NMUL: 3,
+        FN.OP_NDIV: 3,
+        FN.OP_PLUS: 5,
+        FN.OP_NPLUS: 5,
+        FN.OP_NSUB: 5,
+        FN.OP_NE: 10,
+        FN.OP_EQ: 10,
+        FN.OP_AND: 15,
+        FN.OP_OR: 20,
+        FN.OP_IN: 25,
+        FN.OP_COMMA: 30,
+    }
+)
 
 
 # Which one of the above are REGIONS (that is, {{ ... }} blocks)
@@ -53,7 +57,7 @@
 REQUIRED = (REG_REPLACE, REG_WITH, O_LEVEL, O_FLAG)
 
 
-def simplify_expr(expr: List[Any]) -> List[Any]:
+def simplify_expr(expr: list[Any]) -> list[Any]:
     """Simplifies ("unnest") a list, removing redundant brackets.
     i.e. [[x, [[y]]] becomes [x, [y]]
     """
@@ -75,14 +79,14 @@ class SourceLine(NamedTuple):
 # Defines a define expr with its linenum
 class DefineLine(NamedTuple):
     lineno: int
-    expr: evaluator.Evaluator
+    expr: Evaluator
 
 
-def parse_ifline(if_line: str, lineno: int) -> Optional[TreeType]:
+def parse_ifline(if_line: str, lineno: int) -> TreeType | None:
     """Given a line from within a IF region (i.e. $1 == "af'")
     returns it as a list of tokens ['$1', '==', "af'"]
     """
-    stack: List[TreeType] = []
+    stack: list[TreeType] = []
     expr: TreeType = []
     paren = 0
     error_ = False
@@ -98,7 +102,7 @@ def parse_ifline(if_line: str, lineno: int) -> Optional[TreeType]:
 
         tok = qq.group()
         if not RE_ID.match(tok):
-            for oper in evaluator.OPERS:
+            for oper in OPERS:
                 if tok.startswith(oper):
                     tok = tok[: len(oper)]
                     break
@@ -111,19 +115,19 @@ def parse_ifline(if_line: str, lineno: int) -> Optional[TreeType]:
             expr = []
             continue
 
-        if tok in evaluator.UNARY:
+        if tok in UNARY:
             stack.append(expr)
             expr = [tok]
             continue
 
         if tok == ")":
             paren -= 1
             if paren < 0:
-                src.api.errmsg.warning(lineno, "Too much closed parenthesis")
+                errmsg.warning(lineno, "Too much closed parenthesis")
                 return None
 
-            if expr and expr[-1] == evaluator.FN.OP_COMMA:
-                src.api.errmsg.warning(lineno, "missing element in list")
+            if expr and expr[-1] == FN.OP_COMMA:
+                errmsg.warning(lineno, "missing element in list")
                 return None
 
             stack[-1].append(expr)
@@ -133,31 +137,31 @@ def parse_ifline(if_line: str, lineno: int) -> Optional[TreeType]:
                 tok = tok[1:-1]
             expr.append(tok)
 
-        if tok == evaluator.FN.OP_COMMA:
+        if tok == FN.OP_COMMA:
             if len(expr) < 2 or expr[-2] == tok:
-                src.api.errmsg.warning(lineno, "Unexpected {} in list".format(tok))
+                errmsg.warning(lineno, "Unexpected {} in list".format(tok))
                 return None
 
         while len(expr) == 2 and isinstance(expr[-2], str):
-            op: Union[str, TreeType] = expr[-2]
-            if op in evaluator.UNARY:
+            op: str | TreeType = expr[-2]
+            if op in UNARY:
                 stack[-1].append(expr)
                 expr = stack.pop()
             else:
                 break
 
-        if len(expr) == 3 and expr[1] != evaluator.FN.OP_COMMA:
-            left_, op, right_ = expr  # type: ignore
+        if len(expr) == 3 and expr[1] != FN.OP_COMMA:
+            left_, op, right_ = expr
             if not isinstance(op, str) or op not in IF_OPERATORS:
-                src.api.errmsg.warning(lineno, "Unexpected binary operator '{0}'".format(op))
+                errmsg.warning(lineno, "Unexpected binary operator '{0}'".format(op))
                 return None
             if isinstance(left_, list) and len(left_) == 3 and IF_OPERATORS[left_[-2]] > IF_OPERATORS[op]:
                 expr = [[left_[:-2], left_[-2], [left_[-1], op, right_]]]  # Rebalance tree
             else:
                 expr = [expr]
 
     if not error_ and paren:
-        src.api.errmsg.warning(lineno, "unclosed parenthesis in IF section")
+        errmsg.warning(lineno, "unclosed parenthesis in IF section")
         return None
 
     while stack and not error_:
@@ -166,32 +170,32 @@ def parse_ifline(if_line: str, lineno: int) -> Optional[TreeType]:
 
         if len(expr) == 2:
             op = expr[0]
-            if not isinstance(op, str) or op not in evaluator.UNARY:
-                src.api.errmsg.warning(lineno, "unexpected unary operator '{0}'".format(op))
+            if not isinstance(op, str) or op not in UNARY:
+                errmsg.warning(lineno, "unexpected unary operator '{0}'".format(op))
                 return None
         elif len(expr) == 3:
             op = expr[1]
-            if not isinstance(op, str) or op not in evaluator.BINARY:
-                src.api.errmsg.warning(lineno, "unexpected binary operator '{0}'".format(op))
+            if not isinstance(op, str) or op not in BINARY:
+                errmsg.warning(lineno, "unexpected binary operator '{0}'".format(op))
                 return None
 
     if error_:
-        src.api.errmsg.warning(lineno, "syntax error in IF section")
+        errmsg.warning(lineno, "syntax error in IF section")
         return None
 
     return simplify_expr(expr)
 
 
-def parse_define_line(sourceline: SourceLine) -> Tuple[Optional[str], Optional[TreeType]]:
+def parse_define_line(sourceline: SourceLine) -> tuple[str | None, TreeType | None]:
     """Given a line $nnn = <expression>, returns a tuple the parsed
     ("$var", [expression]) or None, None if error."""
     if "=" not in sourceline.line:
-        src.api.errmsg.warning(sourceline.lineno, "assignation '=' not found")
+        errmsg.warning(sourceline.lineno, "assignation '=' not found")
         return None, None
 
-    result: List[str] = [x.strip() for x in sourceline.line.split("=", 1)]
+    result: list[str] = [x.strip() for x in sourceline.line.split("=", 1)]
     if not pattern.RE_SVAR.match(result[0]):  # Define vars
-        src.api.errmsg.warning(sourceline.lineno, "'{0}' not a variable name".format(result[0]))
+        errmsg.warning(sourceline.lineno, "'{0}' not a variable name".format(result[0]))
         return None, None
 
     right_part = parse_ifline(result[1], sourceline.lineno)
@@ -201,7 +205,7 @@ def parse_define_line(sourceline: SourceLine) -> Tuple[Optional[str], Optional[T
     return result[0], right_part
 
 
-def parse_str(spec: str) -> Optional[Dict[str, Union[str, int, TreeType]]]:
+def parse_str(spec: str) -> dict[str, str | int | TreeType] | None:
     """Given a string with an optimizer template definition,
     parses it and return a python object as a result.
     If any error is detected, fname will be used as filename.
@@ -210,26 +214,26 @@ def parse_str(spec: str) -> Optional[Dict[str, Union[str, int, TreeType]]]:
     ST_INITIAL = 0
     ST_REGION = 1
 
-    result: Dict[str, Any] = defaultdict(list)
+    result: dict[str, Any] = defaultdict(list)
     state = ST_INITIAL
     line_num = 0
     region_name = None
     is_ok = True
 
-    def add_entry(key: str, val: Union[str, int, TreeType]) -> bool:
+    def add_entry(key: str, val: str | int | TreeType) -> bool:
         key = key.upper()
         if key in result:
-            src.api.errmsg.warning(line_num, "duplicated definition {0}".format(key))
+            errmsg.warning(line_num, "duplicated definition {0}".format(key))
             return False
 
         if key not in REGIONS and key not in SCALARS:
-            src.api.errmsg.warning(line_num, "unknown definition parameter '{0}'".format(key))
+            errmsg.warning(line_num, "unknown definition parameter '{0}'".format(key))
             return False
 
         if key in NUMERIC:
             assert isinstance(val, str)
             if not RE_INT.match(val):
-                src.api.errmsg.warning(line_num, "field '{0} must be integer".format(key))
+                errmsg.warning(line_num, "field '{0} must be integer".format(key))
                 return False
             val = int(val)
 
@@ -238,7 +242,7 @@ def add_entry(key: str, val: Union[str, int, TreeType]) -> bool:
 
     def check_entry(key: str) -> bool:
         if key not in result:
-            src.api.errmsg.warning(line_num, "undefined section {0}".format(key))
+            errmsg.warning(line_num, "undefined section {0}".format(key))
             return False
 
         return True
@@ -279,7 +283,7 @@ def check_entry(key: str) -> bool:
                 region_name = None
             continue
 
-        src.api.errmsg.warning(line_num, "syntax error. Cannot parse file")
+        errmsg.warning(line_num, "syntax error. Cannot parse file")
         is_ok = False
         break
 
@@ -291,10 +295,10 @@ def check_entry(key: str) -> bool:
             is_ok = False
             break
         if var_ in defined_vars:
-            src.api.errmsg.warning(source_line.lineno, "duplicated variable '{0}'".format(var_))
+            errmsg.warning(source_line.lineno, "duplicated variable '{0}'".format(var_))
             is_ok = False
             break
-        defines.append([var_, DefineLine(expr=evaluator.Evaluator(expr), lineno=source_line.lineno)])
+        defines.append([var_, DefineLine(expr=Evaluator(expr), lineno=source_line.lineno)])
         defined_vars.add(var_)
     result[REG_DEFINE] = defines
 
@@ -313,25 +317,25 @@ def check_entry(key: str) -> bool:
 
     if is_ok:
         if not result[REG_REPLACE]:  # Empty REPLACE region??
-            src.api.errmsg.warning(line_num, "empty region {0}".format(REG_REPLACE))
+            errmsg.warning(line_num, "empty region {0}".format(REG_REPLACE))
             is_ok = False
 
     if not is_ok:
-        src.api.errmsg.warning(line_num, "this optimizer template will be ignored due to errors")
+        errmsg.warning(line_num, "this optimizer template will be ignored due to errors")
         return None
 
     return result
 
 
 def parse_file(fname: str):
     """Opens and parse a file given by filename"""
-    tmp = src.api.global_.FILENAME
-    src.api.global_.FILENAME = fname  # set filename so it shows up in error/warning msgs
+    tmp = global_.FILENAME
+    global_.FILENAME = fname  # set filename so it shows up in error/warning msgs
 
     with open(fname, "rt") as f:
         result = parse_str(f.read())
 
-    src.api.global_.FILENAME = tmp  # restores original filename
+    global_.FILENAME = tmp  # restores original filename
     return result
 
 

tests/arch/zx48k/peephole/test_parser.py

@@ -3,6 +3,7 @@
 import unittest
 
 from src.arch.z80.peephole import parser
+from src.arch.z80.peephole.evaluator import Evaluator
 
 
 class TestParser(unittest.TestCase):
@@ -98,9 +99,7 @@ def test_parse_chain_plus(self):
         self.assertDictEqual(
             result,
             {
-                "DEFINE": [
-                    ["$3", parser.DefineLine(lineno=8, expr=parser.evaluator.Evaluator([["$1", "+", "$1"], "+", "$1"]))]
-                ],
+                "DEFINE": [["$3", parser.DefineLine(lineno=8, expr=Evaluator([["$1", "+", "$1"], "+", "$1"]))]],
                 "IF": [],
                 "OFLAG": 27,
                 "OLEVEL": 1,
@@ -127,9 +126,7 @@ def test_parse_chain_parent(self):
         self.assertDictEqual(
             result,
             {
-                "DEFINE": [
-                    ["$3", parser.DefineLine(lineno=8, expr=parser.evaluator.Evaluator([["(", "+", "$1"], "+", ")"]))]
-                ],
+                "DEFINE": [["$3", parser.DefineLine(lineno=8, expr=Evaluator([["(", "+", "$1"], "+", ")"]))]],
                 "IF": [],
                 "OFLAG": 27,
                 "OLEVEL": 1,
@@ -225,9 +222,7 @@ def test_define_concat(self):
                 "DEFINE": [
                     [
                         "$3",
-                        parser.DefineLine(
-                            lineno=11, expr=parser.evaluator.Evaluator([[["ld ", "+", "$2"], "+", ", "], "+", "$1"])
-                        ),
+                        parser.DefineLine(lineno=11, expr=Evaluator([[["ld ", "+", "$2"], "+", ", "], "+", "$1"])),
                     ]
                 ],
                 "IF": [],