Pass on azure sdk keyword arguments #376
Open
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
added 2 commits
December 1, 2022 16:43
commit ab4ca54 Author: Peter Barmettler <peter.barmettler@raccoonworks.ch> Date: Thu Dec 1 16:31:40 2022 +0100 auto use storage commit d5bdd8c Author: Peter Barmettler <peter.barmettler@raccoonworks.ch> Date: Thu Dec 1 16:26:32 2022 +0100 azure sdk docstring | pass on parameters | basic test commit 8fdb60b Author: Peter Barmettler <peter.barmettler@raccoonworks.ch> Date: Thu Dec 1 15:19:03 2022 +0100 Revert "client and upload kwargs" This reverts commit cca3c5e. commit 8a71e55 Author: Peter Barmettler <peter.barmettler@raccoonworks.ch> Date: Thu Dec 1 15:17:58 2022 +0100 add azure sdk docstring commit cca3c5e Author: Peter Barmettler <peter.barmettler@raccoonworks.ch> Date: Thu Oct 27 12:49:12 2022 +0200 client and upload kwargs
ptrba
changed the title
added 3 commits
December 1, 2022 20:31
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.
Motivation
The current implementation wraps azure-storage-blob methods without giving access to advanced keyword parameters. In rare but some cases (#375) it is necessary to tune those parameters. But, passing on all keyword arguments to azure SDK methods has potentially unintended effects and possible conflicts as discussed in (draft #364).
Suggestion here
This solution is sufficiently safe considering the fact that this is an advanced feature. At the same time, it is flexible enough to deal with changes in the azure SDK contracts. The docstring points to a specific version of the azure SDK. If the user decides to work with a different SDK or wants to use hidden undocumented arguments, he can use any keyword argument (except for the explicitly excluded ones) if he knows what he's doing.
This is a cleanup of the ideas discussed in draft #364.