Skip to content

docs: streamline docs for c.g.c migration #876

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.

Sign up for GitHub

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

Merged
cojenco merged 7 commits into from
Oct 20, 2022
Merged

docs: streamline docs for c.g.c migration #876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1fdb29e
docs: remove literalinclude in client module
cojenco Sep 27, 2022
e1ef6f4
remove literalinclude and update samples in Blob
cojenco Sep 27, 2022
14dc22f
replace literalinclude with samples in Bucket
cojenco Oct 3, 2022
66fa0e7
update docstrings and remove inline samples
cojenco Oct 4, 2022
22a5c07
Merge branch 'main' into cgcdocs
cojenco Oct 18, 2022
0af728c
update docstrings
cojenco Oct 20, 2022
3bd6d22
Merge branch 'main' into cgcdocs
cojenco Oct 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 12 additions & 17 deletions google/cloud/storage/_signing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,15 +282,11 @@ def generate_signed_url_v2(
.. note::

If you are on Google Compute Engine, you can't generate a signed URL.
Follow `Issue 922`_ for updates on this. If you'd like to be able to
generate a signed URL from GCE, you can use a standard service account
from a JSON file rather than a GCE service account.
If you'd like to be able to generate a signed URL from GCE, you can use a
standard service account from a JSON file rather than a GCE service account.

See headers `reference`_ for more details on optional arguments.

.. _Issue 922: https://github.com/GoogleCloudPlatform/\
google-cloud-python/issues/922
.. _reference: https://cloud.google.com/storage/docs/reference-headers
See headers [reference](https://cloud.google.com/storage/docs/reference-headers)
for more details on optional arguments.

:type credentials: :class:`google.auth.credentials.Signing`
:param credentials: Credentials object with an associated private key to
Expand Down Expand Up @@ -382,6 +378,8 @@ def generate_signed_url_v2(
elements_to_sign.append(canonical.resource)
string_to_sign = "\n".join(elements_to_sign)

# If you are on Google Compute Engine, you can't generate a signed URL.
# See https://github.com/googleapis/google-cloud-python/issues/922
# Set the right query parameters.
if access_token and service_account_email:
signature = _sign_message(string_to_sign, access_token, service_account_email)
Expand Down Expand Up @@ -446,16 +444,11 @@ def generate_signed_url_v4(
.. note::

If you are on Google Compute Engine, you can't generate a signed URL.
Follow `Issue 922`_ for updates on this. If you'd like to be able to
generate a signed URL from GCE, you can use a standard service account
from a JSON file rather than a GCE service account.

See headers `reference`_ for more details on optional arguments.

.. _Issue 922: https://github.com/GoogleCloudPlatform/\
google-cloud-python/issues/922
.. _reference: https://cloud.google.com/storage/docs/reference-headers
If you'd like to be able to generate a signed URL from GCE,you can use a
standard service account from a JSON file rather than a GCE service account.

See headers [reference](https://cloud.google.com/storage/docs/reference-headers)
for more details on optional arguments.

:type credentials: :class:`google.auth.credentials.Signing`
:param credentials: Credentials object with an associated private key to
Expand Down Expand Up @@ -543,6 +536,8 @@ def generate_signed_url_v4(
request_timestamp = _request_timestamp
datestamp = _request_timestamp[:8]

# If you are on Google Compute Engine, you can't generate a signed URL.
# See https://github.com/googleapis/google-cloud-python/issues/922
client_email = service_account_email
if not access_token or not service_account_email:
ensure_signed_credentials(credentials)
Expand Down
Loading