scottwernervt/cloudstorage

"""Cloud Storage

:copyright: (c) 2018 by Scott Werner.
:license: MIT, see LICENSE for more details.
"""
import logging
from enum import Enum, unique

from cloudstorage.base import Blob, Container, Driver
from cloudstorage.exceptions import CloudStorageError
from cloudstorage.typed import Drivers

__all__ = [
    "Blob",
    "Container",
    "Driver",
    "DriverName",
    "get_driver",
    "get_driver_by_name",
]

__title__ = "Cloud Storage"
__version__ = "0.11.0"
__author__ = "Scott Werner"
__license__ = "MIT"
__copyright__ = "Copyright 2017-2018 Scott Werner"


@unique
class DriverName(Enum):
    """DriverName enumeration."""

    AZURE = "AZURE"
    CLOUDFILES = "CLOUDFILES"
    GOOGLESTORAGE = "GOOGLESTORAGE"
    LOCAL = "LOCAL"
    MINIO = "MINIO"
    S3 = "S3"
    DIGITALOCEANSPACES = "DIGITALOCEANSPACES"


_DRIVER_IMPORTS = {
    DriverName.AZURE: ("cloudstorage.drivers.microsoft", "AzureStorageDriver"),
    DriverName.CLOUDFILES: ("cloudstorage.drivers.rackspace", "CloudFilesDriver"),
    DriverName.GOOGLESTORAGE: ("cloudstorage.drivers.google", "GoogleStorageDriver"),
    DriverName.LOCAL: ("cloudstorage.drivers.local", "LocalDriver"),
    DriverName.MINIO: ("cloudstorage.drivers.minio", "MinioDriver"),
    DriverName.S3: ("cloudstorage.drivers.amazon", "S3Driver"),
    DriverName.DIGITALOCEANSPACES: (
        "cloudstorage.drivers.digitalocean",
        "DigitalOceanSpacesDriver",
    ),
}


def get_driver(driver: DriverName) -> Drivers:
    """Get driver class by DriverName enumeration member.

    .. code-block:: python

        >>> from cloudstorage import DriverName, get_driver
        >>> driver_cls = get_driver(DriverName.LOCAL)
        <class 'cloudstorage.drivers.local.LocalDriver'>

    :param driver: DriverName member.
    :type driver: :class:`.DriverName`

    :return: DriverName driver class.
    :rtype: :class:`.AzureStorageDriver`, :class:`.CloudFilesDriver`,
      :class:`.GoogleStorageDriver`, :class:`.S3Driver`, :class:`.LocalDriver`,
      :class:`.MinioDriver`, :class:`.DigitalOceanSpacesDriver`
    """
    if driver in _DRIVER_IMPORTS:
        mod_name, driver_name = _DRIVER_IMPORTS[driver]
        _mod = __import__(mod_name, globals(), locals(), [driver_name])
        return getattr(_mod, driver_name)

    raise CloudStorageError("Driver '%s' does not exist." % driver)


def get_driver_by_name(driver_name: str) -> Drivers:
    """Get driver class by driver name.

    .. code-block:: python

        >>> from cloudstorage import get_driver_by_name
        >>> driver_cls = get_driver_by_name('LOCAL')
        <class 'cloudstorage.drivers.local.LocalDriver'>

    :param driver_name: Driver name.

        * `AZURE`
        * `CLOUDFILES`
        * `GOOGLESTORAGE`
        * `S3`
        * `LOCAL`
        * `MINIO`
        * `DIGITALOCEANSPACES`
    :type driver_name: str

    :return: DriverName driver class.
    :rtype: :class:`.AzureStorageDriver`, :class:`.CloudFilesDriver`,
      :class:`.GoogleStorageDriver`, :class:`.S3Driver`, :class:`.LocalDriver`,
      :class:`.MinioDriver`, :class:`.DigitalOceanSpacesDriver`
    """
    driver = DriverName[driver_name]
    return get_driver(driver)


# Set up logging to ``/dev/null`` like a library is supposed to.
logging.getLogger("cloudstorage").addHandler(logging.NullHandler())