From 3211d3a78d8702e8a893e091ef42d16b90b28d05 Mon Sep 17 00:00:00 2001
From: Florian Fischer <florian.fischer@muhq.space>
Date: Mon, 19 May 2025 18:56:29 -0600
Subject: improve code style

---
 scripts/prepare_html_rules.py | 60 ++++++++++++++++++++++++++-----------------
 1 file changed, 36 insertions(+), 24 deletions(-)

(limited to 'scripts')

diff --git a/scripts/prepare_html_rules.py b/scripts/prepare_html_rules.py
index 4d533bec..aca29932 100755
--- a/scripts/prepare_html_rules.py
+++ b/scripts/prepare_html_rules.py
@@ -1,44 +1,56 @@
 #!/usr/bin/env python3
+"""Add ids to all rules based on their headline"""
 # TODO: support nested lists
 
 import sys
 import re
 
+HEADER_RE = re.compile(r'<h\d')
+DATA_NUMBER_RE = re.compile(r'data\-number="([^"]*)"')
+
+
 def add_ids(ol):
     """add ids to all li"""
-    id = ""
+    _id = ""
     for s in ol.previous_siblings:
         if not s.name:
             continue
         if s.name.startswith("h"):
-            id = s.attrs["data-number"]
+            _id = s.attrs["data-number"]
             break
 
     for i, li in enumerate(ol.find_all("li")):
-        li["id"] = f"{id}-{i+1}"
+        li["id"] = f"{_id}-{i+1}"
         li["class"] = "rule"
 
-header_re = re.compile(r'<h\d')
-data_number_re = re.compile(r'data\-number="([^"]*)"')
+
 def extract_headline_nr(line: str) -> str:
-    m = data_number_re.search(line)
+    """Extract the headline's number from it's data-number attribute"""
+    m = DATA_NUMBER_RE.search(line)
     if m:
         return m.group(1)
-    else:
-        return ""
-
-headline = ""
-i = 0
-for line in sys.stdin.readlines():
-    if header_re.match(line):
-        headline = extract_headline_nr(line)
-        h_idx = line.find('<h') + 3
-        line = line[:h_idx] + ' class="rule"' + line[h_idx:]
-    if '<ol' in line and headline:
-        i = 1
-    if '<li' in line and i:
-        line = line.replace('<li', f'<li id="{headline}-{i}" class="rule"')
-        i = i + 1
-    if '</ol' in line:
-        i = 0
-    print(line, end="")
+
+    return ""
+
+
+def main():
+    """Add ids to all ordered lists in the input"""
+    headline = ""
+    i = 0
+    for line in sys.stdin.readlines():
+        if HEADER_RE.match(line):
+            headline = extract_headline_nr(line)
+            h_idx = line.find('<h') + 3
+            line = line[:h_idx] + ' class="rule"' + line[h_idx:]
+        if '<ol' in line and headline:
+            i = 1
+        if '<li' in line and i:
+            line = line.replace('<li', f'<li id="{headline}-{i}" class="rule"')
+            i = i + 1
+        if '</ol' in line:
+            i = 0
+        print(line, end="")
+
+
+if __name__ == "__main__":
+    main()
-- 
cgit v1.2.3