Clean up cloud provider-related identifiers in the backend code #9928
Conversation
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
Currently, the naming pattern is inconsistent and sometimes doesn't match the official name of the external service. This patch renames such identifiers, starting from the following official names: * Amazon S3 (ref: <https://aws.amazon.com/s3/>). * Azure Blob Storage (ref: <https://azure.microsoft.com/en-us/products/storage/blobs>). * Google Cloud Storage (ref: <https://cloud.google.com/storage?hl=en>). I guess technically they just call it "Cloud Storage", but it would be ambiguous without Google. Specifically, I renamed the members of `CloudProviderChoice`, and the names of the `_CloudStorage` subclasses. I didn't change the _values_ of `CloudProviderChoice`, because this would be a breaking API change, and I don't think that's worth doing. In addition, I: * Removed the `GOOGLE_DRIVE` member, which has no implementation. * Used `TextChoices` to give each member a human-readable description.
e9f869d to
fcc1989
Compare
|
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## develop #9928 +/- ##
===========================================
+ Coverage 75.35% 82.11% +6.75%
===========================================
Files 427 427
Lines 46353 46342 -11
Branches 4131 4131
===========================================
+ Hits 34931 38053 +3122
+ Misses 11422 8289 -3133
🚀 New features to boost your workflow:
|
|
|
||
|
|
||
| class AzureBlobContainer(_CloudStorage): | ||
| class AbsCloudStorage(_CloudStorage): |
There was a problem hiding this comment.
I'm not sure Abs can be considered the established abbreviation for this service. Have you seen it anywhere? I'd prefer calling it Azure....
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 and context
Currently, the naming pattern is inconsistent and sometimes doesn't match the official name of the external service. This patch renames such identifiers, starting from the following official names:
Amazon S3 (ref: https://aws.amazon.com/s3/).
Azure Blob Storage (ref: https://azure.microsoft.com/en-us/products/storage/blobs).
Google Cloud Storage (ref: https://cloud.google.com/storage?hl=en). I guess technically they just call it "Cloud Storage", but it would be ambiguous without Google.
Specifically, I renamed the members of
CloudProviderChoice, and the names of the_CloudStoragesubclasses.I didn't change the values of
CloudProviderChoice, because this would be a breaking API change, and I don't think that's worth doing.In addition, I:
GOOGLE_DRIVEmember, which has no implementation.TextChoicesto give each member a human-readable description.How has this been tested?
Checklist
developbranch[ ] I have updated the documentation accordingly[ ] I have added tests to cover my changes[ ] I have linked related issues (see GitHub docs)License
Feel free to contact the maintainers if that's a concern.