Remove duplicated sourcing of settings via environment variables and .env file

Author: rragundez

src/app/core/config.py

@@ -1,143 +1,160 @@
 import os
 from enum import Enum
 
-from pydantic import SecretStr
-from pydantic_settings import BaseSettings
-from starlette.config import Config
+from pydantic import SecretStr, computed_field, field_validator
+from pydantic_settings import BaseSettings, SettingsConfigDict
 
-current_file_dir = os.path.dirname(os.path.realpath(__file__))
-env_path = os.path.join(current_file_dir, "..", "..", ".env")
-config = Config(env_path)
 
-
-def str_setting_to_list(setting: str) -> list[str]:
-    if isinstance(setting, str):
-        return [item.strip() for item in setting.split(",") if item.strip()]
+def str_to_list(value: str) -> list[str]:
+    if isinstance(value, str):
+        return [item.strip() for item in value.split(",") if item.strip()]
     raise ValueError("Invalid string setting for list conversion.")
 
 
 class AppSettings(BaseSettings):
-    APP_NAME: str = config("APP_NAME", default="FastAPI app")
-    APP_DESCRIPTION: str | None = config("APP_DESCRIPTION", default=None)
-    APP_VERSION: str | None = config("APP_VERSION", default=None)
-    LICENSE_NAME: str | None = config("LICENSE", default=None)
-    CONTACT_NAME: str | None = config("CONTACT_NAME", default=None)
-    CONTACT_EMAIL: str | None = config("CONTACT_EMAIL", default=None)
+    APP_NAME: str = "FastAPI app"
+    APP_DESCRIPTION: str | None = None
+    APP_VERSION: str | None = None
+    LICENSE_NAME: str | None = None
+    CONTACT_NAME: str | None = None
+    CONTACT_EMAIL: str | None = None
 
 
 class CryptSettings(BaseSettings):
-    SECRET_KEY: SecretStr = config("SECRET_KEY", cast=SecretStr)
-    ALGORITHM: str = config("ALGORITHM", default="HS256")
-    ACCESS_TOKEN_EXPIRE_MINUTES: int = config("ACCESS_TOKEN_EXPIRE_MINUTES", default=30)
-    REFRESH_TOKEN_EXPIRE_DAYS: int = config("REFRESH_TOKEN_EXPIRE_DAYS", default=7)
+    SECRET_KEY: SecretStr
+    ALGORITHM: str = "HS256"
+    ACCESS_TOKEN_EXPIRE_MINUTES: int = 30
+    REFRESH_TOKEN_EXPIRE_DAYS: int = 7
 
 
 class DatabaseSettings(BaseSettings):
     pass
 
 
 class SQLiteSettings(DatabaseSettings):
-    SQLITE_URI: str = config("SQLITE_URI", default="./sql_app.db")
-    SQLITE_SYNC_PREFIX: str = config("SQLITE_SYNC_PREFIX", default="sqlite:///")
-    SQLITE_ASYNC_PREFIX: str = config("SQLITE_ASYNC_PREFIX", default="sqlite+aiosqlite:///")
+    SQLITE_URI: str = "./sql_app.db"
+    SQLITE_SYNC_PREFIX: str = "sqlite:///"
+    SQLITE_ASYNC_PREFIX: str = "sqlite+aiosqlite:///"
 
 
 class MySQLSettings(DatabaseSettings):
-    MYSQL_USER: str = config("MYSQL_USER", default="username")
-    MYSQL_PASSWORD: str = config("MYSQL_PASSWORD", default="password")
-    MYSQL_SERVER: str = config("MYSQL_SERVER", default="localhost")
-    MYSQL_PORT: int = config("MYSQL_PORT", default=5432)
-    MYSQL_DB: str = config("MYSQL_DB", default="dbname")
-    MYSQL_URI: str = f"{MYSQL_USER}:{MYSQL_PASSWORD}@{MYSQL_SERVER}:{MYSQL_PORT}/{MYSQL_DB}"
-    MYSQL_SYNC_PREFIX: str = config("MYSQL_SYNC_PREFIX", default="mysql://")
-    MYSQL_ASYNC_PREFIX: str = config("MYSQL_ASYNC_PREFIX", default="mysql+aiomysql://")
-    MYSQL_URL: str | None = config("MYSQL_URL", default=None)
+    MYSQL_USER: str = "username"
+    MYSQL_PASSWORD: str = "password"
+    MYSQL_SERVER: str = "localhost"
+    MYSQL_PORT: int = 5432
+    MYSQL_DB: str = "dbname"
+    MYSQL_SYNC_PREFIX: str = "mysql://"
+    MYSQL_ASYNC_PREFIX: str = "mysql+aiomysql://"
+    MYSQL_URL: str | None = None
+
+    @computed_field
+    @property
+    def MYSQL_URI(self) -> str:
+        credentials = f"{self.MYSQL_USER}:{self.MYSQL_PASSWORD}"
+        location = f"{self.MYSQL_SERVER}:{self.MYSQL_PORT}/{self.MYSQL_DB}"
+        return f"{credentials}@{location}"
 
 
 class PostgresSettings(DatabaseSettings):
-    POSTGRES_USER: str = config("POSTGRES_USER", default="postgres")
-    POSTGRES_PASSWORD: str = config("POSTGRES_PASSWORD", default="postgres")
-    POSTGRES_SERVER: str = config("POSTGRES_SERVER", default="localhost")
-    POSTGRES_PORT: int = config("POSTGRES_PORT", default=5432)
-    POSTGRES_DB: str = config("POSTGRES_DB", default="postgres")
-    POSTGRES_SYNC_PREFIX: str = config("POSTGRES_SYNC_PREFIX", default="postgresql://")
-    POSTGRES_ASYNC_PREFIX: str = config("POSTGRES_ASYNC_PREFIX", default="postgresql+asyncpg://")
-    POSTGRES_URI: str = f"{POSTGRES_USER}:{POSTGRES_PASSWORD}@{POSTGRES_SERVER}:{POSTGRES_PORT}/{POSTGRES_DB}"
-    POSTGRES_URL: str | None = config("POSTGRES_URL", default=None)
+    POSTGRES_USER: str = "postgres"
+    POSTGRES_PASSWORD: str = "postgres"
+    POSTGRES_SERVER: str = "localhost"
+    POSTGRES_PORT: int = 5432
+    POSTGRES_DB: str = "postgres"
+    POSTGRES_SYNC_PREFIX: str = "postgresql://"
+    POSTGRES_ASYNC_PREFIX: str = "postgresql+asyncpg://"
+    POSTGRES_URL: str | None = None
+
+    @computed_field
+    @property
+    def POSTGRES_URI(self) -> str:
+        credentials = f"{self.POSTGRES_USER}:{self.POSTGRES_PASSWORD}"
+        location = f"{self.POSTGRES_SERVER}:{self.POSTGRES_PORT}/{self.POSTGRES_DB}"
+        return f"{credentials}@{location}"
 
 
 class FirstUserSettings(BaseSettings):
-    ADMIN_NAME: str = config("ADMIN_NAME", default="admin")
-    ADMIN_EMAIL: str = config("ADMIN_EMAIL", default="[email protected]")
-    ADMIN_USERNAME: str = config("ADMIN_USERNAME", default="admin")
-    ADMIN_PASSWORD: str = config("ADMIN_PASSWORD", default="!Ch4ng3Th1sP4ssW0rd!")
+    ADMIN_NAME: str = "admin"
+    ADMIN_EMAIL: str = "[email protected]"
+    ADMIN_USERNAME: str = "admin"
+    ADMIN_PASSWORD: str = "!Ch4ng3Th1sP4ssW0rd!"
 
 
 class TestSettings(BaseSettings):
     ...
 
 
 class RedisCacheSettings(BaseSettings):
-    REDIS_CACHE_HOST: str = config("REDIS_CACHE_HOST", default="localhost")
-    REDIS_CACHE_PORT: int = config("REDIS_CACHE_PORT", default=6379)
-    REDIS_CACHE_URL: str = f"redis://{REDIS_CACHE_HOST}:{REDIS_CACHE_PORT}"
+    REDIS_CACHE_HOST: str = "localhost"
+    REDIS_CACHE_PORT: int = 6379
+
+    @computed_field
+    @property
+    def REDIS_CACHE_URL(self) -> str:
+        return f"redis://{self.REDIS_CACHE_HOST}:{self.REDIS_CACHE_PORT}"
 
 
 class ClientSideCacheSettings(BaseSettings):
-    CLIENT_CACHE_MAX_AGE: int = config("CLIENT_CACHE_MAX_AGE", default=60)
+    CLIENT_CACHE_MAX_AGE: int = 60
 
 
 class RedisQueueSettings(BaseSettings):
-    REDIS_QUEUE_HOST: str = config("REDIS_QUEUE_HOST", default="localhost")
-    REDIS_QUEUE_PORT: int = config("REDIS_QUEUE_PORT", default=6379)
+    REDIS_QUEUE_HOST: str = "localhost"
+    REDIS_QUEUE_PORT: int = 6379
 
 
 class RedisRateLimiterSettings(BaseSettings):
-    REDIS_RATE_LIMIT_HOST: str = config("REDIS_RATE_LIMIT_HOST", default="localhost")
-    REDIS_RATE_LIMIT_PORT: int = config("REDIS_RATE_LIMIT_PORT", default=6379)
-    REDIS_RATE_LIMIT_URL: str = f"redis://{REDIS_RATE_LIMIT_HOST}:{REDIS_RATE_LIMIT_PORT}"
+    REDIS_RATE_LIMIT_HOST: str = "localhost"
+    REDIS_RATE_LIMIT_PORT: int = 6379
+
+    @computed_field
+    @property
+    def REDIS_RATE_LIMIT_URL(self) -> str:
+        return f"redis://{self.REDIS_RATE_LIMIT_HOST}:{self.REDIS_RATE_LIMIT_PORT}"
 
 
 class DefaultRateLimitSettings(BaseSettings):
-    DEFAULT_RATE_LIMIT_LIMIT: int = config("DEFAULT_RATE_LIMIT_LIMIT", default=10)
-    DEFAULT_RATE_LIMIT_PERIOD: int = config("DEFAULT_RATE_LIMIT_PERIOD", default=3600)
+    DEFAULT_RATE_LIMIT_LIMIT: int = 10
+    DEFAULT_RATE_LIMIT_PERIOD: int = 3600
 
 
 class CRUDAdminSettings(BaseSettings):
-    CRUD_ADMIN_ENABLED: bool = config("CRUD_ADMIN_ENABLED", default=True)
-    CRUD_ADMIN_MOUNT_PATH: str = config("CRUD_ADMIN_MOUNT_PATH", default="/admin")
+    CRUD_ADMIN_ENABLED: bool = True
+    CRUD_ADMIN_MOUNT_PATH: str = "/admin"
 
     CRUD_ADMIN_ALLOWED_IPS_LIST: list[str] | None = None
     CRUD_ADMIN_ALLOWED_NETWORKS_LIST: list[str] | None = None
-    CRUD_ADMIN_MAX_SESSIONS: int = config("CRUD_ADMIN_MAX_SESSIONS", default=10)
-    CRUD_ADMIN_SESSION_TIMEOUT: int = config("CRUD_ADMIN_SESSION_TIMEOUT", default=1440)
-    SESSION_SECURE_COOKIES: bool = config("SESSION_SECURE_COOKIES", default=True)
+    CRUD_ADMIN_MAX_SESSIONS: int = 10
+    CRUD_ADMIN_SESSION_TIMEOUT: int = 1440
+    SESSION_SECURE_COOKIES: bool = True
 
-    CRUD_ADMIN_TRACK_EVENTS: bool = config("CRUD_ADMIN_TRACK_EVENTS", default=True)
-    CRUD_ADMIN_TRACK_SESSIONS: bool = config("CRUD_ADMIN_TRACK_SESSIONS", default=True)
+    CRUD_ADMIN_TRACK_EVENTS: bool = True
+    CRUD_ADMIN_TRACK_SESSIONS: bool = True
 
-    CRUD_ADMIN_REDIS_ENABLED: bool = config("CRUD_ADMIN_REDIS_ENABLED", default=False)
-    CRUD_ADMIN_REDIS_HOST: str = config("CRUD_ADMIN_REDIS_HOST", default="localhost")
-    CRUD_ADMIN_REDIS_PORT: int = config("CRUD_ADMIN_REDIS_PORT", default=6379)
-    CRUD_ADMIN_REDIS_DB: int = config("CRUD_ADMIN_REDIS_DB", default=0)
-    CRUD_ADMIN_REDIS_PASSWORD: str | None = config("CRUD_ADMIN_REDIS_PASSWORD", default="None")
-    CRUD_ADMIN_REDIS_SSL: bool = config("CRUD_ADMIN_REDIS_SSL", default=False)
+    CRUD_ADMIN_REDIS_ENABLED: bool = False
+    CRUD_ADMIN_REDIS_HOST: str = "localhost"
+    CRUD_ADMIN_REDIS_PORT: int = 6379
+    CRUD_ADMIN_REDIS_DB: int = 0
+    CRUD_ADMIN_REDIS_PASSWORD: str | None = "None"
+    CRUD_ADMIN_REDIS_SSL: bool = False
 
 
-class EnvironmentOption(Enum):
+class EnvironmentOption(str, Enum):
     LOCAL = "local"
     STAGING = "staging"
     PRODUCTION = "production"
 
 
 class EnvironmentSettings(BaseSettings):
-    ENVIRONMENT: EnvironmentOption = config("ENVIRONMENT", default=EnvironmentOption.LOCAL)
+    ENVIRONMENT: EnvironmentOption = EnvironmentOption.LOCAL
 
 
 class CORSSettings(BaseSettings):
-    CORS_ORIGINS: list[str] = config("CORS_ORIGINS", cast=str_setting_to_list, default="*")
-    CORS_METHODS: list[str] = config("CORS_METHODS", cast=str_setting_to_list, default="*")
-    CORS_HEADERS: list[str] = config("CORS_HEADERS", cast=str_setting_to_list, default="*")
+    CORS_ORIGINS: list[str] | str = "*"
+    CORS_METHODS: list[str] | str = "*"
+    CORS_HEADERS: list[str] | str = "*"
+
+    _normalize_to_list = field_validator("CORS_ORIGINS", "CORS_METHODS", "CORS_HEADERS", mode="before")(str_to_list)
 
 
 class Settings(
@@ -156,7 +173,12 @@ class Settings(
     EnvironmentSettings,
     CORSSettings,
 ):
-    pass
+    model_config = SettingsConfigDict(
+        env_file=os.path.join(os.path.dirname(os.path.realpath(__file__)), "..", "..", ".env"),
+        env_file_encoding="utf-8",
+        case_sensitive=True,
+        extra="ignore",
+    )
 
 
 settings = Settings()