fix: make GOOGLE_APPLICATION_CREDENTIALS optional #2295
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
The variable can often be omitted in environments that use default credentials such as GKE (Google cloud's managed Kubernetes) or VM instances. Django-storages also acknowledges this, and it provides GS_CREDENTIALS as a way around systems where the default credentials are not used or undesired. However, it's impossible to not set the environment variable setting, and without passing a path to a valid file that contains a valid JSON structure of a service account key, this code will raise an error. Refs: * https://django-storages.readthedocs.io/en/latest/backends/gcloud.html#authentication-settings * https://googleapis.dev/python/google-auth/latest/reference/google.auth.html#google.auth.default * https://github.com/googleapis/google-auth-library-python/blob/d2ab3afdb567850121fec7de1d86fb5fb0fa80ed/google/oauth2/service_account.py#L643-L658 * https://github.com/googleapis/google-auth-library-python/blob/d2ab3afdb567850121fec7de1d86fb5fb0fa80ed/google/auth/_service_account_info.py#L78-L80
Apply Sweep Rules to your PR?
|
|
@doccano could anyone kindly review this PR? |
|
+1 |
asfaltboy
commented
Apr 24, 2024
Comment on lines
+14
to
+18
| _google_application_credentials = env("GOOGLE_APPLICATION_CREDENTIALS", "") | ||
| if _google_application_credentials: | ||
| GS_CREDENTIALS = service_account.Credentials.from_service_account_file( | ||
| _google_application_credentials | ||
| ) |
There was a problem hiding this comment.
Perhaps we ought to set the default to None when not set:
Suggested change
| _google_application_credentials = env("GOOGLE_APPLICATION_CREDENTIALS", "") | |
| if _google_application_credentials: | |
| GS_CREDENTIALS = service_account.Credentials.from_service_account_file( | |
| _google_application_credentials | |
| ) | |
| _google_application_credentials = env("GOOGLE_APPLICATION_CREDENTIALS", "") | |
| if _google_application_credentials: | |
| GS_CREDENTIALS = service_account.Credentials.from_service_account_file( | |
| _google_application_credentials | |
| ) | |
| else: | |
| GS_CREDENTIALS = None |
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.
The variable can often be omitted in environments that use default credentials such as GKE (Google cloud's managed Kubernetes) or VM instances.
Django-storages also acknowledges this, and it provides GS_CREDENTIALS as a way around systems where the default credentials are not used or undesired.
However, it's impossible to not set the environment variable setting, and without passing a path to a valid file that contains a valid JSON structure of a service account key, this code will raise an error.
Refs: