Determine desired/expected return value(s) of storage.bucket.Bucket.delete_keys

[dhermes]

From TODO:

    # TODO: What should be the return value here?

See storage.bucket.Bucket.delete_keys for relevant code and #146 for some context.

git blame output

b7f1b774 (JJ Geewax   2014-01-29 18:02:29 -0500 192)     # TODO: What should be the return value here?

[dhermes]

From the code, note that in a similar situation the boto library returns a MultiDeleteResult instance.

[tseaver]

ISTM that the "Pythonic" return would be a sequence of the deleted keys, i.e:

def delete_keys(self, keys):
    deleted = []
    for key in keys:
        deleted.append(self.delete_key(key))
    return deleted

We can't use a generator, because that would require the caller to iterate-consume it to perform any but the first deletion.

[dhermes]

SGTM.

It may be worth looking into MultiDeleteResult. From search results it seems to only be used in Bucket.delete_keys.

[tseaver]

Note that the boto bit is wrapping an XML response document for a multi-delete request. Because the gcloud storage API does not support multi-delete, we would be synthesizing an entity which doesn't have a server-side analog.

[dhermes]

I see, maybe worth opening a feature request with the API team? But in the mean time, an object which tracks both deleted and errors may be useful.