From 9947c55eaa27b2fe4136e117bee23507fbf643c9 Mon Sep 17 00:00:00 2001 From: MrDocuments <150382708+Mr-Documents@users.noreply.github.com> Date: Thu, 2 Apr 2026 15:28:26 +0000 Subject: [PATCH 1/4] Fix typos and improve wording in README.rst fix: correct typos and grammar in README. --- packages/google-cloud-storage/README.rst | 28 +++++++++++------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/packages/google-cloud-storage/README.rst b/packages/google-cloud-storage/README.rst index 9e9014ddcedc..0d9b4bd9705f 100644 --- a/packages/google-cloud-storage/README.rst +++ b/packages/google-cloud-storage/README.rst @@ -4,7 +4,7 @@ Python Client for Google Cloud Storage |stable| |pypi| |versions| `Google Cloud Storage`_ is a managed service for storing unstructured data. Cloud Storage -allows world-wide storage and retrieval of any amount of data at any time. You can use +allows worldwide storage and retrieval of any amount of data at any time. You can use Cloud Storage for a range of scenarios including serving website content, storing data for archival and disaster recovery, or distributing large data objects to users via direct download. @@ -43,13 +43,13 @@ Google APIs Client Libraries, in `Client Libraries Explained`_. Quick Start ----------- -In order to use this library, you first need to go through the following steps. +To use this library, you first need to follow these steps. A step-by-step guide may also be found in `Get Started with Client Libraries`_. 1. `Select or create a Cloud Platform project.`_ 2. `Enable billing for your project.`_ 3. `Enable the Google Cloud Storage API.`_ -4. `Setup Authentication.`_ +4. `Set up Authentication.`_ .. _Get Started with Client Libraries: https://cloud.google.com/storage/docs/reference/libraries#client-libraries-install-python .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project @@ -145,7 +145,7 @@ Tracing With OpenTelemetry This is a PREVIEW FEATURE: Coverage and functionality are still in development and subject to change. This library can be configured to use `OpenTelemetry`_ to generate traces on calls to Google Cloud Storage. -For information on the benefits and utility of tracing, read the `Cloud Trace Overview `_. +For information on the benefits and utility of tracing, read the `Cloud Trace Overview`_. To enable OpenTelemetry tracing in the Cloud Storage client, first install OpenTelemetry: @@ -153,7 +153,7 @@ To enable OpenTelemetry tracing in the Cloud Storage client, first install OpenT pip install google-cloud-storage[tracing] -Set the ``ENABLE_GCS_PYTHON_CLIENT_OTEL_TRACES`` environment variable to selectively opt-in tracing for the Cloud Storage client: +Set the ``ENABLE_GCS_PYTHON_CLIENT_OTEL_TRACES`` environment variable to opt in selectively to tracing for the Cloud Storage client: .. code-block:: console @@ -199,8 +199,8 @@ For a list of libraries that can be instrumented, refer to the `OpenTelemetry Re Feedback Welcome ~~~~~~~~~~~~~~~~ -If you experience that backwards compatibility for your application is broken -with this major version release, please let us know through the Github issues +If you experience any break in backwards compatibility for your application +with this major version release, please let us know through the GitHub issues system. While some breaks of backwards compatibility may be unavoidable due to new features in the major version release, we will do our best to minimize them. Thank you. @@ -226,7 +226,7 @@ Some users may be using the original exception classes from the ``google-resumable-media`` library without explicitly installing that library. So as not to break user applications following this pattern, ``google-resumable-media`` is still in the list of dependencies in this package's -setup.py file. Applications which do not import directly from +setup.py file. Applications that do not import directly from ``google-resumable-media`` can safely disregard this dependency. This backwards compatibility feature **will be removed** in a future major version update. Please migrate to using the ``google.cloud.storage.exceptions`` @@ -239,12 +239,11 @@ In Python Storage 3.0, uploads and downloads now have a default of "auto" where applicable. "Auto" will use crc32c checksums, except for unusual cases where the fast (C extension) crc32c implementation is not available, in which case it will use md5 instead. Before Python Storage 3.0, the default was md5 for most -downloads and None for most uploads. Note that ranged downloads ("start" or -"end" set) still do not support any checksumming, and some features in +downloads and none for most uploads. Note that ranged downloads ("start" or "end" set) still do not support any checksumming, and some features in ``transfer_manager.py`` still support crc32c only. Note: The method ``Blob.upload_from_file()`` requires a file in bytes mode, but -when checksum is set to None, as was the previous default, would not throw an +when checksum is set to None, as was the previous default, it would not throw an error if passed a file in string mode under some circumstances. With the new defaults, it will now raise a TypeError. Please use a file opened in bytes reading mode as required. @@ -255,13 +254,12 @@ Miscellaneous - The ``BlobWriter`` class now attempts to terminate an ongoing resumable upload if the writer exits with an exception. - Retry behavior is now identical between media operations (uploads and - downloads) and other operations, and custom predicates are now supported for - media operations as well. + downloads) and other operations, and custom predicates are now supported + for media operations as well. - ``Blob.download_as_filename()`` will now delete the empty file if it results in a google.cloud.exceptions.NotFound exception (HTTP 404). - Previously, object upload, metadata update, and delete methods had retries - disabled by default unless the generation or metageneration was specified in - the request. This has now changed so that retries are enabled by default. + disabled by default unless the generation or metageneration was specified in the request. This has now changed so that retries are enabled by default. Next Steps From 46d2523f41aac7ecad9daeb8c385fd3ad581b80a Mon Sep 17 00:00:00 2001 From: MrDocuments <150382708+Mr-Documents@users.noreply.github.com> Date: Thu, 2 Apr 2026 16:04:58 +0000 Subject: [PATCH 2/4] fix: restore inline link and capitalization of None in README. --- packages/google-cloud-storage/README.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/packages/google-cloud-storage/README.rst b/packages/google-cloud-storage/README.rst index 0d9b4bd9705f..de7bbb3abfc1 100644 --- a/packages/google-cloud-storage/README.rst +++ b/packages/google-cloud-storage/README.rst @@ -145,7 +145,7 @@ Tracing With OpenTelemetry This is a PREVIEW FEATURE: Coverage and functionality are still in development and subject to change. This library can be configured to use `OpenTelemetry`_ to generate traces on calls to Google Cloud Storage. -For information on the benefits and utility of tracing, read the `Cloud Trace Overview`_. +For information on the benefits and utility of tracing, read the Cloud Trace Overview _. To enable OpenTelemetry tracing in the Cloud Storage client, first install OpenTelemetry: @@ -229,8 +229,7 @@ as not to break user applications following this pattern, setup.py file. Applications that do not import directly from ``google-resumable-media`` can safely disregard this dependency. This backwards compatibility feature **will be removed** in a future major -version update. Please migrate to using the ``google.cloud.storage.exceptions`` -classes as above. +version update. Please migrate to using the ``google.cloud.storage.exceptions`` classes as above. Checksum Defaults ~~~~~~~~~~~~~~~~~ @@ -239,7 +238,7 @@ In Python Storage 3.0, uploads and downloads now have a default of "auto" where applicable. "Auto" will use crc32c checksums, except for unusual cases where the fast (C extension) crc32c implementation is not available, in which case it will use md5 instead. Before Python Storage 3.0, the default was md5 for most -downloads and none for most uploads. Note that ranged downloads ("start" or "end" set) still do not support any checksumming, and some features in +downloads and None for most uploads. Note that ranged downloads ("start" or "end" set) still do not support any checksumming, and some features in ``transfer_manager.py`` still support crc32c only. Note: The method ``Blob.upload_from_file()`` requires a file in bytes mode, but From c98d6fb42a61de2b786474d4d91f57a415a366a1 Mon Sep 17 00:00:00 2001 From: Anthonios Partheniou Date: Fri, 14 Aug 2026 16:39:47 +0000 Subject: [PATCH 3/4] update post processing scripts --- .../storage-integration.yaml | 19 +++++++++---------- packages/google-cloud-storage/README.rst | 12 +++++++----- packages/google-cloud-storage/docs/README.rst | 19 +++++++++---------- 3 files changed, 25 insertions(+), 25 deletions(-) diff --git a/.librarian/generator-input/client-post-processing/storage-integration.yaml b/.librarian/generator-input/client-post-processing/storage-integration.yaml index 0710e22a9d6e..dff96767be39 100644 --- a/.librarian/generator-input/client-post-processing/storage-integration.yaml +++ b/.librarian/generator-input/client-post-processing/storage-integration.yaml @@ -296,7 +296,7 @@ replacements: |stable| |pypi| |versions| `Google Cloud Storage`_ is a managed service for storing unstructured data. Cloud Storage - allows world-wide storage and retrieval of any amount of data at any time. You can use + allows worldwide storage and retrieval of any amount of data at any time. You can use Cloud Storage for a range of scenarios including serving website content, storing data for archival and disaster recovery, or distributing large data objects to users via direct download. @@ -335,13 +335,13 @@ replacements: Quick Start ----------- - In order to use this library, you first need to go through the following steps. + To use this library, you first need to follow these steps. A step-by-step guide may also be found in `Get Started with Client Libraries`_. 1. `Select or create a Cloud Platform project.`_ 2. `Enable billing for your project.`_ 3. `Enable the Google Cloud Storage API.`_ - 4. `Setup Authentication.`_ + 4. `Set up Authentication.`_ .. _Get Started with Client Libraries: https://cloud.google.com/storage/docs/reference/libraries#client-libraries-install-python .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project @@ -445,7 +445,7 @@ replacements: pip install google-cloud-storage[tracing] - Set the ``ENABLE_GCS_PYTHON_CLIENT_OTEL_TRACES`` environment variable to selectively opt-in tracing for the Cloud Storage client: + Set the ``ENABLE_GCS_PYTHON_CLIENT_OTEL_TRACES`` environment variable to opt in selectively to tracing for the Cloud Storage client: .. code-block:: console @@ -491,8 +491,8 @@ replacements: Feedback Welcome ~~~~~~~~~~~~~~~~ - If you experience that backwards compatibility for your application is broken - with this major version release, please let us know through the Github issues + If you experience any break in backwards compatibility for your application + with this major version release, please let us know through the GitHub issues system. While some breaks of backwards compatibility may be unavoidable due to new features in the major version release, we will do our best to minimize them. Thank you. @@ -518,11 +518,10 @@ replacements: ``google-resumable-media`` library without explicitly installing that library. So as not to break user applications following this pattern, ``google-resumable-media`` is still in the list of dependencies in this package's - setup.py file. Applications which do not import directly from + setup.py file. Applications that do not import directly from ``google-resumable-media`` can safely disregard this dependency. This backwards compatibility feature **will be removed** in a future major - version update. Please migrate to using the ``google.cloud.storage.exceptions`` - classes as above. + version update. Please migrate to using the ``google.cloud.storage.exceptions`` classes as above. Checksum Defaults ~~~~~~~~~~~~~~~~~ @@ -536,7 +535,7 @@ replacements: ``transfer_manager.py`` still support crc32c only. Note: The method ``Blob.upload_from_file()`` requires a file in bytes mode, but - when checksum is set to None, as was the previous default, would not throw an + when checksum is set to None, as was the previous default, it would not throw an error if passed a file in string mode under some circumstances. With the new defaults, it will now raise a TypeError. Please use a file opened in bytes reading mode as required. diff --git a/packages/google-cloud-storage/README.rst b/packages/google-cloud-storage/README.rst index d603ee40eb3a..2062e4534ee4 100644 --- a/packages/google-cloud-storage/README.rst +++ b/packages/google-cloud-storage/README.rst @@ -145,7 +145,7 @@ Tracing With OpenTelemetry This is a PREVIEW FEATURE: Coverage and functionality are still in development and subject to change. This library can be configured to use `OpenTelemetry`_ to generate traces on calls to Google Cloud Storage. -For information on the benefits and utility of tracing, read the Cloud Trace Overview _. +For information on the benefits and utility of tracing, read the `Cloud Trace Overview `_. To enable OpenTelemetry tracing in the Cloud Storage client, first install OpenTelemetry: @@ -238,7 +238,8 @@ In Python Storage 3.0, uploads and downloads now have a default of "auto" where applicable. "Auto" will use crc32c checksums, except for unusual cases where the fast (C extension) crc32c implementation is not available, in which case it will use md5 instead. Before Python Storage 3.0, the default was md5 for most -downloads and None for most uploads. Note that ranged downloads ("start" or "end" set) still do not support any checksumming, and some features in +downloads and None for most uploads. Note that ranged downloads ("start" or +"end" set) still do not support any checksumming, and some features in ``transfer_manager.py`` still support crc32c only. Note: The method ``Blob.upload_from_file()`` requires a file in bytes mode, but @@ -253,12 +254,13 @@ Miscellaneous - The ``BlobWriter`` class now attempts to terminate an ongoing resumable upload if the writer exits with an exception. - Retry behavior is now identical between media operations (uploads and - downloads) and other operations, and custom predicates are now supported - for media operations as well. + downloads) and other operations, and custom predicates are now supported for + media operations as well. - ``Blob.download_as_filename()`` will now delete the empty file if it results in a google.cloud.exceptions.NotFound exception (HTTP 404). - Previously, object upload, metadata update, and delete methods had retries - disabled by default unless the generation or metageneration was specified in the request. This has now changed so that retries are enabled by default. + disabled by default unless the generation or metageneration was specified in + the request. This has now changed so that retries are enabled by default. Next Steps diff --git a/packages/google-cloud-storage/docs/README.rst b/packages/google-cloud-storage/docs/README.rst index 5c3a4f3ba591..2062e4534ee4 100644 --- a/packages/google-cloud-storage/docs/README.rst +++ b/packages/google-cloud-storage/docs/README.rst @@ -4,7 +4,7 @@ Python Client for Cloud Storage |stable| |pypi| |versions| `Google Cloud Storage`_ is a managed service for storing unstructured data. Cloud Storage -allows world-wide storage and retrieval of any amount of data at any time. You can use +allows worldwide storage and retrieval of any amount of data at any time. You can use Cloud Storage for a range of scenarios including serving website content, storing data for archival and disaster recovery, or distributing large data objects to users via direct download. @@ -43,13 +43,13 @@ Google APIs Client Libraries, in `Client Libraries Explained`_. Quick Start ----------- -In order to use this library, you first need to go through the following steps. +To use this library, you first need to follow these steps. A step-by-step guide may also be found in `Get Started with Client Libraries`_. 1. `Select or create a Cloud Platform project.`_ 2. `Enable billing for your project.`_ 3. `Enable the Google Cloud Storage API.`_ -4. `Setup Authentication.`_ +4. `Set up Authentication.`_ .. _Get Started with Client Libraries: https://cloud.google.com/storage/docs/reference/libraries#client-libraries-install-python .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project @@ -153,7 +153,7 @@ To enable OpenTelemetry tracing in the Cloud Storage client, first install OpenT pip install google-cloud-storage[tracing] -Set the ``ENABLE_GCS_PYTHON_CLIENT_OTEL_TRACES`` environment variable to selectively opt-in tracing for the Cloud Storage client: +Set the ``ENABLE_GCS_PYTHON_CLIENT_OTEL_TRACES`` environment variable to opt in selectively to tracing for the Cloud Storage client: .. code-block:: console @@ -199,8 +199,8 @@ For a list of libraries that can be instrumented, refer to the `OpenTelemetry Re Feedback Welcome ~~~~~~~~~~~~~~~~ -If you experience that backwards compatibility for your application is broken -with this major version release, please let us know through the Github issues +If you experience any break in backwards compatibility for your application +with this major version release, please let us know through the GitHub issues system. While some breaks of backwards compatibility may be unavoidable due to new features in the major version release, we will do our best to minimize them. Thank you. @@ -226,11 +226,10 @@ Some users may be using the original exception classes from the ``google-resumable-media`` library without explicitly installing that library. So as not to break user applications following this pattern, ``google-resumable-media`` is still in the list of dependencies in this package's -setup.py file. Applications which do not import directly from +setup.py file. Applications that do not import directly from ``google-resumable-media`` can safely disregard this dependency. This backwards compatibility feature **will be removed** in a future major -version update. Please migrate to using the ``google.cloud.storage.exceptions`` -classes as above. +version update. Please migrate to using the ``google.cloud.storage.exceptions`` classes as above. Checksum Defaults ~~~~~~~~~~~~~~~~~ @@ -244,7 +243,7 @@ downloads and None for most uploads. Note that ranged downloads ("start" or ``transfer_manager.py`` still support crc32c only. Note: The method ``Blob.upload_from_file()`` requires a file in bytes mode, but -when checksum is set to None, as was the previous default, would not throw an +when checksum is set to None, as was the previous default, it would not throw an error if passed a file in string mode under some circumstances. With the new defaults, it will now raise a TypeError. Please use a file opened in bytes reading mode as required. From 8fdfa10a8b8ebdc75c25776fede999e97302cd18 Mon Sep 17 00:00:00 2001 From: Anthonios Partheniou Date: Fri, 14 Aug 2026 16:41:23 +0000 Subject: [PATCH 4/4] revert --- .../client-post-processing/storage-integration.yaml | 3 ++- packages/google-cloud-storage/README.rst | 3 ++- packages/google-cloud-storage/docs/README.rst | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/.librarian/generator-input/client-post-processing/storage-integration.yaml b/.librarian/generator-input/client-post-processing/storage-integration.yaml index dff96767be39..6a26886ca39f 100644 --- a/.librarian/generator-input/client-post-processing/storage-integration.yaml +++ b/.librarian/generator-input/client-post-processing/storage-integration.yaml @@ -521,7 +521,8 @@ replacements: setup.py file. Applications that do not import directly from ``google-resumable-media`` can safely disregard this dependency. This backwards compatibility feature **will be removed** in a future major - version update. Please migrate to using the ``google.cloud.storage.exceptions`` classes as above. + version update. Please migrate to using the ``google.cloud.storage.exceptions`` + classes as above. Checksum Defaults ~~~~~~~~~~~~~~~~~ diff --git a/packages/google-cloud-storage/README.rst b/packages/google-cloud-storage/README.rst index 2062e4534ee4..7422dfc88401 100644 --- a/packages/google-cloud-storage/README.rst +++ b/packages/google-cloud-storage/README.rst @@ -229,7 +229,8 @@ as not to break user applications following this pattern, setup.py file. Applications that do not import directly from ``google-resumable-media`` can safely disregard this dependency. This backwards compatibility feature **will be removed** in a future major -version update. Please migrate to using the ``google.cloud.storage.exceptions`` classes as above. +version update. Please migrate to using the ``google.cloud.storage.exceptions`` +classes as above. Checksum Defaults ~~~~~~~~~~~~~~~~~ diff --git a/packages/google-cloud-storage/docs/README.rst b/packages/google-cloud-storage/docs/README.rst index 2062e4534ee4..7422dfc88401 100644 --- a/packages/google-cloud-storage/docs/README.rst +++ b/packages/google-cloud-storage/docs/README.rst @@ -229,7 +229,8 @@ as not to break user applications following this pattern, setup.py file. Applications that do not import directly from ``google-resumable-media`` can safely disregard this dependency. This backwards compatibility feature **will be removed** in a future major -version update. Please migrate to using the ``google.cloud.storage.exceptions`` classes as above. +version update. Please migrate to using the ``google.cloud.storage.exceptions`` +classes as above. Checksum Defaults ~~~~~~~~~~~~~~~~~