Rename datastore._helpers -> helpers.

tseaver · tseaver · commit 949df739ba8c · 2014-10-23T14:50:23.000-04:00
We are going to move 'Entity.from_protobuf' and 'Key.from_protobuf' into
the module as free functions, which will be APIs:  this module needs not
to signal that it has no APIs.

Document now-API module 'gcloud.datastore.helpers'.
diff --git a/docs/datastore-api.rst b/docs/datastore-api.rst
@@ -56,3 +56,9 @@ Transactions
   :members:
   :undoc-members:
   :show-inheritance:
+
+Helper functions
+----------------
+
+.. automodule:: gcloud.datastore.helpers
+  :members:
diff --git a/gcloud/datastore/connection.py b/gcloud/datastore/connection.py
@@ -2,7 +2,7 @@
 
 from gcloud import connection
 from gcloud.datastore import datastore_v1_pb2 as datastore_pb
-from gcloud.datastore import _helpers
+from gcloud.datastore import helpers
 from gcloud.datastore.dataset import Dataset
 
 
@@ -376,7 +376,7 @@ def save_entity(self, dataset_id, key_pb, properties):
             prop.name = name
 
             # Set the appropriate value.
-            _helpers._set_protobuf_value(prop.value, value)
+            helpers._set_protobuf_value(prop.value, value)
 
         # If this is in a transaction, we should just return True. The
         # transaction will handle assigning any keys as necessary.
diff --git a/gcloud/datastore/entity.py b/gcloud/datastore/entity.py
@@ -161,13 +161,13 @@ def from_protobuf(cls, pb, dataset=None):
         """
 
         # This is here to avoid circular imports.
-        from gcloud.datastore import _helpers
+        from gcloud.datastore import helpers
 
         key = Key.from_protobuf(pb.key)
         entity = cls.from_key(key, dataset)
 
         for property_pb in pb.property:
-            value = _helpers._get_value_from_property_pb(property_pb)
+            value = helpers._get_value_from_property_pb(property_pb)
             entity[property_pb.name] = value
 
         return entity
diff --git a/gcloud/datastore/helpers.py b/gcloud/datastore/helpers.py
diff --git a/gcloud/datastore/query.py b/gcloud/datastore/query.py
@@ -3,7 +3,7 @@
 import base64
 
 from gcloud.datastore import datastore_v1_pb2 as datastore_pb
-from gcloud.datastore import _helpers
+from gcloud.datastore import helpers
 from gcloud.datastore.entity import Entity
 from gcloud.datastore.key import Key
 
@@ -151,7 +151,7 @@ def filter(self, expression, value):
         property_filter.operator = operator
 
         # Set the value to filter on based on the type.
-        _helpers._set_protobuf_value(property_filter.value, value)
+        helpers._set_protobuf_value(property_filter.value, value)
         return clone
 
     def ancestor(self, ancestor):
diff --git a/gcloud/datastore/test_helpers.py b/gcloud/datastore/test_helpers.py
@@ -4,7 +4,7 @@
 class Test__get_protobuf_attribute_and_value(unittest2.TestCase):
 
     def _callFUT(self, val):
-        from gcloud.datastore._helpers import _get_protobuf_attribute_and_value
+        from gcloud.datastore.helpers import _get_protobuf_attribute_and_value
 
         return _get_protobuf_attribute_and_value(val)
 
@@ -107,7 +107,7 @@ def test_object(self):
 class Test__get_value_from_value_pb(unittest2.TestCase):
 
     def _callFUT(self, pb):
-        from gcloud.datastore._helpers import _get_value_from_value_pb
+        from gcloud.datastore.helpers import _get_value_from_value_pb
 
         return _get_value_from_value_pb(pb)
 
@@ -197,7 +197,7 @@ def test_unknown(self):
 class Test__get_value_from_property_pb(unittest2.TestCase):
 
     def _callFUT(self, pb):
-        from gcloud.datastore._helpers import _get_value_from_property_pb
+        from gcloud.datastore.helpers import _get_value_from_property_pb
 
         return _get_value_from_property_pb(pb)
 
@@ -212,7 +212,7 @@ def test_it(self):
 class Test_set_protobuf_value(unittest2.TestCase):
 
     def _callFUT(self, value_pb, val):
-        from gcloud.datastore._helpers import _set_protobuf_value
+        from gcloud.datastore.helpers import _set_protobuf_value
 
         return _set_protobuf_value(value_pb, val)
 
