Proper exit status for failed CLI requests #12375
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
Some CLI commands simply `print` messages when the requests fail. The issue is the exit code for these commands are `0` while it should be non-zero. More proper exist status ensures people can better make use of the CLI.
XD-DENG
added
priority:medium
XD-DENG
force-pushed
the
consistent-cli-exit-code
branch
from
2c3c8c9
to
90da8cb
Compare
turbaszek
reviewed
Nov 15, 2020
| @@ -65,7 +65,7 @@ def variables_import(args): | |||
| if os.path.exists(args.file): | |||
| _import_helper(args.file) | |||
| else: | |||
| print("Missing variables file.") | |||
| raise SystemExit("Missing variables file.") | |||
There was a problem hiding this comment.
Suggested change
| raise SystemExit("Missing variables file.") | |
| raise SystemExit("\n\tMissing variables file.") |
If we want to be consistent... but to be honest I'm not sure if we need this "prefix".
There was a problem hiding this comment.
Style consistency will need more effort. For example:
- with or without prefix "\n\t" are varying among different sub-command-groups (the same raises in
user_command.pyare withOUT this "prefix"). - some CLI failures are directly throwing "original" Python exceptions.
In this PR I would dedicate on the exit status, if you don't mind.
turbaszek
approved these changes
Nov 15, 2020
github-actions
bot
added
the
okay to merge
|
The PR should be OK to be merged with just subset of tests as it does not modify Core of Airflow. The committers might merge it or can add a label 'full tests needed' and re-run it to run all tests if they see it is needed! |
XD-DENG
force-pushed
the
consistent-cli-exit-code
branch
from
90da8cb
to
f5b1468
Compare
XD-DENG
changed the title
turbaszek
added a commit
to PolideaInternal/airflow
that referenced
this pull request
Dec 2, 2020
This PR is a followup after apache#12375 and apache#12704 it improves handling of some errors in cli commands to avoid show users to much traceback and uses SystemExit consitently.
turbaszek
added a commit
that referenced
this pull request
Dec 4, 2020
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.
Some CLI commands simply
printmessages when the requests fail. The issue is the exit code for these commands are0while it should be non-zero.Pursuing very detailed status code may not make sense here. But we can at least ensure we give non-zero status by using
raise SystemExit().More proper exist status ensures people can better make use of the CLI.
(A few minor string expression issues are fixed here as well).
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.