Files
computer-playbook/utils/env/builder.py
T
kevinveenbirkenbachandClaude Opus 4.7 22cf6f38f1 refactor(env+make): rename static.env→default.env + sort + lint gates
Rename env/static.env → env/default.env across the entire repo
(string label, doc links, Python file-path constants) — the
`parse_static_env*` function names stay as a stable API surface.

Sort all `*.env` / `*.env.j2` entries alphabetically (52 in
default.env, 4 in ci.env, 46 of 49 j2 templates; 3 templates
with Jinja2 `{% %}` control flow are skipped because conditional
blocks would tear apart under a naive sort). Sort all 83
Makefile target blocks alphabetically; .PHONY group headers
stay in place.

Collapse the two remaining multi-line Makefile recipe comments
(dotenv-force, test-signed) to single-line WHY comments.

Add four lint tests under tests/lint/filesystem/ to keep the
invariants enforced going forward:
- env/test_alphabetical_sort.py
- env/test_single_line_comments.py        (# nocheck: markers exempt)
- makefile/test_alphabetical_targets.py
- makefile/test_single_line_comments.py   (# nocheck: markers exempt)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-20 22:26:16 +02:00

94 lines
2.7 KiB
Python

"""Compose the `.env` value-set from static defaults plus runtime context.
Thin orchestrator: each variable's mapping/computation lives in its own
module under :mod:`utils.env.handlers`. ``build_env`` walks the
``ORDERED_HANDLERS`` registry, letting each handler read/write through
an :class:`EnvBuilder`.
"""
from __future__ import annotations
import os
from dataclasses import dataclass
from typing import TYPE_CHECKING
from utils.env.handlers import ORDERED_HANDLERS
from utils.env.runtime import detect_gha_act
if TYPE_CHECKING:
from pathlib import Path
@dataclass(frozen=True)
class BuildContext:
"""Per-build inputs passed to every handler.
Attributes are read-only; per-handler scratch state lives on the
:class:`EnvBuilder` instead.
"""
static: dict[str, str]
static_comments: dict[str, str]
repo_root: Path
on_gha: bool
on_act: bool
class EnvBuilder:
"""Mirror bash ``: "${KEY:=value}"`` semantics with per-key comments.
``setdefault`` falls back to the supplied value only when the
process env has no non-empty value for the key. ``set`` is
unconditional. ``get`` reads from the builder, falling back to the
process env so derived values (e.g. ``INFINITO_CONTAINER``) can be
composed off previously-set keys.
"""
def __init__(self) -> None:
self.values: dict[str, str] = {}
self.comments: dict[str, str] = {}
def setdefault(self, key: str, value: str, *, comment: str = "") -> str:
existing = os.environ.get(key, "").strip()
self.values[key] = existing or value
if comment:
self.comments.setdefault(key, comment)
return self.values[key]
def set(self, key: str, value: str, *, comment: str = "") -> str:
self.values[key] = value
if comment:
self.comments.setdefault(key, comment)
return value
def get(self, key: str) -> str:
return self.values.get(key, os.environ.get(key, ""))
def build_env(
static: dict[str, str],
repo_root: Path,
*,
comments: dict[str, str] | None = None,
) -> EnvBuilder:
"""Compose the full env-set from ``static`` (parsed env/default.env) +
runtime context resolved against ``repo_root``.
``comments`` is the parsed per-key comment map from env/default.env
(see :func:`utils.env.parser.parse_static_env_with_comments`).
Dynamic keys carry their comments via each handler's ``COMMENT``
constant.
"""
on_gha, on_act = detect_gha_act()
ctx = BuildContext(
static=static,
static_comments=comments or {},
repo_root=repo_root,
on_gha=on_gha,
on_act=on_act,
)
eb = EnvBuilder()
for handler in ORDERED_HANDLERS:
handler.apply(eb, ctx)
return eb