volaro 0.0.2 → 0.1.0-alpha.3

package/compiler/validator/vlcheck/project_config.py

@@ -0,0 +1,97 @@
+"""Shared, read-only versioned project configuration for checker and builder."""
+from dataclasses import dataclass
+import json
+from pathlib import Path
+
+
+class ConfigError(ValueError):
+    def __init__(self, code, path, message):
+        self.code, self.path = code, path
+        super().__init__(f"{code}: {path}: {message}")
+
+
+@dataclass(frozen=True)
+class ProjectConfig:
+    emit_ids: bool = True
+    path: Path | None = None
+
+
+CONFIG_NAME = "volaro.json"
+LEGACY_CONFIG_NAME = "volara.json"
+
+
+def _legacy_error(target, *, both):
+    # The project config was renamed volara.json -> volaro.json. The old name is
+    # never read: silently ignoring it would flip a project's emit_ids default,
+    # and silently preferring the new name when both exist hides a half-done
+    # migration. Both cases fail loudly with the fix in the message.
+    if both:
+        message = (f"both {CONFIG_NAME} and the legacy {LEGACY_CONFIG_NAME} are "
+                   f"present; reconcile the settings into {CONFIG_NAME}, then "
+                   f"remove {LEGACY_CONFIG_NAME} (config was renamed "
+                   f"{LEGACY_CONFIG_NAME} → {CONFIG_NAME}; the files may differ)")
+    else:
+        message = (f"rename {LEGACY_CONFIG_NAME} to {CONFIG_NAME}; the old name "
+                   f"is no longer read (config was renamed {LEGACY_CONFIG_NAME} "
+                   f"→ {CONFIG_NAME})")
+    return ConfigError("E-CONFIG-LEGACY", target, message)
+
+
+def load_config(source, explicit=None):
+    if explicit is not None:
+        path = Path(explicit).absolute()
+        if path.name == LEGACY_CONFIG_NAME:
+            raise _legacy_error(path, both=False)
+    else:
+        path = None
+        start = Path(source).resolve()
+        start = start if start.is_dir() else start.parent
+        for directory in (start, *start.parents):
+            candidate = directory / CONFIG_NAME
+            legacy = directory / LEGACY_CONFIG_NAME
+            here = candidate.exists() or candidate.is_symlink()
+            legacy_here = legacy.exists() or legacy.is_symlink()
+            if here and legacy_here:
+                raise _legacy_error(legacy, both=True)
+            if legacy_here:
+                raise _legacy_error(legacy, both=False)
+            if here:
+                path = candidate
+                break
+            if (directory / ".git").exists():
+                break
+    if path is None:
+        return ProjectConfig()
+
+    def pairs(items):
+        obj = {}
+        for key, value in items:
+            if key in obj:
+                raise ConfigError("E-CONFIG-JSON", path, "duplicate object key; remove the duplicate")
+            obj[key] = value
+        return obj
+
+    try:
+        raw = path.read_text(encoding="utf-8")
+    except (OSError, UnicodeError) as exc:
+        raise ConfigError("E-CONFIG-READ", path, "cannot read UTF-8 configuration") from exc
+    try:
+        data = json.loads(raw, object_pairs_hook=pairs,
+                          parse_constant=lambda _: (_ for _ in ()).throw(ValueError()))
+    except (ValueError, RecursionError) as exc:
+        if isinstance(exc, ConfigError):
+            raise
+        raise ConfigError("E-CONFIG-JSON", path, "invalid JSON; use a JSON object") from exc
+    if not isinstance(data, dict):
+        raise ConfigError("E-CONFIG-OPTION", path, "configuration must be an object")
+    if type(data.get("schema_version")) is not int or data["schema_version"] != 1:
+        raise ConfigError("E-CONFIG-VERSION", path, "schema_version must be integer 1")
+    if set(data) - {"schema_version", "testing"}:
+        raise ConfigError("E-CONFIG-OPTION", path, "unsupported top-level option")
+    testing = data.get("testing", {})
+    if not isinstance(testing, dict) or set(testing) - {"emit_ids"}:
+        raise ConfigError("E-CONFIG-OPTION", path, "testing supports only emit_ids")
+    emit = testing.get("emit_ids", True)
+    if type(emit) is not bool:
+        raise ConfigError("E-CONFIG-OPTION", path, "testing.emit_ids must be boolean")
+    return ProjectConfig(emit, path)