Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,7 @@ with the Cloud Datastore using this Client Library.
.. code:: python

from gcloud import datastore
datastore.set_default_connection()
datastore.set_default_dataset_id()
datastore.set_defaults()
# Then do other things...
from gcloud.datastore.entity import Entity
from gcloud.datastore.key import Key
Expand Down
3 changes: 1 addition & 2 deletions docs/_components/datastore-getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ Add some data to your dataset
Open a Python console and...

>>> from gcloud import datastore
>>> datastore.set_default_connection()
>>> datastore.set_default_dataset_id('<your-dataset-id>')
>>> datastore.set_defaults()
>>> from gcloud.datastore.query import Query
>>> list(Query(kind='Person').fetch())
[]
Expand Down
3 changes: 1 addition & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ Cloud Datastore
.. code-block:: python

from gcloud import datastore
datastore.set_default_connection()
datastore.set_default_dataset_id('<dataset-id>')
datastore.set_defaults()

from gcloud.datastore.entity import Entity
from gcloud.datastore.key import Key
Expand Down
23 changes: 21 additions & 2 deletions gcloud/datastore/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@
>>> from gcloud.datastore.key import Key
>>> from gcloud.datastore.query import Query

>>> datastore.set_default_connection()
>>> datastore.set_default_dataset_id()
>>> datastore.set_defaults()

>>> key = Key('EntityKind', 1234)
>>> entity = Entity(key)
Expand Down Expand Up @@ -95,6 +94,26 @@ def set_default_connection(connection=None):
_implicit_environ.CONNECTION = connection


def set_defaults(dataset_id=None, connection=None):
"""Set defaults either explicitly or implicitly as fall-back.

Uses the arguments to call the individual default methods
- set_default_dataset_id
- set_default_connection

In the future we will likely enable methods like
- set_default_namespace

:type dataset_id: string
:param dataset_id: Optional. The dataset ID to use as default.

:type connection: :class:`gcloud.datastore.connection.Connection`
:param connection: A connection provided to be the default.
"""
set_default_dataset_id(dataset_id=dataset_id)
set_default_connection(connection=connection)


def get_connection():
"""Shortcut method to establish a connection to the Cloud Datastore.

Expand Down
5 changes: 2 additions & 3 deletions gcloud/datastore/connection.py
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ def lookup(self, dataset_id, key_pbs,

>>> from gcloud import datastore
>>> from gcloud.datastore.key import Key
>>> datastore.set_default_connection()
>>> datastore.set_defaults()
>>> key = Key('MyKind', 1234, dataset_id='dataset-id')
>>> datastore.get(key)
<Entity object>
Expand Down Expand Up @@ -263,8 +263,7 @@ def run_query(self, dataset_id, query_pb, namespace=None, eventual=False):
>>> from gcloud import datastore
>>> from gcloud.datastore.query import Query

>>> datastore.set_default_connection()
>>> datastore.set_default_dataset_id()
>>> datastore.set_defaults()

>>> query = Query(kind='MyKind')
>>> query.add_filter('property', '=', 'val')
Expand Down
3 changes: 1 addition & 2 deletions gcloud/datastore/demo/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,4 @@


def initialize():
datastore.set_default_connection()
datastore.set_default_dataset_id(DATASET_ID)
datastore.set_defaults(dataset_id=DATASET_ID)
31 changes: 31 additions & 0 deletions gcloud/datastore/test___init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,37 @@ def test_set_implicit(self):
self.assertEqual(_implicit_environ.CONNECTION, fake_cnxn)


class Test_set_defaults(unittest2.TestCase):

def _callFUT(self, dataset_id=None, connection=None):
from gcloud.datastore import set_defaults
return set_defaults(dataset_id=dataset_id, connection=connection)

def test_it(self):
from gcloud._testing import _Monkey
from gcloud import datastore

DATASET_ID = object()
CONNECTION = object()

SET_DATASET_CALLED = []

def call_set_dataset(dataset_id=None):
SET_DATASET_CALLED.append(dataset_id)

SET_CONNECTION_CALLED = []

def call_set_connection(connection=None):
SET_CONNECTION_CALLED.append(connection)

with _Monkey(datastore, set_default_dataset_id=call_set_dataset,
set_default_connection=call_set_connection):
self._callFUT(dataset_id=DATASET_ID, connection=CONNECTION)

self.assertEqual(SET_DATASET_CALLED, [DATASET_ID])
self.assertEqual(SET_CONNECTION_CALLED, [CONNECTION])


class Test_get_connection(unittest2.TestCase):

def _callFUT(self):
Expand Down
3 changes: 1 addition & 2 deletions gcloud/datastore/transaction.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ class Transaction(Batch):
>>> from gcloud import datastore
>>> from gcloud.datastore.transaction import Transaction

>>> datastore.set_default_connection()
>>> datastore.set_default_dataset_id()
>>> datastore.set_defaults()

>>> with Transaction()
... entity1.save()
Expand Down
3 changes: 1 addition & 2 deletions regression/clear_datastore.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@


datastore._DATASET_ENV_VAR_NAME = 'GCLOUD_TESTS_DATASET_ID'
datastore.set_default_dataset_id()
datastore.set_default_connection()
datastore.set_defaults()


FETCH_MAX = 20
Expand Down
3 changes: 1 addition & 2 deletions regression/datastore.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@


datastore._DATASET_ENV_VAR_NAME = 'GCLOUD_TESTS_DATASET_ID'
datastore.set_default_dataset_id()
datastore.set_default_connection()
datastore.set_defaults()


class TestDatastore(unittest2.TestCase):
Expand Down
3 changes: 1 addition & 2 deletions regression/populate_datastore.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@


datastore._DATASET_ENV_VAR_NAME = 'GCLOUD_TESTS_DATASET_ID'
datastore.set_default_dataset_id()
datastore.set_default_connection()
datastore.set_defaults()


ANCESTOR = ('Book', 'GoT')
Expand Down