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

Documentation: Clarify upload_from_file and download_to_file usecases #165

@rafilong

Description

@rafilong

Issue
When using upload_from_file and download_to_file to manipulate large files, it's hard to tell whether any progress is being made and whether the functions are suited for such a case. Both reference google-resumable-media as an option for more fine-grain control, but aren't clear about when this fine-grained control may be needed.

Suggestions

  • Documentation for _do_upload mentions use of resumable media requests over a size threshold. Including this in upload_from_file and download_to_file would make it clear that these functions are suited for large file upload/download
  • Alternatively, explicitly state that functions will not timeout or run into OOM issues due to large file size.

Metadata

Metadata

Labels

api: storageIssues related to the googleapis/python-storage API.documentationImprovements or additions to documentationtype: docsImprovement to the documentation for an API.

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions