Split breeze commands across multiple files #23205
Merged
Conversation
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
The cached parameters in Python Breeze were largely based on Bash implementation. They did the job but required pretty cumbersome synchronization of cached values with parameters passed and it was easy to forget about this as you had to do it sepearately in each method that had potentially cacheable parameters. In this PR we take advantage of the Click class hiarchy and their extendability. We've already extended Click Choice parameter to be much better formatted for long list of choices but we take this a bit further now with adding new type of parameter that can cache the values between runs. This has multiple advantages: * we do not have to remember about synchroniation - parameters automatically read/write their values from cache as they are used * we can automatically set parameters to default when wrong value is passed. This is nice as user does not have to re-run the command because the values are corrected on-the-flight. * the parameters can have their default values displayed in help screen (we use sentinel default that we can use to detect if value was passed from parameter or taken from default) * the parameters can also have their <current> values marked in list of choices - so the user in the help screen can see not only the default but also which value is currently selected and will be used if you do not pass any parameter.
potiuk
changed the title
Member
Author
|
cc: @Bowrna @eladkal @edithturn - we came to the point when we should split the commands into separate packages (This change is based on #23195 so it should be merged first). |
The new breeze.py commands grew into separated groups of commands and breeze.py became far too big. This change is a refactor to split breeze.py into separated groups of commands. No new functionality is added, just refactoring to separate files. Fixes: apache#23204
potiuk
force-pushed
the
split-breeze-commands
branch
from
2768b83 to
7576632
Compare
eladkal
approved these changes
Apr 25, 2022
github-actions
bot
added
the
okay to merge
|
The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest main or amend the last commit of the PR, and push it with --force-with-lease. |
Member
Author
Member
Author
|
Rebased and merged both :) |
This was referenced Apr 25, 2022
ephraimbuddy
added
the
changelog:skip
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.
The new breeze.py commands grew into separated groups of commands and
breeze.py became far too big.
This change is a refactor to split breeze.py into separated groups of
commands.
No new functionality is added, just refactoring to separate files.
Fixes: #23204
^ 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 a newsfragement file, named
{pr_number}.significant.rst, in newsfragments.