WIP: NDB: Async context#6429

Merged

chrisrossi merged 11 commits intogoogleapis:masterfrom

chrisrossi:ndb-async-context

Nov 8, 2018

chrisrossi commented Nov 6, 2018

Work in progress. Sharing early so I can get feedback.

chrisrossi requested a review from crwilcox as a code owner

November 6, 2018 21:26

googlebot added the cla: yes label

chrisrossi added do not merge api: ndb labels

chrisrossi commented

View reviewed changes

ndb/src/google/cloud/ndb/async_context.py Outdated Show resolved Hide resolved

chrisrossi commented

View reviewed changes

ndb/src/google/cloud/ndb/async_context.py Outdated Show resolved Hide resolved

chrisrossi commented

View reviewed changes

ndb/src/google/cloud/ndb/async_context.py Outdated

+                  accomplished in a middleware layer.
+                  """
+                  loop = _eventloop.contexts.push()
+                  yield

This comment was marked as spam.

Sign in to view

chrisrossi assigned dhermes and tseaver

dhermes reviewed

View reviewed changes

ndb/src/google/cloud/ndb/async_.py Outdated Show resolved Hide resolved

ndb/src/google/cloud/ndb/async_.py Outdated Show resolved Hide resolved

ndb/src/google/cloud/ndb/async_.py Outdated Show resolved Hide resolved

ndb/src/google/cloud/ndb/async_.py Outdated

+                  This function provides a context manager which establishes the event loop
+                  that will be used for any asynchronous NDB calls that occur in the context.
+                  For example::

This comment was marked as spam.

Sign in to view

ndb/src/google/cloud/ndb/async_.py Outdated

+                  loop = _eventloop.contexts.push()
+                  yield
+                  _eventloop.contexts.pop()
+                  loop.run()

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

ndb/tests/unit/test_async_.py Outdated

		@@ -0,0 +1,24 @@
		import unittest

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

ndb/tests/unit/test_async_.py Outdated

		from google.cloud.ndb import async_


		@unittest.mock.patch("google.cloud.ndb.async_._eventloop.EventLoop")

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

ndb/tests/unit/test_async_.py Outdated

+              @unittest.mock.patch("google.cloud.ndb.async_._eventloop.EventLoop")
+              def test_async_context(EventLoop):
+                  one = unittest.mock.Mock()

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

ndb/tests/unit/test_async_.py Outdated

+              def test_async_context(EventLoop):
+                  one = unittest.mock.Mock()
+                  two = unittest.mock.Mock()
+                  EventLoop.return_value = one

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

ndb/tests/unit/test_async_.py Outdated

+                      one.run.assert_not_called()
+                      two.run.assert_called_once_with()
+                  assert _eventloop.contexts.current() is None
+                  one.run.assert_called_once_with()

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

tseaver suggested changes

View reviewed changes

ndb/src/google/cloud/ndb/_eventloop.py Show resolved Hide resolved

Chris Rossi added 3 commits

November 7, 2018 14:39


          Basic idea for establishing asyn context.

bd007c3


          Add a docstring.

2d91a2b


          Get in top-level imports.

acbe003

chrisrossi force-pushed the ndb-async-context branch from f0673b5 to acbe003 Compare

November 7, 2018 19:44

Chris Rossi added 5 commits

November 7, 2018 14:48


          Don't use relative imports.

8176db3


          Add license header.

0305c12


          Add whitespace.

afea4be


          Clean up test


          Move async_context back to _eventloop, where I originally had it. Mak…

359dcd6

…e the stack work like a stack.

dhermes reviewed

View reviewed changes

ndb/src/google/cloud/ndb/__init__.py

               from google.cloud.ndb.context import ContextOptions
               from google.cloud.ndb.context import EVENTUAL_CONSISTENCY
               from google.cloud.ndb.context import TransactionOptions
+              from google.cloud.ndb._eventloop import async_context

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

ndb/src/google/cloud/ndb/_eventloop.py Outdated

+                  loop = EventLoop()
+                  contexts.push(loop)
+                  yield
+                  contexts.pop()

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view


          Docs cleanup.

f0b12d3

chrisrossi commented

View reviewed changes

ndb/src/google/cloud/ndb/_eventloop.py

+                  In the context of a web application, it is recommended that a single
+                  asynchronous context be used per HTTP request. This can typically be
+                  accomplished in a middleware layer.
+                  """

This comment was marked as spam.

Sign in to view


          Add comment.

78fdec9

chrisrossi removed the do not merge label

Author

chrisrossi commented Nov 8, 2018

@tseaver @dhermes I think I've addressed everyone's comments. PTAL.

dhermes approved these changes

View reviewed changes

Contributor

dhermes left a comment

LGTM

ndb/src/google/cloud/ndb/_eventloop.py Outdated

+                  Within the context, any calls to a ``*_async`` function or to an
+                  ``ndb.tasklet``, will be added to the event loop established by the
+                  context.  Upon exiting the context, execution will block until all

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

ndb/src/google/cloud/ndb/_eventloop.py Show resolved Hide resolved

tseaver approved these changes

View reviewed changes


          Try to disuse 'typewriter' spaces at the end of sentences.

dc64d64

chrisrossi merged commit 8517524 into googleapis:master

chrisrossi deleted the ndb-async-context branch

November 8, 2018 19:26

chrisrossi pushed a commit to chrisrossi/google-cloud-python that referenced this pull request


          NDB: Async context (googleapis#6429)

Establish an async context for managing the current event loop for asynchronous communication with the datastore backend.

parthea pushed a commit that referenced this pull request


          NDB: Async context (#6429)

b89bbb5

Establish an async context for managing the current event loop for asynchronous communication with the datastore backend.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: ndb cla: yes