SG-35529 Minor code refactoring: Clarify the use of _build_opener in download_attachment#343
Merged
julien-lang merged 2 commits intomasterfrom Jun 6, 2024
Merged
Conversation
…cookie to download_attachment
…p_auth_cookie to download_attachment
eduardoChaucaGallegos
approved these changes
Jun 5, 2024
|
For what it's worth a year after the battle: |
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
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.
Clarify the use of
_build_openerindownload_attachmentBefore this change,
download_attachmentindirectly used_build_openerby callingset_up_auth_cookie. This was misleading because the name of the function,set_up_auth_cookie, does not indicate that it will return a request handler object.Since
set_up_auth_cookieis only used bydownload_attachment, I suggest this small refactoring makingdownload_attachmentdirectly call_build_openerwith an optional cookie handler if necessary.This PR renames/transforms the
set_up_auth_cookiefunction toget_auth_cookie_handler.