Skip to content

Storage: document thread-safety of client. #5763

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.

Sign up for GitHub

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

Merged
tseaver merged 2 commits into from
Aug 20, 2018
Merged

Storage: document thread-safety of client. #5763

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc6998c
Document thread-safety of storage client.
tseaver Aug 7, 2018
23546d2
Strengthen language for thread safety.
tseaver Aug 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/storage/client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ Install the ``google-cloud-storage`` library using ``pip``:
Usage
-----

.. note::

Becuase the :class:`~google.cloud.storage.client.Client` uses the
third-party :mod:`requests` library by default, it is 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`.

.. automodule:: google.cloud.storage.client
:members:
:show-inheritance: