Skip to content
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

#484 Add GSClient timeout support #485

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

#484 Add GSClient timeout support #485

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8caa7e8
add timeout support
Nov 4, 2024
9b034b7
no implicit optional
Nov 13, 2024
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
13 changes: 9 additions & 4 deletions cloudpathlib/gs/gsclient.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
local_cache_dir: Optional[Union[str, os.PathLike]] = None,
content_type_method: Optional[Callable] = mimetypes.guess_type,
download_chunks_concurrently_kwargs: Optional[Dict[str, Any]] = None,
timeout: Optional[float] = None,
):
"""Class constructor. Sets up a [`Storage
Client`](https://googleapis.dev/python/storage/latest/client.html).
Expand Down Expand Up @@ -85,6 +86,7 @@
download_chunks_concurrently_kwargs (Optional[Dict[str, Any]]): Keyword arguments to pass to
[`download_chunks_concurrently`](https://cloud.google.com/python/docs/reference/storage/latest/google.cloud.storage.transfer_manager#google_cloud_storage_transfer_manager_download_chunks_concurrently)
for sliced parallel downloads; Only available in `google-cloud-storage` version 2.7.0 or later, otherwise ignored and a warning is emitted.
timeout (Optional[float]): Cloud Storage [timeout value](https://cloud.google.com/python/docs/reference/storage/1.39.0/retry_timeout)
"""
if application_credentials is None:
application_credentials = os.getenv("GOOGLE_APPLICATION_CREDENTIALS")
Expand All @@ -102,6 +104,10 @@
self.client = StorageClient.create_anonymous_client()

self.download_chunks_concurrently_kwargs = download_chunks_concurrently_kwargs
self.timeout = timeout
self.blob_kwargs = {}
if self.timeout:
self.blob_kwargs["timeout"] = self.timeout

Check warning on line 110 in cloudpathlib/gs/gsclient.py

View check run for this annotation

Codecov / codecov/patch

cloudpathlib/gs/gsclient.py#L110 

Added line #L110 was not covered by tests

super().__init__(
local_cache_dir=local_cache_dir,
Expand All @@ -128,7 +134,6 @@
blob = bucket.get_blob(cloud_path.blob)

local_path = Path(local_path)

if transfer_manager is not None and self.download_chunks_concurrently_kwargs is not None:
transfer_manager.download_chunks_concurrently(
blob, local_path, **self.download_chunks_concurrently_kwargs
Expand All @@ -139,7 +144,7 @@
"Ignoring `download_chunks_concurrently_kwargs` for version of google-cloud-storage that does not support them (<2.7.0)."
)

blob.download_to_filename(local_path)
blob.download_to_filename(local_path, **self.blob_kwargs)

return local_path

Expand Down Expand Up @@ -246,7 +251,7 @@
dst_bucket = self.client.bucket(dst.bucket)

src_blob = src_bucket.get_blob(src.blob)
src_bucket.copy_blob(src_blob, dst_bucket, dst.blob)
src_bucket.copy_blob(src_blob, dst_bucket, dst.blob, **self.blob_kwargs)

if remove_src:
src_blob.delete()
Expand Down Expand Up @@ -279,7 +284,7 @@
content_type, _ = self.content_type_method(str(local_path))
extra_args["content_type"] = content_type

blob.upload_from_filename(str(local_path), **extra_args)
blob.upload_from_filename(str(local_path), **extra_args, **self.blob_kwargs)
return cloud_path

def _get_public_url(self, cloud_path: GSPath) -> str:
Expand Down
Loading