Red-DiscordBot/redbot/core/drivers/red_base.py

__all__ = ["BaseDriver"]


class BaseDriver:
    def __init__(self, cog_name):
        self.cog_name = cog_name
        self.unique_cog_identifier = None  # This is set by Config's init method

    async def get(self, *identifiers: str):
        """
        Finds the value indicate by the given identifiers.

        Parameters
        ----------
        identifiers
            A list of identifiers that correspond to nested dict accesses.

        Returns
        -------
        Any
            Stored value.
        """
        raise NotImplementedError

    def get_config_details(self):
        """
        Asks users for additional configuration information necessary
        to use this config driver.

        Returns
        -------
            Dict of configuration details.
        """
        raise NotImplementedError

    async def set(self, *identifiers: str, value=None):
        """
        Sets the value of the key indicated by the given identifiers.

        Parameters
        ----------
        identifiers
            A list of identifiers that correspond to nested dict accesses.
        value
            Any JSON serializable python object.
        """
        raise NotImplementedError

    async def clear(self, *identifiers: str):
        """
        Clears out the value specified by the given identifiers.

        Equivalent to using ``del`` on a dict.

        Parameters
        ----------
        identifiers
            A list of identifiers that correspond to nested dict accesses.
        """
        raise NotImplementedError