-
Notifications
You must be signed in to change notification settings - Fork 14.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
Also allow passing buffer instead of path for retrieve_file and store_file methods in SFTPHook #44247
Open
dabla
wants to merge
52
commits into
apache:main
Choose a base branch
from
dabla:feature/allow-passing-buffer-to-retrieve_file-in-sftp-hook
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.
Open
Also allow passing buffer instead of path for retrieve_file and store_file methods in SFTPHook #44247
dabla
wants to merge
52
commits into
apache:main
from
dabla:feature/allow-passing-buffer-to-retrieve_file-in-sftp-hook
+240
−181
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
… and store_file methods in SFTPHook like it's the case in FTPSHook
dabla
changed the title
Also allow passing buffer instead of path for retrieve_file and store_file methods in FTPSHook
Also allow passing buffer instead of path for retrieve_file and store_file methods in SFTPHook
Nov 21, 2024
…gets automatically closed
… in a context manager which makes sure every operation release the opened connection
…ed test_sftp_hook_with_proxy_command to TestSFTPHook where it belongs and reorganized imports
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.
In the FTPSHook it's also possible to pass a buffer (like StringIO/BytesIO) instead of a path, I've refactored the retrieve_file and store_file methods in SFTPHook so those also support those types. This avoids the need to create a file to be able to download a file to FTP, you can directly download it into a buffer and vice versa if you need to upload content to an FTP server you don't need to create a file locally to be able to upload it. I just delegate this to the underlying paramiko getfo and putfo methods, nothing fancy had to be done to achieve this as the paramiko library already supported this. This shortcoming was described as a pitfall for the SFTPHook.
Also using our in-house StreamOperator which allows executing an operator in a multi-threaded way within the same worker (similar to expand but then distributing the work over multiple threads within the same worker instead of multiple workers), we discovered that when using the SFTPHook in a PythonOperator to retrieve a file, the connections don't get closed, which seems probable as each thread has to instantiate a new SFTPHook as the underlying library paramiko isn't thread-safe. When you look at the source code you'll notice that each operation within the SFTPHook get's a connection but actually never closes it as you have to call the close_conn method manually.
In the past we didn't use the SFTPHook but used directly the paramiko library like this and didn't have any issues:
So I think we should refactor the SFTP hook so it always release the sftp connection after each operator to avoid connection leaks:
Otherwise we would need to call it like this, in the above you don't need to worry about the connection:
I've added a test case for both changes.
^ 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.rst
or{issue_number}.significant.rst
, in newsfragments.