Add --format=json option to cylc broadcast command#6892
Merged
wxtim merged 1 commit intocylc:8.5.xfrom Aug 11, 2025
Merged
Conversation
MetRonnie
force-pushed
the
broadcast-json
branch
from
9e8b3c6 to
85f79bb
Compare
MetRonnie
force-pushed
the
broadcast-json
branch
from
85f79bb to
11cdf47
Compare
wxtim
approved these changes
Jul 31, 2025
Member
wxtim
left a comment
wxtim
left a comment
There was a problem hiding this comment.
It all works, and it's an elegant test. I wonder if it might be faster set up using the integration test infrastructure then just running the cli under test with a subprocess.run. Don't think it's worth spending time on.
Comment on lines
+321
to
+345
| parser.add_option( | ||
| '--json', | ||
| help=( | ||
| "With -d/--display or -k/--display-task, write out " | ||
| "the broadcast config structure in JSON format." | ||
| ), | ||
| action='store_true', | ||
| default=False, | ||
| dest='json', | ||
| ) |
Member
There was a problem hiding this comment.
In an attempt to standardise the Cylc CLI options, can we have --format=json, -t=json.
Context: #2972
MetRonnie
force-pushed
the
broadcast-json
branch
from
11cdf47 to
ee5cf77
Compare
Deprecate `--raw` in favor of `--format=raw`
MetRonnie
force-pushed
the
broadcast-json
branch
from
ee5cf77 to
6e4242d
Compare
MetRonnie
changed the title
--json option to cylc broadcast command--format=json option to cylc broadcast command
oliver-sanders
approved these changes
Aug 5, 2025
| action="store_true", default=False, dest="raw") | ||
|
|
||
| parser.add_option( | ||
| '--format', |
Member
There was a problem hiding this comment.
Consider adding the short option -t.
Member
Author
There was a problem hiding this comment.
I had a look at scripts that we might implement --format for:
broadcast: No conflict for-tin this case. However...dump:-tis--taskslist:-tis--treeplay: (which already has--format)-tis--start-taskgraph:-tis--transposeworkflow-state:-tis--task
So I'm not sure there is going to be consistency with scan
wxtim
approved these changes
Aug 11, 2025
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
3 participants
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.
Closes #6873
Check List
CONTRIBUTING.mdand added my name as a Code Contributor.