Warn user about unused replace parameter in insert_rows (OracleHook) #39408
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
Taragolis
reviewed
May 4, 2024
RichieSK
changed the title
RichieSK
force-pushed
the
patch-1
branch
2 times, most recently
from
67ece44
to
8c36ec2
Compare
syedahsn
reviewed
May 6, 2024
…acleHook class The replace boolean parameter claims to replace rows instead of insert, but this functionality has not been implemented and the documentation claims it works. This can be misleading to any user of this class. Furthermore, the parameter isn't even being used anywhere in this function. In this commit, I removed the parameter to prevent any confusion amongst the users of this class.
Re-introduced the replace boolean parameter. Added a warning when the user sets the replace parameter to True. Updated the docstring to let the user know that the replace boolean parameter does nothing.
Updated the formatting of warning to increase readability.
Switched back to original description of replace parameter with a warning of no current implementation
Taragolis
approved these changes
May 18, 2024
Added a format fix to pass static format testing
potiuk
approved these changes
May 19, 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.
Following changes made to OracleHook class.
The replace boolean parameter claims to replace rows instead of insert, but this functionality has not been implemented and the documentation claims it works. This can be misleading to any user of this class. Furthermore, the parameter isn't even being used anywhere in this function.
In this change, I removed the unused 'replace' parameter in both the function and the docs to prevent any confusion amongst the users of this class.
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an 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 newsfragment file, named
{pr_number}.significant.rstor{issue_number}.significant.rst, in newsfragments.