Roll version of gsutil to 4.15.

third_party/gsutil/gslib/cloud_api.py

 # -*- coding: utf-8 -*-
 # Copyright 2013 Google Inc. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
 #     http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Gsutil API for interacting with cloud storage providers."""
 
 from __future__ import absolute_import
 
 
 class CloudApi(object):
   """Abstract base class for interacting with cloud storage providers.
 
   Implementations of the gsutil Cloud API are not guaranteed to be thread-safe.
   Behavior when calling a gsutil Cloud API instance simultaneously across
   threads is undefined and doing so will likely cause errors. Therefore,
   a separate instance of the gsutil Cloud API should be instantiated per-thread.
   """
 
-  def __init__(self, bucket_storage_uri_class, logger, provider=None, debug=0):
+  def __init__(self, bucket_storage_uri_class, logger, provider=None,
+               debug=0, trace_token=None):
     """Performs necessary setup for interacting with the cloud storage provider.
 
     Args:
       bucket_storage_uri_class: boto storage_uri class, used by APIs that
                                 provide boto translation or mocking.
       logger: logging.logger for outputting log messages.
       provider: Default provider prefix describing cloud storage provider to
                 connect to.
       debug: Debug level for the API implementation (0..3).
+      trace_token: Google internal trace token to pass to the API
+                   implementation (string).
     """
     self.bucket_storage_uri_class = bucket_storage_uri_class
     self.logger = logger
     self.provider = provider
     self.debug = debug
+    self.trace_token = trace_token
 
   def GetBucket(self, bucket_name, provider=None, fields=None):
     """Gets Bucket metadata.
 
     Args:
       bucket_name: Name of the bucket.
       provider: Cloud storage provider to connect to.  If not present,
                 class-wide default is used.
       fields: If present, return only these Bucket metadata fields, for
               example, ['logging', 'defaultObjectAcl']
@@ skipping 208 matching lines @@
       object_name: Object name.
       download_stream: Stream to send the object data to.
       provider: Cloud storage provider to connect to.  If not present,
                 class-wide default is used.
       generation: Generation of the object to retrieve.
       object_size: Total size of the object being downloaded.
       download_strategy: Cloud API download strategy to use for download.
       start_byte: Starting point for download (for resumable downloads and
                   range requests). Can be set to negative to request a range
                   of bytes (python equivalent of [:-3])
-      end_byte: Ending point for download (for range requests).
+      end_byte: Ending byte number, inclusive, for download (for range
+                requests). If None, download the rest of the object.
       progress_callback: Optional callback function for progress notifications.
                          Receives calls with arguments
                          (bytes_transferred, total_size).
-      serialization_data: Implementation-specific dict containing serialization
-                          information for the download.
+      serialization_data: Implementation-specific JSON string of a dict
+                          containing serialization information for the download.
       digesters: Dict of {string : digester}, where string is a name of a hash
                  algorithm, and digester is a validation digester that supports
                  update(bytes) and digest() using that algorithm.
                  Implementation can set the digester value to None to indicate
                  bytes were not successfully digested on-the-fly.
 
     Raises:
       ArgumentException for errors during input validation.
       ServiceException for errors interacting with cloud storage providers.
 
@@ skipping 307 matching lines @@
 
 
 class PreconditionException(ServiceException):
   """Exception raised for precondition failures."""
 
 
 class NotFoundException(ServiceException):
   """Exception raised when a resource is not found (404)."""
 
 
+class BucketNotFoundException(NotFoundException):
+  """Exception raised when a bucket resource is not found (404)."""
+
+  def __init__(self, reason, bucket_name, status=None, body=None):
+    super(BucketNotFoundException, self).__init__(reason, status=status,
+                                                  body=body)
+    self.bucket_name = bucket_name
+
+
 class NotEmptyException(ServiceException):
   """Exception raised when trying to delete a bucket is not empty."""
 
 
 class BadRequestException(ServiceException):
   """Exception raised for malformed requests.
 
     Where it is possible to detect invalid arguments prior to sending them
     to the server, an ArgumentException should be raised instead.
   """
 
 
 class AccessDeniedException(ServiceException):
   """Exception raised  when authenticated user has insufficient access rights.
 
     This is raised when the authentication process succeeded but the
     authenticated user does not have access rights to the requested resource.
   """