Skip to content

#260: break datastore cycles via factories #268

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

Closed
tseaver wants to merge 11 commits into from
Closed

#260: break datastore cycles via factories #268

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
1036f85
Drop 'Dataset.query' and 'Dataset.entity' convenience APIs.
tseaver Oct 20, 2014
1c432a9
Add a factory registry to datastore._helpers.
tseaver Oct 20, 2014
8d05122
Break import cycles via a factory registry.
tseaver Oct 20, 2014
3c1d516
Tidy local imports, remove remaining cycles.
tseaver Oct 20, 2014
cf29c90
Fix build: invoke correct factory when unmarshalling key from pb.
tseaver Oct 20, 2014
31f60d8
Reorder 'Query.__init__' paramters to match Entity.
tseaver Oct 20, 2014
3a62db9
Rename '_query_factory' helper -> '_get_factory' to avoid confustion.
tseaver Oct 20, 2014
daf889c
Avoid relative imports.
tseaver Oct 21, 2014
a2c8bcb
Encapsulate factory registry as a singleton object.
tseaver Oct 21, 2014
3cc965c
Rename alternate factories for clarity.
tseaver Oct 21, 2014
d539b17
Use 'invoke' rather than 'get' followed by call to invoke factories.
tseaver Oct 21, 2014
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
Prev Previous commit
Next Next commit
Reorder 'Query.__init__' paramters to match Entity.
  • Loading branch information
@tseaver
tseaver committed Oct 22, 2014
commit 31f60d8169c2d8b121ca57b175ea846f3f2e3f74
4 changes: 2 additions & 2 deletions gcloud/datastore/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
>>> # Then do other things...
>>> from gcloud.datastore.entity import Entity
>>> from gcloud.datastore.query import Query
>>> query = Query('EntityKind', dataset)
>>> query = Query(dataset, 'EntityKind')
>>> entity = Entity(dataset, 'EntityKind')

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view


The main concepts with this API are:
Expand Down Expand Up @@ -90,7 +90,7 @@ def get_dataset(dataset_id, client_email, private_key_path):
>>> dataset = datastore.get_dataset('dataset-id', email, key_path)
>>> # Now you can do things with the dataset.
>>> from gcloud.datastore.query import Query
>>> query = Query('TestKind', dataset)
>>> query = Query(dataset, 'TestKind')
>>> query.fetch()
[...]

Expand Down
2 changes: 1 addition & 1 deletion gcloud/datastore/connection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ def run_query(self, dataset_id, query_pb, namespace=None):
>>> from gcloud.datastore.query import Query
>>> connection = datastore.get_connection(email, key_path)
>>> dataset = connection.dataset('dataset-id')
>>> query = Query('MyKind', dataset).filter('property =', 'val')
>>> query = Query(dataset, 'MyKind').filter('property =', 'val')

Using the `fetch`` method...

Expand Down
2 changes: 1 addition & 1 deletion gcloud/datastore/demo/demo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

# Now let's try a more advanced query.
# We'll start by look at all Thing entities:
query = Query('Thing', dataset)
query = Query(dataset, 'Thing')

# Let's look at the first two.
print query.limit(2).fetch()
Expand Down
2 changes: 1 addition & 1 deletion gcloud/datastore/query.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ class Query(object):
}
"""Mapping of operator strings and their protobuf equivalents."""

def __init__(self, kind=None, dataset=None, namespace=None):
def __init__(self, dataset=None, kind=None, namespace=None):
self._dataset = dataset
self._namespace = namespace
self._pb = datastore_pb.Query()
Expand Down
4 changes: 2 additions & 2 deletions gcloud/datastore/test_connection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ def test_run_query_wo_namespace_empty_result(self):

DATASET_ID = 'DATASET'
KIND = 'Nonesuch'
q_pb = Query(KIND, DATASET_ID).to_protobuf()
q_pb = Query(kind=KIND).to_protobuf()
rsp_pb = datastore_pb.RunQueryResponse()
conn = self._makeOne()
URI = '/'.join([
Expand Down Expand Up @@ -349,7 +349,7 @@ def test_run_query_w_namespace_nonempty_result(self):
DATASET_ID = 'DATASET'
KIND = 'Kind'
entity = datastore_pb.Entity()
q_pb = Query(KIND, DATASET_ID).to_protobuf()
q_pb = Query(kind=KIND).to_protobuf()
rsp_pb = datastore_pb.RunQueryResponse()
rsp_pb.batch.entity_result.add(entity=entity)
rsp_pb.batch.entity_result_type = 1 # FULL
Expand Down
42 changes: 21 additions & 21 deletions gcloud/datastore/test_query.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ def _getTargetClass(self):

return Query

def _makeOne(self, kind=None, dataset=None, namespace=None):
return self._getTargetClass()(kind, dataset, namespace)
def _makeOne(self, dataset=None, kind=None, namespace=None):
return self._getTargetClass()(dataset, kind, namespace)

def test_ctor_defaults(self):
query = self._getTargetClass()()
Expand All @@ -25,7 +25,7 @@ def test_ctor_explicit(self):
_KIND = 'KIND'
_NAMESPACE = 'NAMESPACE'
dataset = Dataset(_DATASET)
query = self._makeOne(_KIND, dataset, _NAMESPACE)
query = self._makeOne(dataset, _KIND, _NAMESPACE)
self.assertTrue(query.dataset() is dataset)
kq_pb, = list(query.kind())
self.assertEqual(kq_pb.name, _KIND)
Expand All @@ -39,7 +39,7 @@ def test__clone(self):
_CURSOR = 'DEADBEEF'
_NAMESPACE = 'NAMESPACE'
dataset = Dataset(_DATASET)
query = self._makeOne(_KIND, dataset, _NAMESPACE)
query = self._makeOne(dataset, _KIND, _NAMESPACE)
query._cursor = _CURSOR
clone = query._clone()
self.assertFalse(clone is query)
Expand All @@ -58,7 +58,7 @@ def test_to_protobuf_empty(self):

def test_to_protobuf_w_kind(self):
_KIND = 'KIND'
query = self._makeOne(_KIND)
query = self._makeOne(kind=_KIND)
q_pb = query.to_protobuf()
kq_pb, = list(q_pb.kind)
self.assertEqual(kq_pb.name, _KIND)
Expand Down Expand Up @@ -189,7 +189,7 @@ def test_kind_setter_wo_existing(self):
_DATASET = 'DATASET'
_KIND = 'KIND'
dataset = Dataset(_DATASET)
query = self._makeOne(dataset=dataset)
query = self._makeOne(dataset)
after = query.kind(_KIND)
self.assertFalse(after is query)
self.assertTrue(isinstance(after, self._getTargetClass()))
Expand All @@ -203,7 +203,7 @@ def test_kind_setter_w_existing(self):
_KIND_BEFORE = 'KIND_BEFORE'
_KIND_AFTER = 'KIND_AFTER'
dataset = Dataset(_DATASET)
query = self._makeOne(_KIND_BEFORE, dataset)
query = self._makeOne(dataset, _KIND_BEFORE)
after = query.kind(_KIND_AFTER)
self.assertFalse(after is query)
self.assertTrue(isinstance(after, self._getTargetClass()))
Expand All @@ -218,7 +218,7 @@ def test_limit_setter_wo_existing(self):
_KIND = 'KIND'
_LIMIT = 42
dataset = Dataset(_DATASET)
query = self._makeOne(_KIND, dataset)
query = self._makeOne(dataset, _KIND)
after = query.limit(_LIMIT)
self.assertFalse(after is query)
self.assertTrue(isinstance(after, self._getTargetClass()))
Expand All @@ -232,7 +232,7 @@ def test_dataset_setter(self):
_DATASET = 'DATASET'
_KIND = 'KIND'
dataset = Dataset(_DATASET)
query = self._makeOne(_KIND)
query = self._makeOne(kind=_KIND)
after = query.dataset(dataset)
self.assertFalse(after is query)
self.assertTrue(isinstance(after, self._getTargetClass()))
Expand All @@ -254,7 +254,7 @@ def test_fetch_default_limit(self):
prop.value.string_value = u'Foo'
connection = _Connection(entity_pb)
dataset = _Dataset(_DATASET, connection)
query = self._makeOne(_KIND, dataset)
query = self._makeOne(dataset, _KIND)
entities = query.fetch()
self.assertEqual(len(entities), 1)
self.assertEqual(entities[0].key().path(),
Expand Down Expand Up @@ -283,7 +283,7 @@ def test_fetch_explicit_limit(self):
connection = _Connection(entity_pb)
connection._cursor = _CURSOR
dataset = _Dataset(_DATASET, connection)
query = self._makeOne(_KIND, dataset, _NAMESPACE)
query = self._makeOne(dataset, _KIND, _NAMESPACE)
limited = query.limit(13)
entities = query.fetch(13)
self.assertEqual(query._cursor, _CURSOR)
Expand All @@ -302,7 +302,7 @@ def test_cursor_not_fetched(self):
_KIND = 'KIND'
connection = _Connection()
dataset = _Dataset(_DATASET, connection)
query = self._makeOne(_KIND, dataset)
query = self._makeOne(dataset, _KIND)
self.assertRaises(RuntimeError, query.cursor)

def test_cursor_fetched(self):
Expand All @@ -312,7 +312,7 @@ def test_cursor_fetched(self):
_KIND = 'KIND'
connection = _Connection()
dataset = _Dataset(_DATASET, connection)
query = self._makeOne(_KIND, dataset)
query = self._makeOne(dataset, _KIND)
query._cursor = _CURSOR
self.assertEqual(query.cursor(), base64.b64encode(_CURSOR))

Expand All @@ -321,7 +321,7 @@ def test_with_cursor_neither(self):
_KIND = 'KIND'
connection = _Connection()
dataset = _Dataset(_DATASET, connection)
query = self._makeOne(_KIND, dataset)
query = self._makeOne(dataset, _KIND)
self.assertTrue(query.with_cursor(None) is query)

def test_with_cursor_w_start(self):
Expand All @@ -332,7 +332,7 @@ def test_with_cursor_w_start(self):
_KIND = 'KIND'
connection = _Connection()
dataset = _Dataset(_DATASET, connection)
query = self._makeOne(_KIND, dataset)
query = self._makeOne(dataset, _KIND)
after = query.with_cursor(_CURSOR_B64)
self.assertFalse(after is query)
q_pb = after.to_protobuf()
Expand All @@ -347,7 +347,7 @@ def test_with_cursor_w_end(self):
_KIND = 'KIND'
connection = _Connection()
dataset = _Dataset(_DATASET, connection)
query = self._makeOne(_KIND, dataset)
query = self._makeOne(dataset, _KIND)
after = query.with_cursor(None, _CURSOR_B64)
self.assertFalse(after is query)
q_pb = after.to_protobuf()
Expand All @@ -364,7 +364,7 @@ def test_with_cursor_w_both(self):
_KIND = 'KIND'
connection = _Connection()
dataset = _Dataset(_DATASET, connection)
query = self._makeOne(_KIND, dataset)
query = self._makeOne(dataset, _KIND)
after = query.with_cursor(_START_B64, _END_B64)
self.assertFalse(after is query)
q_pb = after.to_protobuf()
Expand All @@ -373,15 +373,15 @@ def test_with_cursor_w_both(self):

def test_order_empty(self):
_KIND = 'KIND'
before = self._makeOne(_KIND)
before = self._makeOne(kind=_KIND)
after = before.order()
self.assertFalse(after is before)
self.assertTrue(isinstance(after, self._getTargetClass()))
self.assertEqual(before.to_protobuf(), after.to_protobuf())

def test_order_single_asc(self):
_KIND = 'KIND'
before = self._makeOne(_KIND)
before = self._makeOne(kind=_KIND)
after = before.order('field')
after_pb = after.to_protobuf()
order_pb = list(after_pb.order)
Expand All @@ -392,7 +392,7 @@ def test_order_single_asc(self):

def test_order_single_desc(self):
_KIND = 'KIND'
before = self._makeOne(_KIND)
before = self._makeOne(kind=_KIND)
after = before.order('-field')
after_pb = after.to_protobuf()
order_pb = list(after_pb.order)
Expand All @@ -403,7 +403,7 @@ def test_order_single_desc(self):

def test_order_multiple(self):
_KIND = 'KIND'
before = self._makeOne(_KIND)
before = self._makeOne(kind=_KIND)
after = before.order('foo', '-bar')
after_pb = after.to_protobuf()
order_pb = list(after_pb.order)
Expand Down