diff --git a/docs/datastore-dataset.rst b/docs/datastore-client.rst similarity index 62% rename from docs/datastore-dataset.rst rename to docs/datastore-client.rst index 6a5711f906c3..7d0ede1a9836 100644 --- a/docs/datastore-dataset.rst +++ b/docs/datastore-client.rst @@ -1,7 +1,7 @@ Dataset ~~~~~~~ -.. automodule:: gcloud.datastore.dataset +.. automodule:: gcloud.datastore.client :members: :undoc-members: :show-inheritance: diff --git a/docs/index.rst b/docs/index.rst index 0480c536f339..99c495cf6592 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,13 +3,13 @@ :hidden: gcloud-api + datastore-client datastore-api datastore-entities datastore-keys datastore-queries datastore-transactions datastore-batches - datastore-dataset storage-api storage-blobs storage-buckets diff --git a/gcloud/datastore/__init__.py b/gcloud/datastore/__init__.py index ac114ec51249..db0e8dfa2d0d 100644 --- a/gcloud/datastore/__init__.py +++ b/gcloud/datastore/__init__.py @@ -28,9 +28,10 @@ which represents a connection between your machine and the Cloud Datastore API. -- :class:`gcloud.datastore.dataset.Dataset` - which represents a dataset ID (string) bundled with a connection and has - convenience methods for constructing objects with that dataset ID. +- :class:`gcloud.datastore.client.Client` + which represents a dataset ID (string) and namespace (string) bundled with + a connection and has convenience methods for constructing objects with that + dataset ID / namespace. - :class:`gcloud.datastore.entity.Entity` which represents a single entity in the datastore @@ -63,7 +64,7 @@ from gcloud.datastore.batch import Batch from gcloud.datastore.connection import SCOPE from gcloud.datastore.connection import Connection -from gcloud.datastore.dataset import Dataset +from gcloud.datastore.client import Client from gcloud.datastore.entity import Entity from gcloud.datastore.key import Key from gcloud.datastore.query import Query diff --git a/gcloud/datastore/dataset.py b/gcloud/datastore/client.py similarity index 99% rename from gcloud/datastore/dataset.py rename to gcloud/datastore/client.py index 01d19f64b4a1..f1c7be41da72 100644 --- a/gcloud/datastore/dataset.py +++ b/gcloud/datastore/client.py @@ -25,7 +25,7 @@ from gcloud.datastore.transaction import Transaction -class Dataset(object): +class Client(object): """Convenience wrapper for invoking APIs/factories w/ a dataset ID. :type dataset_id: string diff --git a/gcloud/datastore/test_dataset.py b/gcloud/datastore/test_client.py similarity index 77% rename from gcloud/datastore/test_dataset.py rename to gcloud/datastore/test_client.py index 6acc0ac5ebf2..3a5965ca7778 100644 --- a/gcloud/datastore/test_dataset.py +++ b/gcloud/datastore/test_client.py @@ -15,13 +15,13 @@ import unittest2 -class TestDataset(unittest2.TestCase): +class TestClient(unittest2.TestCase): DATASET_ID = 'DATASET' def _getTargetClass(self): - from gcloud.datastore.dataset import Dataset - return Dataset + from gcloud.datastore.client import Client + return Client def _makeOne(self, dataset_id=DATASET_ID, namespace=None, connection=None): return self._getTargetClass()(dataset_id, namespace=namespace, @@ -31,19 +31,19 @@ def test_ctor_w_dataset_id_None(self): self.assertRaises(ValueError, self._makeOne, None) def test_ctor_w_dataset_id_no_connection(self): - dataset = self._makeOne() - self.assertEqual(dataset.dataset_id, self.DATASET_ID) + client = self._makeOne() + self.assertEqual(client.dataset_id, self.DATASET_ID) def test_ctor_w_explicit_inputs(self): conn = object() namespace = object() - dataset = self._makeOne(namespace=namespace, connection=conn) - self.assertEqual(dataset.dataset_id, self.DATASET_ID) - self.assertTrue(dataset.connection is conn) - self.assertTrue(dataset.namespace is namespace) + client = self._makeOne(namespace=namespace, connection=conn) + self.assertEqual(client.dataset_id, self.DATASET_ID) + self.assertTrue(client.connection is conn) + self.assertTrue(client.namespace is namespace) def test_get_defaults(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey _called_with = [] @@ -51,11 +51,11 @@ def test_get_defaults(self): def _get(*args, **kw): _called_with.append((args, kw)) - dataset = self._makeOne() + client = self._makeOne() key = object() with _Monkey(MUT, get=_get): - dataset.get(key) + client.get(key) self.assertEqual(_called_with[0][0], (key,)) self.assertTrue(_called_with[0][1]['missing'] is None) @@ -64,7 +64,7 @@ def _get(*args, **kw): self.assertEqual(_called_with[0][1]['dataset_id'], self.DATASET_ID) def test_get_explicit(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey _called_with = [] @@ -73,11 +73,11 @@ def _get(*args, **kw): _called_with.append((args, kw)) conn = object() - dataset = self._makeOne(connection=conn) + client = self._makeOne(connection=conn) key, missing, deferred = object(), [], [] with _Monkey(MUT, get=_get): - dataset.get(key, missing, deferred) + client.get(key, missing, deferred) self.assertEqual(_called_with[0][0], (key,)) self.assertTrue(_called_with[0][1]['missing'] is missing) @@ -86,7 +86,7 @@ def _get(*args, **kw): self.assertEqual(_called_with[0][1]['dataset_id'], self.DATASET_ID) def test_get_multi_defaults(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey _called_with = [] @@ -94,11 +94,11 @@ def test_get_multi_defaults(self): def _get_multi(*args, **kw): _called_with.append((args, kw)) - dataset = self._makeOne() + client = self._makeOne() key = object() with _Monkey(MUT, get_multi=_get_multi): - dataset.get_multi([key]) + client.get_multi([key]) self.assertEqual(_called_with[0][0], ([key],)) self.assertTrue(_called_with[0][1]['missing'] is None) @@ -107,7 +107,7 @@ def _get_multi(*args, **kw): self.assertEqual(_called_with[0][1]['dataset_id'], self.DATASET_ID) def test_get_multi_explicit(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey _called_with = [] @@ -116,11 +116,11 @@ def _get_multi(*args, **kw): _called_with.append((args, kw)) conn = object() - dataset = self._makeOne(connection=conn) + client = self._makeOne(connection=conn) key, missing, deferred = object(), [], [] with _Monkey(MUT, get_multi=_get_multi): - dataset.get_multi([key], missing, deferred) + client.get_multi([key], missing, deferred) self.assertEqual(_called_with[0][0], ([key],)) self.assertTrue(_called_with[0][1]['missing'] is missing) @@ -129,7 +129,7 @@ def _get_multi(*args, **kw): self.assertEqual(_called_with[0][1]['dataset_id'], self.DATASET_ID) def test_put_wo_connection(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey _called_with = [] @@ -137,18 +137,18 @@ def test_put_wo_connection(self): def _put(*args, **kw): _called_with.append((args, kw)) - dataset = self._makeOne() + client = self._makeOne() entity = object() with _Monkey(MUT, put=_put): - dataset.put(entity) + client.put(entity) self.assertEqual(_called_with[0][0], (entity,)) self.assertTrue(_called_with[0][1]['connection'] is None) self.assertEqual(_called_with[0][1]['dataset_id'], self.DATASET_ID) def test_put_w_connection(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey _called_with = [] @@ -157,17 +157,17 @@ def _put(*args, **kw): _called_with.append((args, kw)) entity, conn = object(), object() - dataset = self._makeOne(connection=conn) + client = self._makeOne(connection=conn) with _Monkey(MUT, put=_put): - dataset.put(entity) + client.put(entity) self.assertEqual(_called_with[0][0], (entity,)) self.assertTrue(_called_with[0][1]['connection'] is conn) self.assertEqual(_called_with[0][1]['dataset_id'], self.DATASET_ID) def test_put_multi_wo_connection(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey _called_with = [] @@ -175,18 +175,18 @@ def test_put_multi_wo_connection(self): def _put_multi(*args, **kw): _called_with.append((args, kw)) - dataset = self._makeOne() + client = self._makeOne() entity = object() with _Monkey(MUT, put_multi=_put_multi): - dataset.put_multi([entity]) + client.put_multi([entity]) self.assertEqual(_called_with[0][0], ([entity],)) self.assertTrue(_called_with[0][1]['connection'] is None) self.assertEqual(_called_with[0][1]['dataset_id'], self.DATASET_ID) def test_put_multi_w_connection(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey _called_with = [] @@ -195,17 +195,17 @@ def _put_multi(*args, **kw): _called_with.append((args, kw)) entity, conn = object(), object() - dataset = self._makeOne(connection=conn) + client = self._makeOne(connection=conn) with _Monkey(MUT, put_multi=_put_multi): - dataset.put_multi([entity]) + client.put_multi([entity]) self.assertEqual(_called_with[0][0], ([entity],)) self.assertTrue(_called_with[0][1]['connection'] is conn) self.assertEqual(_called_with[0][1]['dataset_id'], self.DATASET_ID) def test_delete_wo_connection(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey _called_with = [] @@ -213,18 +213,18 @@ def test_delete_wo_connection(self): def _delete(*args, **kw): _called_with.append((args, kw)) - dataset = self._makeOne() + client = self._makeOne() key = object() with _Monkey(MUT, delete=_delete): - dataset.delete(key) + client.delete(key) self.assertEqual(_called_with[0][0], (key,)) self.assertTrue(_called_with[0][1]['connection'] is None) self.assertEqual(_called_with[0][1]['dataset_id'], self.DATASET_ID) def test_delete_w_connection(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey _called_with = [] @@ -233,16 +233,16 @@ def _delete(*args, **kw): _called_with.append((args, kw)) key, conn = object(), object() - dataset = self._makeOne(connection=conn) + client = self._makeOne(connection=conn) with _Monkey(MUT, delete=_delete): - dataset.delete(key) + client.delete(key) self.assertEqual(_called_with[0][0], (key,)) self.assertTrue(_called_with[0][1]['connection'] is conn) self.assertEqual(_called_with[0][1]['dataset_id'], self.DATASET_ID) def test_delete_multi_wo_connection(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey _called_with = [] @@ -250,18 +250,18 @@ def test_delete_multi_wo_connection(self): def _delete_multi(*args, **kw): _called_with.append((args, kw)) - dataset = self._makeOne() + client = self._makeOne() key = object() with _Monkey(MUT, delete_multi=_delete_multi): - dataset.delete_multi([key]) + client.delete_multi([key]) self.assertEqual(_called_with[0][0], ([key],)) self.assertTrue(_called_with[0][1]['connection'] is None) self.assertEqual(_called_with[0][1]['dataset_id'], self.DATASET_ID) def test_delete_multi_w_connection(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey _called_with = [] @@ -270,9 +270,9 @@ def _delete_multi(*args, **kw): _called_with.append((args, kw)) key, conn = object(), object() - dataset = self._makeOne(connection=conn) + client = self._makeOne(connection=conn) with _Monkey(MUT, delete_multi=_delete_multi): - dataset.delete_multi([key]) + client.delete_multi([key]) self.assertEqual(_called_with[0][0], ([key],)) self.assertTrue(_called_with[0][1]['connection'] is conn) @@ -281,19 +281,19 @@ def _delete_multi(*args, **kw): def test_key_w_dataset_id(self): KIND = 'KIND' ID = 1234 - dataset = self._makeOne() + client = self._makeOne() self.assertRaises(TypeError, - dataset.key, KIND, ID, dataset_id=self.DATASET_ID) + client.key, KIND, ID, dataset_id=self.DATASET_ID) def test_key_wo_dataset_id(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey KIND = 'KIND' ID = 1234 - dataset = self._makeOne() + client = self._makeOne() with _Monkey(MUT, Key=_Dummy): - key = dataset.key(KIND, ID) + key = client.key(KIND, ID) self.assertTrue(isinstance(key, _Dummy)) self.assertEqual(key.args, (KIND, ID)) @@ -304,15 +304,15 @@ def test_key_wo_dataset_id(self): self.assertEqual(key.kwargs, expected_kwargs) def test_key_w_namespace(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey KIND = 'KIND' ID = 1234 NAMESPACE = object() - dataset = self._makeOne(namespace=NAMESPACE) + client = self._makeOne(namespace=NAMESPACE) with _Monkey(MUT, Key=_Dummy): - key = dataset.key(KIND, ID) + key = client.key(KIND, ID) self.assertTrue(isinstance(key, _Dummy)) expected_kwargs = { @@ -322,16 +322,16 @@ def test_key_w_namespace(self): self.assertEqual(key.kwargs, expected_kwargs) def test_key_w_namespace_collision(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey KIND = 'KIND' ID = 1234 NAMESPACE1 = object() NAMESPACE2 = object() - dataset = self._makeOne(namespace=NAMESPACE1) + client = self._makeOne(namespace=NAMESPACE1) with _Monkey(MUT, Key=_Dummy): - key = dataset.key(KIND, ID, namespace=NAMESPACE2) + key = client.key(KIND, ID, namespace=NAMESPACE2) self.assertTrue(isinstance(key, _Dummy)) expected_kwargs = { @@ -341,12 +341,12 @@ def test_key_w_namespace_collision(self): self.assertEqual(key.kwargs, expected_kwargs) def test_batch_wo_connection(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey - dataset = self._makeOne() + client = self._makeOne() with _Monkey(MUT, Batch=_Dummy): - batch = dataset.batch() + batch = client.batch() self.assertTrue(isinstance(batch, _Dummy)) self.assertEqual(batch.args, ()) @@ -354,13 +354,13 @@ def test_batch_wo_connection(self): {'dataset_id': self.DATASET_ID, 'connection': None}) def test_batch_w_connection(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey conn = object() - dataset = self._makeOne(connection=conn) + client = self._makeOne(connection=conn) with _Monkey(MUT, Batch=_Dummy): - batch = dataset.batch() + batch = client.batch() self.assertTrue(isinstance(batch, _Dummy)) self.assertEqual(batch.args, ()) @@ -368,12 +368,12 @@ def test_batch_w_connection(self): {'dataset_id': self.DATASET_ID, 'connection': conn}) def test_transaction_wo_connection(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey - dataset = self._makeOne() + client = self._makeOne() with _Monkey(MUT, Transaction=_Dummy): - xact = dataset.transaction() + xact = client.transaction() self.assertTrue(isinstance(xact, _Dummy)) self.assertEqual(xact.args, ()) @@ -381,13 +381,13 @@ def test_transaction_wo_connection(self): {'dataset_id': self.DATASET_ID, 'connection': None}) def test_transaction_w_connection(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey conn = object() - dataset = self._makeOne(connection=conn) + client = self._makeOne(connection=conn) with _Monkey(MUT, Transaction=_Dummy): - xact = dataset.transaction() + xact = client.transaction() self.assertTrue(isinstance(xact, _Dummy)) self.assertEqual(xact.args, ()) @@ -399,17 +399,17 @@ def test_transaction_w_connection(self): def test_query_w_dataset_id(self): KIND = 'KIND' - dataset = self._makeOne() + client = self._makeOne() self.assertRaises(TypeError, - dataset.query, kind=KIND, dataset_id=self.DATASET_ID) + client.query, kind=KIND, dataset_id=self.DATASET_ID) def test_query_w_defaults(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey - dataset = self._makeOne() + client = self._makeOne() with _Monkey(MUT, Query=_Dummy): - query = dataset.query() + query = client.query() self.assertTrue(isinstance(query, _Dummy)) self.assertEqual(query.args, ()) @@ -420,7 +420,7 @@ def test_query_w_defaults(self): self.assertEqual(query.kwargs, expected_kwargs) def test_query_explicit(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey KIND = 'KIND' NAMESPACE = 'NAMESPACE' @@ -429,10 +429,10 @@ def test_query_explicit(self): PROJECTION = ['__key__'] ORDER = ['PROPERTY'] GROUP_BY = ['GROUPBY'] - dataset = self._makeOne() + client = self._makeOne() with _Monkey(MUT, Query=_Dummy): - query = dataset.query( + query = client.query( kind=KIND, namespace=NAMESPACE, ancestor=ANCESTOR, @@ -457,14 +457,14 @@ def test_query_explicit(self): self.assertEqual(query.kwargs, kwargs) def test_query_w_namespace(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey KIND = 'KIND' NAMESPACE = object() - dataset = self._makeOne(namespace=NAMESPACE) + client = self._makeOne(namespace=NAMESPACE) with _Monkey(MUT, Query=_Dummy): - query = dataset.query(kind=KIND) + query = client.query(kind=KIND) self.assertTrue(isinstance(query, _Dummy)) self.assertEqual(query.args, ()) @@ -476,15 +476,15 @@ def test_query_w_namespace(self): self.assertEqual(query.kwargs, expected_kwargs) def test_query_w_namespace_collision(self): - from gcloud.datastore import dataset as MUT + from gcloud.datastore import client as MUT from gcloud._testing import _Monkey KIND = 'KIND' NAMESPACE1 = object() NAMESPACE2 = object() - dataset = self._makeOne(namespace=NAMESPACE1) + client = self._makeOne(namespace=NAMESPACE1) with _Monkey(MUT, Query=_Dummy): - query = dataset.query(kind=KIND, namespace=NAMESPACE2) + query = client.query(kind=KIND, namespace=NAMESPACE2) self.assertTrue(isinstance(query, _Dummy)) self.assertEqual(query.args, ())