Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR modernizes the parameter parsing infrastructure by replacing the simple toml library with tomlkit and significantly enhancing the TomlParmParse class with auto-documentation, auto-save features, and improved command-line integration.
Key Changes:
- Complete rewrite of
TomlParmParseclass with new features including nested parameter access via dict-like interface, automatic documentation generation, command-line argument parsing, and unused input detection - Migration from
tomllibrary totomlkitfor better control over formatting and comments - Updated example scripts to use the new
parse_args()API with inline documentation strings
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 13 comments.
Show a summary per file
| File | Description |
|---|---|
cmlm/utils/input_file.py |
Complete rewrite with new TomlParmParse implementation featuring auto-documentation, command-line parsing, and nested parameter access |
run_scripts/ctable/create_spray_table_nd.py |
Updated to use new TomlParmParse.parse_args() API with doc strings for each parameter |
run_scripts/ctable/create_spray_table_nd.toml |
Reformatted with enhanced comments and documentation structure |
run_scripts/ctable/create_dummy_table_nd.py |
Updated to use new TomlParmParse.parse_args() API |
run_scripts/ctable/create_dummy_table_nd.toml |
Reformatted with enhanced comments |
pyproject.toml |
Changed dependency from toml >= 0.10.0 to tomlkit >= 0.13.0 |
cmlm/utils/__init__.py |
Minor whitespace formatting change |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Use TOML files for config, but with auto-documentation and auto-save features.