[cli] Move output command state out of CliContext#426
Merged
Breakthrough merged 3 commits intomainfrom Oct 6, 2024
Merged
Conversation
0bd3221 to
17bfa7d
Compare
To simplify things, all output commands can be treated similarily as they all act on the result of the processing pipeline. This allows new commands to be added without needing to explicitly define their values in CliContext, and makes the values that do remain there much more meaningful. It also allows commands to be specified multiple times gracefully and with different options, so for example `save-images` can now be run twice with different encoding parameters.
17bfa7d to
ded3708
Compare
85d69f7 to
1154c01
Compare
Collaborator
|
Alright, I have had a good look through this and I think I have wrapped my head around it. I don't use the cli too often, so I always need to refresh my memory on how it all works. If I understand what this is doing correctly, then it works like this under this paradigm:
I think this makes sense and does make it easier to add additional output formats in the future. To add a new output format, I think the changes that would need to be made would be:
|
wjs018
approved these changes
Oct 5, 2024
Owner
Author
|
Though still WIP, feel free to check out #427 for a concrete example of how this simplifies adding new CLI commands. |
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.
This PR makes it a lot easier to integrate new output commands into the CLI. The goal is to have the controller treat all output commands the same by operating on the result of the processing pipeline. For dependent jobs, they can still use the shared context to communicate results. This has a few benefits:
split-videotwice to generate output videos with different parameters--verbosity debugThis should also help reduce the friction to adding new output formats, supporting #156, #323, and #388. As part of this change, some log statements will now be emitted later when a command is actually running. Previously, some commands would emit things like the location of saved files when processing the command-line arguments, rather than when the sub-command was about to run.