Document thread-safety of library

After reading through the docs, it is unclear to me whether I should expect this code to work:

from google.cloud import storage
import thread

client = storage.Client()
for blob in bucket.list_blobs():
  thread.start_new_thread( blob.download_to_filename, '/tmp/' + blob.name)

google-cloud-storage has been based on requests since #3674, released with google-cloud-storage 1.3.0 just about a year ago.

I'm leaving this open as a docs bug so that we add a note to that effect.

Sorry, you last me. Does being based on requests imply that google-cloud-storage is thread-safe, and the code example above should work fine?

Yes to both questions.

@BrandonY

@BrandonY Here is the text I am planning to add to the client page:

.. note::

   Becuase the :class:`~google.cloud.storage.client.Client` uses the
   third-party :mod:`requests` library by default, it should be safe to
   share instances across threads.  In multiprocessing scenarious, best
   practice is to create client instances *after* 
   :class:`multiprocessing.Pool` or :class:`multiprocessing.Process` invokes
   :func:`os.fork`.

Does that address your need?

@BrandonY

@BrandonY Please follow up via #5763, if needed.

Storage: document thread-safety of client. (#5763)

Navigation Menu

Repository navigation

Document thread-safety of library #5685

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Document thread-safety of library #5685

Description

Activity

tseaver commented on Jul 25, 2018

BrandonY commented on Jul 25, 2018

tseaver commented on Jul 26, 2018

tseaver commented on Aug 7, 2018

tseaver commented on Aug 7, 2018

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions