chore: update sample tests and README to reflect new checksum defaults

andrewsg · andrewsg · commit 6aef9b7bf17c · 2024-12-10T16:13:05.000-08:00
diff --git a/README.rst b/README.rst
@@ -85,10 +85,16 @@ 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
+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.
+
 Miscellaneous
 ~~~~~~~~~~~~~
 
-- The BlobWriter class now attempts to terminate an ongoing resumable upload if
+- 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
diff --git a/samples/snippets/snippets_test.py b/samples/snippets/snippets_test.py
@@ -233,8 +233,8 @@ def test_upload_blob_from_memory(test_bucket, capsys):
 
 
 def test_upload_blob_from_stream(test_bucket, capsys):
-    file_obj = io.StringIO()
-    file_obj.write("This is test data.")
+    file_obj = io.BytesIO()
+    file_obj.write(b"This is test data.")
     storage_upload_from_stream.upload_blob_from_stream(
         test_bucket.name, file_obj, "test_upload_blob"
     )

Original file line number	Diff line number	Diff line change
`@@ -233,8 +233,8 @@ def test_upload_blob_from_memory(test_bucket, capsys):`
`233`	`233`
`234`	`234`
`235`	`235`	`def test_upload_blob_from_stream(test_bucket, capsys):`
`236`		`- file_obj = io.StringIO()`
`237`		`- file_obj.write("This is test data.")`
	`236`	`+ file_obj = io.BytesIO()`
	`237`	`+ file_obj.write(b"This is test data.")`
`238`	`238`	`storage_upload_from_stream.upload_blob_from_stream(`
`239`	`239`	`test_bucket.name, file_obj, "test_upload_blob"`
`240`	`240`	`)`