tux.utils.env ¶

def get(self, key: str, default: T | None = None, required: bool = False) -> T | None:
    """
    Get environment variable with type conversion.

    Parameters
    ----------
    key : str
        Environment variable name
    default : Optional[T]
        Default value if not found
    required : bool
        Whether this variable is required

    Returns
    -------
    Optional[T]
        The value of the environment variable

    Raises
    ------
    ConfigurationError
        If variable is required but not found
    """
    value = os.environ.get(key)

    if value is None:
        if required:
            error_msg = f"Required environment variable {key} is not set"
            raise ConfigurationError(error_msg)
        return default

    # If default is provided, attempt to cast to the same type
    if default is not None:
        try:
            if isinstance(default, bool):
                return value.lower() in ("true", "yes", "1", "y")  # type: ignore
            return type(default)(value)  # type: ignore
        except ValueError as e:
            if required:
                error_msg = f"Environment variable {key} is not a valid {type(default).__name__}"
                raise ConfigurationError(error_msg) from e
            return default

    return value  # type: ignore

def set(self, key: str, value: Any, persist: bool = False) -> None:
    """
    Set environment variable.

    Parameters
    ----------
    key : str
        Environment variable name
    value : Any
        Value to set
    persist : bool
        Whether to persist to .env file
    """
    os.environ[key] = str(value)

    if persist and self.dotenv_path.exists():
        set_key(self.dotenv_path, key, str(value))

def get_database_url(self, env: Environment) -> str:
    """
    Get database URL for specified environment.

    Parameters
    ----------
    env : Environment
        The environment to get URL for

    Returns
    -------
    str
        Database URL

    Raises
    ------
    ConfigurationError
        If database URL is not configured for environment
    """
    # Get the appropriate database URL key based on the environment
    key = "DEV_DATABASE_URL" if env.is_dev else "PROD_DATABASE_URL"
    url = self.get(key, default="")

    if not url:
        # If no URL is found, raise an error.
        # We no longer provide a default/mock URL here.
        error_msg = f"No database URL found for the {env.value.upper()} environment."
        raise ConfigurationError(error_msg)

    return url

def get_bot_token(self, env: Environment) -> str:
    """
    Get bot token for specified environment.

    Parameters
    ----------
    env : Environment
        The environment to get token for

    Returns
    -------
    str
        Bot token

    Raises
    ------
    ConfigurationError
        If bot token is not configured for environment
    """
    # Get the appropriate bot token key based on the environment
    key = "DEV_BOT_TOKEN" if env.is_dev else "PROD_BOT_TOKEN"
    token = self.get(key, default="")

    if not token:
        # If no token is found, raise an error.
        error_msg = f"No bot token found for the {env.value.upper()} environment."
        raise ConfigurationError(error_msg)

    return token

def __new__(cls, *args: Any, **kwargs: Any) -> "EnvironmentManager":
    """Create or return the singleton instance."""
    if cls._instance is None:
        cls._instance = super().__new__(cls)
        cls._instance._initialized = False
    return cls._instance

def configure(self, environment: Environment) -> None:
    """
    Configure the environment mode.

    Parameters
    ----------
    environment : Environment
        The environment mode to set (DEVELOPMENT or PRODUCTION)
    """
    self.environment = environment