Adding connection lazy loading in storage.

Author: dhermes

README.rst

@@ -99,7 +99,6 @@ to Cloud Storage using this Client Library.
 .. code:: python
 
     from gcloud import storage
-    storage.set_defaults()
     bucket = storage.get_bucket('bucket-id-here')
     # Then do other things...
     blob = bucket.get_blob('/remote/path/to/file.txt')

docs/index.rst

@@ -51,7 +51,6 @@ Cloud Storage
 .. code-block:: python
 
   from gcloud import storage
-  storage.set_defaults()
   bucket = storage.get_bucket('<your-bucket-name>')
   blob = storage.Blob('my-test-file.txt', bucket=bucket)
   blob = blob.upload_contents_from_string('this is test content!')

gcloud/pubsub/test__implicit_environ.py

@@ -18,7 +18,7 @@
 class Test_get_default_connection(unittest2.TestCase):
 
     def _callFUT(self):
-        from gcloud.storage._implicit_environ import get_default_connection
+        from gcloud.pubsub._implicit_environ import get_default_connection
         return get_default_connection()
 
     def test_wo_override(self):

gcloud/storage/__init__.py

@@ -17,7 +17,6 @@
 You'll typically use these to get started with the API:
 
 >>> from gcloud import storage
->>> storage.set_defaults()
 >>> bucket = storage.get_bucket('bucket-id-here')
 >>> # Then do other things...
 >>> blob = bucket.get_blob('/remote/path/to/file.txt')

gcloud/storage/_implicit_environ.py

@@ -19,6 +19,7 @@
 """
 
 
+from gcloud._helpers import _lazy_property_deco
 from gcloud.connection import get_scoped_connection
 from gcloud.storage.connection import Connection
 
@@ -38,9 +39,16 @@ class _DefaultsContainer(object):
     :param connection: Persistent implied connection from environment.
     """
 
-    def __init__(self, bucket=None, connection=None):
+    @_lazy_property_deco
+    @staticmethod
+    def connection():
+        """Return the implicit default connection.."""
+        return get_connection()
+
+    def __init__(self, bucket=None, connection=None, implicit=False):
         self.bucket = bucket
-        self.connection = connection
+        if connection is not None or not implicit:
+            self.connection = connection
 
 
 def get_default_bucket():
@@ -88,4 +96,4 @@ def set_default_connection(connection=None):
     _DEFAULTS.connection = connection
 
 
-_DEFAULTS = _DefaultsContainer()
+_DEFAULTS = _DefaultsContainer(implicit=True)

gcloud/storage/api.py

@@ -33,7 +33,6 @@ def lookup_bucket(bucket_name, connection=None):
     than catching an exception::
 
       >>> from gcloud import storage
-      >>> storage.set_defaults()
       >>> bucket = storage.lookup_bucket('doesnt-exist')
       >>> print bucket
       None
@@ -172,7 +171,6 @@ def create_bucket(bucket_name, project=None, connection=None):
     For example::
 
       >>> from gcloud import storage
-      >>> storage.set_defaults()
       >>> bucket = storage.create_bucket('my-bucket')
       >>> print bucket
       <Bucket: my-bucket>

gcloud/storage/test__implicit_environ.py

@@ -27,6 +27,14 @@ def test_wo_override(self):
 
 class Test_get_default_connection(unittest2.TestCase):
 
+    def setUp(self):
+        from gcloud.storage._testing import _setup_defaults
+        _setup_defaults(self)
+
+    def tearDown(self):
+        from gcloud.storage._testing import _tear_down_defaults
+        _tear_down_defaults(self)
+
     def _callFUT(self):
         from gcloud.storage._implicit_environ import get_default_connection
         return get_default_connection()
@@ -99,3 +107,30 @@ def mock_get_connection(*args, **kwargs):
         self.assertEqual(_implicit_environ.get_default_connection(), fake_cnxn)
         self.assertEqual(_called_args, [()])
         self.assertEqual(_called_kwargs, [{}])
+
+
+class Test_lazy_loading(unittest2.TestCase):
+
+    def setUp(self):
+        from gcloud.storage._testing import _setup_defaults
+        _setup_defaults(self, implicit=True)
+
+    def tearDown(self):
+        from gcloud.storage._testing import _tear_down_defaults
+        _tear_down_defaults(self)
+
+    def test_descriptor_for_connection(self):
+        from gcloud._testing import _Monkey
+        from gcloud.storage import _implicit_environ
+
+        self.assertFalse(
+            'connection' in _implicit_environ._DEFAULTS.__dict__)
+
+        DEFAULT = object()
+
+        with _Monkey(_implicit_environ, get_connection=lambda: DEFAULT):
+            lazy_loaded = _implicit_environ._DEFAULTS.connection
+
+        self.assertEqual(lazy_loaded, DEFAULT)
+        self.assertTrue(
+            'connection' in _implicit_environ._DEFAULTS.__dict__)

regression/storage.py

@@ -28,7 +28,6 @@
 SHARED_BUCKETS = {}
 
 _helpers._PROJECT_ENV_VAR_NAME = 'GCLOUD_TESTS_PROJECT_ID'
-storage.set_defaults()
 
 
 def setUpModule():