feat: Enhance config validation (Resolves #33)#42
Open
dyrpsf wants to merge 1 commit into
Open
Conversation
Resolves draeger-lab#33. Replaces verbose YAML traversal and USER/_USER_ keyword logic with a recursive dictionary schema validator. Adds support for type enforcement, range checking, path validation, and sensible defaults.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces a robust, dictionary-based configuration validation system to resolve Issue #33. It centralizes the validation logic into a new
config_validator.pyutility, replacing the previously verbose YAML traversal[cite: 2].Key Changes
SchemaFieldandvalidate_configto allow developers to define expected configuration structures cleanly.USER->Nonefallback with a system that warns the user and automatically applies sensible developer-defined defaults[cite: 2]._USER_keyword now throws an explicitConfigValidationErrorfor missing required parameters[cite: 2].min_val/max_val) and if string parameters match an expected list (allowed_values)[cite: 2].is_pathandpath_must_existflags to strictly verify that provided file/directory paths actually exist on the system[cite: 2].Testing
Tested locally to ensure accurate error throwing for missing parameters and out-of-bound variables, as well as successful fallbacks for deprecated keywords.