Skip to content

Commit c5a634f

Browse files
dhermesdhermes
committed
Adding api.delete() and removing Key.delete().
Also: - Changing api.get() back to accept only `keys` and returns only a list (a lot of headache for not much gain). - Factored out behavior to extract shared dataset_id from a set of keys into _get_dataset_id_from_keys(). - Updated docstrings and other tests that rely on changed / removed methods. See googleapis#518 for some context.
1 parent 0525530 commit c5a634f

11 files changed

Lines changed: 174 additions & 151 deletions

File tree

‎gcloud/datastore/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@
5555
from gcloud import credentials
5656
from gcloud.datastore import _implicit_environ
5757
from gcloud.datastore.api import allocate_ids
58+
from gcloud.datastore.api import delete
5859
from gcloud.datastore.api import get
5960
from gcloud.datastore.connection import Connection
6061

‎gcloud/datastore/api.py‎

Lines changed: 57 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
Query objects rather than via protobufs.
1919
"""
2020

21-
import collections
22-
2321
from gcloud.datastore import _implicit_environ
22+
from gcloud.datastore.batch import _BATCHES
23+
from gcloud.datastore.batch import Batch
2424
from gcloud.datastore import helpers
2525

2626

@@ -60,12 +60,33 @@ def _require_connection(connection=None):
6060
return connection
6161

6262

63-
def get(key_or_keys, missing=None, deferred=None, connection=None):
63+
def _get_dataset_id_from_keys(keys):
64+
"""Determines dataset ID from a list of keys.
65+
66+
:type keys: list of :class:`gcloud.datastore.key.Key`
67+
:param keys: The keys from the same dataset.
68+
69+
:rtype: string
70+
:returns: The dataset ID of the keys.
71+
:raises: :class:`ValueError` if the key dataset IDs don't agree.
72+
"""
73+
dataset_id = keys[0].dataset_id
74+
# Rather than creating a list or set of all dataset IDs, we iterate
75+
# and check. We could allow the backend to check this for us if IDs
76+
# with no prefix worked (GoogleCloudPlatform/google-cloud-datastore#59)
77+
# or if we made sure that a prefix s~ or e~ was on each key.
78+
for key in keys[1:]:
79+
if key.dataset_id != dataset_id:
80+
raise ValueError('All keys in get must be from the same dataset.')
81+
82+
return dataset_id
83+
84+
85+
def get(keys, missing=None, deferred=None, connection=None):
6486
"""Retrieves entities, along with their attributes.
6587
66-
:type key_or_keys: list of :class:`gcloud.datastore.key.Key` or single
67-
:class:`gcloud.datastore.key.Key`
68-
:param key_or_keys: The key or keys to be retrieved from the datastore.
88+
:type keys: list of :class:`gcloud.datastore.key.Key`
89+
:param keys: The keys to be retrieved from the datastore.
6990
7091
:type missing: an empty list or None.
7192
:param missing: If a list is passed, the key-only entities returned
@@ -80,27 +101,14 @@ def get(key_or_keys, missing=None, deferred=None, connection=None):
80101
:type connection: :class:`gcloud.datastore.connection.Connection`
81102
:param connection: Optional. The connection used to connect to datastore.
82103
83-
:rtype: list of :class:`gcloud.datastore.entity.Entity`, single
84-
:class:`gcloud.datastore.entity.Entity`, or ``NoneType``
85-
:returns: The requested entities, or single entity.
104+
:rtype: list of :class:`gcloud.datastore.entity.Entity`
105+
:returns: The requested entities.
86106
"""
87-
if isinstance(key_or_keys, collections.Iterable):
88-
keys = key_or_keys
89-
else:
90-
keys = [key_or_keys]
91-
92107
if not keys:
93108
return []
94109

95110
connection = _require_connection(connection)
96-
dataset_id = keys[0].dataset_id
97-
# Rather than creating a list or set of all dataset IDs, we iterate
98-
# and check. We could allow the backend to check this for us if IDs
99-
# with no prefix worked (GoogleCloudPlatform/google-cloud-datastore#59)
100-
# or if we made sure that a prefix s~ or e~ was on each key.
101-
for key in keys[1:]:
102-
if key.dataset_id != dataset_id:
103-
raise ValueError('All keys in get must be from the same dataset.')
111+
dataset_id = _get_dataset_id_from_keys(keys)
104112

105113
entity_pbs = connection.lookup(
106114
dataset_id=dataset_id,
@@ -122,11 +130,33 @@ def get(key_or_keys, missing=None, deferred=None, connection=None):
122130
for entity_pb in entity_pbs:
123131
entities.append(helpers.entity_from_protobuf(entity_pb))
124132

125-
if keys is key_or_keys:
126-
return entities
127-
else:
128-
if entities:
129-
return entities[0]
133+
return entities
134+
135+
136+
def delete(keys, connection=None):
137+
"""Delete the keys in the Cloud Datastore.
138+
139+
:type keys: list of :class:`gcloud.datastore.key.Key`
140+
:param keys: The keys to be deleted from the datastore.
141+
142+
:type connection: :class:`gcloud.datastore.connection.Connection`
143+
:param connection: Optional connection used to connect to datastore.
144+
"""
145+
if not keys:
146+
return
147+
148+
connection = connection or _implicit_environ.CONNECTION
149+
150+
# We allow partial keys to attempt a delete, the backend will fail.
151+
current = _BATCHES.top
152+
in_batch = current is not None
153+
if not in_batch:
154+
dataset_id = _get_dataset_id_from_keys(keys)
155+
current = Batch(dataset_id=dataset_id, connection=connection)
156+
for key in keys:
157+
current.delete(key)
158+
if not in_batch:
159+
current.commit()
130160

131161

132162
def allocate_ids(incomplete_key, num_ids, connection=None):

‎gcloud/datastore/batch.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ class Batch(object):
8282
operations and the delete operatiuon into the same mutation, and send
8383
them to the server in a single API request::
8484
85-
>>> from gcloud import datastore
85+
>>> from gcloud.datastore.batch import Batch
8686
>>> batch = Batch()
8787
>>> batch.put(entity1)
8888
>>> batch.put(entity2)
@@ -102,7 +102,7 @@ class Batch(object):
102102
103103
>>> from gcloud import datastore
104104
>>> dataset = datastore.get_dataset('dataset-id')
105-
>>> with Batch as batch:
105+
>>> with Batch() as batch:
106106
... do_some_work(batch)
107107
... raise Exception() # rolls back
108108
"""

‎gcloud/datastore/connection.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -509,8 +509,7 @@ def delete_entities(self, dataset_id, key_pbs, mutation=None):
509509
This method deals only with
510510
:class:`gcloud.datastore.datastore_v1_pb2.Key` protobufs and not
511511
with any of the other abstractions. For example, it's used
512-
under the hood in the
513-
:meth:`gcloud.datastore.entity.Entity.delete` method.
512+
under the hood in :func:`gcloud.datastore.api.delete`.
514513
515514
:type dataset_id: string
516515
:param dataset_id: The ID of the dataset from which to delete the keys.

‎gcloud/datastore/demo/demo.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@
3030
toy.save()
3131

3232
# If we look it up by its key, we should find it...
33-
from gcloud.datastore import get
34-
print(get([toy.key]))
33+
from gcloud import datastore
34+
print(datastore.get(toy.key))
3535

3636
# And we should be able to delete it...
37-
toy.key.delete()
37+
datastore.delete([toy.key])
3838

3939
# Since we deleted it, if we do another lookup it shouldn't be there again:
40-
print(get([toy.key]))
40+
print(datastore.get(toy.key))
4141

4242
# Now let's try a more advanced query.
4343
# First, let's create some entities.
@@ -48,10 +48,10 @@
4848
(4567, 'Printer', 11),
4949
(5678, 'Printer', 12),
5050
(6789, 'Computer', 13)]
51-
samples = []
51+
sample_keys = []
5252
for id, name, age in SAMPLE_DATA:
5353
key = Key('Thing', id)
54-
samples.append(key)
54+
sample_keys.append(key)
5555
entity = Entity(key)
5656
entity['name'] = name
5757
entity['age'] = age
@@ -73,7 +73,7 @@
7373
print(list(query.fetch()))
7474

7575
# Now delete them.
76-
print([key.delete() for key in samples])
76+
datastore.delete(sample_keys)
7777

7878
# You can also work inside a transaction.
7979
# (Check the official docs for explanations of what's happening here.)
@@ -94,7 +94,7 @@
9494
print('Committing the transaction...')
9595

9696
# Now that the transaction is commited, let's delete the entities.
97-
print(key.delete(), key2.delete())
97+
datastore.delete([key, key2])
9898

9999
# To rollback a transaction, just call .rollback()
100100
with Transaction() as t:
@@ -104,7 +104,7 @@
104104
t.rollback()
105105

106106
# Let's check if the entity was actually created:
107-
created = get([key])
107+
created = datastore.get(key)
108108
print('yes' if created else 'no')
109109

110110
# Remember, a key won't be complete until the transaction is commited.
@@ -118,4 +118,4 @@
118118
print(thing.key) # This will be complete
119119

120120
# Now let's delete the entity.
121-
thing.key.delete()
121+
datastore.delete([thing.key])

‎gcloud/datastore/key.py‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -217,19 +217,6 @@ def to_protobuf(self):
217217

218218
return key
219219

220-
def delete(self, connection=None):
221-
"""Delete the key in the Cloud Datastore.
222-
223-
:type connection: :class:`gcloud.datastore.connection.Connection`
224-
:param connection: Optional connection used to connect to datastore.
225-
"""
226-
# We allow partial keys to attempt a delete, the backend will fail.
227-
connection = connection or _implicit_environ.CONNECTION
228-
connection.delete_entities(
229-
dataset_id=self.dataset_id,
230-
key_pbs=[self.to_protobuf()],
231-
)
232-
233220
@property
234221
def is_partial(self):
235222
"""Boolean indicating if the key has an ID (or name).

0 commit comments

Comments
 (0)