Skip to content
v0.1.3

Context Module API Reference

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

bijux_cli.core.context

Provides a concrete implementation for request-scoped context management.

This module defines the Context class, which implements the ContextProtocol. It uses Python's contextvars to provide a thread-safe and async-safe mechanism for storing and retrieving key-value data associated with a specific command execution or request. This allows state to be passed through the application's call stack without explicit argument passing.

Context 

Context(di: DIContainer)

Bases: ContextProtocol

Provides thread-safe, request-scoped storage for CLI commands.

This class uses contextvars to manage a dictionary of data that is isolated to the current task or thread. It is intended to be used as both a synchronous and asynchronous context manager.

Attributes:

  • _di (DIContainer) –

    The dependency injection container.

  • _log (ObservabilityProtocol) –

    The logging service.

  • _data (dict[str, Any]) –

    The dictionary storing the context's data.

  • _token (Token | None) –

    The token for resetting the ContextVar.

Initializes a new Context instance.

Parameters:

  • di (DIContainer) –

    The dependency injection container used to resolve the logging service.

Source code in src/bijux_cli/core/context.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
@inject
def __init__(self, di: DIContainer) -> None:
    """Initializes a new Context instance.

    Args:
        di (DIContainer): The dependency injection container used to
            resolve the logging service.
    """
    self._di = di
    self._log: ObservabilityProtocol = di.resolve(ObservabilityProtocol)
    self._data: dict[str, Any] = {}
    self._token: Token[dict[str, Any] | None] | None = None
    if os.getenv("VERBOSE_DI") and not os.getenv("BIJUXCLI_TEST_MODE"):
        self._log.log("debug", "Context initialized", extra={})

clear 

clear() -> None

Removes all values from the context's data.

Source code in src/bijux_cli/core/context.py 
101
102
103
104
105
def clear(self) -> None:
    """Removes all values from the context's data."""
    self._data.clear()
    if os.getenv("VERBOSE_DI") and not os.getenv("BIJUXCLI_TEST_MODE"):
        self._log.log("debug", "Context cleared", extra={})

current_data classmethod 

current_data() -> dict[str, Any]

Returns the dictionary for the currently active CLI context.

This provides direct access to the data stored in the underlying contextvar for the current execution scope.

Returns:

  • dict[str, Any] –

    dict[str, Any]: The active context data dictionary.

Source code in src/bijux_cli/core/context.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
@classmethod
def current_data(cls) -> dict[str, Any]:
    """Returns the dictionary for the currently active CLI context.

    This provides direct access to the data stored in the underlying
    `contextvar` for the current execution scope.

    Returns:
        dict[str, Any]: The active context data dictionary.
    """
    data = _current_context.get()
    if data is None:
        data = {}
        _current_context.set(data)
    return data

get 

get(key: str) -> Any

Gets a value from the current context's data.

Parameters:

  • key (str) –

    The key of the value to retrieve.

Returns:

  • Any ( Any ) –

    The value associated with the key.

Raises:

  • KeyError –

    If the key is not found in the context.

Source code in src/bijux_cli/core/context.py 
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
def get(self, key: str) -> Any:
    """Gets a value from the current context's data.

    Args:
        key (str): The key of the value to retrieve.

    Returns:
        Any: The value associated with the key.

    Raises:
        KeyError: If the key is not found in the context.
    """
    if key not in self._data:
        if os.getenv("VERBOSE_DI") and not os.getenv("BIJUXCLI_TEST_MODE"):
            self._log.log("warning", "Context key not found", extra={"key": key})
        raise KeyError(f"Key '{key}' not found in context")
    if os.getenv("VERBOSE_DI") and not os.getenv("BIJUXCLI_TEST_MODE"):
        self._log.log(
            "debug",
            "Context get",
            extra={"key": key, "value": str(self._data[key])},
        )
    return self._data[key]

set 

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

Sets a value in the current context's data.

Parameters:

  • key (str) –

    The key for the value.

  • value (Any) –

    The value to store.

Returns:

  • None ( None ) –
Source code in src/bijux_cli/core/context.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def set(self, key: str, value: Any) -> None:
    """Sets a value in the current context's data.

    Args:
        key (str): The key for the value.
        value (Any): The value to store.

    Returns:
        None:
    """
    self._data[key] = value
    if os.getenv("VERBOSE_DI") and not os.getenv("BIJUXCLI_TEST_MODE"):
        self._log.log(
            "debug", "Context set", extra={"key": key, "value": str(value)}
        )

set_current_data classmethod 

set_current_data(data: dict[str, Any]) -> None

Sets the dictionary for the currently active CLI context.

Parameters:

  • data (dict[str, Any]) –

    The data to use for the active context.

Returns:

  • None ( None ) –
Source code in src/bijux_cli/core/context.py 
187
188
189
190
191
192
193
194
195
196
197
@classmethod
def set_current_data(cls, data: dict[str, Any]) -> None:
    """Sets the dictionary for the currently active CLI context.

    Args:
        data (dict[str, Any]): The data to use for the active context.

    Returns:
        None:
    """
    _current_context.set(data)

use_context classmethod 

use_context(data: dict[str, Any]) -> Iterator[None]

Temporarily replaces the current context data within a with block.

Parameters:

  • data (dict[str, Any]) –

    The dictionary to use as the context for the duration of the with block.

Yields:

  • None ( None ) –
Source code in src/bijux_cli/core/context.py 
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
@classmethod
@contextmanager
def use_context(cls, data: dict[str, Any]) -> Iterator[None]:
    """Temporarily replaces the current context data within a `with` block.

    Args:
        data (dict[str, Any]): The dictionary to use as the context for
            the duration of the `with` block.

    Yields:
        None:
    """
    token = _current_context.set(data)
    try:
        yield
    finally:
        _current_context.reset(token)