Module secfsdstools.a_config.configmodel

Base Model for configuration.

"""
Base Model for configuration.
"""

import os
from dataclasses import dataclass, asdict
from typing import Optional


@dataclass
class Configuration:
    """ Basic configuration settings """
    download_dir: str
    db_dir: str
    parquet_dir: str
    user_agent_email: str
    rapid_api_key: Optional[str] = None
    rapid_api_plan: Optional[str] = 'basic'
    daily_download_dir: Optional[str] = None
    auto_update: Optional[bool] = True
    keep_zip_files: Optional[bool] = False

    def __post_init__(self):
        self.daily_download_dir = os.path.join(self.download_dir, "daily")

    def get_dict(self):
        """
        returns the configuration as a dictionary
        Returns:
            the configuration as a dictionary
        """
        return dict(asdict(self))

Classes

class Configuration (download_dir: str, db_dir: str, parquet_dir: str, user_agent_email: str, rapid_api_key: Optional[str] = None, rapid_api_plan: Optional[str] = 'basic', daily_download_dir: Optional[str] = None, auto_update: Optional[bool] = True, keep_zip_files: Optional[bool] = False)

Basic configuration settings

Expand source code

class Configuration:
    """ Basic configuration settings """
    download_dir: str
    db_dir: str
    parquet_dir: str
    user_agent_email: str
    rapid_api_key: Optional[str] = None
    rapid_api_plan: Optional[str] = 'basic'
    daily_download_dir: Optional[str] = None
    auto_update: Optional[bool] = True
    keep_zip_files: Optional[bool] = False

    def __post_init__(self):
        self.daily_download_dir = os.path.join(self.download_dir, "daily")

    def get_dict(self):
        """
        returns the configuration as a dictionary
        Returns:
            the configuration as a dictionary
        """
        return dict(asdict(self))

Class variables

var auto_update : Optional[bool]

var daily_download_dir : Optional[str]

var db_dir : str

var download_dir : str

var keep_zip_files : Optional[bool]

var parquet_dir : str

var rapid_api_key : Optional[str]

var rapid_api_plan : Optional[str]

var user_agent_email : str

Methods

def get_dict(self)

returns the configuration as a dictionary

Returns

the configuration as a dictionary

Expand source code

def get_dict(self):
    """
    returns the configuration as a dictionary
    Returns:
        the configuration as a dictionary
    """
    return dict(asdict(self))