Skip to content
v0.1.3

Config Module API Reference

This section documents the internals of the config module in Bijux CLI.

bijux_cli.contracts.config

Defines the contract for the application configuration service.

This module specifies the ConfigProtocol, a formal interface that any configuration management service within the application must implement. This ensures a consistent API for loading, accessing, modifying, and persisting key-value settings, promoting modularity and testability.

ConfigProtocol

Bases: Protocol

Defines the contract for application configuration management.

This interface specifies the methods for loading, accessing, modifying, and persisting configuration data from various sources (e.g., .env, JSON, or YAML files).

all 

all() -> dict[str, str]

Returns all configuration key-value pairs.

Returns:

  • dict[str, str] –

    dict[str, str]: A dictionary of all configuration data.

Source code in src/bijux_cli/contracts/config.py 
121
122
123
124
125
126
127
def all(self) -> dict[str, str]:
    """Returns all configuration key-value pairs.

    Returns:
        dict[str, str]: A dictionary of all configuration data.
    """
    ...

clear 

clear() -> None

Clears all configuration data from memory.

Source code in src/bijux_cli/contracts/config.py 
109
110
111
def clear(self) -> None:
    """Clears all configuration data from memory."""
    ...

delete 

delete(key: str) -> None

Deletes a configuration key and persists the change.

Parameters:

  • key (str) –

    The key to delete.

Returns:

  • None ( None ) –
Source code in src/bijux_cli/contracts/config.py 
84
85
86
87
88
89
90
91
92
93
def delete(self, key: str) -> None:
    """Deletes a configuration key and persists the change.

    Args:
        key (str): The key to delete.

    Returns:
        None:
    """
    ...

export 

export(
    path: str | Path, out_format: str | None = None
) -> None

Exports the current configuration to a file.

Parameters:

  • path (str | Path) –

    The path to the destination file.

  • out_format (str | None, default: None ) –

    The desired output format (e.g., 'env'). If None, the format may be inferred from the path.

Returns:

  • None ( None ) –
Source code in src/bijux_cli/contracts/config.py 
63
64
65
66
67
68
69
70
71
72
73
74
def export(self, path: str | Path, out_format: str | None = None) -> None:
    """Exports the current configuration to a file.

    Args:
        path (str | Path): The path to the destination file.
        out_format (str | None): The desired output format (e.g., 'env').
            If None, the format may be inferred from the path.

    Returns:
        None:
    """
    ...

get 

get(key: str, default: Any = None) -> Any

Retrieves a configuration value by its key.

Parameters:

  • key (str) –

    The key of the value to retrieve.

  • default (Any, default: None ) –

    The value to return if the key is not found.

Returns:

  • Any ( Any ) –

    The configuration value or the provided default.

Source code in src/bijux_cli/contracts/config.py 
39
40
41
42
43
44
45
46
47
48
49
def get(self, key: str, default: Any = None) -> Any:
    """Retrieves a configuration value by its key.

    Args:
        key (str): The key of the value to retrieve.
        default (Any): The value to return if the key is not found.

    Returns:
        Any: The configuration value or the provided default.
    """
    ...

list_keys 

list_keys() -> list[str]

Returns a list of all configuration keys.

Returns:

  • list[str] –

    list[str]: A list of all keys present in the configuration.

Source code in src/bijux_cli/contracts/config.py 
113
114
115
116
117
118
119
def list_keys(self) -> list[str]:
    """Returns a list of all configuration keys.

    Returns:
        list[str]: A list of all keys present in the configuration.
    """
    ...

load 

load(path: str | Path | None = None) -> None

Loads configuration from a specified file path.

Parameters:

  • path (str | Path | None, default: None ) –

    The path to the configuration file. If None, the service may load from a default location.

Returns:

  • None ( None ) –
Source code in src/bijux_cli/contracts/config.py 
27
28
29
30
31
32
33
34
35
36
37
def load(self, path: str | Path | None = None) -> None:
    """Loads configuration from a specified file path.

    Args:
        path (str | Path | None): The path to the configuration file. If
            None, the service may load from a default location.

    Returns:
        None:
    """
    ...

reload 

reload() -> None

Reloads the configuration from its last-known source file.

Source code in src/bijux_cli/contracts/config.py 
76
77
78
def reload(self) -> None:
    """Reloads the configuration from its last-known source file."""
    ...

save 

save() -> None

Saves the current in-memory configuration state to its source file.

Source code in src/bijux_cli/contracts/config.py 
80
81
82
def save(self) -> None:
    """Saves the current in-memory configuration state to its source file."""
    ...

set 

set(key: str, value: Any) -> None

Sets a configuration key and persists the change.

Parameters:

  • key (str) –

    The key to set or update.

  • value (Any) –

    The value to associate with the key.

Returns:

  • None ( None ) –
Source code in src/bijux_cli/contracts/config.py 
51
52
53
54
55
56
57
58
59
60
61
def set(self, key: str, value: Any) -> None:
    """Sets a configuration key and persists the change.

    Args:
        key (str): The key to set or update.
        value (Any): The value to associate with the key.

    Returns:
        None:
    """
    ...

unset 

unset(key: str) -> None

Removes a configuration key from the current in-memory session.

Unlike delete, this operation may not be immediately persisted to the source file.

Parameters:

  • key (str) –

    The key to remove from the in-memory configuration.

Returns:

  • None ( None ) –
Source code in src/bijux_cli/contracts/config.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def unset(self, key: str) -> None:
    """Removes a configuration key from the current in-memory session.

    Unlike `delete`, this operation may not be immediately persisted to the
    source file.

    Args:
        key (str): The key to remove from the in-memory configuration.

    Returns:
        None:
    """
    ...