mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 19:01:54 +00:00
kevinveenbirkenbachandClaude Opus 4.7
12a56e449d
With env.development and env/ci.env both gone, env/default.env was the
last inhabitant of the directory. Hoisting it to the repo root removes
the empty-shell indirection: the SPOT is now [default.env](default.env),
sitting next to .env (its generated companion) and other repo-root
configuration artefacts like compose.yml, Dockerfile, and Makefile.
Path updates land in:
- generator: cli/meta/env/__main__.py (REPO_ROOT / "default.env")
- workflow: .github/workflows/test-install-make.yml (awk reads from
default.env, error message updated in lockstep)
- lint tests: test_used_keys_declared.py and test_infinito_prefix.py
switched from globbing env/*.env to targeting default.env directly;
test_default_env_keys_handled.py points at the new path
- drift test: test_inventory_vars_file_spot.py whitelist + STATIC_ENV
- smoke test: tests/integration/meta/env/test_dotenv_generator.py
STATIC_ENV + every docstring/error message
Doc-string and prose references in utils/env/*, scripts/*,
cli/administration/deploy/development/{common,coredns}.py,
Makefile, Dockerfile, and every doc page that mentioned env/default.env
are rewritten in the same pass so future readers see one path.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
94 lines
2.7 KiB
Python
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 default.env) +
|
|
runtime context resolved against ``repo_root``.
|
|
|
|
``comments`` is the parsed per-key comment map from 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
|