"""The "Report a run" GitHub issue form, written from collection/specs/report_form.yaml, and the parser for the issues it creates (GitHub renders each answer as "### " followed by the answer).""" import re import yaml from .common import read_yaml class _Dumper(yaml.SafeDumper): pass def _str(dumper, s): # multi-line text (the intro) as a readable block return dumper.represent_scalar("tag:yaml.org,2002:str", s, style="|" if "\n" in s else None) _Dumper.add_representer(str, _str) SPEC_PATH = "collection/specs/report_form.yaml" TEMPLATE = ".github/ISSUE_TEMPLATE/report-a-run.yml" NOT_SURE = "Not sure" NO_RESPONSE = {"", "_No response_", "None", NOT_SURE} def spec(): return read_yaml(SPEC_PATH) def render(s=None): s = s or spec() body = [{"type": "markdown", "attributes": {"value": s["intro"]}}] for f in s["fields"]: if f.get("type") == "integer": item = {"type": "input", "id": f["id"], "attributes": {"label": f["label"], "placeholder": "e.g. 3"}} else: opts = list(f["options"]) if not f.get("required"): opts.append(NOT_SURE) item = {"type": "dropdown", "id": f["id"], "attributes": {"label": f["label"], "options": opts}} item["validations"] = {"required": bool(f.get("required"))} body.append(item) form = {"name": s["name"], "description": s["description"], "title": s["title"], "labels": [s["label"]], "body": body} head = f"# Written by collection/etl/report_form.py from {SPEC_PATH}: edit that file, then run `python -m collection build`.\n" return head + yaml.dump(form, Dumper=_Dumper, sort_keys=False, allow_unicode=True, width=1000) def parse_body(body, s=None): """Issue body -> {field id: chosen option label or text}. Unanswered questions are left out.""" s = s or spec() by_label = {f["label"].strip(): f["id"] for f in s["fields"]} out = {} for block in re.split(r"^### ", body or "", flags=re.M)[1:]: q, _, a = block.partition("\n") fid = by_label.get(q.strip()) a = a.strip() if fid and a not in NO_RESPONSE: out[fid] = a return out