Add optional 'connection' parameter for any method that hits the wire #825
Description
From #796
@dhermes, @jgeewax could we make every API-triggering method take an optional connection argument, which would override the bound / default connection for only that call? Seems like that would be a useful pattern across all services; it would also help mark those methods as being API/latency relevant.
Activity
dhermes commentedon Apr 15, 2015
Thanks for filing. That's the goal. Mentioned this in #728 and #632 but it's not really spelled out.
tseaver commentedon Apr 16, 2015
datastoreFree API functions
api.getapi.putapi.deleteapi.allocate_idsbatch.Batchmethods(note that
Batch.__init__takes aconnection, handles fallback)Batch.commitBatchexists purely as a wrapper/proxy for an existing connection.dataset.Datasetmethods(note that
Dataset.__init__takes aconnection, defaulting to None).Dataset.get(wrapsapi.get) (#825: Allow passing explicit connection to dataset API methods. #858)Dataset.put(wrapsapi.put) (#825: Allow passing explicit connection to dataset API methods. #858)Dataset.delete(wrapsapi.delete) (#825: Allow passing explicit connection to dataset API methods. #858)Dataset.batch(Batchinstance holds connection) (#825: Allow passing explicit connection to dataset API methods. #858)Dataset.transaction(Transactioninstance holds connection) (#825: Allow passing explicit connection to dataset API methods. #858)query.QuerymethodsQuery.fetch(handles fallback, passes connection toIterator)transaction.TransactionmethodsNo real usecase for an explicit connection, given that
Batchexists purely as a wrapper/proxy for an existing connection.(note that
Transaction.__init__takes aconnection, handles fallback viaBatch.__init__)Transaction.beginTransaction.rollbackTransaction.commitBatch.commit)pubsubFree API functions
api.list_topicsapi.list_subscriptionssubscription.SubscriptionmethodsSubscription.from_api_reprSubscription.create(usesself.topic.connection) (#825: Allow passing explicit connection to pubsub API methods #859)Subscription.exists(usesself.topic.connection) (#825: Allow passing explicit connection to pubsub API methods #859)Subscription.reload(usesself.topic.connection) (#825: Allow passing explicit connection to pubsub API methods #859)Subscription.modify_push_configuration(usesself.topic.connection) (#825: Allow passing explicit connection to pubsub API methods #859)Subscription.pull(usesself.topic.connection) (#825: Allow passing explicit connection to pubsub API methods #859)Subscription.acknowledge(usesself.topic.connection) (#825: Allow passing explicit connection to pubsub API methods #859)Subscription.modify_ack_deadline(usesself.topic.connection) (#825: Allow passing explicit connection to pubsub API methods #859)Subscription.delete(usesself.topic.connection) (#825: Allow passing explicit connection to pubsub API methods #859)topic.Topicmethods:(note that
Topic.__init__takes aconnection, handles fallback)Topic.from_api_reprTopic.create(usesself.connection) (#825: Allow passing explicit connection to pubsub API methods #859)Topic.exists(usesself.connection) (#825: Allow passing explicit connection to pubsub API methods #859)Topic.publish(usesself.connection) (#825: Allow passing explicit connection to pubsub API methods #859)Topic.batch(delegates to_Batchinstance) (#825: Allow passing explicit connection to pubsub API methods #859)Topic.delete(usesself.connection) (#825: Allow passing explicit connection to pubsub API methods #859)topic._Batchmethods:_Batch.commit(usesself.topic.connection, called from__exit__when batch used as a context manager) (#825: Allow passing explicit connection to pubsub API methods #859)storage_helpers._PropertyMixinmethods (inherited byBlob/Bucket)_PropertyMixin.reload(#825: Allow passing explicit connection to '_PropertyMixin.{reload,patch}'. #852)_PropertyMixin.patch(#825: Allow passing explicit connection to '_PropertyMixin.{reload,patch}'. #852)acl.ACLmethodsACL.reload(#825: Allow passing explicit connection toACL.{reload,save}#853)ACL.save(#825: Allow passing explicit connection toACL.{reload,save}#853)ACL.clear(#825: Allow passing explicit connection toACL.{reload,save}#853)acl.BucketACLmethodsBucketACL.reload(#825: Allow passing explicit connection toACL.{reload,save}#853)BucketACL.save(#825: Allow passing explicit connection toACL.{reload,save}#853)BucketACL.clear(#825: Allow passing explicit connection toACL.{reload,save}#853)acl.BlobACLmethodsBlobACL.reload(#825: Allow passing explicit connection toACL.{reload,save}#853)BlobACL.save(#825: Allow passing explicit connection toACL.{reload,save}#853)BlobACL.clear(#825: Allow passing explicit connection toACL.{reload,save}#853)Free API functions
api.lookup_bucketapi.list_buckets(handles fallback, passes connection to_BucketIterator)api.get_bucketapi.create_bucketbatch.BatchmethodsNo real usecase for an explicit connection, given that
Batchexists purely as a wrapper/proxy for an existing connection.(note that
Batch.__init__takes aconnection, handles fallback)Batch._do_requestself._connection)Batch.finish_do_request; called in__exit__when batch used as a context manager).blob.BlobmethodsBlob.connectionproperty (delegates toself.bucket.connection) (Remove 'Blob.connection' property. #873)Blob.generate_signed_urlBlob.existsBlob.rename(delegates toself.bucket.copy_blob, #825: Allow passing explicit connection to 'Blob.{rename,delete}'. #854)Blob.delete(delegates toself.bucket.delete_blob, #825: Allow passing explicit connection to 'Blob.{rename,delete}'. #854)Blob.download_to_fileBlob.download_to_filenameBlob.download_as_stringBlob.upload_from_fileBlob.upload_from_filenameBlob.upload_from_stringBlob.make_public(#825: Allow passing explicit connection to 'Blob.make_public' #855)bucket.Bucketmethods(note that
Bucket.__init__takes aconnection, does not handle fallback)Bucket.connectionproperty (Remove 'Bucket.connection' property #876)Bucket.exists(Removing most remaining uses of self.connection in Bucket #843)Bucket.create(Removing most remaining uses of self.connection in Bucket #843)Bucket.get_blob(Removing most remaining uses of self.connection in Bucket #843)Bucket.delete(Removing most remaining uses of self.connection in Bucket #843)Bucket.list_blobs(#825: Allow passing explicit connection to 'Bucket.{list_blobs,make public}' #856)Bucket.delete_blob(Removing most remaining uses of self.connection in Bucket #843)Bucket.delete_blobs(delegates todelete_blob) (Removing most remaining uses of self.connection in Bucket #843)Bucket.copy_blob(Removing most remaining uses of self.connection in Bucket #843)Bucket.upload_file(should die?) (Removing most remaining uses of self.connection in Bucket #843)Bucket.upload_file_object(should die?) (Removing most remaining uses of self.connection in Bucket #843)Bucket.make_public(#825: Allow passing explicit connection to 'Bucket.{list_blobs,make public}' #856)[-]Add connection as a parameter for any method that hits the wire?[/-][+]Add optional 'connection' parameter for any method that hits the wire[/+]Merge pull request #854 from tseaver/825-storage_blob-explicit_connec…
Merge pull request #852 from tseaver/825-storage_property_mixin-allow…
Merge pull request #853 from tseaver/825-storage_acl-explicit_connection
Merge pull request #859 from tseaver/825-pubsub-explicit_connection
Merge pull request #855 from tseaver/825-storage_blob_make_public-exp…
Merge pull request #856 from tseaver/825-storage_bucket_list_blobs_ma…
dhermes commentedon Aug 28, 2015
@tseaver Please re-open if this isn't covered (by
clients now instead ofconnections)Auto-update dependencies. [(#825)](GoogleCloudPlatform/python-docs-sa…
3 remaining items
chore(deps): update all dependencies (#825)
chore(python): remove obsolete release scripts and config files (#825)
chore: add experimental async data client (#920)
chore(main): release 2.25.1 (#825)
build: update actions/upload-artifact and actions/download-artifact (#…
chore(.github): Update python logging issues and prs assignee (#825)
chore: Update release-please (#825)
chore(.github): Update python logging issues and prs assignee (#825)
chore: add experimental async data client (#920)
samples: add samples from pubsub/cloud-client (#134)
Auto-update dependencies. [(#825)](GoogleCloudPlatform/python-docs-sa…
chore: release 2.23.1 (#825)
build(deps): [autoapprove] bump cryptography from 41.0.0 to 41.0.2 (#825
chore(deps): update dependency cachetools to v6.2.6 (#825)
chore(main): release 2.5.0 (#825)