Skip to content
This repository was archived by the owner on Mar 31, 2026. It is now read-only.

Commit 3be7f6e

Browse files
tseavertseaver
committed
fix: rename parameter
Per review from @frankyn.
1 parent 1aa1a94 commit 3be7f6e

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

‎google/cloud/storage/blob.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@ def generate_signed_url(
361361
version=None,
362362
service_account_email=None,
363363
access_token=None,
364-
use_virtual_hostname=False,
364+
virtual_host_style=False,
365365
):
366366
"""Generates a signed URL for this blob.
367367
@@ -455,8 +455,8 @@ def generate_signed_url(
455455
:type access_token: str
456456
:param access_token: (Optional) Access token for a service account.
457457
458-
:type use_virtual_hostname: bool
459-
:param use_virtual_hostname:
458+
:type virtual_host_style: bool
459+
:param virtual_host_style:
460460
(Optional) If true, then construct the URL relative the bucket's
461461
virtual hostname, e.g., '<bucket-name>.storage.googleapis.com'.
462462
@@ -476,7 +476,7 @@ def generate_signed_url(
476476

477477
quoted_name = _quote(self.name, safe=b"/~")
478478

479-
if use_virtual_hostname:
479+
if virtual_host_style:
480480
api_access_endpoint = "https://{bucket_name}.storage.googleapis.com".format(
481481
bucket_name=self.bucket.name
482482
)

‎google/cloud/storage/bucket.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2354,7 +2354,7 @@ def generate_signed_url(
23542354
client=None,
23552355
credentials=None,
23562356
version=None,
2357-
use_virtual_hostname=False,
2357+
virtual_host_style=False,
23582358
):
23592359
"""Generates a signed URL for this bucket.
23602360
@@ -2417,8 +2417,8 @@ def generate_signed_url(
24172417
:param version: (Optional) The version of signed credential to create.
24182418
Must be one of 'v2' | 'v4'.
24192419
2420-
:type use_virtual_hostname: bool
2421-
:param use_virtual_hostname:
2420+
:type virtual_host_style: bool
2421+
:param virtual_host_style:
24222422
(Optional) If true, then construct the URL relative the bucket's
24232423
virtual hostname, e.g., '<bucket-name>.storage.googleapis.com'.
24242424
@@ -2436,7 +2436,7 @@ def generate_signed_url(
24362436
elif version not in ("v2", "v4"):
24372437
raise ValueError("'version' must be either 'v2' or 'v4'")
24382438

2439-
if use_virtual_hostname:
2439+
if virtual_host_style:
24402440
api_access_endpoint = "https://{bucket_name}.storage.googleapis.com".format(
24412441
bucket_name=self.name
24422442
)

‎tests/unit/test_blob.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ def _generate_signed_url_helper(
399399
encryption_key=None,
400400
access_token=None,
401401
service_account_email=None,
402-
use_virtual_hostname=False,
402+
virtual_host_style=False,
403403
):
404404
from six.moves.urllib import parse
405405
from google.cloud._helpers import UTC
@@ -443,7 +443,7 @@ def _generate_signed_url_helper(
443443
version=version,
444444
access_token=access_token,
445445
service_account_email=service_account_email,
446-
use_virtual_hostname=use_virtual_hostname,
446+
virtual_host_style=virtual_host_style,
447447
)
448448

449449
self.assertEqual(signed_uri, signer.return_value)
@@ -456,7 +456,7 @@ def _generate_signed_url_helper(
456456
encoded_name = blob_name.encode("utf-8")
457457
quoted_name = parse.quote(encoded_name, safe=b"/~")
458458

459-
if use_virtual_hostname:
459+
if virtual_host_style:
460460
expected_api_access_endpoint = "https://{}.storage.googleapis.com".format(
461461
bucket.name
462462
)
@@ -617,7 +617,7 @@ def test_generate_signed_url_v4_w_csek_and_headers(self):
617617
)
618618

619619
def test_generate_signed_url_v4_w_virtual_hostname(self):
620-
self._generate_signed_url_v4_helper(use_virtual_hostname=True)
620+
self._generate_signed_url_v4_helper(virtual_host_style=True)
621621

622622
def test_generate_signed_url_v4_w_credentials(self):
623623
credentials = object()

‎tests/unit/test_bucket.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2739,7 +2739,7 @@ def _generate_signed_url_helper(
27392739
query_parameters=None,
27402740
credentials=None,
27412741
expiration=None,
2742-
use_virtual_hostname=False,
2742+
virtual_host_style=False,
27432743
):
27442744
from six.moves.urllib import parse
27452745
from google.cloud._helpers import UTC
@@ -2774,7 +2774,7 @@ def _generate_signed_url_helper(
27742774
headers=headers,
27752775
query_parameters=query_parameters,
27762776
version=version,
2777-
use_virtual_hostname=use_virtual_hostname,
2777+
virtual_host_style=virtual_host_style,
27782778
)
27792779

27802780
self.assertEqual(signed_uri, signer.return_value)
@@ -2784,7 +2784,7 @@ def _generate_signed_url_helper(
27842784
else:
27852785
expected_creds = credentials
27862786

2787-
if use_virtual_hostname:
2787+
if virtual_host_style:
27882788
expected_api_access_endpoint = "https://{}.storage.googleapis.com".format(
27892789
bucket_name
27902790
)
@@ -2926,7 +2926,7 @@ def test_generate_signed_url_v4_w_credentials(self):
29262926
self._generate_signed_url_v4_helper(credentials=credentials)
29272927

29282928
def test_generate_signed_url_v4_w_virtual_hostname(self):
2929-
self._generate_signed_url_v4_helper(use_virtual_hostname=True)
2929+
self._generate_signed_url_v4_helper(virtual_host_style=True)
29302930

29312931

29322932
class _Connection(object):

0 commit comments

Comments
 (0)