springsuite: planemo/lib/python3.7/site-packages/boto/gs/key.py annotate

annotate planemo/lib/python3.7/site-packages/boto/gs/key.py @ 1:56ad4e20f292 draft

"planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1"

author	guerler
date	Fri, 31 Jul 2020 00:32:28 -0400
parents	d30785e31577
children

rev	line source
0 d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1 # Copyright 2010 Google Inc.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	2 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	3 # Permission is hereby granted, free of charge, to any person obtaining a
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	4 # copy of this software and associated documentation files (the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	5 # "Software"), to deal in the Software without restriction, including
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	6 # without limitation the rights to use, copy, modify, merge, publish, dis-
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	7 # tribute, sublicense, and/or sell copies of the Software, and to permit
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	8 # persons to whom the Software is furnished to do so, subject to the fol-
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	9 # lowing conditions:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	10 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	11 # The above copyright notice and this permission notice shall be included
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	12 # in all copies or substantial portions of the Software.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	13 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	14 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	15 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	16 # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	17 # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	18 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	19 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	20 # IN THE SOFTWARE.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	21
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	22 import base64
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	23 import binascii
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	24 import os
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	25 import re
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	26
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	27 from boto.compat import StringIO
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	28 from boto.exception import BotoClientError
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	29 from boto.s3.key import Key as S3Key
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	30 from boto.s3.keyfile import KeyFile
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	31 from boto.utils import compute_hash
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	32 from boto.utils import get_utf8_value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	33
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	34 class Key(S3Key):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	35 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	36 Represents a key (object) in a GS bucket.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	37
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	38 :ivar bucket: The parent :class:`boto.gs.bucket.Bucket`.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	39 :ivar name: The name of this Key object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	40 :ivar metadata: A dictionary containing user metadata that you
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	41 wish to store with the object or that has been retrieved from
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	42 an existing object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	43 :ivar cache_control: The value of the `Cache-Control` HTTP header.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	44 :ivar content_type: The value of the `Content-Type` HTTP header.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	45 :ivar content_encoding: The value of the `Content-Encoding` HTTP header.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	46 :ivar content_disposition: The value of the `Content-Disposition` HTTP
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	47 header.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	48 :ivar content_language: The value of the `Content-Language` HTTP header.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	49 :ivar etag: The `etag` associated with this object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	50 :ivar last_modified: The string timestamp representing the last
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	51 time this object was modified in GS.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	52 :ivar owner: The ID of the owner of this object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	53 :ivar storage_class: The storage class of the object. Currently, one of:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	54 STANDARD \| DURABLE_REDUCED_AVAILABILITY.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	55 :ivar md5: The MD5 hash of the contents of the object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	56 :ivar size: The size, in bytes, of the object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	57 :ivar generation: The generation number of the object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	58 :ivar metageneration: The generation number of the object metadata.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	59 :ivar encrypted: Whether the object is encrypted while at rest on
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	60 the server.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	61 :ivar cloud_hashes: Dictionary of checksums as supplied by the storage
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	62 provider.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	63 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	64
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	65 def __init__(self, bucket=None, name=None, generation=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	66 super(Key, self).__init__(bucket=bucket, name=name)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	67 self.generation = generation
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	68 self.meta_generation = None
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	69 self.cloud_hashes = {}
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	70 self.component_count = None
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	71
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	72 def __repr__(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	73 if self.generation and self.metageneration:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	74 ver_str = '#%s.%s' % (self.generation, self.metageneration)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	75 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	76 ver_str = ''
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	77 if self.bucket:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	78 return '<Key: %s,%s%s>' % (self.bucket.name, self.name, ver_str)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	79 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	80 return '<Key: None,%s%s>' % (self.name, ver_str)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	81
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	82 def endElement(self, name, value, connection):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	83 if name == 'Key':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	84 self.name = value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	85 elif name == 'ETag':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	86 self.etag = value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	87 elif name == 'IsLatest':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	88 if value == 'true':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	89 self.is_latest = True
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	90 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	91 self.is_latest = False
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	92 elif name == 'LastModified':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	93 self.last_modified = value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	94 elif name == 'Size':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	95 self.size = int(value)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	96 elif name == 'StorageClass':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	97 self.storage_class = value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	98 elif name == 'Owner':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	99 pass
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	100 elif name == 'VersionId':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	101 self.version_id = value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	102 elif name == 'Generation':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	103 self.generation = value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	104 elif name == 'MetaGeneration':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	105 self.metageneration = value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	106 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	107 setattr(self, name, value)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	108
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	109 def handle_version_headers(self, resp, force=False):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	110 self.metageneration = resp.getheader('x-goog-metageneration', None)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	111 self.generation = resp.getheader('x-goog-generation', None)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	112
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	113 def handle_restore_headers(self, response):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	114 return
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	115
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	116 def handle_addl_headers(self, headers):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	117 for key, value in headers:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	118 if key == 'x-goog-hash':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	119 for hash_pair in value.split(','):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	120 alg, b64_digest = hash_pair.strip().split('=', 1)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	121 self.cloud_hashes[alg] = binascii.a2b_base64(b64_digest)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	122 elif key == 'x-goog-component-count':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	123 self.component_count = int(value)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	124 elif key == 'x-goog-generation':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	125 self.generation = value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	126 # Use x-goog-stored-content-encoding and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	127 # x-goog-stored-content-length to indicate original content length
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	128 # and encoding, which are transcoding-invariant (so are preferable
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	129 # over using content-encoding and size headers).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	130 elif key == 'x-goog-stored-content-encoding':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	131 self.content_encoding = value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	132 elif key == 'x-goog-stored-content-length':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	133 self.size = int(value)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	134 elif key == 'x-goog-storage-class':
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	135 self.storage_class = value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	136
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	137 def open_read(self, headers=None, query_args='',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	138 override_num_retries=None, response_headers=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	139 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	140 Open this key for reading
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	141
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	142 :type headers: dict
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	143 :param headers: Headers to pass in the web request
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	144
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	145 :type query_args: string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	146 :param query_args: Arguments to pass in the query string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	147 (ie, 'torrent')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	148
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	149 :type override_num_retries: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	150 :param override_num_retries: If not None will override configured
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	151 num_retries parameter for underlying GET.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	152
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	153 :type response_headers: dict
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	154 :param response_headers: A dictionary containing HTTP
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	155 headers/values that will override any headers associated
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	156 with the stored object in the response. See
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	157 http://goo.gl/EWOPb for details.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	158 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	159 # For GCS we need to include the object generation in the query args.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	160 # The rest of the processing is handled in the parent class.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	161 if self.generation:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	162 if query_args:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	163 query_args += '&'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	164 query_args += 'generation=%s' % self.generation
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	165 super(Key, self).open_read(headers=headers, query_args=query_args,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	166 override_num_retries=override_num_retries,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	167 response_headers=response_headers)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	168
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	169 def get_file(self, fp, headers=None, cb=None, num_cb=10,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	170 torrent=False, version_id=None, override_num_retries=None,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	171 response_headers=None, hash_algs=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	172 query_args = None
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	173 if self.generation:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	174 query_args = ['generation=%s' % self.generation]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	175 self._get_file_internal(fp, headers=headers, cb=cb, num_cb=num_cb,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	176 override_num_retries=override_num_retries,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	177 response_headers=response_headers,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	178 hash_algs=hash_algs,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	179 query_args=query_args)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	180
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	181 def get_contents_to_file(self, fp, headers=None,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	182 cb=None, num_cb=10,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	183 torrent=False,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	184 version_id=None,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	185 res_download_handler=None,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	186 response_headers=None,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	187 hash_algs=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	188 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	189 Retrieve an object from GCS using the name of the Key object as the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	190 key in GCS. Write the contents of the object to the file pointed
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	191 to by 'fp'.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	192
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	193 :type fp: File -like object
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	194 :param fp:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	195
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	196 :type headers: dict
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	197 :param headers: additional HTTP headers that will be sent with
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	198 the GET request.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	199
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	200 :type cb: function
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	201 :param cb: a callback function that will be called to report
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	202 progress on the upload. The callback should accept two
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	203 integer parameters, the first representing the number of
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	204 bytes that have been successfully transmitted to GCS and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	205 the second representing the size of the to be transmitted
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	206 object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	207
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	208 :type cb: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	209 :param num_cb: (optional) If a callback is specified with the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	210 cb parameter this parameter determines the granularity of
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	211 the callback by defining the maximum number of times the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	212 callback will be called during the file transfer.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	213
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	214 :type torrent: bool
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	215 :param torrent: If True, returns the contents of a torrent
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	216 file as a string.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	217
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	218 :type res_upload_handler: ResumableDownloadHandler
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	219 :param res_download_handler: If provided, this handler will
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	220 perform the download.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	221
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	222 :type response_headers: dict
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	223 :param response_headers: A dictionary containing HTTP
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	224 headers/values that will override any headers associated
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	225 with the stored object in the response. See
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	226 http://goo.gl/sMkcC for details.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	227 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	228 if self.bucket is not None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	229 if res_download_handler:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	230 res_download_handler.get_file(self, fp, headers, cb, num_cb,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	231 torrent=torrent,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	232 version_id=version_id,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	233 hash_algs=hash_algs)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	234 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	235 self.get_file(fp, headers, cb, num_cb, torrent=torrent,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	236 version_id=version_id,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	237 response_headers=response_headers,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	238 hash_algs=hash_algs)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	239
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	240 def compute_hash(self, fp, algorithm, size=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	241 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	242 :type fp: file
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	243 :param fp: File pointer to the file to hash. The file
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	244 pointer will be reset to the same position before the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	245 method returns.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	246
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	247 :type algorithm: zero-argument constructor for hash objects that
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	248 implements update() and digest() (e.g. hashlib.md5)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	249
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	250 :type size: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	251 :param size: (optional) The Maximum number of bytes to read
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	252 from the file pointer (fp). This is useful when uploading
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	253 a file in multiple parts where the file is being split
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	254 in place into different parts. Less bytes may be available.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	255 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	256 hex_digest, b64_digest, data_size = compute_hash(
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	257 fp, size=size, hash_algorithm=algorithm)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	258 # The internal implementation of compute_hash() needs to return the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	259 # data size, but we don't want to return that value to the external
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	260 # caller because it changes the class interface (i.e. it might
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	261 # break some code), so we consume the third tuple value here and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	262 # return the remainder of the tuple to the caller, thereby preserving
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	263 # the existing interface.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	264 self.size = data_size
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	265 return (hex_digest, b64_digest)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	266
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	267 def send_file(self, fp, headers=None, cb=None, num_cb=10,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	268 query_args=None, chunked_transfer=False, size=None,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	269 hash_algs=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	270 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	271 Upload a file to GCS.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	272
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	273 :type fp: file
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	274 :param fp: The file pointer to upload. The file pointer must
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	275 point at the offset from which you wish to upload.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	276 ie. if uploading the full file, it should point at the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	277 start of the file. Normally when a file is opened for
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	278 reading, the fp will point at the first byte. See the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	279 bytes parameter below for more info.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	280
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	281 :type headers: dict
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	282 :param headers: The headers to pass along with the PUT request
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	283
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	284 :type num_cb: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	285 :param num_cb: (optional) If a callback is specified with the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	286 cb parameter this parameter determines the granularity of
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	287 the callback by defining the maximum number of times the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	288 callback will be called during the file
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	289 transfer. Providing a negative integer will cause your
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	290 callback to be called with each buffer read.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	291
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	292 :type query_args: string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	293 :param query_args: Arguments to pass in the query string.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	294
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	295 :type chunked_transfer: boolean
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	296 :param chunked_transfer: (optional) If true, we use chunked
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	297 Transfer-Encoding.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	298
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	299 :type size: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	300 :param size: (optional) The Maximum number of bytes to read
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	301 from the file pointer (fp). This is useful when uploading
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	302 a file in multiple parts where you are splitting the file
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	303 up into different ranges to be uploaded. If not specified,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	304 the default behaviour is to read all bytes from the file
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	305 pointer. Less bytes may be available.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	306
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	307 :type hash_algs: dictionary
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	308 :param hash_algs: (optional) Dictionary of hash algorithms and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	309 corresponding hashing class that implements update() and digest().
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	310 Defaults to {'md5': hashlib.md5}.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	311 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	312 self._send_file_internal(fp, headers=headers, cb=cb, num_cb=num_cb,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	313 query_args=query_args,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	314 chunked_transfer=chunked_transfer, size=size,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	315 hash_algs=hash_algs)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	316
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	317 def delete(self, headers=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	318 return self.bucket.delete_key(self.name, version_id=self.version_id,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	319 generation=self.generation,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	320 headers=headers)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	321
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	322 def add_email_grant(self, permission, email_address):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	323 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	324 Convenience method that provides a quick way to add an email grant to a
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	325 key. This method retrieves the current ACL, creates a new grant based on
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	326 the parameters passed in, adds that grant to the ACL and then PUT's the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	327 new ACL back to GS.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	328
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	329 :type permission: string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	330 :param permission: The permission being granted. Should be one of:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	331 READ\|FULL_CONTROL
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	332 See http://code.google.com/apis/storage/docs/developer-guide.html#authorization
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	333 for more details on permissions.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	334
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	335 :type email_address: string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	336 :param email_address: The email address associated with the Google
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	337 account to which you are granting the permission.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	338 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	339 acl = self.get_acl()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	340 acl.add_email_grant(permission, email_address)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	341 self.set_acl(acl)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	342
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	343 def add_user_grant(self, permission, user_id):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	344 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	345 Convenience method that provides a quick way to add a canonical user
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	346 grant to a key. This method retrieves the current ACL, creates a new
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	347 grant based on the parameters passed in, adds that grant to the ACL and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	348 then PUT's the new ACL back to GS.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	349
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	350 :type permission: string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	351 :param permission: The permission being granted. Should be one of:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	352 READ\|FULL_CONTROL
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	353 See http://code.google.com/apis/storage/docs/developer-guide.html#authorization
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	354 for more details on permissions.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	355
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	356 :type user_id: string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	357 :param user_id: The canonical user id associated with the GS account to
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	358 which you are granting the permission.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	359 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	360 acl = self.get_acl()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	361 acl.add_user_grant(permission, user_id)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	362 self.set_acl(acl)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	363
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	364 def add_group_email_grant(self, permission, email_address, headers=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	365 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	366 Convenience method that provides a quick way to add an email group
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	367 grant to a key. This method retrieves the current ACL, creates a new
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	368 grant based on the parameters passed in, adds that grant to the ACL and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	369 then PUT's the new ACL back to GS.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	370
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	371 :type permission: string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	372 :param permission: The permission being granted. Should be one of:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	373 READ\|FULL_CONTROL
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	374 See http://code.google.com/apis/storage/docs/developer-guide.html#authorization
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	375 for more details on permissions.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	376
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	377 :type email_address: string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	378 :param email_address: The email address associated with the Google
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	379 Group to which you are granting the permission.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	380 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	381 acl = self.get_acl(headers=headers)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	382 acl.add_group_email_grant(permission, email_address)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	383 self.set_acl(acl, headers=headers)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	384
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	385 def add_group_grant(self, permission, group_id):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	386 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	387 Convenience method that provides a quick way to add a canonical group
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	388 grant to a key. This method retrieves the current ACL, creates a new
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	389 grant based on the parameters passed in, adds that grant to the ACL and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	390 then PUT's the new ACL back to GS.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	391
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	392 :type permission: string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	393 :param permission: The permission being granted. Should be one of:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	394 READ\|FULL_CONTROL
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	395 See http://code.google.com/apis/storage/docs/developer-guide.html#authorization
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	396 for more details on permissions.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	397
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	398 :type group_id: string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	399 :param group_id: The canonical group id associated with the Google
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	400 Groups account you are granting the permission to.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	401 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	402 acl = self.get_acl()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	403 acl.add_group_grant(permission, group_id)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	404 self.set_acl(acl)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	405
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	406 def set_contents_from_file(self, fp, headers=None, replace=True,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	407 cb=None, num_cb=10, policy=None, md5=None,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	408 res_upload_handler=None, size=None, rewind=False,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	409 if_generation=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	410 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	411 Store an object in GS using the name of the Key object as the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	412 key in GS and the contents of the file pointed to by 'fp' as the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	413 contents.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	414
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	415 :type fp: file
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	416 :param fp: The file whose contents are to be uploaded.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	417
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	418 :type headers: dict
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	419 :param headers: (optional) Additional HTTP headers to be sent with the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	420 PUT request.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	421
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	422 :type replace: bool
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	423 :param replace: (optional) If this parameter is False, the method will
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	424 first check to see if an object exists in the bucket with the same
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	425 key. If it does, it won't overwrite it. The default value is True
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	426 which will overwrite the object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	427
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	428 :type cb: function
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	429 :param cb: (optional) Callback function that will be called to report
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	430 progress on the upload. The callback should accept two integer
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	431 parameters, the first representing the number of bytes that have
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	432 been successfully transmitted to GS and the second representing the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	433 total number of bytes that need to be transmitted.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	434
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	435 :type num_cb: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	436 :param num_cb: (optional) If a callback is specified with the cb
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	437 parameter, this parameter determines the granularity of the callback
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	438 by defining the maximum number of times the callback will be called
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	439 during the file transfer.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	440
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	441 :type policy: :class:`boto.gs.acl.CannedACLStrings`
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	442 :param policy: (optional) A canned ACL policy that will be applied to
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	443 the new key in GS.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	444
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	445 :type md5: tuple
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	446 :param md5: (optional) A tuple containing the hexdigest version of the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	447 MD5 checksum of the file as the first element and the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	448 Base64-encoded version of the plain checksum as the second element.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	449 This is the same format returned by the compute_md5 method.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	450
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	451 If you need to compute the MD5 for any reason prior to upload, it's
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	452 silly to have to do it twice so this param, if present, will be
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	453 used as the MD5 values of the file. Otherwise, the checksum will be
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	454 computed.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	455
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	456 :type res_upload_handler: :py:class:`boto.gs.resumable_upload_handler.ResumableUploadHandler`
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	457 :param res_upload_handler: (optional) If provided, this handler will
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	458 perform the upload.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	459
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	460 :type size: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	461 :param size: (optional) The Maximum number of bytes to read from the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	462 file pointer (fp). This is useful when uploading a file in multiple
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	463 parts where you are splitting the file up into different ranges to
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	464 be uploaded. If not specified, the default behaviour is to read all
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	465 bytes from the file pointer. Less bytes may be available.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	466
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	467 Notes:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	468
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	469 1. The "size" parameter currently cannot be used when a
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	470 resumable upload handler is given but is still useful for
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	471 uploading part of a file as implemented by the parent class.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	472 2. At present Google Cloud Storage does not support multipart
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	473 uploads.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	474
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	475 :type rewind: bool
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	476 :param rewind: (optional) If True, the file pointer (fp) will be
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	477 rewound to the start before any bytes are read from it. The default
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	478 behaviour is False which reads from the current position of the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	479 file pointer (fp).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	480
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	481 :type if_generation: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	482 :param if_generation: (optional) If set to a generation number, the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	483 object will only be written to if its current generation number is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	484 this value. If set to the value 0, the object will only be written
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	485 if it doesn't already exist.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	486
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	487 :rtype: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	488 :return: The number of bytes written to the key.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	489
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	490 TODO: At some point we should refactor the Bucket and Key classes,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	491 to move functionality common to all providers into a parent class,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	492 and provider-specific functionality into subclasses (rather than
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	493 just overriding/sharing code the way it currently works).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	494 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	495 provider = self.bucket.connection.provider
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	496 if res_upload_handler and size:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	497 # could use size instead of file_length if provided but...
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	498 raise BotoClientError(
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	499 '"size" param not supported for resumable uploads.')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	500 headers = headers or {}
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	501 if policy:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	502 headers[provider.acl_header] = policy
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	503
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	504 if rewind:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	505 # caller requests reading from beginning of fp.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	506 fp.seek(0, os.SEEK_SET)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	507 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	508 # The following seek/tell/seek logic is intended
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	509 # to detect applications using the older interface to
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	510 # set_contents_from_file(), which automatically rewound the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	511 # file each time the Key was reused. This changed with commit
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	512 # 14ee2d03f4665fe20d19a85286f78d39d924237e, to support uploads
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	513 # split into multiple parts and uploaded in parallel, and at
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	514 # the time of that commit this check was added because otherwise
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	515 # older programs would get a success status and upload an empty
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	516 # object. Unfortuantely, it's very inefficient for fp's implemented
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	517 # by KeyFile (used, for example, by gsutil when copying between
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	518 # providers). So, we skip the check for the KeyFile case.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	519 # TODO: At some point consider removing this seek/tell/seek
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	520 # logic, after enough time has passed that it's unlikely any
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	521 # programs remain that assume the older auto-rewind interface.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	522 if not isinstance(fp, KeyFile):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	523 spos = fp.tell()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	524 fp.seek(0, os.SEEK_END)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	525 if fp.tell() == spos:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	526 fp.seek(0, os.SEEK_SET)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	527 if fp.tell() != spos:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	528 # Raise an exception as this is likely a programming
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	529 # error whereby there is data before the fp but nothing
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	530 # after it.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	531 fp.seek(spos)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	532 raise AttributeError('fp is at EOF. Use rewind option '
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	533 'or seek() to data start.')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	534 # seek back to the correct position.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	535 fp.seek(spos)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	536
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	537 if hasattr(fp, 'name'):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	538 self.path = fp.name
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	539 if self.bucket is not None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	540 if isinstance(fp, KeyFile):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	541 # Avoid EOF seek for KeyFile case as it's very inefficient.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	542 key = fp.getkey()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	543 size = key.size - fp.tell()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	544 self.size = size
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	545 # At present both GCS and S3 use MD5 for the etag for
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	546 # non-multipart-uploaded objects. If the etag is 32 hex
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	547 # chars use it as an MD5, to avoid having to read the file
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	548 # twice while transferring.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	549 if (re.match('^"[a-fA-F0-9]{32}"$', key.etag)):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	550 etag = key.etag.strip('"')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	551 md5 = (etag, base64.b64encode(binascii.unhexlify(etag)))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	552 if size:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	553 self.size = size
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	554 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	555 # If md5 is provided, still need to size so
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	556 # calculate based on bytes to end of content
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	557 spos = fp.tell()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	558 fp.seek(0, os.SEEK_END)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	559 self.size = fp.tell() - spos
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	560 fp.seek(spos)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	561 size = self.size
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	562
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	563 if md5 is None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	564 md5 = self.compute_md5(fp, size)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	565 self.md5 = md5[0]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	566 self.base64md5 = md5[1]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	567
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	568 if self.name is None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	569 self.name = self.md5
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	570
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	571 if not replace:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	572 if self.bucket.lookup(self.name):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	573 return
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	574
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	575 if if_generation is not None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	576 headers['x-goog-if-generation-match'] = str(if_generation)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	577
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	578 if res_upload_handler:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	579 res_upload_handler.send_file(self, fp, headers, cb, num_cb)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	580 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	581 # Not a resumable transfer so use basic send_file mechanism.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	582 self.send_file(fp, headers, cb, num_cb, size=size)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	583
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	584 def set_contents_from_filename(self, filename, headers=None, replace=True,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	585 cb=None, num_cb=10, policy=None, md5=None,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	586 reduced_redundancy=None,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	587 res_upload_handler=None,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	588 if_generation=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	589 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	590 Store an object in GS using the name of the Key object as the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	591 key in GS and the contents of the file named by 'filename'.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	592 See set_contents_from_file method for details about the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	593 parameters.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	594
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	595 :type filename: string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	596 :param filename: The name of the file that you want to put onto GS.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	597
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	598 :type headers: dict
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	599 :param headers: (optional) Additional headers to pass along with the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	600 request to GS.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	601
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	602 :type replace: bool
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	603 :param replace: (optional) If True, replaces the contents of the file
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	604 if it already exists.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	605
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	606 :type cb: function
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	607 :param cb: (optional) Callback function that will be called to report
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	608 progress on the upload. The callback should accept two integer
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	609 parameters, the first representing the number of bytes that have
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	610 been successfully transmitted to GS and the second representing the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	611 total number of bytes that need to be transmitted.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	612
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	613 :type num_cb: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	614 :param num_cb: (optional) If a callback is specified with the cb
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	615 parameter this parameter determines the granularity of the callback
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	616 by defining the maximum number of times the callback will be called
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	617 during the file transfer.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	618
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	619 :type policy: :py:attribute:`boto.gs.acl.CannedACLStrings`
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	620 :param policy: (optional) A canned ACL policy that will be applied to
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	621 the new key in GS.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	622
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	623 :type md5: tuple
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	624 :param md5: (optional) A tuple containing the hexdigest version of the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	625 MD5 checksum of the file as the first element and the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	626 Base64-encoded version of the plain checksum as the second element.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	627 This is the same format returned by the compute_md5 method.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	628
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	629 If you need to compute the MD5 for any reason prior to upload, it's
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	630 silly to have to do it twice so this param, if present, will be
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	631 used as the MD5 values of the file. Otherwise, the checksum will be
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	632 computed.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	633
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	634 :type res_upload_handler: :py:class:`boto.gs.resumable_upload_handler.ResumableUploadHandler`
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	635 :param res_upload_handler: (optional) If provided, this handler will
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	636 perform the upload.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	637
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	638 :type if_generation: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	639 :param if_generation: (optional) If set to a generation number, the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	640 object will only be written to if its current generation number is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	641 this value. If set to the value 0, the object will only be written
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	642 if it doesn't already exist.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	643 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	644 # Clear out any previously computed hashes, since we are setting the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	645 # content.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	646 self.local_hashes = {}
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	647
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	648 with open(filename, 'rb') as fp:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	649 self.set_contents_from_file(fp, headers, replace, cb, num_cb,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	650 policy, md5, res_upload_handler,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	651 if_generation=if_generation)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	652
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	653 def set_contents_from_string(self, s, headers=None, replace=True,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	654 cb=None, num_cb=10, policy=None, md5=None,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	655 if_generation=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	656 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	657 Store an object in GCS using the name of the Key object as the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	658 key in GCS and the string 's' as the contents.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	659 See set_contents_from_file method for details about the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	660 parameters.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	661
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	662 :type headers: dict
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	663 :param headers: Additional headers to pass along with the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	664 request to AWS.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	665
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	666 :type replace: bool
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	667 :param replace: If True, replaces the contents of the file if
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	668 it already exists.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	669
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	670 :type cb: function
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	671 :param cb: a callback function that will be called to report
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	672 progress on the upload. The callback should accept
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	673 two integer parameters, the first representing the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	674 number of bytes that have been successfully
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	675 transmitted to GCS and the second representing the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	676 size of the to be transmitted object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	677
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	678 :type cb: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	679 :param num_cb: (optional) If a callback is specified with
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	680 the cb parameter this parameter determines the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	681 granularity of the callback by defining
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	682 the maximum number of times the callback will
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	683 be called during the file transfer.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	684
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	685 :type policy: :class:`boto.gs.acl.CannedACLStrings`
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	686 :param policy: A canned ACL policy that will be applied to the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	687 new key in GCS.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	688
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	689 :type md5: A tuple containing the hexdigest version of the MD5
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	690 checksum of the file as the first element and the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	691 Base64-encoded version of the plain checksum as the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	692 second element. This is the same format returned by
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	693 the compute_md5 method.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	694 :param md5: If you need to compute the MD5 for any reason prior
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	695 to upload, it's silly to have to do it twice so this
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	696 param, if present, will be used as the MD5 values
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	697 of the file. Otherwise, the checksum will be computed.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	698
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	699 :type if_generation: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	700 :param if_generation: (optional) If set to a generation number, the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	701 object will only be written to if its current generation number is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	702 this value. If set to the value 0, the object will only be written
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	703 if it doesn't already exist.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	704 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	705
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	706 # Clear out any previously computed md5 hashes, since we are setting the content.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	707 self.md5 = None
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	708 self.base64md5 = None
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	709
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	710 fp = StringIO(get_utf8_value(s))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	711 r = self.set_contents_from_file(fp, headers, replace, cb, num_cb,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	712 policy, md5,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	713 if_generation=if_generation)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	714 fp.close()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	715 return r
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	716
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	717 def set_contents_from_stream(self, args, *kwargs):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	718 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	719 Store an object using the name of the Key object as the key in
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	720 cloud and the contents of the data stream pointed to by 'fp' as
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	721 the contents.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	722
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	723 The stream object is not seekable and total size is not known.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	724 This has the implication that we can't specify the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	725 Content-Size and Content-MD5 in the header. So for huge
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	726 uploads, the delay in calculating MD5 is avoided but with a
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	727 penalty of inability to verify the integrity of the uploaded
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	728 data.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	729
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	730 :type fp: file
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	731 :param fp: the file whose contents are to be uploaded
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	732
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	733 :type headers: dict
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	734 :param headers: additional HTTP headers to be sent with the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	735 PUT request.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	736
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	737 :type replace: bool
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	738 :param replace: If this parameter is False, the method will first check
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	739 to see if an object exists in the bucket with the same key. If it
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	740 does, it won't overwrite it. The default value is True which will
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	741 overwrite the object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	742
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	743 :type cb: function
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	744 :param cb: a callback function that will be called to report
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	745 progress on the upload. The callback should accept two integer
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	746 parameters, the first representing the number of bytes that have
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	747 been successfully transmitted to GS and the second representing the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	748 total number of bytes that need to be transmitted.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	749
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	750 :type num_cb: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	751 :param num_cb: (optional) If a callback is specified with the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	752 cb parameter, this parameter determines the granularity of
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	753 the callback by defining the maximum number of times the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	754 callback will be called during the file transfer.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	755
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	756 :type policy: :class:`boto.gs.acl.CannedACLStrings`
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	757 :param policy: A canned ACL policy that will be applied to the new key
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	758 in GS.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	759
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	760 :type size: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	761 :param size: (optional) The Maximum number of bytes to read from
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	762 the file pointer (fp). This is useful when uploading a
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	763 file in multiple parts where you are splitting the file up
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	764 into different ranges to be uploaded. If not specified,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	765 the default behaviour is to read all bytes from the file
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	766 pointer. Less bytes may be available.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	767
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	768 :type if_generation: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	769 :param if_generation: (optional) If set to a generation number, the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	770 object will only be written to if its current generation number is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	771 this value. If set to the value 0, the object will only be written
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	772 if it doesn't already exist.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	773 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	774 if_generation = kwargs.pop('if_generation', None)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	775 if if_generation is not None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	776 headers = kwargs.get('headers', {})
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	777 headers['x-goog-if-generation-match'] = str(if_generation)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	778 kwargs['headers'] = headers
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	779 super(Key, self).set_contents_from_stream(args, *kwargs)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	780
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	781 def set_acl(self, acl_or_str, headers=None, generation=None,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	782 if_generation=None, if_metageneration=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	783 """Sets the ACL for this object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	784
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	785 :type acl_or_str: string or :class:`boto.gs.acl.ACL`
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	786 :param acl_or_str: A canned ACL string (see
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	787 :data:`~.gs.acl.CannedACLStrings`) or an ACL object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	788
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	789 :type headers: dict
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	790 :param headers: Additional headers to set during the request.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	791
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	792 :type generation: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	793 :param generation: If specified, sets the ACL for a specific generation
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	794 of a versioned object. If not specified, the current version is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	795 modified.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	796
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	797 :type if_generation: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	798 :param if_generation: (optional) If set to a generation number, the acl
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	799 will only be updated if its current generation number is this value.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	800
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	801 :type if_metageneration: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	802 :param if_metageneration: (optional) If set to a metageneration number,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	803 the acl will only be updated if its current metageneration number is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	804 this value.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	805 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	806 if self.bucket is not None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	807 self.bucket.set_acl(acl_or_str, self.name, headers=headers,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	808 generation=generation,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	809 if_generation=if_generation,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	810 if_metageneration=if_metageneration)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	811
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	812 def get_acl(self, headers=None, generation=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	813 """Returns the ACL of this object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	814
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	815 :param dict headers: Additional headers to set during the request.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	816
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	817 :param int generation: If specified, gets the ACL for a specific
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	818 generation of a versioned object. If not specified, the current
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	819 version is returned.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	820
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	821 :rtype: :class:`.gs.acl.ACL`
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	822 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	823 if self.bucket is not None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	824 return self.bucket.get_acl(self.name, headers=headers,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	825 generation=generation)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	826
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	827 def get_xml_acl(self, headers=None, generation=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	828 """Returns the ACL string of this object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	829
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	830 :param dict headers: Additional headers to set during the request.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	831
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	832 :param int generation: If specified, gets the ACL for a specific
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	833 generation of a versioned object. If not specified, the current
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	834 version is returned.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	835
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	836 :rtype: str
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	837 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	838 if self.bucket is not None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	839 return self.bucket.get_xml_acl(self.name, headers=headers,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	840 generation=generation)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	841
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	842 def set_xml_acl(self, acl_str, headers=None, generation=None,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	843 if_generation=None, if_metageneration=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	844 """Sets this objects's ACL to an XML string.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	845
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	846 :type acl_str: string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	847 :param acl_str: A string containing the ACL XML.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	848
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	849 :type headers: dict
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	850 :param headers: Additional headers to set during the request.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	851
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	852 :type generation: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	853 :param generation: If specified, sets the ACL for a specific generation
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	854 of a versioned object. If not specified, the current version is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	855 modified.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	856
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	857 :type if_generation: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	858 :param if_generation: (optional) If set to a generation number, the acl
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	859 will only be updated if its current generation number is this value.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	860
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	861 :type if_metageneration: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	862 :param if_metageneration: (optional) If set to a metageneration number,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	863 the acl will only be updated if its current metageneration number is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	864 this value.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	865 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	866 if self.bucket is not None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	867 return self.bucket.set_xml_acl(acl_str, self.name, headers=headers,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	868 generation=generation,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	869 if_generation=if_generation,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	870 if_metageneration=if_metageneration)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	871
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	872 def set_canned_acl(self, acl_str, headers=None, generation=None,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	873 if_generation=None, if_metageneration=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	874 """Sets this objects's ACL using a predefined (canned) value.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	875
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	876 :type acl_str: string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	877 :param acl_str: A canned ACL string. See
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	878 :data:`~.gs.acl.CannedACLStrings`.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	879
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	880 :type headers: dict
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	881 :param headers: Additional headers to set during the request.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	882
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	883 :type generation: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	884 :param generation: If specified, sets the ACL for a specific generation
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	885 of a versioned object. If not specified, the current version is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	886 modified.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	887
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	888 :type if_generation: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	889 :param if_generation: (optional) If set to a generation number, the acl
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	890 will only be updated if its current generation number is this value.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	891
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	892 :type if_metageneration: int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	893 :param if_metageneration: (optional) If set to a metageneration number,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	894 the acl will only be updated if its current metageneration number is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	895 this value.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	896 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	897 if self.bucket is not None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	898 return self.bucket.set_canned_acl(
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	899 acl_str,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	900 self.name,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	901 headers=headers,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	902 generation=generation,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	903 if_generation=if_generation,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	904 if_metageneration=if_metageneration
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	905 )
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	906
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	907 def compose(self, components, content_type=None, headers=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	908 """Create a new object from a sequence of existing objects.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	909
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	910 The content of the object representing this Key will be the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	911 concatenation of the given object sequence. For more detail, visit
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	912
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	913 https://developers.google.com/storage/docs/composite-objects
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	914
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	915 :type components list of Keys
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	916 :param components List of gs.Keys representing the component objects
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	917
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	918 :type content_type (optional) string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	919 :param content_type Content type for the new composite object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	920 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	921 compose_req = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	922 for key in components:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	923 if key.bucket.name != self.bucket.name:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	924 raise BotoClientError(
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	925 'GCS does not support inter-bucket composing')
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	926
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	927 generation_tag = ''
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	928 if key.generation:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	929 generation_tag = ('<Generation>%s</Generation>'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	930 % str(key.generation))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	931 compose_req.append('<Component><Name>%s</Name>%s</Component>' %
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	932 (key.name, generation_tag))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	933 compose_req_xml = ('<ComposeRequest>%s</ComposeRequest>' %
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	934 ''.join(compose_req))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	935 headers = headers or {}
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	936 if content_type:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	937 headers['Content-Type'] = content_type
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	938 resp = self.bucket.connection.make_request(
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	939 'PUT', get_utf8_value(self.bucket.name), get_utf8_value(self.name),
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	940 headers=headers, query_args='compose',
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	941 data=get_utf8_value(compose_req_xml))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	942 if resp.status < 200 or resp.status > 299:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	943 raise self.bucket.connection.provider.storage_response_error(
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	944 resp.status, resp.reason, resp.read())
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	945
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	946 # Return the generation so that the result URI can be built with this
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	947 # for automatic parallel uploads.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	948 return resp.getheader('x-goog-generation')

Mercurial > repos > guerler > springsuite

annotate planemo/lib/python3.7/site-packages/boto/gs/key.py @ 1:56ad4e20f292 draft