Skip to content

config#

Application configuration

ZooSettings #

Bases: BaseSettings

Application configuration

Source code in zoo/config.py 
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
class ZooSettings(BaseSettings):
    """
    Application configuration
    """

    PRODUCTION: bool = False
    DOCKER: bool = False
    DEBUG: bool = False

    DATABASE_FILE: str = str(pathlib.Path(__file__).resolve().parent / "zoo.sqlite")
    DATABASE_DRIVER: str = "sqlite+aiosqlite"
    DATABASE_HOST: Optional[str] = None
    DATABASE_PORT: Optional[int] = None
    DATABASE_USER: Optional[str] = None
    DATABASE_PASSWORD: Optional[str] = None
    DATABASE_NAME: Optional[str] = None
    JWT_EXPIRATION: Optional[int] = None
    SEED_DATA: bool = True

    DATABASE_SECRET: str = __application__

    model_config = SettingsConfigDict(
        env_prefix="ZOO_",
        case_sensitive=True,
    )

    @property
    def connection_string(self) -> str:
        """
        Get the database connection string
        """
        database_url = URL.create(
            drivername=self.DATABASE_DRIVER,
            username=self.DATABASE_USER,
            password=self.DATABASE_PASSWORD,
            host=self.DATABASE_HOST or self.DATABASE_FILE,
            port=self.DATABASE_PORT,
            database=self.DATABASE_NAME,
        ).render_as_string(hide_password=False)
        if all(
            [
                self.DATABASE_HOST is None,
                "sqlite" in self.DATABASE_DRIVER.lower(),
                "////" not in database_url,
            ]
        ):
            database_url = str(database_url).replace("///", "////", 1)
        return database_url

    @classmethod
    def rich_logging(cls, loggers: List[Union[str, logging.Logger]]) -> None:
        """
        Configure logging for development
        """
        for logger in loggers:
            if isinstance(logger, str):
                logger_inst = logging.getLogger(logger)
            else:
                logger_inst = logger
            logger_inst.handlers = [rich_handler]

    @classmethod
    def custom_generate_unique_id(cls, route: APIRoute) -> str:
        """
        Custom function to generate unique id for each route
        """
        return f"{route.tags[0]}-{route.name}"

connection_string: str property #

Get the database connection string

custom_generate_unique_id(route) classmethod #

Custom function to generate unique id for each route

Source code in zoo/config.py 
 96
 97
 98
 99
100
101
@classmethod
def custom_generate_unique_id(cls, route: APIRoute) -> str:
    """
    Custom function to generate unique id for each route
    """
    return f"{route.tags[0]}-{route.name}"

rich_logging(loggers) classmethod #

Configure logging for development

Source code in zoo/config.py 
84
85
86
87
88
89
90
91
92
93
94
@classmethod
def rich_logging(cls, loggers: List[Union[str, logging.Logger]]) -> None:
    """
    Configure logging for development
    """
    for logger in loggers:
        if isinstance(logger, str):
            logger_inst = logging.getLogger(logger)
        else:
            logger_inst = logger
        logger_inst.handlers = [rich_handler]