chore: add a utility to generate a schema file

Signed-off-by: Henry Schreiner <[email protected]>

Author: henryiii

misc/make_schema.py

@@ -0,0 +1,108 @@
+from __future__ import annotations
+
+import dataclasses
+import json
+import re
+import textwrap
+from collections.abc import Generator, Sequence
+from pathlib import Path
+from typing import Any
+
+DIR = Path(__file__).parent.resolve()
+
+
+@dataclasses.dataclass(frozen=True)
+class ConfigOpt:
+    name: str
+    type_str: str
+    is_global: bool
+    description: str
+    default: str | None
+
+    def define(self) -> dict[str, str]:
+        retval: dict[str, Any] = {"description": self.description}
+        if self.default is not None:
+            match self.type_str:
+                case "boolean":
+                    retval["default"] = {"true": True, "false": False}[self.default.lower()]
+                case "integer":
+                    retval["default"] = int(self.default)
+                case "string":
+                    retval["default"] = self.default.strip("`")
+                case _:
+                    msg = f"Default not suppored for {self.type_str}"
+                    raise RuntimeError(msg)
+        match self.type_str:
+            case "boolean" | "integer" | "string":
+                retval["type"] = self.type_str
+            case "comma-separated list of strings" | "regular expression":
+                retval["oneOf"] = [
+                    {"type": "string"},
+                    {"type": "array", "items": {"type": "string"}},
+                ]
+            case _:
+                msg = f"{self.type_str} not supported for type"
+                raise RuntimeError(msg)
+
+        return retval
+
+
+def parse_rst_docs(txt: str) -> Generator[ConfigOpt, None, None]:
+    for match in re.finditer(r".. confval:: ([^\s]*)\n\n((?:    .*\n|\n)*)", txt):
+        name, body = match.groups()
+        body = textwrap.dedent(body)
+        body_match = re.match(r":type: (.*?)\n(?::default: (.*?)\n)?(.*)$", body, re.DOTALL)
+        assert body_match is not None
+        type_str, default, inner = body_match.groups()
+        is_global = "only be set in the global section" in body
+        description = inner.strip().split("\n\n")[0].replace("\n", " ")
+        # Patches
+        if name == "mypy_path":
+            type_str = "comma-separated list of strings"
+        yield ConfigOpt(
+            name=name,
+            type_str=type_str,
+            is_global=is_global,
+            description=description,
+            default=default,
+        )
+
+
+def make_schema(opts: Sequence[ConfigOpt]) -> dict[str, Any]:
+    definitions = {s.name: s.define() for s in opts}
+    overrides = {s.name: {"$ref": f"#/properties/{s.name}"} for s in opts if not s.is_global}
+    module = {
+        "oneOf": [
+            {"type": "string"},
+            {"type": "array", "items": {"type": "string"}, "minItems": 1},
+        ]
+    }
+
+    # Improve some fields
+    definitions["follow_imports"]["enum"] = ["normal", "silent", "skip", "error"]
+
+    return {
+        "$id": "https://json.schemastore.org/mypy.json",
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "additionalProperties": False,
+        "type": "object",
+        "properties": {
+            **definitions,
+            "overrides": {
+                "type": "array",
+                "items": {
+                    "type": "object",
+                    "additionalProperties": False,
+                    "required": ["module"],
+                    "minProperties": 2,
+                    "properties": {"module": module, **overrides},
+                },
+            },
+        },
+    }
+
+
+if __name__ == "__main__":
+    filepath = DIR.parent / "docs/source/config_file.rst"
+    opts = parse_rst_docs(filepath.read_text())
+    print(json.dumps(make_schema(list(opts)), indent=2))