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

feat: add additional_blob_attributes to upload_many_from_filenames #1162

Merged
merged 3 commits into from
Oct 12, 2023

Conversation

andrewsg
Copy link
Contributor

Fixes #996 🦕

@andrewsg andrewsg requested review from a team as code owners October 12, 2023 00:11
@product-auto-label product-auto-label bot added size: m Pull request size is medium. api: storage Issues related to the googleapis/python-storage API. labels Oct 12, 2023
@product-auto-label product-auto-label bot added size: s Pull request size is small. and removed size: m Pull request size is medium. labels Oct 12, 2023

file_blob_pairs = []

for filename in filenames:
path = os.path.join(source_directory, filename)
blob_name = blob_name_prefix + filename
blob = bucket.blob(blob_name, **blob_constructor_kwargs)
for prop, value in additional_blob_attributes.items():
setattr(blob, prop, value)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason not to use blob._patch_property() that is broadly used in the library? Blob property changes are propagated through blob._get_writable_metadata and blob._get_upload_arguments

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did consider that but decided there was no need to use a private method on the blob class when the typical public interface of attribute assignment would do the same thing.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious how the blob properties are actually picked up in blob._changes. I thought we're relying on blob._changes to get writable metadata for the upload arguments

object_metadata = {"name": self.name}
for key in self._changes:
if key in _WRITABLE_FIELDS:
object_metadata[key] = self._properties[key]
return object_metadata

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the _PropertyMixin, all the fields set as a _scalar_property have a custom setter that updates _changes. This solution using setattr will also activate that.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see, that makes sense, thanks! One last nit on the naming, maybe consider additional_blob_properties for consistency? Property is used in the official docs and in the lib.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haha, that was actually the name in my first revision.

I changed it to "attributes" because it's not only _scalar_property but any attribute that we can set with setattr. Also, since we're using setattr the nomenclature matches.

@andrewsg
Copy link
Contributor Author

I'm going to add a system test to this before merging, working on it now.

@product-auto-label product-auto-label bot added size: m Pull request size is medium. and removed size: s Pull request size is small. labels Oct 12, 2023
Copy link
Contributor

@cojenco cojenco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@andrewsg andrewsg added the automerge Merge the pull request once unit tests and other checks pass. label Oct 12, 2023
@gcf-merge-on-green gcf-merge-on-green bot merged commit c7229f2 into main Oct 12, 2023
13 checks passed
@gcf-merge-on-green gcf-merge-on-green bot deleted the tm-attribs branch October 12, 2023 18:46
@gcf-merge-on-green gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Oct 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: storage Issues related to the googleapis/python-storage API. size: m Pull request size is medium.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add properties like e.g. cache-control to transfer manager
2 participants