Skip to content

Replace connection in bucket constructor. #987

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 20, 2015
Merged

Replace connection in bucket constructor. #987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a93e20
Updating storage.Batch to accept a client.
dhermes Jul 11, 2015
017346a
Binding client to Bucket.
dhermes Jul 13, 2015
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
2 changes: 1 addition & 1 deletion gcloud/storage/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ def set_default_bucket(bucket=None):
bucket_name = os.getenv(_BUCKET_ENV_VAR_NAME)

if bucket_name is not None:
bucket = Bucket(bucket_name)
bucket = Bucket(None, name=bucket_name)

This comment was marked as spam.

Sign in to view

if bucket is not None:
_implicit_environ._DEFAULTS.bucket = bucket
Expand Down
14 changes: 5 additions & 9 deletions gcloud/storage/batch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@

from gcloud._helpers import _LocalStack
from gcloud.exceptions import make_exception
from gcloud.storage import _implicit_environ
from gcloud.storage.connection import Connection


Expand Down Expand Up @@ -130,17 +129,14 @@ def __setitem__(self, key, value):
class Batch(Connection):
"""Proxy an underlying connection, batching up change operations.

:type connection: :class:`gcloud.storage.connection.Connection`
:param connection: the connection for which the batch proxies.
:type client: :class:`gcloud.storage.client.Client`
:param client: The client to use for making connections.
"""
_MAX_BATCH_SIZE = 1000

def __init__(self, connection=None):
if connection is None:
connection = _implicit_environ.get_default_connection()

def __init__(self, client):
super(Batch, self).__init__()
self._connection = connection
self._client = client
self._requests = []
self._target_objects = []

Expand Down Expand Up @@ -248,7 +244,7 @@ def finish(self):

url = '%s/batch' % self.API_BASE_URL

response, content = self._connection._make_request(
response, content = self._client.connection._make_request(
'POST', url, data=body, headers=headers)
responses = list(_unpack_batch_response(response, content))
self._finish_futures(responses)
Expand Down
124 changes: 63 additions & 61 deletions gcloud/storage/bucket.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
from gcloud.exceptions import NotFound
from gcloud.iterator import Iterator
from gcloud.storage._helpers import _PropertyMixin
from gcloud.storage._helpers import _require_connection
from gcloud.storage._helpers import _scalar_property
from gcloud.storage.acl import BucketACL
from gcloud.storage.acl import DefaultObjectACL
Expand All @@ -45,17 +44,18 @@ class _BlobIterator(Iterator):
:type extra_params: dict or None
:param extra_params: Extra query string parameters for the API call.

:type connection: :class:`gcloud.storage.connection.Connection`
:param connection: The connection to use when sending requests. Defaults
to the bucket's connection
:type client: :class:`gcloud.storage.client.Client`
:param client: Optional. The client to use for making connections.
Defaults to the bucket's client.
"""
def __init__(self, bucket, extra_params=None, connection=None):
connection = _require_connection(connection)
def __init__(self, bucket, extra_params=None, client=None):
if client is None:
client = bucket.client
self.bucket = bucket
self.prefixes = set()
self._current_prefixes = None
super(_BlobIterator, self).__init__(
connection=connection, path=bucket.path + '/o',
connection=client.connection, path=bucket.path + '/o',
extra_params=extra_params)

def get_items_from_response(self, response):
Expand All @@ -76,6 +76,10 @@ def get_items_from_response(self, response):
class Bucket(_PropertyMixin):
"""A class representing a Bucket on Cloud Storage.

:type client: :class:`gcloud.storage.client.Client`
:param client: A client which holds credentials and project configuration
for the bucket (which requires a project).

:type name: string
:param name: The name of the bucket.
"""
Expand All @@ -87,60 +91,57 @@ class Bucket(_PropertyMixin):
This is used in Bucket.delete() and Bucket.make_public().
"""

def __init__(self, name=None):
def __init__(self, client, name=None):
super(Bucket, self).__init__(name=name)
self._client = client
self._acl = BucketACL(self)
self._default_object_acl = DefaultObjectACL(self)

def __repr__(self):
return '<Bucket: %s>' % self.name

@staticmethod
def _client_or_connection(client):
"""Temporary method to get a connection from a client.

If the client is null, gets the connection from the environment.
def _require_client(self, client):
"""Check client or verify over-ride.

:type client: :class:`gcloud.storage.client.Client` or ``NoneType``
:param client: Optional. The client to use. If not passed, falls back
to default connection.
:param client: the client to use. If not passed, falls back to the
``client`` stored on the current object.

:rtype: :class:`gcloud.storage.connection.Connection`
:returns: The connection determined from the ``client`` or environment.
:rtype: :class:`gcloud.storage.client.Client`
:returns: The client passed in or the currently bound client.
"""
if client is None:
return _require_connection()
else:
return client.connection
client = self.client
return client

def exists(self, client=None):
"""Determines whether or not this bucket exists.

:type client: :class:`gcloud.storage.client.Client` or ``NoneType``
:param client: Optional. The client to use. If not passed, falls back
to default connection.
to the ``client`` stored on the current bucket.

:rtype: boolean
:returns: True if the bucket exists in Cloud Storage.
"""
connection = self._client_or_connection(client)
client = self._require_client(client)
try:
# We only need the status code (200 or not) so we seek to
# minimize the returned payload.
query_params = {'fields': 'name'}
# We intentionally pass `_target_object=None` since fields=name
# would limit the local properties.
connection.api_request(method='GET', path=self.path,
query_params=query_params,
_target_object=None)
client.connection.api_request(method='GET', path=self.path,
query_params=query_params,
_target_object=None)
# NOTE: This will not fail immediately in a batch. However, when
# Batch.finish() is called, the resulting `NotFound` will be
# raised.
return True
except NotFound:
return False

def create(self, project=None, connection=None):
def create(self, project=None, client=None):
"""Creates current bucket.

If the bucket already exists, will raise
Expand All @@ -152,25 +153,24 @@ def create(self, project=None, connection=None):
:param project: Optional. The project to use when creating bucket.
If not provided, falls back to default.

:type connection: :class:`gcloud.storage.connection.Connection` or
``NoneType``
:param connection: Optional. The connection to use when sending
requests. If not provided, falls back to default.
:type client: :class:`gcloud.storage.client.Client` or ``NoneType``
:param client: Optional. The client to use. If not passed, falls back
to the ``client`` stored on the current bucket.

:rtype: :class:`gcloud.storage.bucket.Bucket`
:returns: The newly created bucket.
:raises: :class:`EnvironmentError` if the project is not given and
can't be inferred.
"""
connection = _require_connection(connection)
client = self._require_client(client)
if project is None:
project = get_default_project()
if project is None:
raise EnvironmentError('Project could not be inferred '
'from environment.')

query_params = {'project': project}
api_response = connection.api_request(
api_response = client.connection.api_request(
method='POST', path='/b', query_params=query_params,
data={'name': self.name}, _target_object=self)
self._set_properties(api_response)
Expand Down Expand Up @@ -205,6 +205,11 @@ def path(self):

return self.path_helper(self.name)

@property

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

def client(self):
"""The client bound to this bucket."""
return self._client

def get_blob(self, blob_name, client=None):
"""Get a blob object by name.

Expand All @@ -223,15 +228,15 @@ def get_blob(self, blob_name, client=None):

:type client: :class:`gcloud.storage.client.Client` or ``NoneType``
:param client: Optional. The client to use. If not passed, falls back
to default connection.
to the ``client`` stored on the current bucket.

:rtype: :class:`gcloud.storage.blob.Blob` or None
:returns: The blob object if it exists, otherwise None.
"""
connection = self._client_or_connection(client)
client = self._require_client(client)
blob = Blob(bucket=self, name=blob_name)
try:
response = connection.api_request(
response = client.connection.api_request(
method='GET', path=blob.path, _target_object=blob)
# NOTE: We assume response.get('name') matches `blob_name`.
blob._set_properties(response)
Expand All @@ -244,7 +249,7 @@ def get_blob(self, blob_name, client=None):

def list_blobs(self, max_results=None, page_token=None, prefix=None,
delimiter=None, versions=None,
projection='noAcl', fields=None, connection=None):
projection='noAcl', fields=None, client=None):
"""Return an iterator used to find blobs in the bucket.

:type max_results: integer or ``NoneType``
Expand Down Expand Up @@ -276,10 +281,9 @@ def list_blobs(self, max_results=None, page_token=None, prefix=None,
and the language of each blob returned:
'items/contentLanguage,nextPageToken'

:type connection: :class:`gcloud.storage.connection.Connection` or
``NoneType``
:param connection: Optional. The connection to use when sending
requests. If not provided, falls back to default.
:type client: :class:`gcloud.storage.client.Client` or ``NoneType``
:param client: Optional. The client to use. If not passed, falls back
to the ``client`` stored on the current bucket.

:rtype: :class:`_BlobIterator`.
:returns: An iterator of blobs.
Expand All @@ -304,7 +308,7 @@ def list_blobs(self, max_results=None, page_token=None, prefix=None,
extra_params['fields'] = fields

result = self._iterator_class(
self, extra_params=extra_params, connection=connection)
self, extra_params=extra_params, client=client)
# Page token must be handled specially since the base `Iterator`
# class has it as a reserved property.
if page_token is not None:
Expand Down Expand Up @@ -332,16 +336,16 @@ def delete(self, force=False, client=None):

:type client: :class:`gcloud.storage.client.Client` or ``NoneType``
:param client: Optional. The client to use. If not passed, falls back
to default connection.
to the ``client`` stored on the current bucket.

:raises: :class:`ValueError` if ``force`` is ``True`` and the bucket
contains more than 256 objects / blobs.
"""
connection = self._client_or_connection(client)
client = self._require_client(client)
if force:
blobs = list(self.list_blobs(
max_results=self._MAX_OBJECTS_FOR_ITERATION + 1,
connection=connection))
client=client))
if len(blobs) > self._MAX_OBJECTS_FOR_ITERATION:
message = (
'Refusing to delete bucket with more than '
Expand All @@ -358,8 +362,8 @@ def delete(self, force=False, client=None):
# We intentionally pass `_target_object=None` since a DELETE
# request has no response value (whether in a standard request or
# in a batch request).
connection.api_request(method='DELETE', path=self.path,
_target_object=None)
client.connection.api_request(method='DELETE', path=self.path,
_target_object=None)

def delete_blob(self, blob_name, client=None):
"""Deletes a blob from the current bucket.
Expand All @@ -386,21 +390,21 @@ def delete_blob(self, blob_name, client=None):

:type client: :class:`gcloud.storage.client.Client` or ``NoneType``
:param client: Optional. The client to use. If not passed, falls back
to default connection.
to the ``client`` stored on the current bucket.

:raises: :class:`gcloud.exceptions.NotFound` (to suppress
the exception, call ``delete_blobs``, passing a no-op
``on_error`` callback, e.g.::

>>> bucket.delete_blobs([blob], on_error=lambda blob: None)
"""
connection = self._client_or_connection(client)
client = self._require_client(client)
blob_path = Blob.path_helper(self.path, blob_name)
# We intentionally pass `_target_object=None` since a DELETE
# request has no response value (whether in a standard request or
# in a batch request).
connection.api_request(method='DELETE', path=blob_path,
_target_object=None)
client.connection.api_request(method='DELETE', path=blob_path,
_target_object=None)

def delete_blobs(self, blobs, on_error=None, client=None):
"""Deletes a list of blobs from the current bucket.
Expand All @@ -417,7 +421,7 @@ def delete_blobs(self, blobs, on_error=None, client=None):

:type client: :class:`gcloud.storage.client.Client` or ``NoneType``
:param client: Optional. The client to use. If not passed, falls back
to default connection.
to the ``client`` stored on the current bucket.

:raises: :class:`gcloud.exceptions.NotFound` (if
`on_error` is not passed).
Expand Down Expand Up @@ -450,18 +454,18 @@ def copy_blob(self, blob, destination_bucket, new_name=None,

:type client: :class:`gcloud.storage.client.Client` or ``NoneType``
:param client: Optional. The client to use. If not passed, falls back
to default connection.
to the ``client`` stored on the current bucket.

:rtype: :class:`gcloud.storage.blob.Blob`
:returns: The new Blob.
"""
connection = self._client_or_connection(client)
client = self._require_client(client)
if new_name is None:
new_name = blob.name
new_blob = Blob(bucket=destination_bucket, name=new_name)
api_path = blob.path + '/copyTo' + new_blob.path
copy_result = connection.api_request(method='POST', path=api_path,
_target_object=new_blob)
copy_result = client.connection.api_request(
method='POST', path=api_path, _target_object=new_blob)
new_blob._set_properties(copy_result)
return new_blob

Expand Down Expand Up @@ -500,7 +504,7 @@ def upload_file(self, filename, blob_name=None, client=None):

:type client: :class:`gcloud.storage.client.Client` or ``NoneType``
:param client: Optional. The client to use. If not passed, falls back
to default connection.
to the ``client`` stored on the current bucket.

:rtype: :class:`Blob`
:returns: The updated Blob object.
Expand Down Expand Up @@ -546,7 +550,7 @@ def upload_file_object(self, file_obj, blob_name=None, client=None):

:type client: :class:`gcloud.storage.client.Client` or ``NoneType``
:param client: Optional. The client to use. If not passed, falls back
to default connection.
to the ``client`` stored on the current bucket.

:rtype: :class:`Blob`
:returns: The updated Blob object.
Expand Down Expand Up @@ -847,10 +851,8 @@ def make_public(self, recursive=False, future=False, client=None):

:type client: :class:`gcloud.storage.client.Client` or ``NoneType``
:param client: Optional. The client to use. If not passed, falls back
to default connection.
to the ``client`` stored on the current bucket.
"""
connection = self._client_or_connection(client)

self.acl.all().grant_read()
self.acl.save(client=client)

Expand All @@ -865,7 +867,7 @@ def make_public(self, recursive=False, future=False, client=None):
blobs = list(self.list_blobs(
projection='full',
max_results=self._MAX_OBJECTS_FOR_ITERATION + 1,
connection=connection))
client=client))
if len(blobs) > self._MAX_OBJECTS_FOR_ITERATION:
message = (
'Refusing to make public recursively with more than '
Expand Down
Loading