Skip to content

dirs

🤖 AI-Generated Content

This documentation was generated with AI assistance and is still being audited. Some, or potentially a lot, of this information may be inaccurate. Learn more.

flavor.config.dirs

XDG-compliant config directory resolution for Flavor.

Functions

get_config_dir 

get_config_dir() -> Path

Get the user-level config directory for Flavor.

Uses XDG Base Directory specification: - FLAVOR_CONFIG_DIR environment variable if set - XDG_CONFIG_HOME/flavor if XDG_CONFIG_HOME is set - ~/.config/flavor by default

Source code in flavor/config/dirs.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
def get_config_dir() -> Path:
    """Get the user-level config directory for Flavor.

    Uses XDG Base Directory specification:
    - FLAVOR_CONFIG_DIR environment variable if set
    - XDG_CONFIG_HOME/flavor if XDG_CONFIG_HOME is set
    - ~/.config/flavor by default
    """
    # Check FLAVOR_CONFIG_DIR override first
    config_dir = get_str(ENV_CONFIG_DIR)
    if config_dir:
        if log.is_trace_enabled():
            log.trace(f"🗂️ Using FLAVOR_CONFIG_DIR: {config_dir}")
        return Path(config_dir)

    # Use XDG_CONFIG_HOME if set (respects XDG Base Directory standard)
    xdg_config = get_str("XDG_CONFIG_HOME")
    if xdg_config:
        result = Path(xdg_config) / "flavor"
        if log.is_trace_enabled():
            log.trace(f"🗂️ Using XDG_CONFIG_HOME: {result}")
        return result

    # Default to ~/.config/flavor
    default = Path.home() / ".config" / "flavor"
    if log.is_trace_enabled():
        log.trace(f"🗂️ Using default config dir: {default}")
    return default

get_policy_file 

get_policy_file(*, system: bool = False) -> Path

Get the policy file path for Flavor.

Returns the path to policy.json in the appropriate config directory.

Parameters:

Name Type Description Default
system bool

If True, return the system-level policy file. If False (default), return the user-level policy file.

 False
Source code in flavor/config/dirs.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
def get_policy_file(*, system: bool = False) -> Path:
    """Get the policy file path for Flavor.

    Returns the path to policy.json in the appropriate config directory.

    Args:
        system: If True, return the system-level policy file.
                If False (default), return the user-level policy file.
    """
    config_dir = get_system_config_dir() if system else get_config_dir()
    result = config_dir / "policy.json"
    if log.is_trace_enabled():
        log.trace(f"🗂️ Using {'system' if system else 'user'} policy file: {result}")
    return result

get_system_config_dir 

get_system_config_dir() -> Path

Get the system-level config directory for Flavor.

  • Linux/macOS: /etc/flavor
  • Windows: %PROGRAMDATA%\flavor
Source code in flavor/config/dirs.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def get_system_config_dir() -> Path:
    """Get the system-level config directory for Flavor.

    - Linux/macOS: /etc/flavor
    - Windows: %PROGRAMDATA%\\flavor
    """
    if sys.platform == "win32":
        programdata = get_str("PROGRAMDATA") or "C:\\ProgramData"
        result = Path(programdata) / "flavor"
        if log.is_trace_enabled():
            log.trace(f"🗂️ Using Windows system config dir: {result}")
        return result

    result = Path("/etc/flavor")
    if log.is_trace_enabled():
        log.trace(f"🗂️ Using system config dir: {result}")
    return result

get_trusted_keys_dir 

get_trusted_keys_dir(*, system: bool = False) -> Path

Get the trusted keys directory for Flavor.

Parameters:

Name Type Description Default
system bool

If True, return the system-level trusted keys directory. If False (default), check FLAVOR_TRUSTED_KEYS_DIR env var first, then fall back to get_config_dir() / "trusted-keys".

 False
Source code in flavor/config/dirs.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
def get_trusted_keys_dir(*, system: bool = False) -> Path:
    """Get the trusted keys directory for Flavor.

    Args:
        system: If True, return the system-level trusted keys directory.
                If False (default), check FLAVOR_TRUSTED_KEYS_DIR env var first,
                then fall back to get_config_dir() / "trusted-keys".
    """
    if system:
        result = get_system_config_dir() / "trusted-keys"
        if log.is_trace_enabled():
            log.trace(f"🗂️ Using system trusted keys dir: {result}")
        return result

    # Check FLAVOR_TRUSTED_KEYS_DIR override first
    trusted_keys_dir = get_str(ENV_TRUSTED_KEYS_DIR)
    if trusted_keys_dir:
        if log.is_trace_enabled():
            log.trace(f"🗂️ Using FLAVOR_TRUSTED_KEYS_DIR: {trusted_keys_dir}")
        return Path(trusted_keys_dir)

    result = get_config_dir() / "trusted-keys"
    if log.is_trace_enabled():
        log.trace(f"🗂️ Using default trusted keys dir: {result}")
    return result