Storage: document thread-safety of client. - #5763
Merged
tseaver merged 2 commits intoAug 20, 2018
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Also note general best practice for multiprocessing use. Closes #5685.
frankyn
reviewed
Aug 8, 2018
Comment thread
docs/storage/client.rst
| 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`. |
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
theacodes
approved these changes
Aug 14, 2018
Copy link
Copy Markdown
Contributor
|
sure
…On Tue, Aug 14, 2018 at 1:04 PM Frank Natividad ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In docs/storage/client.rst
<#5763 (comment)>
:
> @@ -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 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`.
Can we update the wording to "is thread-safe" or is that too strong?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#5763 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAPUc2SuZZiCdZP-wSKdfDaZComMg-5sks5uQy1WgaJpZM4VyHbE>
.
|
Sorry, something went wrong.
Copy link
Copy Markdown
|
I ran into this same question when trying to optimize some Flask code running on GCF/GAE. Is the library written in such a way where we can make a general statement for all the APIs? Or is it really different for each API? |
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
|
@kaliberto We have two basic groups of APIs: those which use gRPC as their basic transport, and those whic use requests/HTTP. The gRPC-based clients are threadsafe, but not fork-safe; the requests-based clients are as threadsafe as requests (i.e., no known issues). |
Sorry, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
/cc @BrandonY
Also note general best practice for multiprocessing use.
Closes #5685.