Source code for thoth.storages.base

#!/usr/bin/env python3
# thoth-storages
# Copyright(C) 2018, 2019, 2020 Fridolin Pokorny
#
# This program is free software: you can redistribute it and / or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

"""A base class for implementing storage adapters."""

import abc


[docs]class StorageBase(metaclass=abc.ABCMeta):
    """A base class for implementing storage adapters."""

[docs]    def is_connected(self) -> bool:
        """Check if the given database adapter is in connected state."""

[docs]    def connect(self) -> None:
        """Connect the given storage adapter."""