Skip to content
v0.1.3

Memory Module API Reference

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

bijux_cli.contracts.memory

Defines the contract for the transient in-memory key-value service.

This module specifies the MemoryProtocol, a formal interface that any service providing a non-persistent, in-memory key-value store must implement. This is used for managing ephemeral state within the CLI.

MemoryProtocol

Bases: Protocol

Defines the contract for a simple in-memory key-value store.

This interface specifies the essential methods for a basic key-value data storage service. It is used for managing ephemeral state within the CLI that does not need to persist across sessions.

clear 

clear() -> None

Removes all key-value pairs from the store.

Source code in src/bijux_cli/contracts/memory.py 
66
67
68
def clear(self) -> None:
    """Removes all key-value pairs from the store."""
    ...

delete 

delete(key: str) -> None

Deletes a key-value pair by its key.

Parameters:

  • key (str) –

    The key of the value to delete.

Raises:

  • KeyError –

    If the key does not exist in the store.

Source code in src/bijux_cli/contracts/memory.py 
55
56
57
58
59
60
61
62
63
64
def delete(self, key: str) -> None:
    """Deletes a key-value pair by its key.

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

    Raises:
        KeyError: If the key does not exist in the store.
    """
    ...

get 

get(key: str) -> Any

Retrieves a value by its key.

Parameters:

  • key (str) –

    The key of the value to retrieve.

Returns:

  • Any ( Any ) –

    The value associated with the key.

Raises:

  • KeyError –

    If the key does not exist in the store.

Source code in src/bijux_cli/contracts/memory.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
def get(self, key: str) -> Any:
    """Retrieves a value by its key.

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

    Returns:
        Any: The value associated with the key.

    Raises:
        KeyError: If the key does not exist in the store.
    """
    ...

keys 

keys() -> list[str]

Returns a list of all keys currently in the store.

Returns:

  • list[str] –

    list[str]: A list of all string keys.

Source code in src/bijux_cli/contracts/memory.py 
70
71
72
73
74
75
76
def keys(self) -> list[str]:
    """Returns a list of all keys currently in the store.

    Returns:
        list[str]: A list of all string keys.
    """
    ...

set 

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

Sets a key-value pair in the store.

If the key already exists, its value will be overwritten.

Parameters:

  • key (str) –

    The key for the value being set.

  • value (Any) –

    The value to store.

Returns:

  • None ( None ) –
Source code in src/bijux_cli/contracts/memory.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
def set(self, key: str, value: Any) -> None:
    """Sets a key-value pair in the store.

    If the key already exists, its value will be overwritten.

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

    Returns:
        None:
    """
    ...