Add config-specific exception hierarchy, validation checks, and CLI validation checks, and CLI error handling by idoudali · Pull Request #2319 · oumi-ai/oumi

idoudali · 2026-03-26T12:06:02Z

Description

Introduce dedicated config exception types and add explicit configuration checks to catch invalid or missing values early. Wire these failures into the CLI global handler so users get clearer, consistent error messages. Improve current file checks during configuration parsing

Related issues

Fixes # (issue)

Before submitting

This PR only changes documentation. (You can ignore the following checks in that case)
Did you read the contributor guideline Pull Request guidelines?
Did you link the issue(s) related to this PR in the section above?
Did you add / update tests where needed?

Reviewers

At least one review from a member of oumi-ai/oumi-staff is required.

Copilot

Pull request overview

Adds a configuration-specific exception hierarchy and uses it to fail fast on invalid/missing config file paths, then surfaces these failures as cleaner CLI errors.

Changes:

Introduce OumiConfigError / ConfigFileNotFoundError and export them from oumi.core.configs.
Add explicit “path exists and is a file” checks in config loading/saving and in LoRA adapter config discovery/reading (including wrapping read/JSON errors).
Add unit tests covering the new exception hierarchy and the new validation/error-handling paths.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
tests/unit/core/configs/test_base_config.py	Adds tests for config exception hierarchy and file/path validation behaviors in `BaseConfig`.
tests/unit/core/configs/params/test_model_params.py	Adds tests for adapter config path/file validation and read/JSON error wrapping.
src/oumi/core/configs/params/model_params.py	Validates adapter config path is a file; wraps adapter-config read/JSON errors as `OumiConfigError`.
src/oumi/core/configs/exceptions.py	Introduces new config exception types.
src/oumi/core/configs/base_config.py	Adds file existence checks and wraps YAML save `OSError` as `OumiConfigError`.
src/oumi/core/configs/init.py	Re-exports the new config exception types.
src/oumi/cli/main.py	Adds a top-level `OumiConfigError` handler to print a user-friendly error and exit.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-26T12:09:54Z

src/oumi/core/configs/base_config.py

+    if not Path(config_path).is_file():
+        raise ConfigFileNotFoundError(
+            f"Config file not found or path is not a file: {config_path}"
+        )
    with open(config_path) as f:
        stringified_config = f.read()


_read_config_without_interpolation() now checks is_file() but still calls open() without handling permission/IO errors. If the file exists but is unreadable (e.g., permission denied), this will raise a raw OSError and bypass the new OumiConfigError/CLI-friendly path. Consider catching OSError around the file read and re-raising as OumiConfigError with the path included (while preserving the original exception via from).

Copilot · 2026-03-26T12:09:55Z

src/oumi/cli/main.py

                return app()
+    except OumiConfigError as e:
+        logging.getLogger(__name__).debug(traceback.format_exc())
+        CONSOLE.print(f"[red]Error: {e}[/red]")


CONSOLE.print(f"[red]Error: {e}[/red]") uses Rich markup interpolation with an exception message that may contain [/] or other markup-like sequences. That can lead to malformed markup and potentially raise during error handling, hiding the original config error. Prefer printing with style="red" (or escaping the message) so exception text is treated as plain text.

Suggested change

CONSOLE.print(f"[red]Error: {e}[/red]")

CONSOLE.print(f"Error: {e}", style="red")

Copilot · 2026-03-26T12:09:55Z

src/oumi/cli/main.py

+    except OumiConfigError as e:
+        logging.getLogger(__name__).debug(traceback.format_exc())
+        CONSOLE.print(f"[red]Error: {e}[/red]")
+        sys.exit(1)
    except Exception as e:


The new top-level CLI handler only treats OumiConfigError as a user-facing configuration error, but most config validation in this repo raises ValueError (e.g., in ModelParams and many other config/params classes). As a result, many invalid-config cases will still fall into the generic except Exception branch and print a full traceback. If the intent is consistent user-friendly config errors, consider also handling ValueError (or normalizing validation errors to OumiConfigError).

This will be handled in a separate PR

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-27T11:28:07Z

src/oumi/core/configs/base_config.py

        Returns:
            BaseConfig: The merged configuration object.
        """
+        if not Path(config_path).is_file():


from_yaml() now checks Path(config_path).is_file() and then (in the default ignore_interpolation=True path) calls _read_config_without_interpolation(), which performs the same is_file() check again. Consider centralizing the check (e.g., rely on _read_config_without_interpolation for that branch, or factor out a shared helper) to avoid redundant filesystem stats and duplicated error logic.

Suggested change

if not Path(config_path).is_file():

if not ignore_interpolation and not Path(config_path).is_file():

Copilot · 2026-03-27T11:28:07Z

src/oumi/cli/main.py

                return app()
+    except OumiConfigError as e:
+        logging.getLogger(__name__).debug(traceback.format_exc())
+        CONSOLE.print(f"[red]Error: {e}[/red]")


CLI error formatting here differs from the pattern used elsewhere in the CLI ([red]Error:[/red] ... in e.g. cli/analyze.py and cli/deploy.py). For consistency, consider using the same [red]Error:[/red] {e} formatting (and keep only the “Error:” prefix styled).

Suggested change

CONSOLE.print(f"[red]Error: {e}[/red]")

CONSOLE.print(f"[red]Error:[/red] {e}")

src/oumi/core/configs/exceptions.py

…rror handling Introduce dedicated config exception types and add explicit configuration checks to catch invalid or missing values early. Wire these failures into the CLI global handler so users get clearer, consistent error messages. Improve current file checks during configuration parsing. Fixes OPE-1848

idoudali requested a review from oelachqar March 26, 2026 12:06

idoudali self-assigned this Mar 26, 2026

Copilot AI review requested due to automatic review settings March 26, 2026 12:06

Copilot started reviewing on behalf of idoudali March 26, 2026 12:06 View session

Copilot AI reviewed Mar 26, 2026

View reviewed changes

idoudali mentioned this pull request Mar 26, 2026

Add dataset_path existence check in DatasetParams finalize_and_validate #2320

Open

4 tasks

idoudali force-pushed the idoudali/config-exceptions branch from 14e626c to 35745d5 Compare March 26, 2026 16:19

idoudali requested a review from Copilot March 27, 2026 11:24

Copilot started reviewing on behalf of idoudali March 27, 2026 11:25 View session

Copilot AI reviewed Mar 27, 2026

View reviewed changes

idoudali force-pushed the idoudali/config-exceptions branch from 35745d5 to 9c851f3 Compare March 27, 2026 11:56

idoudali mentioned this pull request Mar 27, 2026

Validate explicitly-provided adapter_model path in ModelParams #2321

Open

4 tasks

idoudali force-pushed the idoudali/config-exceptions branch from 9c851f3 to e5f549f Compare March 27, 2026 14:33

idoudali mentioned this pull request Mar 28, 2026

Replace config ValueError with OumiConfigValueError #2325

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add config-specific exception hierarchy, validation checks, and CLI validation checks, and CLI error handling#2319

Add config-specific exception hierarchy, validation checks, and CLI validation checks, and CLI error handling#2319
idoudali wants to merge 1 commit intomainfrom
idoudali/config-exceptions

idoudali commented Mar 26, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 26, 2026

Uh oh!

Copilot AI Mar 26, 2026

Uh oh!

Copilot AI Mar 26, 2026

Uh oh!

idoudali Mar 27, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 27, 2026

Uh oh!

Copilot AI Mar 27, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	CONSOLE.print(f"[red]Error: {e}[/red]")
	CONSOLE.print(f"Error: {e}", style="red")

	if not Path(config_path).is_file():
	if not ignore_interpolation and not Path(config_path).is_file():

	CONSOLE.print(f"[red]Error: {e}[/red]")
	CONSOLE.print(f"[red]Error:[/red] {e}")

Conversation

idoudali commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related issues

Before submitting

Reviewers

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

Uh oh!

idoudali Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

idoudali commented Mar 26, 2026 •

edited

Loading