-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support passing args
as keyword argument for run-operation
in programmatic invocations
#10473
Open
dbeatty10
wants to merge
10
commits into
main
Choose a base branch
from
dbeatty/10355-rename-invoke-args
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
dbeatty10
added
user docs
[docs.getdbt.com] Needs better documentation
Skip Changelog
Skips GHA to check for changelog file
labels
Jul 22, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #10473 +/- ##
==========================================
- Coverage 88.86% 88.80% -0.06%
==========================================
Files 180 180
Lines 22560 22573 +13
==========================================
Hits 20047 20047
- Misses 2513 2526 +13
Flags with carried forward coverage won't be shown. Click here to find out more.
|
…programmatic invocations
dbeatty10
changed the title
Support passing
Support passing Jul 23, 2024
--args
for run-operation
in programmatic invocationsargs
as keyword argument for run-operation
in programmatic invocations
dbeatty10
commented
Jul 23, 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.
resolves #10355
Problem
As described in #10355, there's a naming conflict between the first parameter of
dbtRunner.invoke()
and the--args
CLI flag of therun-operation
command.Solution
args
toinvocation_args
run_dbt
andrun_dbt_and_capture
test utilities to take optionalkwargs
parameters for testing purposesInterface changes
These interface changes assume that the intended and dominant usage of
dbtRunner.invoke
is a positional first argument along with optional kwargs:dbtRunner.invoke
renameargs
toinvocation_args
and explicitly make it positionalrun_dbt
andrun_dbt_and_capture
with those same changesIf anyone has code like
dbtRunner().invoke(args=["run", ...])
they would need to update it by removingargs=
.Testing strategy
Indirectly testing
dbtRunner().invoke()
viarun_dbt_and_capture
&run_dbt
-- added this new test to verify that customargs
makes it through:Checklist