Updated DB_Helper by adding firebase methods.
This commit is contained in:
parent
485cc3bbba
commit
c82121d036
1810 changed files with 537281 additions and 1 deletions
306
venv/Lib/site-packages/gcloud/storage/client.py
Normal file
306
venv/Lib/site-packages/gcloud/storage/client.py
Normal file
|
|
@ -0,0 +1,306 @@
|
|||
# Copyright 2015 Google Inc. All rights reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
"""Client for interacting with the Google Cloud Storage API."""
|
||||
|
||||
|
||||
from gcloud._helpers import _LocalStack
|
||||
from gcloud.client import JSONClient
|
||||
from gcloud.exceptions import NotFound
|
||||
from gcloud.iterator import Iterator
|
||||
from gcloud.storage.batch import Batch
|
||||
from gcloud.storage.bucket import Bucket
|
||||
from gcloud.storage.connection import Connection
|
||||
|
||||
|
||||
class Client(JSONClient):
|
||||
"""Client to bundle configuration needed for API requests.
|
||||
|
||||
:type project: string
|
||||
:param project: the project which the client acts on behalf of. Will be
|
||||
passed when creating a topic. If not passed,
|
||||
falls back to the default inferred from the environment.
|
||||
|
||||
:type credentials: :class:`oauth2client.client.OAuth2Credentials` or
|
||||
:class:`NoneType`
|
||||
:param credentials: The OAuth2 Credentials to use for the connection
|
||||
owned by this client. If not passed (and if no ``http``
|
||||
object is passed), falls back to the default inferred
|
||||
from the environment.
|
||||
|
||||
:type http: :class:`httplib2.Http` or class that defines ``request()``.
|
||||
:param http: An optional HTTP object to make requests. If not passed, an
|
||||
``http`` object is created that is bound to the
|
||||
``credentials`` for the current object.
|
||||
"""
|
||||
|
||||
_connection_class = Connection
|
||||
|
||||
def __init__(self, project=None, credentials=None, http=None):
|
||||
self._connection = None
|
||||
super(Client, self).__init__(project=project, credentials=credentials,
|
||||
http=http)
|
||||
self._batch_stack = _LocalStack()
|
||||
|
||||
@property
|
||||
def connection(self):
|
||||
"""Get connection or batch on the client.
|
||||
|
||||
:rtype: :class:`gcloud.storage.connection.Connection`
|
||||
:returns: The connection set on the client, or the batch
|
||||
if one is set.
|
||||
"""
|
||||
if self.current_batch is not None:
|
||||
return self.current_batch
|
||||
else:
|
||||
return self._connection
|
||||
|
||||
@connection.setter
|
||||
def connection(self, value):
|
||||
"""Set connection on the client.
|
||||
|
||||
Intended to be used by constructor (since the base class calls)
|
||||
self.connection = connection
|
||||
Will raise if the connection is set more than once.
|
||||
|
||||
:type value: :class:`gcloud.storage.connection.Connection`
|
||||
:param value: The connection set on the client.
|
||||
|
||||
:raises: :class:`ValueError` if connection has already been set.
|
||||
"""
|
||||
if self._connection is not None:
|
||||
raise ValueError('Connection already set on client')
|
||||
self._connection = value
|
||||
|
||||
def _push_batch(self, batch):
|
||||
"""Push a batch onto our stack.
|
||||
|
||||
"Protected", intended for use by batch context mgrs.
|
||||
|
||||
:type batch: :class:`gcloud.storage.batch.Batch`
|
||||
:param batch: newly-active batch
|
||||
"""
|
||||
self._batch_stack.push(batch)
|
||||
|
||||
def _pop_batch(self):
|
||||
"""Pop a batch from our stack.
|
||||
|
||||
"Protected", intended for use by batch context mgrs.
|
||||
|
||||
:raises: IndexError if the stack is empty.
|
||||
:rtype: :class:`gcloud.storage.batch.Batch`
|
||||
:returns: the top-most batch/transaction, after removing it.
|
||||
"""
|
||||
return self._batch_stack.pop()
|
||||
|
||||
@property
|
||||
def current_batch(self):
|
||||
"""Currently-active batch.
|
||||
|
||||
:rtype: :class:`gcloud.storage.batch.Batch` or ``NoneType`` (if
|
||||
no batch is active).
|
||||
:returns: The batch at the top of the batch stack.
|
||||
"""
|
||||
return self._batch_stack.top
|
||||
|
||||
def bucket(self, bucket_name):
|
||||
"""Factory constructor for bucket object.
|
||||
|
||||
.. note::
|
||||
This will not make an HTTP request; it simply instantiates
|
||||
a bucket object owned by this client.
|
||||
|
||||
:type bucket_name: string
|
||||
:param bucket_name: The name of the bucket to be instantiated.
|
||||
|
||||
:rtype: :class:`gcloud.storage.bucket.Bucket`
|
||||
:returns: The bucket object created.
|
||||
"""
|
||||
return Bucket(client=self, name=bucket_name)
|
||||
|
||||
def batch(self):
|
||||
"""Factory constructor for batch object.
|
||||
|
||||
.. note::
|
||||
This will not make an HTTP request; it simply instantiates
|
||||
a batch object owned by this client.
|
||||
|
||||
:rtype: :class:`gcloud.storage.batch.Batch`
|
||||
:returns: The batch object created.
|
||||
"""
|
||||
return Batch(client=self)
|
||||
|
||||
def get_bucket(self, bucket_name):
|
||||
"""Get a bucket by name.
|
||||
|
||||
If the bucket isn't found, this will raise a
|
||||
:class:`gcloud.storage.exceptions.NotFound`.
|
||||
|
||||
For example::
|
||||
|
||||
>>> try:
|
||||
>>> bucket = client.get_bucket('my-bucket')
|
||||
>>> except gcloud.exceptions.NotFound:
|
||||
>>> print 'Sorry, that bucket does not exist!'
|
||||
|
||||
This implements "storage.buckets.get".
|
||||
|
||||
:type bucket_name: string
|
||||
:param bucket_name: The name of the bucket to get.
|
||||
|
||||
:rtype: :class:`gcloud.storage.bucket.Bucket`
|
||||
:returns: The bucket matching the name provided.
|
||||
:raises: :class:`gcloud.exceptions.NotFound`
|
||||
"""
|
||||
bucket = Bucket(self, name=bucket_name)
|
||||
bucket.reload(client=self)
|
||||
return bucket
|
||||
|
||||
def lookup_bucket(self, bucket_name):
|
||||
"""Get a bucket by name, returning None if not found.
|
||||
|
||||
You can use this if you would rather check for a None value
|
||||
than catching an exception::
|
||||
|
||||
>>> bucket = client.lookup_bucket('doesnt-exist')
|
||||
>>> print bucket
|
||||
None
|
||||
>>> bucket = client.lookup_bucket('my-bucket')
|
||||
>>> print bucket
|
||||
<Bucket: my-bucket>
|
||||
|
||||
:type bucket_name: string
|
||||
:param bucket_name: The name of the bucket to get.
|
||||
|
||||
:rtype: :class:`gcloud.storage.bucket.Bucket`
|
||||
:returns: The bucket matching the name provided or None if not found.
|
||||
"""
|
||||
try:
|
||||
return self.get_bucket(bucket_name)
|
||||
except NotFound:
|
||||
return None
|
||||
|
||||
def create_bucket(self, bucket_name):
|
||||
"""Create a new bucket.
|
||||
|
||||
For example::
|
||||
|
||||
>>> bucket = client.create_bucket('my-bucket')
|
||||
>>> print bucket
|
||||
<Bucket: my-bucket>
|
||||
|
||||
This implements "storage.buckets.insert".
|
||||
|
||||
If the bucket already exists, will raise
|
||||
:class:`gcloud.exceptions.Conflict`.
|
||||
|
||||
:type bucket_name: string
|
||||
:param bucket_name: The bucket name to create.
|
||||
|
||||
:rtype: :class:`gcloud.storage.bucket.Bucket`
|
||||
:returns: The newly created bucket.
|
||||
"""
|
||||
bucket = Bucket(self, name=bucket_name)
|
||||
bucket.create(client=self)
|
||||
return bucket
|
||||
|
||||
def list_buckets(self, max_results=None, page_token=None, prefix=None,
|
||||
projection='noAcl', fields=None):
|
||||
"""Get all buckets in the project associated to the client.
|
||||
|
||||
This will not populate the list of blobs available in each
|
||||
bucket.
|
||||
|
||||
>>> for bucket in client.list_buckets():
|
||||
>>> print bucket
|
||||
|
||||
This implements "storage.buckets.list".
|
||||
|
||||
:type max_results: integer or ``NoneType``
|
||||
:param max_results: Optional. Maximum number of buckets to return.
|
||||
|
||||
:type page_token: string or ``NoneType``
|
||||
:param page_token: Optional. Opaque marker for the next "page" of
|
||||
buckets. If not passed, will return the first page
|
||||
of buckets.
|
||||
|
||||
:type prefix: string or ``NoneType``
|
||||
:param prefix: Optional. Filter results to buckets whose names begin
|
||||
with this prefix.
|
||||
|
||||
:type projection: string or ``NoneType``
|
||||
:param projection: If used, must be 'full' or 'noAcl'. Defaults to
|
||||
'noAcl'. Specifies the set of properties to return.
|
||||
|
||||
:type fields: string or ``NoneType``
|
||||
:param fields: Selector specifying which fields to include in a
|
||||
partial response. Must be a list of fields. For example
|
||||
to get a partial response with just the next page token
|
||||
and the language of each bucket returned:
|
||||
'items/id,nextPageToken'
|
||||
|
||||
:rtype: iterable of :class:`gcloud.storage.bucket.Bucket` objects.
|
||||
:returns: All buckets belonging to this project.
|
||||
"""
|
||||
extra_params = {'project': self.project}
|
||||
|
||||
if max_results is not None:
|
||||
extra_params['maxResults'] = max_results
|
||||
|
||||
if prefix is not None:
|
||||
extra_params['prefix'] = prefix
|
||||
|
||||
extra_params['projection'] = projection
|
||||
|
||||
if fields is not None:
|
||||
extra_params['fields'] = fields
|
||||
|
||||
result = _BucketIterator(client=self,
|
||||
extra_params=extra_params)
|
||||
# Page token must be handled specially since the base `Iterator`
|
||||
# class has it as a reserved property.
|
||||
if page_token is not None:
|
||||
result.next_page_token = page_token
|
||||
return result
|
||||
|
||||
|
||||
class _BucketIterator(Iterator):
|
||||
"""An iterator listing all buckets.
|
||||
|
||||
You shouldn't have to use this directly, but instead should use the
|
||||
helper methods on :class:`gcloud.storage.connection.Connection`
|
||||
objects.
|
||||
|
||||
:type client: :class:`gcloud.storage.client.Client`
|
||||
:param client: The client to use for making connections.
|
||||
|
||||
:type extra_params: dict or ``NoneType``
|
||||
:param extra_params: Extra query string parameters for the API call.
|
||||
"""
|
||||
|
||||
def __init__(self, client, extra_params=None):
|
||||
super(_BucketIterator, self).__init__(client=client, path='/b',
|
||||
extra_params=extra_params)
|
||||
|
||||
def get_items_from_response(self, response):
|
||||
"""Factory method which yields :class:`.Bucket` items from a response.
|
||||
|
||||
:type response: dict
|
||||
:param response: The JSON API response for a page of buckets.
|
||||
"""
|
||||
for item in response.get('items', []):
|
||||
name = item.get('name')
|
||||
bucket = Bucket(self.client, name)
|
||||
bucket._set_properties(item)
|
||||
yield bucket
|
||||
Loading…
Add table
Add a link
Reference in a new issue