Configuration

config

Application configuration and runtime constants for Leeroy.

Purpose

Defines environment helpers, filesystem paths, model settings, database paths, logging configuration, Streamlit UI labels, runtime defaults, mode names, compiled text patterns, and help text used throughout the Leeroy application. The module keeps configuration import-safe by returning defaults when optional environment variables are missing or malformed.

throw_if

throw_if(name: str, value: object) -> None

Raise a ValueError when a required value is empty.

Purpose

Provides a consistent guard for required arguments and configuration values used by Leeroy helpers. The function treats falsy values as invalid and raises a ValueError containing the caller-supplied argument or setting name.

Parameters:

Name	Type	Description	Default
name	str	Name of the argument or configuration value being validated.	required
value	object	Value to validate.	required

Raises:

Type	Description
ValueError	Raised when value is falsy.

Source code in config.py

def throw_if( name: str, value: object ) -> None:
	"""Raise a ``ValueError`` when a required value is empty.

	Purpose:
		Provides a consistent guard for required arguments and configuration values used
		by Leeroy helpers. The function treats falsy values as invalid and raises a
		``ValueError`` containing the caller-supplied argument or setting name.

	Args:
		name: Name of the argument or configuration value being validated.
		value: Value to validate.

	Raises:
		ValueError: Raised when ``value`` is falsy.
	"""
	if not value:
		raise ValueError( f'Argument "{name}" cannot be empty!' )

get_bool

get_bool(name: str, default: bool = False) -> bool

Read a Boolean environment variable.

Purpose

Converts environment-variable text into a deterministic Boolean value for optional runtime settings. Missing variables return the caller-provided default. Values of 1, true, yes, y, and on are treated as True; all other defined values are treated as False.

Parameters:

Name	Type	Description	Default
name	str	Environment variable name.	required
default	bool	Default value used when the environment variable is not defined.	False

Returns:

Name	Type	Description
bool	bool	Parsed Boolean value, or the original default value when parsing fails.

Source code in config.py

def get_bool( name: str, default: bool = False ) -> bool:
	"""Read a Boolean environment variable.

	Purpose:
		Converts environment-variable text into a deterministic Boolean value for optional
		runtime settings. Missing variables return the caller-provided default. Values of
		``1``, ``true``, ``yes``, ``y``, and ``on`` are treated as ``True``; all other
		defined values are treated as ``False``.

	Args:
		name: Environment variable name.
		default: Default value used when the environment variable is not defined.

	Returns:
		bool: Parsed Boolean value, or the original default value when parsing fails.
	"""
	try:
		throw_if( 'name', name )
		value = os.getenv( name )
		return default if value is None else value.strip( ).lower( ) in (
				'1',
				'true',
				'yes',
				'y',
				'on'
		)
	except Exception:
		return default

get_int

get_int(name: str, default: int) -> int

Read an integer environment variable.

Purpose

Parses an optional environment variable as an integer while preserving a safe default when the variable is missing, empty, or invalid. This keeps module import safe even when deployment configuration is incomplete.

Parameters:

Name	Type	Description	Default
name	str	Environment variable name.	required
default	int	Default integer value used when parsing is not possible.	required

Returns:

Name	Type	Description
int	int	Parsed integer value or the supplied default value.

Source code in config.py

def get_int( name: str, default: int ) -> int:
	"""Read an integer environment variable.

	Purpose:
		Parses an optional environment variable as an integer while preserving a safe
		default when the variable is missing, empty, or invalid. This keeps module import
		safe even when deployment configuration is incomplete.

	Args:
		name: Environment variable name.
		default: Default integer value used when parsing is not possible.

	Returns:
		int: Parsed integer value or the supplied default value.
	"""
	try:
		throw_if( 'name', name )
		value = os.getenv( name )
		return default if value in (None, '') else int( str( value ).strip( ) )
	except Exception:
		return default

get_float

get_float(name: str, default: float) -> float

Read a floating-point environment variable.

Purpose

Parses an optional environment variable as a float while preserving a safe default when the variable is missing, empty, or invalid. This helper supports numeric configuration without making module import dependent on perfect environment state.

Parameters:

Name	Type	Description	Default
name	str	Environment variable name.	required
default	float	Default floating-point value used when parsing is not possible.	required

Returns:

Name	Type	Description
float	float	Parsed floating-point value or the supplied default value.

Source code in config.py

def get_float( name: str, default: float ) -> float:
	"""Read a floating-point environment variable.

	Purpose:
		Parses an optional environment variable as a float while preserving a safe default
		when the variable is missing, empty, or invalid. This helper supports numeric
		configuration without making module import dependent on perfect environment state.

	Args:
		name: Environment variable name.
		default: Default floating-point value used when parsing is not possible.

	Returns:
		float: Parsed floating-point value or the supplied default value.
	"""
	try:
		throw_if( 'name', name )
		value = os.getenv( name )
		return default if value in (None, '') else float( str( value ).strip( ) )
	except Exception:
		return default

get_path

get_path(name: str, default: Path) -> Path

Read a path environment variable.

Purpose

Resolves optional filesystem configuration from the environment. Missing variables return the resolved default path, and invalid values fall back to the resolved default path rather than interrupting module import.

Parameters:

Name	Type	Description	Default
name	str	Environment variable name.	required
default	Path	Default path used when the environment variable is not defined.	required

Returns:

Name	Type	Description
Path	Path	Resolved path value or the resolved default path.

Source code in config.py

def get_path( name: str, default: Path ) -> Path:
	"""Read a path environment variable.

	Purpose:
		Resolves optional filesystem configuration from the environment. Missing variables
		return the resolved default path, and invalid values fall back to the resolved
		default path rather than interrupting module import.

	Args:
		name: Environment variable name.
		default: Default path used when the environment variable is not defined.

	Returns:
		Path: Resolved path value or the resolved default path.
	"""
	try:
		throw_if( 'name', name )
		throw_if( 'default', default )
		value = os.getenv( name )
		return Path( value ).resolve( ) if value else default.resolve( )
	except Exception:
		return default.resolve( )

get_text

get_text(name: str, default: str) -> str

Read a text environment variable.

Purpose

Returns an environment variable as text while preserving the supplied default when the variable is missing or empty. This keeps optional configuration centralized and stable for callers that import the module early in application startup.

Parameters:

Name	Type	Description	Default
name	str	Environment variable name.	required
default	str	Default text value.	required

Returns:

Name	Type	Description
str	str	Environment value or supplied default.

Source code in config.py

def get_text( name: str, default: str ) -> str:
	"""Read a text environment variable.

	Purpose:
		Returns an environment variable as text while preserving the supplied default when
		the variable is missing or empty. This keeps optional configuration centralized and
		stable for callers that import the module early in application startup.

	Args:
		name: Environment variable name.
		default: Default text value.

	Returns:
		str: Environment value or supplied default.
	"""
	try:
		throw_if( 'name', name )
		value = os.getenv( name )
		return default if value in (None, '') else str( value )
	except Exception:
		return default