Ensure blob/bucket upload methods return the blob.

Fixes #596.

Author: tseaver

gcloud/storage/blob.py

@@ -289,6 +289,9 @@ def upload_from_file(self, file_obj, rewind=False, size=None,
         :param size: The number of bytes to read from the file handle.
                      If not provided, we'll try to guess the size using
                      :func:`os.fstat`
+
+        :rtype: :class:`Blob`
+        :returns: The updated Blob object.
         """
         # Rewind the file if desired.
         if rewind:
@@ -335,6 +338,8 @@ def upload_from_file(self, file_obj, rewind=False, size=None,
         else:
             http_wrapper.MakeRequest(conn.http, request, retries=num_retries)
 
+        return self
+
     def upload_from_filename(self, filename):
         """Upload this blob's contents from the content of a named file.
 
@@ -351,12 +356,17 @@ def upload_from_filename(self, filename):
 
         :type filename: string
         :param filename: The path to the file.
+
+        :rtype: :class:`Blob`
+        :returns: The updated Blob object.
         """
         content_type, _ = mimetypes.guess_type(filename)
 
         with open(filename, 'rb') as file_obj:
             self.upload_from_file(file_obj, content_type=content_type)
 
+        return self
+
     def upload_from_string(self, data, content_type='text/plain'):
         """Upload contents of this blob from the provided string.
 

gcloud/storage/bucket.py

@@ -405,6 +405,9 @@ def upload_file(self, filename, blob=None):
                      to put the file.  If this is blank, we will try to
                      upload the file to the root of the bucket with the
                      same name as on your local file system.
+
+        :rtype: :class:`Blob`
+        :returns: The updated Blob object.
         """
         if blob is None:
             blob = os.path.basename(filename)
@@ -445,12 +448,16 @@ def upload_file_object(self, file_obj, blob=None):
                      to put the file.  If this is blank, we will try to
                      upload the file to the root of the bucket with the
                      same name as on your local file system.
+
+        :rtype: :class:`Blob`
+        :returns: The updated Blob object.
         """
         if blob:
             blob = self.new_blob(blob)
         else:
             blob = self.new_blob(os.path.basename(file_obj.name))
-        return blob.upload_from_file(file_obj)
+        blob.upload_from_file(file_obj)
+        return blob
 
     def get_cors(self):
         """Retrieve CORS policies configured for this bucket.

gcloud/storage/test_blob.py

@@ -323,7 +323,8 @@ def test_upload_from_file_simple(self):
         with NamedTemporaryFile() as fh:
             fh.write(DATA)
             fh.flush()
-            blob.upload_from_file(fh, rewind=True)
+            found = blob.upload_from_file(fh, rewind=True)
+        self.assertTrue(found is blob)
         rq = connection.http._requested
         self.assertEqual(len(rq), 1)
         self.assertEqual(rq[0]['method'], 'POST')
@@ -367,7 +368,8 @@ def test_upload_from_file_resumable(self):
             with NamedTemporaryFile() as fh:
                 fh.write(DATA)
                 fh.flush()
-                blob.upload_from_file(fh, rewind=True)
+                found = blob.upload_from_file(fh, rewind=True)
+        self.assertTrue(found is blob)
         rq = connection.http._requested
         self.assertEqual(len(rq), 3)
         self.assertEqual(rq[0]['method'], 'POST')
@@ -422,7 +424,8 @@ def test_upload_from_file_w_slash_in_name(self):
         with NamedTemporaryFile() as fh:
             fh.write(DATA)
             fh.flush()
-            blob.upload_from_file(fh, rewind=True)
+            found = blob.upload_from_file(fh, rewind=True)
+        self.assertTrue(found is blob)
         rq = connection.http._requested
         self.assertEqual(len(rq), 1)
         self.assertEqual(rq[0]['method'], 'POST')
@@ -462,7 +465,8 @@ def test_upload_from_filename(self):
         with NamedTemporaryFile(suffix='.jpeg') as fh:
             fh.write(DATA)
             fh.flush()
-            blob.upload_from_filename(fh.name)
+            found = blob.upload_from_filename(fh.name)
+        self.assertTrue(found is blob)
         rq = connection.http._requested
         self.assertEqual(len(rq), 1)
         self.assertEqual(rq[0]['method'], 'POST')
@@ -498,7 +502,8 @@ def test_upload_from_string_w_bytes(self):
         bucket = _Bucket(connection)
         blob = self._makeOne(bucket, BLOB_NAME)
         blob.CHUNK_SIZE = 5
-        blob.upload_from_string(DATA)
+        found = blob.upload_from_string(DATA)
+        self.assertTrue(found is blob)
         rq = connection.http._requested
         self.assertEqual(len(rq), 1)
         self.assertEqual(rq[0]['method'], 'POST')
@@ -536,7 +541,8 @@ def test_upload_from_string_w_text(self):
         bucket = _Bucket(connection)
         blob = self._makeOne(bucket, BLOB_NAME)
         blob.CHUNK_SIZE = 5
-        blob.upload_from_string(DATA)
+        found = blob.upload_from_string(DATA)
+        self.assertTrue(found is blob)
         rq = connection.http._requested
         self.assertEqual(len(rq), 1)
         self.assertEqual(rq[0]['method'], 'POST')

gcloud/storage/test_bucket.py

@@ -517,8 +517,11 @@ def upload_from_file(self, fh):
 
         bucket = self._makeOne()
         with _Monkey(MUT, Blob=_Blob):
-            bucket.upload_file_object(FILEOBJECT)
+            found = bucket.upload_file_object(FILEOBJECT)
         self.assertEqual(_uploaded, [(bucket, FILENAME, FILEOBJECT)])
+        self.assertTrue(isinstance(found, _Blob))
+        self.assertEqual(found._name, FILENAME)
+        self.assertTrue(found._bucket is bucket)
 
     def test_upload_file_object_explicit_blob(self):
         from gcloud._testing import _Monkey
@@ -539,8 +542,11 @@ def upload_from_file(self, fh):
 
         bucket = self._makeOne()
         with _Monkey(MUT, Blob=_Blob):
-            bucket.upload_file_object(FILEOBJECT, BLOB_NAME)
+            found = bucket.upload_file_object(FILEOBJECT, BLOB_NAME)
         self.assertEqual(_uploaded, [(bucket, BLOB_NAME, FILEOBJECT)])
+        self.assertTrue(isinstance(found, _Blob))
+        self.assertEqual(found._name, BLOB_NAME)
+        self.assertTrue(found._bucket is bucket)
 
     def test_get_cors_eager(self):
         NAME = 'name'