Module furiosa.config

FuriosaSDK Config

"""FuriosaSDK Config"""
import os
from pathlib import Path

import dotenv
from furiosa.openapi.configuration import Configuration

DEFAULT_API_ENDPOINT = 'https://api.furiosa.ai'
FURIOSA_API_ENDPOINT_ENV = 'FURIOSA_API_ENDPOINT'
FURIOSA_ACCESS_KEY_ID_ENV = 'FURIOSA_ACCESS_KEY_ID'
SECRET_ACCESS_KEY_ENV = 'FURIOSA_SECRET_ACCESS_KEY'


class ConfigLoader:  # pylint: disable=too-few-public-methods
    """
    ClassLoader loads the local configuration of FuriosaAI SDK.
    """

    def __init__(self):
        home = str(Path.home())
        dotenv.load_dotenv('{}/.furiosa/config'.format(home), verbose=False, override=False)
        dotenv.load_dotenv('{}/.furiosa/credential'.format(home), verbose=False, override=False)

        self.api_endpoint = os.environ.get(FURIOSA_API_ENDPOINT_ENV)
        self.access_key_id = os.environ.get(FURIOSA_ACCESS_KEY_ID_ENV)
        self.secret_key_access = os.environ.get(SECRET_ACCESS_KEY_ENV)

        if self.api_endpoint is None:
            self.api_endpoint = DEFAULT_API_ENDPOINT

        if self.access_key_id is None or self.secret_key_access is None:
            raise Exception('FURIOSA_ACCESS_KEY_ID, FURIOSA_SECRET_ACCESS_KEY must be set', 1)

    def apply(self, client_configuration: Configuration) -> None:
        """
        Apply the loaded configuration to OpenAPI Configuration
        :param client_configuration: OpenAPI client configuration
        :return:
        """
        set_apikey(client_configuration, self.access_key_id, self.secret_key_access)
        client_configuration.host = self.api_endpoint
        client_configuration.discard_unknown_keys = True


def load_furiosa_config(client_configuration=None) -> None:
    """
    Loads the local configuration of FuriosaAI SDK and set the configs
    to the default OpenAPI configuration.

    :param client_configuration: OpenAPI client configuration
    :return:
    """
    loader = ConfigLoader()

    if client_configuration is None:
        config = type.__call__(Configuration)
        loader.apply(config)
        Configuration.set_default(config)
    else:
        loader.apply(client_configuration)
        Configuration.set_default(client_configuration)


def set_apikey(client_configuration, access_key_id: str, secret_access_key: str):
    """
    Apply API keys to OpenAPI client configuration

    :param client_configuration: OpenAPI client configuration
    :param access_key_id: Access key id
    :param secret_access_key: Secret access key
    :return:
    """
    client_configuration.api_key['AccessKeyIdAuth'] = access_key_id
    client_configuration.api_key['SecretAccessKeyAuth'] = secret_access_key

Functions

def load_furiosa_config(client_configuration=None) ‑> NoneType

Loads the local configuration of FuriosaAI SDK and set the configs to the default OpenAPI configuration.

:param client_configuration: OpenAPI client configuration :return:

Expand source code

def load_furiosa_config(client_configuration=None) -> None:
    """
    Loads the local configuration of FuriosaAI SDK and set the configs
    to the default OpenAPI configuration.

    :param client_configuration: OpenAPI client configuration
    :return:
    """
    loader = ConfigLoader()

    if client_configuration is None:
        config = type.__call__(Configuration)
        loader.apply(config)
        Configuration.set_default(config)
    else:
        loader.apply(client_configuration)
        Configuration.set_default(client_configuration)

def set_apikey(client_configuration, access_key_id: str, secret_access_key: str)

Apply API keys to OpenAPI client configuration

:param client_configuration: OpenAPI client configuration :param access_key_id: Access key id :param secret_access_key: Secret access key :return:

Expand source code

def set_apikey(client_configuration, access_key_id: str, secret_access_key: str):
    """
    Apply API keys to OpenAPI client configuration

    :param client_configuration: OpenAPI client configuration
    :param access_key_id: Access key id
    :param secret_access_key: Secret access key
    :return:
    """
    client_configuration.api_key['AccessKeyIdAuth'] = access_key_id
    client_configuration.api_key['SecretAccessKeyAuth'] = secret_access_key

Classes

class ConfigLoader

ClassLoader loads the local configuration of FuriosaAI SDK.

Expand source code

class ConfigLoader:  # pylint: disable=too-few-public-methods
    """
    ClassLoader loads the local configuration of FuriosaAI SDK.
    """

    def __init__(self):
        home = str(Path.home())
        dotenv.load_dotenv('{}/.furiosa/config'.format(home), verbose=False, override=False)
        dotenv.load_dotenv('{}/.furiosa/credential'.format(home), verbose=False, override=False)

        self.api_endpoint = os.environ.get(FURIOSA_API_ENDPOINT_ENV)
        self.access_key_id = os.environ.get(FURIOSA_ACCESS_KEY_ID_ENV)
        self.secret_key_access = os.environ.get(SECRET_ACCESS_KEY_ENV)

        if self.api_endpoint is None:
            self.api_endpoint = DEFAULT_API_ENDPOINT

        if self.access_key_id is None or self.secret_key_access is None:
            raise Exception('FURIOSA_ACCESS_KEY_ID, FURIOSA_SECRET_ACCESS_KEY must be set', 1)

    def apply(self, client_configuration: Configuration) -> None:
        """
        Apply the loaded configuration to OpenAPI Configuration
        :param client_configuration: OpenAPI client configuration
        :return:
        """
        set_apikey(client_configuration, self.access_key_id, self.secret_key_access)
        client_configuration.host = self.api_endpoint
        client_configuration.discard_unknown_keys = True

Methods

def apply(self, client_configuration: furiosa.openapi.configuration.Configuration) ‑> NoneType

Apply the loaded configuration to OpenAPI Configuration :param client_configuration: OpenAPI client configuration :return:

Expand source code

def apply(self, client_configuration: Configuration) -> None:
    """
    Apply the loaded configuration to OpenAPI Configuration
    :param client_configuration: OpenAPI client configuration
    :return:
    """
    set_apikey(client_configuration, self.access_key_id, self.secret_key_access)
    client_configuration.host = self.api_endpoint
    client_configuration.discard_unknown_keys = True