a !fx@sdZddlZddlZddlmZddlmZddlmZddl m Z ddl m Z ddl m Z dd l mZdd lmZGd d d eZGd dde ZdS)z.Create / interact with gcloud storage buckets.N)_rfc3339_to_datetime)NotFound)Iterator)_PropertyMixin)_scalar_property) BucketACL)DefaultObjectACLBlobcs*eZdZdZdfdd ZddZZS) _BlobIteratoraBAn iterator listing blobs in a bucket You shouldn't have to use this directly, but instead should use the :class:`gcloud.storage.blob.Bucket.list_blobs` method. :type bucket: :class:`gcloud.storage.bucket.Bucket` :param bucket: The bucket from which to list blobs. :type extra_params: dict or None :param extra_params: Extra query string parameters for the API call. :type client: :class:`gcloud.storage.client.Client` :param client: Optional. The client to use for making connections. Defaults to the bucket's client. NcsB|dur|j}||_t|_d|_tt|j||jd|ddS)Nz/o)clientpath extra_params) r bucketsetprefixes_current_prefixessuperr __init__r )selfrrr  __class__V/var/www/html/python-backend/venv/lib/python3.9/site-packages/gcloud/storage/bucket.pyr/s  z_BlobIterator.__init__ccs^t|dd|_|j|j|dgD],}|d}t||jd}|||Vq,dS)zYield :class:`.storage.blob.Blob` items from response. :type response: dict :param response: The JSON API response for a page of blobs. rritemsname)rN)tuplegetrrupdater r_set_properties)rresponseitemrblobrrrget_items_from_response9s  z%_BlobIterator.get_items_from_response)NN)__name__ __module__ __qualname____doc__rr# __classcell__rrrrr s r cseZdZdZeZdZdZdQfdd ZddZ e d d Z dRd d Z dSd dZ dTddZe ddZe ddZeddZe ddZdUddZdVddZdWdd ZdXd!d"ZdYd#d$ZdZd%d&Zd[d'd(Ze d)d*Zejd+d*Ze d,d-Ze d.d/Ze d0d1Zejd2d1Ze d3Z!d4d5Z"d\d7d8Z#d9d:Z$e d;d<Z%e d=d>Z&e d?d@Z'e dAdBZ(e dCdDZ)e)jdEdDZ)e dFdGZ*e dHdIZ+e+jdJdIZ+d]dKdLZ,dMdNZ-d^dOdPZ.Z/S)_Bucketa:A class representing a Bucket on Cloud Storage. :type client: :class:`gcloud.storage.client.Client` :param client: A client which holds credentials and project configuration for the bucket (which requires a project). :type name: string :param name: The name of the bucket. )STANDARDZNEARLINEZDURABLE_REDUCED_AVAILABILITYNcs0tt|j|d||_t||_t||_dS)Nr)rr)r_clientr_aclr_default_object_acl)rr rrrrr\s zBucket.__init__cCs d|jS)Nz r,rrrr__repr__bszBucket.__repr__cCs|jS)z The client bound to this bucket.)r-r0rrrr esz Bucket.clientcCst|||dS)a]Factory constructor for blob object. .. note:: This will not make an HTTP request; it simply instantiates a blob object owned by this bucket. :type blob_name: string :param blob_name: The name of the blob to be instantiated. :type chunk_size: integer :param chunk_size: The size of a chunk of data whenever iterating (1 MB). This must be a multiple of 256 KB per the API specification. :rtype: :class:`gcloud.storage.blob.Blob` :returns: The blob object created. )rr chunk_sizer )r blob_namer2rrrr"jsz Bucket.blobcCsH||}z$ddi}|jjd|j|ddWdStyBYdS0dS)apDetermines whether or not this bucket exists. :type client: :class:`gcloud.storage.client.Client` or ``NoneType`` :param client: Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :rtype: boolean :returns: True if the bucket exists in Cloud Storage. fieldsrGETN)methodr query_params_target_objectTF)_require_client connection api_requestr r)rr r7rrrexists~s   z Bucket.existscsZ|}d|ji}tfddjD}j|d<|jjdd||d}|dS) aCreates current bucket. If the bucket already exists, will raise :class:`gcloud.exceptions.Conflict`. This implements "storage.buckets.insert". :type client: :class:`gcloud.storage.client.Client` or ``NoneType`` :param client: Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket. projectc3s|]}|j|fVqdSN) _properties).0keyr0rr sz Bucket.create..rPOSTz/b)r6r r7datar8N)r9r=dictZ_changesrr:r;r)rr r7 propertiesZ api_responserr0rcreates    z Bucket.createcCs|jS)zCreate our ACL on demand.)r.r0rrraclsz Bucket.aclcCs|jS)z&Create our defaultObjectACL on demand.)r/r0rrrdefault_object_aclszBucket.default_object_aclcCsd|S)zRelative URL path for a bucket. :type bucket_name: string :param bucket_name: The bucket name in the path. :rtype: string :returns: The relative URL path for ``bucket_name``. z/b/r) bucket_namerrr path_helpers zBucket.path_helpercCs|jstd||jS)zThe URL path to this bucket.z*Cannot determine path without bucket name.)r ValueErrorrKr0rrrr sz Bucket.pathcCsT||}t||d}z$|jjd|j|d}|||WStyNYdS0dS)aSGet a blob object by name. This will return None if the blob doesn't exist:: >>> from gcloud import storage >>> client = storage.Client() >>> bucket = client.get_bucket('my-bucket') >>> print bucket.get_blob('/path/to/blob.txt') >>> print bucket.get_blob('/does-not-exist.txt') None :type blob_name: string :param blob_name: The name of the blob to retrieve. :type client: :class:`gcloud.storage.client.Client` or ``NoneType`` :param client: Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :rtype: :class:`gcloud.storage.blob.Blob` or None :returns: The blob object if it exists, otherwise None. rrr5r6r r8N)r9r r:r;r rr)rr3r r"r rrrget_blobs    zBucket.get_blobnoAclc Cs~i} |dur|| d<|dur$|| d<|dur4|| d<|durD|| d<|| d<|dur\|| d<|j|| |d} |durz|| _| S) aReturn an iterator used to find blobs in the bucket. :type max_results: integer or ``NoneType`` :param max_results: maximum number of blobs to return. :type page_token: string :param page_token: opaque marker for the next "page" of blobs. If not passed, will return the first page of blobs. :type prefix: string or ``NoneType`` :param prefix: optional prefix used to filter blobs. :type delimiter: string or ``NoneType`` :param delimiter: optional delimter, used with ``prefix`` to emulate hierarchy. :type versions: boolean or ``NoneType`` :param versions: whether object versions should be returned as separate blobs. :type projection: string or ``NoneType`` :param projection: If used, must be 'full' or 'noAcl'. Defaults to 'noAcl'. Specifies the set of properties to return. :type fields: string or ``NoneType`` :param fields: Selector specifying which fields to include in a partial response. Must be a list of fields. For example to get a partial response with just the next page token and the language of each blob returned: 'items/contentLanguage,nextPageToken' :type client: :class:`gcloud.storage.client.Client` or ``NoneType`` :param client: Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :rtype: :class:`_BlobIterator`. :returns: An iterator of blobs. NZ maxResultsprefix delimiterversions projectionr4)rr )_iterator_classZnext_page_token) r max_resultsZ page_tokenrQrRrSrTr4r rresultrrr list_blobss$)zBucket.list_blobsFcCst||}|r\t|j|jd|d}t||jkrHd|jf}t||j|dd|d|jjd|j dd dS) aDelete this bucket. The bucket **must** be empty in order to submit a delete request. If ``force=True`` is passed, this will first attempt to delete all the objects / blobs in the bucket (i.e. try to empty the bucket). If the bucket doesn't exist, this will raise :class:`gcloud.exceptions.NotFound`. If the bucket is not empty (and ``force=False``), will raise :class:`gcloud.exceptions.Conflict`. If ``force=True`` and the bucket contains more than 256 objects / blobs this will cowardly refuse to delete the objects (or the bucket). This is to prevent accidental bucket deletion and to prevent extremely long runtime of this method. :type force: boolean :param force: If True, empties the bucket's objects then deletes it. :type client: :class:`gcloud.storage.client.Client` or ``NoneType`` :param client: Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :raises: :class:`ValueError` if ``force`` is ``True`` and the bucket contains more than 256 objects / blobs. )rVr zRefusing to delete bucket with more than %d objects. If you actually want to delete this bucket, please delete the objects yourself before calling Bucket.delete().cSsdSr>r)r"rrr_zBucket.delete..)on_errorr DELETENrN) r9listrX_MAX_OBJECTS_FOR_ITERATIONlenrL delete_blobsr:r;r )rforcer blobsmessagerrrdelete6s"   z Bucket.deletecCs.||}t|j|}|jjd|dddS)aDeletes a blob from the current bucket. If the blob isn't found (backend 404), raises a :class:`gcloud.exceptions.NotFound`. For example:: >>> from gcloud.exceptions import NotFound >>> from gcloud import storage >>> client = storage.Client() >>> bucket = client.get_bucket('my-bucket') >>> print bucket.list_blobs() [] >>> bucket.delete_blob('my-file.txt') >>> try: ... bucket.delete_blob('doesnt-exist') ... except NotFound: ... pass :type blob_name: string :param blob_name: A blob name to delete. :type client: :class:`gcloud.storage.client.Client` or ``NoneType`` :param client: Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :raises: :class:`gcloud.exceptions.NotFound` (to suppress the exception, call ``delete_blobs``, passing a no-op ``on_error`` callback, e.g.:: >>> bucket.delete_blobs([blob], on_error=lambda blob: None) r]NrN)r9r rKr r:r;)rr3r Z blob_pathrrr delete_blobhs !  zBucket.delete_blobc Cs^|D]T}z(|}t|tjs |j}|j||dWqtyV|durP||nYq0qdS)aXDeletes a list of blobs from the current bucket. Uses :func:`Bucket.delete_blob` to delete each individual blob. :type blobs: list of string or :class:`gcloud.storage.blob.Blob` :param blobs: A list of blob names or Blob objects to delete. :type on_error: a callable taking (blob) :param on_error: If not ``None``, called once for each blob raising :class:`gcloud.exceptions.NotFound`; otherwise, the exception is propagated. :type client: :class:`gcloud.storage.client.Client` or ``NoneType`` :param client: Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :raises: :class:`gcloud.exceptions.NotFound` (if `on_error` is not passed). r N) isinstancesix string_typesrrfr)rrcr\r r"r3rrrras   zBucket.delete_blobscCsT||}|dur|j}t||d}|jd|j}|jjd||d}|||S)a Copy the given blob to the given bucket, optionally with a new name. :type blob: :class:`gcloud.storage.blob.Blob` :param blob: The blob to be copied. :type destination_bucket: :class:`gcloud.storage.bucket.Bucket` :param destination_bucket: The bucket into which the blob should be copied. :type new_name: string :param new_name: (optional) the new name for the copied file. :type client: :class:`gcloud.storage.client.Client` or ``NoneType`` :param client: Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :rtype: :class:`gcloud.storage.blob.Blob` :returns: The new Blob. NrMz/copyTorCrN)r9rr r r:r;r)rr"Zdestination_bucketnew_namer new_blobZapi_pathZ copy_resultrrr copy_blobs   zBucket.copy_blobcCs"|j||||d}|j|d|S)axRename the given blob using copy and delete operations. Effectively, copies blob to the same bucket with a new name, then deletes the blob. .. warning:: This method will first duplicate the data and then delete the old blob. This means that with very large objects renaming could be a very (temporarily) costly or a very slow operation. :type blob: :class:`gcloud.storage.blob.Blob` :param blob: The blob to be renamed. :type new_name: string :param new_name: The new name for this blob. :type client: :class:`gcloud.storage.client.Client` or ``NoneType`` :param client: Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :rtype: :class:`Blob` :returns: The newly-renamed blob. rg)rmre)rr"rkr rlrrr rename_blobs zBucket.rename_blobcCsdd|jddDS)aRetrieve CORS policies configured for this bucket. See: http://www.w3.org/TR/cors/ and https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: list of dictionaries :returns: A sequence of mappings describing each CORS policy. cSsg|]}t|qSrcopydeepcopy)r@policyrrr szBucket.cors..corsrr?rr0rrrrts  z Bucket.corscCs|d|dS)a#Set CORS policies configured for this bucket. See: http://www.w3.org/TR/cors/ and https://cloud.google.com/storage/docs/json_api/v1/buckets :type entries: list of dictionaries :param entries: A sequence of mappings describing each CORS policy. rtN_patch_property)rentriesrrrrts cCs |jdS)a?Retrieve the ETag for the bucket. See: http://tools.ietf.org/html/rfc2616#section-3.11 and https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: string or ``NoneType`` :returns: The bucket etag or ``None`` if the property is not set locally. etagrur0rrrrys z Bucket.etagcCs |jdS)aRetrieve the ID for the bucket. See: https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: string or ``NoneType`` :returns: The ID of the bucket or ``None`` if the property is not set locally. idrur0rrrrzs z Bucket.idcCs$|jdi}dd|ddDS)a"Lifecycle rules configured for this bucket. See: https://cloud.google.com/storage/docs/lifecycle and https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: list(dict) :returns: A sequence of mappings describing each lifecycle rule. lifecyclecSsg|]}t|qSrro)r@rulerrrrs*r[z*Bucket.lifecycle_rules..r|rrurinforrrlifecycle_ruless zBucket.lifecycle_rulescCs|dd|idS)Nr{r|rv)rrulesrrrr,slocationcCs|jd}t|S)a#Return info about access logging for this bucket. See: https://cloud.google.com/storage/docs/accesslogs#status :rtype: dict or None :returns: a dict w/ keys, ``logBucket`` and ``logObjectPrefix`` (if logging is enabled), or None (if not). logging)r?rrprqr}rrr get_logging;s zBucket.get_loggingcCs||d}|d|dS)aFEnable access logging for this bucket. See: https://cloud.google.com/storage/docs/accesslogs#delivery :type bucket_name: string :param bucket_name: name of bucket in which to store access logs :type object_prefix: string :param object_prefix: prefix for access log filenames )Z logBucketZlogObjectPrefixrNrv)rrJZ object_prefixr~rrrenable_loggingGs zBucket.enable_loggingcCs|dddS)zyDisable access logging for this bucket. See: https://cloud.google.com/storage/docs/accesslogs#disabling rNrvr0rrrdisable_loggingUszBucket.disable_loggingcCs |jd}|durt|SdS)aRetrieve the metageneration for the bucket. See: https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: integer or ``NoneType`` :returns: The metageneration of the bucket or ``None`` if the property is not set locally. metagenerationNr?rint)rrrrrr\s zBucket.metagenerationcCst|jdS)aRetrieve info about the owner of the bucket. See: https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: dict or ``NoneType`` :returns: Mapping of owner's role/ID. If the property is not set locally, returns ``None``. owner)rprqr?rr0rrrrjs z Bucket.ownercCs |jd}|durt|SdS)a9Retrieve the number of the project to which the bucket is assigned. See: https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: integer or ``NoneType`` :returns: The project number that owns the bucket or ``None`` if the property is not set locally. Z projectNumberNr)rproject_numberrrrrvs zBucket.project_numbercCs |jdS)a Retrieve the URI for the bucket. See: https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: string or ``NoneType`` :returns: The self link for the bucket or ``None`` if the property is not set locally. ZselfLinkrur0rrr self_links zBucket.self_linkcCs |jdS)aRetrieve the storage class for the bucket. See: https://cloud.google.com/storage/docs/storage-classes https://cloud.google.com/storage/docs/nearline-storage https://cloud.google.com/storage/docs/durable-reduced-availability :rtype: string or ``NoneType`` :returns: If set, one of "STANDARD", "NEARLINE", or "DURABLE_REDUCED_AVAILABILITY", else ``None``. storageClassrur0rrr storage_classs zBucket.storage_classcCs(||jvrtd|f|d|dS)aSet the storage class for the bucket. See: https://cloud.google.com/storage/docs/storage-classes https://cloud.google.com/storage/docs/nearline-storage https://cloud.google.com/storage/docs/durable-reduced-availability :type value: string :param value: one of "STANDARD", "NEARLINE", or "DURABLE_REDUCED_AVAILABILITY" zInvalid storage class: %srN)_STORAGE_CLASSESrLrwrvaluerrrrs cCs |jd}|durt|SdS)aMRetrieve the timestamp at which the bucket was created. See: https://cloud.google.com/storage/docs/json_api/v1/buckets :rtype: :class:`datetime.datetime` or ``NoneType`` :returns: Datetime object parsed from RFC3339 valid timestamp, or ``None`` if the property is not set locally. Z timeCreatedN)r?rrrrrr time_createds zBucket.time_createdcCs|jdi}|ddS)zIs versioning enabled for this bucket? See: https://cloud.google.com/storage/docs/object-versioning for details. :rtype: boolean :returns: True if enabled, else False. versioningenabledFru)rrrrrversioning_enableds zBucket.versioning_enabledcCs|ddt|idS)zEnable versioning for this bucket. See: https://cloud.google.com/storage/docs/object-versioning for details. :type value: convertible to boolean :param value: should versioning be anabled for the bucket? rrN)rwboolrrrrrs cCs||d}|d|dS)aConfigure website-related properties. See: https://developers.google.com/storage/docs/website-configuration .. note:: This (apparently) only works if your bucket name is a domain name (and to do that, you need to get approved somehow...). If you want this bucket to host a website, just provide the name of an index page and a page to use when a blob isn't found:: >>> from gcloud import storage >>> client = storage.Client() >>> bucket = client.get_bucket(bucket_name) >>> bucket.configure_website('index.html', '404.html') You probably should also make the whole bucket public:: >>> bucket.make_public(recursive=True, future=True) This says: "Make the bucket public, and all the stuff already in the bucket, and anything else I add to the bucket. Just make it all public." :type main_page_suffix: string :param main_page_suffix: The page to use as the main page of a directory. Typically something like index.html. :type not_found_page: string :param not_found_page: The file to use when a page isn't found. )ZmainPageSuffixZ notFoundPageZwebsiteNrv)rZmain_page_suffixZnot_found_pagerDrrrconfigure_websites#zBucket.configure_websitecCs |ddS)zDisable the website configuration for this bucket. This is really just a shortcut for setting the website-related attributes to ``None``. N)rr0rrrdisable_websiteszBucket.disable_websitecCs|j|jj|d|rP|j}|js8|j|d||j|d|rt|jd|j d|d}t ||j krd|j f}t ||D] }|j|jj|dqdS)aMake a bucket public. If ``recursive=True`` and the bucket contains more than 256 objects / blobs this will cowardly refuse to make the objects public. This is to prevent extremely long runtime of this method. :type recursive: boolean :param recursive: If True, this will make all blobs inside the bucket public as well. :type future: boolean :param future: If True, this will make all objects created in the future public as well. :type client: :class:`gcloud.storage.client.Client` or ``NoneType`` :param client: Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket. rgfullrY)rTrVr zRefusing to make public recursively with more than %d objects. If you actually want to make every object in this bucket public, please do it on the objects yourself.N) rHallZ grant_readsaverIZloadedreloadr^rXr_r`rL)r recursivefuturer Zdoarcrdr"rrr make_publics,   zBucket.make_public)N)N)N)N)N)NNNNNrPNN)FN)N)NN)NN)N)r)NN)FFN)0r$r%r&r'r rUr_rrr1propertyr r"r<rGrHrI staticmethodrKr rOrXrerfrarmrnrtsetterryrzrrrrrrrrrrrrrrrrr(rrrrr)Hs          % D 2 )                    (r))r'rpriZgcloud._helpersrZgcloud.exceptionsrZgcloud.iteratorrZgcloud.storage._helpersrrZgcloud.storage.aclrrZgcloud.storage.blobr r r)rrrrs        )