Base

BaseCache

Bases: ABC

Abstract base class for cache backends.

Attributes:

Name	Type	Description
client	CacheClient	Cache client instance.

Source code in dynamiq/cache/backends/base.py

class BaseCache(ABC):
    """Abstract base class for cache backends.

    Attributes:
        client (CacheClient): Cache client instance.
    """

    def __init__(self, client: CacheClient):
        """Initialize BaseCache.

        Args:
            client (CacheClient): Cache client instance.
        """
        self.client = client

    @classmethod
    def from_client(cls, client: CacheClient):
        """Create cache instance from client.

        Args:
            client (CacheClient): Cache client instance.

        Returns:
            BaseCache: Cache instance.
        """
        return cls(client=client)

    @classmethod
    @abstractmethod
    def from_config(cls, config: CacheConfig):
        """Create cache instance from configuration.

        Args:
            config (CacheConfig): Cache configuration.

        Raises:
            NotImplementedError: If not implemented.
        """
        raise NotImplementedError

    @abstractmethod
    def get(self, key: str):
        """Retrieve value from cache.

        Args:
            key (str): Cache key.

        Raises:
            NotImplementedError: If not implemented.
        """
        raise NotImplementedError

    @abstractmethod
    def set(self, key: str, value: dict):
        """Set value in cache.

        Args:
            key (str): Cache key.
            value (dict): Value to cache.

        Raises:
            NotImplementedError: If not implemented.
        """
        raise NotImplementedError

    @abstractmethod
    def delete(self, key: str):
        """Delete value from cache.

        Args:
            key (str): Cache key.

        Raises:
            NotImplementedError: If not implemented.
        """
        raise NotImplementedError

__init__(client)

Initialize BaseCache.

Parameters:

Name	Type	Description	Default
client	CacheClient	Cache client instance.	required

Source code in dynamiq/cache/backends/base.py

def __init__(self, client: CacheClient):
    """Initialize BaseCache.

    Args:
        client (CacheClient): Cache client instance.
    """
    self.client = client

delete(key) abstractmethod

Delete value from cache.

Parameters:

Name	Type	Description	Default
key	str	Cache key.	required

Raises:

Type	Description
NotImplementedError	If not implemented.

Source code in dynamiq/cache/backends/base.py

@abstractmethod
def delete(self, key: str):
    """Delete value from cache.

    Args:
        key (str): Cache key.

    Raises:
        NotImplementedError: If not implemented.
    """
    raise NotImplementedError

from_client(client) classmethod

Create cache instance from client.

Parameters:

Name	Type	Description	Default
client	CacheClient	Cache client instance.	required

Returns:

Name	Type	Description
BaseCache		Cache instance.

Source code in dynamiq/cache/backends/base.py

@classmethod
def from_client(cls, client: CacheClient):
    """Create cache instance from client.

    Args:
        client (CacheClient): Cache client instance.

    Returns:
        BaseCache: Cache instance.
    """
    return cls(client=client)

from_config(config) abstractmethod classmethod

Create cache instance from configuration.

Parameters:

Name	Type	Description	Default
config	CacheConfig	Cache configuration.	required

Raises:

Type	Description
NotImplementedError	If not implemented.

Source code in dynamiq/cache/backends/base.py

@classmethod
@abstractmethod
def from_config(cls, config: CacheConfig):
    """Create cache instance from configuration.

    Args:
        config (CacheConfig): Cache configuration.

    Raises:
        NotImplementedError: If not implemented.
    """
    raise NotImplementedError

get(key) abstractmethod

Retrieve value from cache.

Parameters:

Name	Type	Description	Default
key	str	Cache key.	required

Raises:

Type	Description
NotImplementedError	If not implemented.

Source code in dynamiq/cache/backends/base.py

@abstractmethod
def get(self, key: str):
    """Retrieve value from cache.

    Args:
        key (str): Cache key.

    Raises:
        NotImplementedError: If not implemented.
    """
    raise NotImplementedError

set(key, value) abstractmethod

Set value in cache.

Parameters:

Name	Type	Description	Default
key	str	Cache key.	required
value	dict	Value to cache.	required

Raises:

Type	Description
NotImplementedError	If not implemented.

Source code in dynamiq/cache/backends/base.py

@abstractmethod
def set(self, key: str, value: dict):
    """Set value in cache.

    Args:
        key (str): Cache key.
        value (dict): Value to cache.

    Raises:
        NotImplementedError: If not implemented.
    """
    raise NotImplementedError