Fix bugs in cylc broadcast
#5933
Merged
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
Everything after `#` in a setting was getting stripped out
wxtim
reviewed
Jan 22, 2024
wxtim
reviewed
Jan 22, 2024
wxtim
approved these changes
Jan 22, 2024
cylc/flow/parsec/validate.py
Outdated
Comment on lines
1155
to
1156
| if isinstance(value, str) and '#' in value: | ||
| value = f'"{value}"' |
There was a problem hiding this comment.
This doesn't work if the string is already quoted e.g:
$ cylc broadcast one -n root -s 'script="sleep 30 # ja!"'
ERROR: [{'error': {'message': '(type=string) script = ""sleep 30 # ja!""', 'traceback': ['graphql.error.located_error.GraphQLLocatedError: (type=string) script = ""sleep 30 # ja!""\n']}}]Maybe use shlex.quote which has logic to avoid surplus quoting.
There was a problem hiding this comment.
shlex.quote messes with the quotes inside which we don't want. I've come up with a less hacky approach
Comment on lines
+1159
to
+1161
| val = ParsecValidator._unquote(keys, value) or value | ||
| return dedent(val).strip() |
There was a problem hiding this comment.
Should the dedent/strip happen before the _unquote?
If not, wouldn't 'foo' end up as " 'foo' "?
There was a problem hiding this comment.
This stripping is for the stuff inside the quotes, and this is the same as it was before this PR. I've tested
cylc broadcast -s 'script = "foo" 'cylc broadcast -s 'script = foo '
and both set script=foo
Comment on lines
+1148
to
+1150
| @classmethod | ||
| def coerce_str(cls, value, keys) -> str: |
There was a problem hiding this comment.
Suggested change
| @classmethod | |
| def coerce_str(cls, value, keys) -> str: | |
| @staticmethod | |
| def coerce_str(value, keys) -> str: |
There was a problem hiding this comment.
This is overriding a class method from ParsecValidator
oliver-sanders
approved these changes
Jan 24, 2024
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.
cylc broadcast --filewith a relative filepath#character in a broadcast string setting (e.g. the script setting) would be stripped out - edit runtime strips characters after # #5932Check List
CONTRIBUTING.mdand added my name as a Code Contributor.CHANGES.mdentry included if this is a change that can affect users?.?.xbranch.