Skip to content

Profile

profile

current_profile()

Return the active, lexically validated state profile.

Source code in packages/axm-config/src/axm_config/profile.py
Python
35
36
37
38
39
40
41
42
def current_profile() -> str:
    """Return the active, lexically validated state profile."""
    profile = os.environ.get(PROFILE_ENV_VAR)
    if not profile:
        sandbox = active_sandbox()
        launch = sandbox.launch_profile if sandbox is not None else None
        profile = launch or DEFAULT_PROFILE
    return validate_profile_name(profile)

profile_config_path()

Return the config store path for the active profile.

Source code in packages/axm-config/src/axm_config/profile.py
Python
66
67
68
69
70
71
def profile_config_path() -> Path:
    """Return the config store path for the active profile."""
    root = profile_root()
    if root is None:
        return axm_home_path() / "config.toml"
    return root / "config.toml"

profile_env()

Return the environment overlay that propagates the active profile.

Source code in packages/axm-config/src/axm_config/profile.py
Python
74
75
76
def profile_env() -> dict[str, str]:
    """Return the environment overlay that propagates the active profile."""
    return {PROFILE_ENV_VAR: current_profile()}

profile_root()

Return the isolated state root, or None for production.

Source code in packages/axm-config/src/axm_config/profile.py
Python
45
46
47
def profile_root() -> Path | None:
    """Return the isolated state root, or None for production."""
    return profile_root_for(current_profile())

profile_root_for(profile)

Return the state root of profile, or None for the default one.

The named counterpart of :func:profile_root: it answers for an arbitrary profile instead of the active one, so a caller can ask what a profile would use without mutating AXM_PROFILE. Pure computation -- the root hangs below :func:axm_home_path, so no directory is created, and the deliberate asymmetry is preserved: AXM_HOME only selects the config.toml that is read, never this convention.

Source code in packages/axm-config/src/axm_config/profile.py
Python
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def profile_root_for(profile: str) -> Path | None:
    """Return the state root of ``profile``, or None for the default one.

    The named counterpart of :func:`profile_root`: it answers for an arbitrary
    profile instead of the active one, so a caller can ask what a profile
    *would* use without mutating ``AXM_PROFILE``. Pure computation -- the root
    hangs below :func:`axm_home_path`, so no directory is created, and the
    deliberate asymmetry is preserved: ``AXM_HOME`` only selects the
    ``config.toml`` that is read, never this convention.
    """
    validated = validate_profile_name(profile)
    if validated == DEFAULT_PROFILE:
        return None
    return axm_home_path() / "profiles" / validated

validate_profile_name(name)

Return a valid profile name or raise :class:ConfigError.

Source code in packages/axm-config/src/axm_config/profile.py
Python
27
28
29
30
31
32
def validate_profile_name(name: str) -> str:
    """Return a valid profile name or raise :class:`ConfigError`."""
    if not _PROFILE_RE.fullmatch(name):
        msg = f"invalid profile {name!r}: must match {_PROFILE_RE.pattern}"
        raise ConfigError(msg)
    return name