django-constance/constance/backends/__init__.py

"""Defines the base constance backend."""

from abc import ABC
from abc import abstractmethod


class Backend(ABC):
    @abstractmethod
    def get(self, key):
        """
        Get the key from the backend store and return the value.
        Return None if not found.
        """
        ...

    @abstractmethod
    async def aget(self, key):
        """
        Get the key from the backend store and return the value.
        Return None if not found.
        """
        ...

    @abstractmethod
    def mget(self, keys):
        """
        Get the keys from the backend store and return a dict mapping
        each found key to its value. Return an empty dict if no keys
        are provided or none are found.
        """
        ...

    @abstractmethod
    async def amget(self, keys):
        """
        Get the keys from the backend store and return a dict mapping
        each found key to its value. Return an empty dict if no keys
        are provided or none are found.
        """
        ...

    @abstractmethod
    def set(self, key, value):
        """Add the value to the backend store given the key."""
        ...

    @abstractmethod
    async def aset(self, key, value):
        """Add the value to the backend store given the key."""
        ...