Lint: Include remaining Python scripts

Signed-off-by: Matthias J. Kannwischer <matthias@zerorisc.com>

Author: mkannwischer

ruff.toml

@@ -6,8 +6,11 @@
 extend-include = [
     "scripts/autogen",
     "scripts/cfify",
+    "scripts/check-contracts",
+    "scripts/check-magic",
     "scripts/check-namespace",
     "scripts/simpasm",
+    "scripts/stack",
     "scripts/tests",
 ]
 

scripts/check-magic

@@ -10,89 +10,116 @@ import re
 import math
 import pathlib
 
-from sympy import simplify, sympify, Function, Rational
+from sympy import sympify, Rational
+
 
 def get_c_source_files():
     return get_files("mlkem/**/*.c")
 
+
 def get_header_files():
     return get_files("mlkem/**/*.h")
 
+
 def get_files(pattern):
     return list(map(str, pathlib.Path().glob(pattern)))
 
+
 # Standard color definitions
-GREEN="\033[32m"
-RED="\033[31m"
-BLUE="\033[94m"
-BOLD="\033[1m"
-NORMAL="\033[0m"
+GREEN = "\033[32m"
+RED = "\033[31m"
+BLUE = "\033[94m"
+BOLD = "\033[1m"
+NORMAL = "\033[0m"
 
 CHECKED = f"{GREEN}✓{NORMAL}"
 FAIL = f"{RED}✗{NORMAL}"
 REMEMBERED = f"{BLUE}⊢{NORMAL}"
 
+
 def check_magic_numbers():
     mlkem_q = 3329
-    exceptions = [mlkem_q,
-                  1665, # q/2
-                  1600, # For Keccak-F1600
-                  1023, 1024, 2047, 2048, 4095, 4096, 8192, 32767, 32768, 65535, 65536,
-                  2025, # years
-                  ]
+    exceptions = [
+        mlkem_q,
+        1665,  # q/2
+        1600,  # For Keccak-F1600
+        1023,
+        1024,
+        2047,
+        2048,
+        4095,
+        4096,
+        8192,
+        32767,
+        32768,
+        65535,
+        65536,
+        2025,  # years
+    ]
     enable_marker = "check-magic: on"
     disable_marker = "check-magic: off"
     autogen_marker = "This file is auto-generated from scripts/autogen"
 
     files = get_c_source_files() + get_header_files()
 
-    def is_exception(filename, l, magic):
+    def is_exception(filename, line, magic):
         return magic in exceptions
 
-    def get_magic(l):
-        regexp = r'/\* check-magic:\s+([-]?\d{4,})\s*==\s*(.*?) \*/'
-        m = re.search(regexp, l)
+    def get_magic(line):
+        regexp = r"/\* check-magic:\s+([-]?\d{4,})\s*==\s*(.*?) \*/"
+        m = re.search(regexp, line)
         if m is not None:
             # Remove magic annotation to avoid it being treated
             # as magic value itself
-            l = re.sub(regexp,'',l)
-            return l, (int(m.group(1)), m.group(2))
-        return l, None
+            line = re.sub(regexp, "", line)
+            return line, (int(m.group(1)), m.group(2))
+        return line, None
 
-    def get_define(l):
-        m = re.search(r'#define\s+(\w+)', l)
+    def get_define(line):
+        m = re.search(r"#define\s+(\w+)", line)
         if m is not None:
             return m.group(1)
         return None
 
     def evaluate_magic(m, known_magics):
-        def unsigned_mod(x,y):
+        def unsigned_mod(x, y):
             return x % y
-        def signed_mod(x,y):
-            r = unsigned_mod(x,y)
+
+        def signed_mod(x, y):
+            r = unsigned_mod(x, y)
             if r >= y // 2:
                 r -= y
             return r
-        def pow_mod(x,y,m):
+
+        def pow_mod(x, y, m):
             x = int(x)
             y = int(y)
             m = int(m)
-            return signed_mod(pow(x,y,m),m)
+            return signed_mod(pow(x, y, m), m)
+
         def safe_round(x):
             if x - math.floor(x) == Rational(1, 2):
-                raise ValueError(f"Ambiguous rounding: {x} is an odd multiple of 0.5 and it is unclear if round-up or round-down is desired")
+                raise ValueError(
+                    f"Ambiguous rounding: {x} is an odd multiple of 0.5 and it is unclear if round-up or round-down is desired"
+                )
             return round(x)
+
         def safe_floordiv(x, y):
             x = int(x)
             y = int(y)
             if x % y != 0:
-                raise ValueError(f"Non-integral division: {x} // {y} has remainder {x % y}")
+                raise ValueError(
+                    f"Non-integral division: {x} // {y} has remainder {x % y}"
+                )
             return x // y
-        locals_dict = {'signed_mod': signed_mod,
-                       'unsigned_mod': unsigned_mod,
-                       'pow': pow_mod,
-                       'round': safe_round,
-                       'intdiv': safe_floordiv }
+
+        locals_dict = {
+            "signed_mod": signed_mod,
+            "unsigned_mod": unsigned_mod,
+            "pow": pow_mod,
+            "round": safe_round,
+            "intdiv": safe_floordiv,
+        }
         locals_dict.update(known_magics)
         return sympify(m, locals=locals_dict)
 
@@ -104,52 +131,60 @@ def check_magic_numbers():
         content = content.split("\n")
         # Use negative lookbefore and lookahead to exclude numbers
         # that occur as part of identifiers (e.g. layer12345 or 199901L)
-        pattern = r'(?<![0-9a-zA-Z/_-])([-]?\d{4,})(?![0-9a-zA-Z_-])'
+        pattern = r"(?<![0-9a-zA-Z/_-])([-]?\d{4,})(?![0-9a-zA-Z_-])"
         enabled = True
-        magic_dict = {'MLKEM_Q': mlkem_q}
+        magic_dict = {"MLKEM_Q": mlkem_q}
         magic_expr = None
         verified_magics = {}
-        for i, l in enumerate(content):
-            if enabled is True and disable_marker in l:
+        for i, line in enumerate(content):
+            if enabled is True and disable_marker in line:
                 enabled = False
                 continue
-            if enabled is False and enable_marker in l:
+            if enabled is False and enable_marker in line:
                 enabled = True
                 continue
             if enabled is False:
                 continue
-            l, g = get_magic(l)
+            line, g = get_magic(line)
             if g is not None:
                 magic_val, magic_expr = g
                 magic_val_check = evaluate_magic(magic_expr, magic_dict)
                 if magic_val != magic_val_check:
-                    print(f"{FAIL}:{filename}:{i}: Mismatching magic annotation: {magic_val} != {magic_expr} (= {magic_val_check})")
+                    print(
+                        f"{FAIL}:{filename}:{i}: Mismatching magic annotation: {magic_val} != {magic_expr} (= {magic_val_check})"
+                    )
                     exit(1)
-                print(f"{REMEMBERED}:{filename}:{i}: Verified explanation {magic_val} == {magic_expr}")
+                print(
+                    f"{REMEMBERED}:{filename}:{i}: Verified explanation {magic_val} == {magic_expr}"
+                )
                 verified_magics[magic_val] = magic_expr
 
-            found = next(re.finditer(pattern, l), None)
+            found = next(re.finditer(pattern, line), None)
             if found is None:
                 continue
 
             magic = int(found.group())
-            if is_exception(filename, l, magic):
+            if is_exception(filename, line, magic):
                 continue
 
             explanation = verified_magics.get(magic, None)
             if explanation is None:
                 print(f"{FAIL}:{filename}:{i}: No explanation for magic value {magic}")
                 exit(1)
 
-            print(f"{CHECKED}:{filename}:{i}: {magic} previously explained as {explanation}")
+            print(
+                f"{CHECKED}:{filename}:{i}: {magic} previously explained as {explanation}"
+            )
 
             # If this is a #define's clause, remember it
-            define = get_define(l)
+            define = get_define(line)
             if define is not None:
                 magic_dict[define] = magic
 
+
 def _main():
     check_magic_numbers()
 
+
 if __name__ == "__main__":
     _main()

scripts/stack

@@ -138,7 +138,7 @@ def run_valgrind_massif_per_api(stack_test_binary, dump_massif=False):
 
         return (
             True,
-            f"API-specific stack usage (measured with valgrind massif):\n"
+            "API-specific stack usage (measured with valgrind massif):\n"
             + "\n".join(result_lines),
         )