FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Adding storage factories for owned objects. · googleapis/google-cloud-python@2a2cc57 · GitHub

/ google-cloud-python Public

Commit 2a2cc57

Browse files
dhermes
committed
Adding storage factories for owned objects.
This includes - `Bucket<--Client` (bucket owned by client) - `Batch<--Client` - `Blob<--Bucket` I refrained from implementing factories for - `BucketACL<--Bucket` - `ObjectACL<--Blob`
1 parent 113a50f commit 2a2cc57

9 files changed

Lines changed: 99 additions & 14 deletions

File tree

‎docs/_components/storage-getting-started.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Python built-in ``object``.
9191
If you want to set some data, you just create a ``Blob`` inside your bucket
9292
and store your data inside the blob::
9393

94-
>>> blob = storage.Blob('greeting.txt', bucket=bucket)
94+
>>> blob = bucket.blob('greeting.txt')
9595
>>> blob.upload_from_string('Hello world!')
9696

9797
This creates a :class:`Blob <gcloud.storage.blob.Blob>` object locally and

‎docs/_components/storage-quickstart.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ you can create buckets and blobs::
6161
>>> bucket = client.create_bucket('my-new-bucket')
6262
>>> print bucket
6363
<Bucket: my-new-bucket>
64-
>>> blob = storage.Blob('my-test-file.txt', bucket=bucket)
64+
>>> blob = bucket.blob('my-test-file.txt')
6565
>>> print blob
6666
<Blob: my-new-bucket, my-test-file.txt>
6767
>>> blob = blob.upload_from_string('this is test content!')

‎docs/index.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,5 @@ Cloud Storage
5454
from gcloud import storage
5555
client = storage.Client()
5656
bucket = client.get_bucket('<your-bucket-name>')
57-
blob = storage.Blob('my-test-file.txt', bucket=bucket)
58-
blob = blob.upload_contents_from_string('this is test content!')
57+
blob = bucket.blob('my-test-file.txt')
58+
blob = blob.upload_from_string('this is test content!')

‎gcloud/storage/bucket.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,26 @@ def __init__(self, client, name=None):
9999
def __repr__(self):
100100
return '<Bucket: %s>' % self.name
101101

102+
def blob(self, blob_name, chunk_size=None):
103+
"""Factory constructor for blob object.
104+
105+
.. note::
106+
This will not make an HTTP request; it simply instantiates
107+
a blob object owned by this bucket.
108+
109+
:type blob_name: string
110+
:param blob_name: The name of the blob to be instantiated.
111+
112+
:type chunk_size: integer
113+
:param chunk_size: The size of a chunk of data whenever iterating
114+
(1 MB). This must be a multiple of 256 KB per the
115+
API specification.
116+
117+
:rtype: :class:`gcloud.storage.blob.Blob`
118+
:returns: The blob object created.
119+
"""
120+
return Blob(name=blob_name, bucket=self, chunk_size=chunk_size)
121+
102122
def exists(self, client=None):
103123
"""Determines whether or not this bucket exists.
104124

‎gcloud/storage/client.py‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
from gcloud.client import JSONClient
2020
from gcloud.exceptions import NotFound
2121
from gcloud.iterator import Iterator
22+
from gcloud.storage.batch import Batch
2223
from gcloud.storage.bucket import Bucket
2324
from gcloud.storage.connection import Connection
2425

@@ -113,6 +114,33 @@ def current_batch(self):
113114
"""
114115
return self._batch_stack.top
115116

117+
def bucket(self, bucket_name):
118+
"""Factory constructor for bucket object.
119+
120+
.. note::
121+
This will not make an HTTP request; it simply instantiates
122+
a bucket object owned by this client.
123+
124+
:type bucket_name: string
125+
:param bucket_name: The name of the bucket to be instantiated.
126+
127+
:rtype: :class:`gcloud.storage.bucket.Bucket`
128+
:returns: The bucket object created.
129+
"""
130+
return Bucket(client=self, name=bucket_name)
131+
132+
def batch(self):
133+
"""Factory constructor for batch object.
134+
135+
.. note::
136+
This will not make an HTTP request; it simply instantiates
137+
a batch object owned by this client.
138+
139+
:rtype: :class:`gcloud.storage.batch.Batch`
140+
:returns: The batch object created.
141+
"""
142+
return Batch(client=self)
143+
116144
def get_bucket(self, bucket_name):
117145
"""Get a bucket by name.
118146

‎gcloud/storage/demo/demo.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
print(list(client.list_buckets()))
3838

3939
# How about we create a new blob inside this bucket.
40-
blob = storage.Blob("my-new-file.txt", bucket=bucket)
40+
blob = bucket.blob("my-new-file.txt")
4141

4242
# Now let's put some data in there.
4343
blob.upload_from_string("this is some data!")

‎gcloud/storage/test_bucket.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,19 @@ def test_ctor(self):
109109
self.assertFalse(bucket._default_object_acl.loaded)
110110
self.assertTrue(bucket._default_object_acl.bucket is bucket)
111111

112+
def test_blob(self):
113+
from gcloud.storage.blob import Blob
114+
115+
BUCKET_NAME = 'BUCKET_NAME'
116+
BLOB_NAME = 'BLOB_NAME'
117+
118+
bucket = self._makeOne(name=BUCKET_NAME)
119+
blob = bucket.blob(BLOB_NAME)
120+
self.assertTrue(isinstance(blob, Blob))
121+
self.assertTrue(blob.bucket is bucket)
122+
self.assertTrue(blob.client is bucket.client)
123+
self.assertEqual(blob.name, BLOB_NAME)
124+
112125
def test_exists_miss(self):
113126
from gcloud.exceptions import NotFound
114127

‎gcloud/storage/test_client.py‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,30 @@ def test_connection_getter_with_batch(self):
8989
self.assertTrue(client.connection is batch)
9090
self.assertTrue(client.current_batch is batch)
9191

92+
def test_bucket(self):
93+
from gcloud.storage.bucket import Bucket
94+
95+
PROJECT = object()
96+
CREDENTIALS = _Credentials()
97+
BUCKET_NAME = 'BUCKET_NAME'
98+
99+
client = self._makeOne(project=PROJECT, credentials=CREDENTIALS)
100+
bucket = client.bucket(BUCKET_NAME)
101+
self.assertTrue(isinstance(bucket, Bucket))
102+
self.assertTrue(bucket.client is client)
103+
self.assertEqual(bucket.name, BUCKET_NAME)
104+
105+
def test_batch(self):
106+
from gcloud.storage.batch import Batch
107+
108+
PROJECT = object()
109+
CREDENTIALS = _Credentials()
110+
111+
client = self._makeOne(project=PROJECT, credentials=CREDENTIALS)
112+
batch = client.batch()
113+
self.assertTrue(isinstance(batch, Batch))
114+
self.assertTrue(batch._client is client)
115+
92116
def test_get_bucket_miss(self):
93117
from gcloud.exceptions import NotFound
94118

‎system_tests/storage.py‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ def setUp(self):
5151
self.case_buckets_to_delete = []
5252

5353
def tearDown(self):
54-
with storage.Batch(CLIENT):
54+
with CLIENT.batch():
5555
for bucket_name in self.case_buckets_to_delete:
56-
storage.Bucket(CLIENT, name=bucket_name).delete()
56+
CLIENT.bucket(bucket_name).delete()
5757

5858
def test_create_bucket(self):
5959
new_bucket_name = 'a-new-bucket'
@@ -114,7 +114,7 @@ def tearDown(self):
114114
class TestStorageWriteFiles(TestStorageFiles):
115115

116116
def test_large_file_write_from_stream(self):
117-
blob = storage.Blob(bucket=self.bucket, name='LargeFile')
117+
blob = self.bucket.blob('LargeFile')
118118
self.assertEqual(blob._properties, {})
119119

120120
file_data = self.FILES['big']
@@ -128,7 +128,7 @@ def test_large_file_write_from_stream(self):
128128
self.assertEqual(md5_hash, file_data['hash'])
129129

130130
def test_small_file_write_from_filename(self):
131-
blob = storage.Blob(bucket=self.bucket, name='SmallFile')
131+
blob = self.bucket.blob('SmallFile')
132132
self.assertEqual(blob._properties, {})
133133

134134
file_data = self.FILES['simple']
@@ -150,12 +150,12 @@ def test_write_metadata(self):
150150
self.assertEqual(blob.content_type, 'image/png')
151151

152152
def test_direct_write_and_read_into_file(self):
153-
blob = storage.Blob(bucket=self.bucket, name='MyBuffer')
153+
blob = self.bucket.blob('MyBuffer')
154154
file_contents = b'Hello World'
155155
blob.upload_from_string(file_contents)
156156
self.case_blobs_to_delete.append(blob)
157157

158-
same_blob = storage.Blob(bucket=self.bucket, name='MyBuffer')
158+
same_blob = self.bucket.blob('MyBuffer')
159159
same_blob.reload() # Initialize properties.
160160
temp_filename = tempfile.mktemp()
161161
with open(temp_filename, 'wb') as file_obj:
@@ -309,7 +309,7 @@ def setUp(self):
309309
with open(logo_path, 'rb') as file_obj:
310310
self.LOCAL_FILE = file_obj.read()
311311

312-
blob = storage.Blob(bucket=self.bucket, name='LogoToSign.jpg')
312+
blob = self.bucket.blob('LogoToSign.jpg')
313313
blob.upload_from_string(self.LOCAL_FILE)
314314
self.case_blobs_to_delete.append(blob)
315315

@@ -319,7 +319,7 @@ def tearDown(self):
319319
blob.delete()
320320

321321
def test_create_signed_read_url(self):
322-
blob = storage.Blob(bucket=self.bucket, name='LogoToSign.jpg')
322+
blob = self.bucket.blob('LogoToSign.jpg')
323323
expiration = int(time.time() + 5)
324324
signed_url = blob.generate_signed_url(expiration, method='GET',
325325
client=CLIENT)
@@ -329,7 +329,7 @@ def test_create_signed_read_url(self):
329329
self.assertEqual(content, self.LOCAL_FILE)
330330

331331
def test_create_signed_delete_url(self):
332-
blob = storage.Blob(bucket=self.bucket, name='LogoToSign.jpg')
332+
blob = self.bucket.blob('LogoToSign.jpg')
333333
expiration = int(time.time() + 283473274)
334334
signed_delete_url = blob.generate_signed_url(expiration,
335335
method='DELETE',

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL