Skip to content
RelationalAI Docs

ConfigErrorContext

relationalai.config.errors.context 
ConfigErrorContext(
    source_type: ConfigSourceType,
    file_path: Path | None = None,
    profile_name: str | None = None,
    connection_name: str | None = None,
    section: str | None = None,
    field_path: list[str] | None = None,
)

Track where a configuration error occurred.

This context is used to format user-facing messages like Config file: raiconfig.yaml, Profile: dev, Connection: snowflake.

Attributes

Section titled “Attributes”

.source_type

Section titled “.source_type”
ConfigErrorContext.source_type: ConfigSourceType

Where the configuration was loaded from.

.file_path

Section titled “.file_path”
ConfigErrorContext.file_path: :class:`~pathlib.Path`, optional

Path to the config file (omitted for programmatic config).

.profile_name

Section titled “.profile_name”
ConfigErrorContext.profile_name: (str, optional)

Profile name when applicable.

.connection_name

Section titled “.connection_name”
ConfigErrorContext.connection_name: (str, optional)

Connection name when applicable.

.section

Section titled “.section”
ConfigErrorContext.section: (str, optional)

Configuration section name (for example, "connections").

.field_path

Section titled “.field_path”
ConfigErrorContext.field_path: (list[str], optional)

Nested field path within the section.

Used By

Section titled “Used By”
 config > errors > exceptions
├──  ConfigError
├──  ConfigFieldMissingError
├──  ConfigFieldTypeError
└──  ConfigValidationError