Merge pull request #8 from wimglenn/extra

extra context

Author: wimglenn

.github/workflows/tests.yml

@@ -30,14 +30,10 @@ jobs:
         run: uv python install ${{ matrix.py-version }}
 
       - name: Install
-        run: |
-          uv venv
-          uv pip install -r tests/requirements.txt --editable .
+        run: uv venv && uv pip install -r tests/requirements.txt --editable .
 
       - name: Run tests for ${{ matrix.python-version }} on ${{ matrix.os }}
         run: uv run pytest
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}

aocd_example_parser/examples.json

@@ -793,7 +793,7 @@
     {
       "answer_a":   "a_code[-5]",
       "answer_b":   "None",
-      "extra":      {"microchips":  [5, 2]}
+      "extra":      {"chip1": 5, "chip2": 2}
     }
   ],
   "2016/12": [
@@ -1183,7 +1183,8 @@
   ],
   "2017/16": [
     {
-      "input_data": "','.join([li.codes[0] for li in a_li[3:]])"
+      "input_data": "','.join([li.codes[0] for li in a_li[3:]])",
+      "extra":      {"n_programs":  5, "iterations": 2}
     }
   ],
   "2017/17": [
@@ -1757,12 +1758,12 @@
     {
       "answer_a":   "a_code[-4]",
       "answer_b":   "b_code[0]",
-      "extra":      {"ta": 10}
+      "extra":      {"iterations": 10}
     },
     {
       "input_data": "a_pre[3]",
       "answer_a":   "a_pre[4].split()[-1]",
-      "extra":      {"ta": 100}
+      "extra":      {"iterations": 100}
     }
   ],
   "2019/13": [],
@@ -1892,7 +1893,7 @@
   "2019/24": [
     {
       "input_data": "a_pre[0][15:45]",
-      "extra":      {"tb": 10}
+      "extra":      {"iterations": 10}
     }
   ],
   "2019/25": [],
@@ -2518,7 +2519,7 @@
   ],
   "2023/21": [
     {
-      "answer_a":   "a_code[-3]",
+      "answer_a":   "a_code[-4]",
       "answer_b":   "b_code[6]",
       "extra":      {"n_steps": 6}
     },

tests/integration.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+import ast
 import pathlib
 import sys
 
@@ -11,13 +12,40 @@
 input_dir = here.parent.parent / "advent-of-code-wim" / "tests"
 
 
-def remove_trailing_comments(lines):
+def split_trailing_comments(lines):
+    extra = []
     while lines and (not lines[-1].strip() or lines[-1].startswith("#")):
-        lines.pop()
-    if len(lines):
-        lines[-1] = lines[-1].split("#")[0].strip()
-    if len(lines) > 1:
-        lines[-2] = lines[-2].split("#")[0].strip()
+        extra.append(lines.pop())
+    if len(lines) and "#" in lines[-1]:
+        line, comment = lines[-1].split("#", 1)
+        lines[-1] = line.strip()
+        extra.append(comment.strip())
+    if len(lines) > 1 and "#" in lines[-2]:
+        line, comment = lines[-2].split("#", 1)
+        lines[-2] = line.strip()
+        extra.append(comment.strip())
+    extra = [x.strip() for x in extra if x.strip()]
+    return extra
+
+
+def parse_extra_context(extra):
+    result = {}
+    for line in extra:
+        equals = line.count("=")
+        commas = line.count(",")
+        if equals and equals == commas + 1:
+            for part in line.split(","):
+                k, v = part.strip().split("=")
+                k = k.strip()
+                v = v.strip()
+                try:
+                    v = ast.literal_eval(v)
+                except ValueError:
+                    pass
+                if k in result:
+                    raise NotImplementedError(f"Duplicate key {k!r}")
+                result[k] = v
+    return result
 
 
 def main():
@@ -40,7 +68,8 @@ def main():
                     rc += 1
                     continue
             lines = example_file.read_text(encoding="utf-8").splitlines()
-            remove_trailing_comments(lines)
+            extra = split_trailing_comments(lines)
+            expected_extra = parse_extra_context(extra)
             *lines, expected_answer_a, expected_answer_b = lines
             expected_input_data = "\n".join(lines).rstrip()
             diff = compare(
@@ -60,6 +89,15 @@ def main():
                 if diff is not None:
                     print(f"incorrect answer {part} ({i}) for", puzzle.url, diff)
                     rc += 1
+            if example.extra or expected_extra:
+                diff = compare(
+                    actual=example.extra,
+                    expected=expected_extra,
+                    raises=False,
+                )
+                if diff is not None:
+                    print(f"incorrect extra ({i}) for", puzzle.url, diff)
+                    rc += 1
     sys.exit(rc)
 
 

tests/test_extra_context.py

@@ -19,4 +19,4 @@ def test_locator_extra_context():
     page = Page.from_raw(html=fake_prose)
     examples = extract_examples(page)
     [example] = examples
-    assert example.extra == {"microchips": [5, 2]}
+    assert example.extra == {"chip1": 5, "chip2": 2}