Generate interfaces #2808
Closed
Generate interfaces #2808
Conversation
This file contains 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
New script interfaces/generate_interfaces.sh executes the secret command-line option __print_full_usage__ for all commands, and saves them in interfaces/legacy/. Consistency of these contents with that generated by compiled commands is verified by CI.
Files ending with .txt are ignored by git due to the contents of .gitignore. To get around this, interface text files are written with no file extension. This however would have resulted in a collision between the interface files generated for Python script algorithm interfaces, and the sub-directories for the algorithms contained within. To get around thhis, files for the former are written into their own sub-directories.
|
Seeking feedback from any @MRtrix3/mrtrix3-devs who may have opinions on this; would like to proceed with merging into #2678. |
7 tasks
|
Following discussion in #2665 and a bit more thought on the topic: We are not going to generate and store the software interfaces within the main repository. In #2678, 8065803 adds unit tests for the C++ CLI that mirror those added for the evaluation of typed Python CLI. The interface of this dummy command as generated in multiple formats can be manually reviewed. Any changes that may affect CLI parsing, eg. addition of new types, should be verified using these tests (or potentially more). |
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.
Proposed extension of #2678 (PR uses that as the base branch).
As discussed in #2798.
Relevant for #2665, which will expand upon the content here to store Pydra interfaces alongside the legacy outputs of
__print_full_usage__.As per #2798, would like to know people's thoughts on incorporating this into the repository. I'm proposing it as part of #2678 as in the absence of that changeset the Python scripts fail to conform to the precedent of
__print_full_usage__due to the absence of more complex custom command-line argument types. The additional documentation here should be one mechanism by which the validity of those changes is manually checked.