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.

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

fix: allow metadata keys to be cleared #383

Merged
merged 1 commit into from Feb 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 4 additions & 1 deletion google/cloud/storage/blob.py
Expand Up @@ -3620,13 +3620,16 @@ def metadata(self):
def metadata(self, value):
"""Update arbitrary/application specific metadata for the object.

Values are stored to GCS as strings. To delete a key, set its value to
None and call blob.patch().

See https://cloud.google.com/storage/docs/json_api/v1/objects

:type value: dict
:param value: The blob metadata to set.
"""
if value is not None:
value = {k: str(v) for k, v in value.items()}
value = {k: str(v) if v is not None else None for k, v in value.items()}
self._patch_property("metadata", value)

@property
Expand Down
13 changes: 13 additions & 0 deletions tests/system/test_system.py
Expand Up @@ -874,6 +874,19 @@ def test_write_metadata(self):
blob.content_type = "image/png"
self.assertEqual(blob.content_type, "image/png")

metadata = {"foo": "Foo", "bar": "Bar"}
blob.metadata = metadata
blob.patch()
blob.reload()
self.assertEqual(blob.metadata, metadata)

# Ensure that metadata keys can be deleted by setting equal to None.
new_metadata = {"foo": "Foo", "bar": None}
blob.metadata = new_metadata
blob.patch()
blob.reload()
self.assertEqual(blob.metadata, {"foo": "Foo"})

def test_direct_write_and_read_into_file(self):
blob = self.bucket.blob("MyBuffer")
file_contents = b"Hello World"
Expand Down