Add --dump-options-json flag for option discovery#2032
Draft
MJohnson459 wants to merge 1 commit into
Draft
Conversation
Adds a --dump-options-json flag to the ODM entrypoint that prints all available options as a JSON object to stdout and exits, before any parsing or validation that would require a dataset. This lets API clients (e.g. NodeODM) discover the available processing options through the normal entrypoint (run.sh / run.bat / pixi run odm), instead of importing opendm/config.py directly and monkeypatching argparse to scrape option metadata. The output format matches what that scraping currently produces, so it is a drop-in for existing clients. The serialization (options_to_json) introspects the parser's actions and stringifies help, metavar, type, default and choices for each option. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
Adds a
--dump-options-jsonflag to the ODM entrypoint that prints all available options as a JSON object to stdout and exits, before any parsing or validation that would require a dataset.This lets API clients (e.g. NodeODM) discover the available processing options through the normal entrypoint without relying on internal knowledge of the ODM codebase e.g. NodeODM odmOptionsToJson.py.
The serialization (options_to_json) introspects the parser's actions and stringifies help, metavar, type, default and choices for each option.
Note this was primarily done by Claude Opus but I tested its output and verified it worked with a modified NodeODM and a the pixi environment.