Visitar URL original
Update 'Client' to hold stack of connection/batch/transaction objects. by tseaver · Pull Request #976 · googleapis/google-cloud-python · GitHub
Skip to content

Update 'Client' to hold stack of connection/batch/transaction objects. #976

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 3 commits into from
Jul 10, 2015
Merged

Update 'Client' to hold stack of connection/batch/transaction objects. #976

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0296e4f
Update 'Client' to hold stack of connection/batch/transaction objects.
tseaver Jul 9, 2015
1d5ad10
Update docstrings
tseaver Jul 9, 2015
82ee82c
Remove confusion between 'connection' and '_batch_stack'.
tseaver Jul 9, 2015
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
35 changes: 35 additions & 0 deletions gcloud/datastore/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
# limitations under the License.
"""Convenience wrapper for invoking APIs/factories w/ a dataset ID."""

from gcloud._helpers import _LocalStack
from gcloud.datastore import helpers
from gcloud.datastore.batch import Batch
from gcloud.datastore.entity import Entity
Expand Down Expand Up @@ -127,8 +128,42 @@ def __init__(self, dataset_id=None, namespace=None, connection=None):
if connection is None:
connection = get_connection()
self.connection = connection
self._batch_stack = _LocalStack()

This comment was marked as spam.

Sign in to view

self.namespace = namespace

def _push_batch(self, batch):
"""Push a batch/transaction onto our stack.

"Protected", intended for use by batch / transaction context mgrs.

:type batch: :class:`gcloud.datastore.batch.Batch`, or an object
implementing its API.
:param batch: newly-active batch/batch/transaction.
"""
self._batch_stack.push(batch)

def _pop_batch(self):
"""Pop a batch/transaction from our stack.

"Protected", intended for use by batch / transaction context mgrs.

:raises: IndexError if the stack is empty.
:rtype: :class:`gcloud.datastore.batch.Batch`, or an object
implementing its API.
:returns: the top-most batch/transaction, after removing it.
"""
return self._batch_stack.pop()

@property
def current_batch(self):
"""Currently-active batch.

:rtype: :class:`gcloud.datastore.batch.Batch`, or an object
implementing its API, or ``NoneType`` (if no batch is active).
:returns: The batch/transaction at the toop of the batch stack.
"""
return self._batch_stack.top

def get(self, key, missing=None, deferred=None):
"""Retrieve an entity from a single key (if it exists).

Expand Down
20 changes: 20 additions & 0 deletions gcloud/datastore/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ def test_ctor_w_implicit_inputs(self):
self.assertEqual(client.dataset_id, OTHER)
self.assertEqual(client.namespace, None)
self.assertTrue(client.connection is conn)
self.assertTrue(client.current_batch is None)

def test_ctor_w_explicit_inputs(self):
OTHER = 'other'
Expand All @@ -74,6 +75,25 @@ def test_ctor_w_explicit_inputs(self):
self.assertEqual(client.dataset_id, OTHER)
self.assertEqual(client.namespace, NAMESPACE)
self.assertTrue(client.connection is conn)
self.assertTrue(client.current_batch is None)
self.assertEqual(list(client._batch_stack), [])

def test__push_connection_and__pop_connection(self):

This comment was marked as spam.

Sign in to view

conn = object()
batch1 = object()
batch2 = object()
client = self._makeOne(connection=conn)
client._push_batch(batch1)
self.assertEqual(list(client._batch_stack), [batch1])
self.assertTrue(client.current_batch is batch1)
client._push_batch(batch2)
self.assertTrue(client.current_batch is batch2)
# list(_LocalStack) returns in reverse order.
self.assertEqual(list(client._batch_stack), [batch2, batch1])
self.assertTrue(client._pop_batch() is batch2)
self.assertEqual(list(client._batch_stack), [batch1])
self.assertTrue(client._pop_batch() is batch1)
self.assertEqual(list(client._batch_stack), [])

def test_get_miss(self):
_called_with = []
Expand Down