o MfE @sdZddlZddlZddlZddlmZddlmZddlZddlZddl Z ddl Z ddl m Z ddl mZddl mZddl mZdd l mZdd l mZddlZdd lmZdd lmZdd lmZddlmZddlmZddlmZddlmZddlmZddlm Z ddl!m"Z"ddl!m#Z#ddl!m$Z$ddl!m%Z%ddl&m'Z'ddl(m)Z)ddl(m*Z*ddl(m+Z+ddl(m,Z,ddl(m-Z-ddl(m.Z.ddl(m/Z/dd l(m0Z0dd!l(m1Z1dd"l2m3Z3dd#l2m4Z4dd$l(m5Z5dd%l(m6Z6dd&l(m7Z7dd'l8m9Z9dd(l8m:Z:dd)l;mZ>dd,l;m?Z?dd-l;m@Z@dd.l;mAZAdd/l;mBZBdd0lCmDZDdd1lCmEZEdd2lCmFZFdd3lCmGZGdd4lCmHZHdd5lImJZJdd6lImKZKd7ZLd8ZMd9ZNeNd:ZOeNd;ZPdd?d@eQdAdBdCdDdEdFdGf ZRdHZSdIZTdJZUdKZVdLZWdMZXdNZYe ZdOZ[dPZ\dQZ]e^e_Z`GdRdSdSe+ZadTdUZbdddWdXZcdedZd[Zdddd\d]Zed^d_Zfd`daZgGdbdcdcehZidS)fz3Create / interact with Google Cloud Storage blobs. N)BytesIO) TextIOWrapper) HeaderParser) parse_qsl)quote) urlencode)urlsplit) urlunsplit)resumable_media)ChunkedDownload)Download) RawDownload)RawChunkedDownload)MultipartUpload)ResumableUpload)Policy) exceptions)_bytes_to_unicode)_datetime_to_rfc3339)_rfc3339_nanos_to_datetime) _to_bytes)NotFound)_add_etag_match_headers) _add_generation_match_parameters)_PropertyMixin)_scalar_property)_bucket_bound_hostname_url)_raise_if_more_than_one_set)(_api_core_retry_to_resumable_media_retry)_get_default_headers)_get_default_storage_base_url)generate_signed_url_v2)generate_signed_url_v4)_NUM_RETRIES_MESSAGE) _API_VERSION)_virtual_hosted_style_base_url)ACL) ObjectACL)_DEFAULT_TIMEOUT)ARCHIVE_STORAGE_CLASS)COLDLINE_STORAGE_CLASS)#MULTI_REGIONAL_LEGACY_STORAGE_CLASS)NEARLINE_STORAGE_CLASS)REGIONAL_LEGACY_STORAGE_CLASS)STANDARD_STORAGE_CLASS)ConditionalRetryPolicy) DEFAULT_RETRY)DEFAULT_RETRY_IF_ETAG_IN_JSON)%DEFAULT_RETRY_IF_GENERATION_SPECIFIED))DEFAULT_RETRY_IF_METAGENERATION_SPECIFIED) BlobReader) BlobWriterzapplication/octet-streamz9{hostname}/download/storage/{api_version}{path}?alt=mediazB{hostname}/upload/storage/{api_version}{bucket_path}/o?uploadType= multipart resumable contentType cacheControlcontentDispositioncontentEncodingcontentLanguagecrc32c customTimemd5Hashmetadataname retention storageClasszOSize {:d} was specified but the file-like object only had {:d} bytes remaining.znA checksum of type `{}` was requested, but checksumming is not available for downloads when chunk_size is set.z'if_generation_match: type list' is deprecated and supported for backwards-compatability reasons only. Use 'if_source_generation_match' instead' to match source objects' generations.zUse 'if_generation_match' to match the generation of the destination object by passing in a generation number, instead of a list. Use 'if_source_generation_match' to match source objects generations.z'if_metageneration_match: type list' is deprecated and supported for backwards-compatability reasons only. Note that the metageneration to be matched is that of the destination blob. Please pass in a single value (type long).zH'if_source_generation_match' length must be the same as 'sources' lengthzlBlob.download_as_string() is deprecated and will be removed in future. Use Blob.download_as_bytes() instead.zB(?Pgs)://(?P[a-z0-9_.-]+)/(?P.+)i@icseZdZdZdZdZ eeee e e fZ    dfdd Z eddZedd Zejd d Zed d Zejd d ZeddZeddZddZeddZeddZeddZddZeddZeddZedd d!Z   "             #  $dd%d&Zddddddde e!df d'd(Z"ddddde e#fd)d*Z$d+d,Z%    dd-d.Z&d/d0Z'ddd#e d1dfd2d3Z(dddd#dddddde d1e!f d4d5Z)d6d7Z*dddd#dddddde d1e!f d8d9Z+dddd#dddddde d1e!f d:d;Z,dddd#dddddde e!f dd?Z.dd@dAZ/dBdCZ0ddDdEZ1e dddfdFdGZ2ddddddde dddf dHdIZ3e dddfdJdKZ4e dddfdLdMZ5d#ddddddddde de#dfdNdOZ6d#ddddddddde de#f dPdQZ7ddRdSZ8dddddddde de#f dTdUZ9dVddddddde de#f dWdXZ:dddde dddddde#f dYdZZ;dde e!fd[d\Zde e!fd_d`Z?de dddde@fdadbZAde dddde@fdcddZBde ddde#fdedfZCdddddddddde e#f dgdhZDddddddddde e#f didjZE k     ddldmZFeGdnZH eGdoZI eGdpZJ eGdqZK eGeLZM eGdrZN dddd#dddddde d1e!dfdsdtZOedudvZPedwdxZQeGdyZR edzd{ZSed|d}ZTeGd~ZU eddZVeddZWeWjddZWeddZXeddZYeddZZeddZ[eddZ\eddZ]e]jddZ]eGdZ^ eGdZ_ eddZ`eddZaeddZbeddZcecjddZceddZdeddZeeddZfZgS)BlobaYA wrapper around Cloud Storage's concept of an ``Object``. :type name: str :param name: The name of the blob. This corresponds to the unique path of the object in the bucket. If bytes, will be converted to a unicode object. Blob / object names can contain any sequence of valid unicode characters, of length 1-1024 bytes when UTF-8 encoded. :type bucket: :class:`google.cloud.storage.bucket.Bucket` :param bucket: The bucket to which this blob belongs. :type chunk_size: int :param chunk_size: (Optional) The size of a chunk of data whenever iterating (in bytes). This must be a multiple of 256 KB per the API specification. If not specified, the chunk_size of the blob itself is used. If that is not specified, a default value of 40 MB is used. :type encryption_key: bytes :param encryption_key: (Optional) 32 byte encryption key for customer-supplied encryption. See https://cloud.google.com/storage/docs/encryption#customer-supplied. :type kms_key_name: str :param kms_key_name: (Optional) Resource name of Cloud KMS key used to encrypt the blob's contents. :type generation: long :param generation: (Optional) If present, selects a specific revision of this object. Nicsnt|}tt|j|d||_||_t||_t||d||_ |dur*||j d<|dur5||j d<dSdS)zH property :attr:`name` Get the blob's name. rA)encryption_key kms_key_nameN kmsKeyName generation) rsuperrD__init__ chunk_size_bucketr'_aclr_encryption_key _properties)selfrAbucketrLrFrGrI __class__[/var/www/html/analyze/labelStudio/lib/python3.10/site-packages/google/cloud/storage/blob.pyrKs   z Blob.__init__cC|jS)zBucket which contains the object. :rtype: :class:`~google.cloud.storage.bucket.Bucket` :returns: The object's bucket. )rMrQrUrUrVrRz Blob.bucketcCrW)zGet the blob's default chunk size. :rtype: int or ``NoneType`` :returns: The current blob's chunk size, if it is set. ) _chunk_sizerXrUrUrVrLrYzBlob.chunk_sizecCs8|dur|dkr||jdkrtd|jf||_dS)aSet the blob's default chunk size. :type value: int :param value: (Optional) The current blob's chunk size, if it is set. :raises: :class:`ValueError` if ``value`` is not ``None`` and is not a multiple of 256 KB. Nrz$Chunk size must be a multiple of %d.)_CHUNK_SIZE_MULTIPLE ValueErrorrZrQvaluerUrUrVrLs    cCrW)a#Retrieve the customer-supplied encryption key for the object. :rtype: bytes or ``NoneType`` :returns: The encryption key or ``None`` if no customer-supplied encryption key was used, or the blob's resource has not been loaded from the server. rOrXrUrUrVrFs zBlob.encryption_keycCs ||_dS)aSet the blob's encryption key. See https://cloud.google.com/storage/docs/encryption#customer-supplied To perform a key rotation for an encrypted blob, use :meth:`rewrite`. See https://cloud.google.com/storage/docs/encryption/using-customer-supplied-keys?hl=ca#rotating :type value: bytes :param value: 32 byte encryption key for customer-supplied encryption. Nr_r]rUrUrVrFs cCs|dt|S)aRelative URL path for a blob. :type bucket_path: str :param bucket_path: The URL path for a bucket. :type blob_name: str :param blob_name: The name of the blob. :rtype: str :returns: The relative URL path for ``blob_name``. z/o/)_quote) bucket_path blob_namerUrUrV path_helper(s zBlob.path_helpercCrW)zCreate our ACL on demand.)rNrXrUrUrVacl7szBlob.aclcCs0|jr|jj}nd}d|d|jd|jdS)Nz)rRrArI)rQ bucket_namerUrUrV__repr__<s z Blob.__repr__cCs |jstd||jj|jS)zyGetter property for the URL path to this Blob. :rtype: str :returns: The URL path to this Blob. z*Cannot determine path without a blob name.)rAr\rcrRpathrXrUrUrVrhDsz Blob.pathcC|jjS)zThe client bound to this blob.)rRclientrXrUrUrVrjPsz Blob.clientcCri)zzProject ID billed for API requests made via this blob. Derived from bucket's value. :rtype: str )rR user_projectrXrUrUrVrkUszBlob.user_projectcCs t|jS)zReturn any encryption headers needed to fetch the object. :rtype: List(Tuple(str, str)) :returns: a list of tuples to be passed as headers. )_get_encryption_headersrOrXrUrUrV_encryption_headers_s zBlob._encryption_headerscCs0i}|jdur |j|d<|jdur|j|d<|S)zDefault query parameters.NrI userProject)rIrk)rQparamsrUrUrV _query_paramsgs     zBlob._query_paramscCs4|jr|jj}nt}dj||jjt|jdddS)zThe public URL for this blob. Use :meth:`make_public` to enable anonymous access via the returned URL. :rtype: `string` :returns: The public URL for this blob. z.{storage_base_url}/{bucket_name}/{quoted_name}/~safe)storage_base_urlrf quoted_name)rj api_endpointr formatrRrAr`)rQendpointrUrUrV public_urlqs  zBlob.public_urlcCsDddlm}t|}|std|||dd}||d|S)aGet a constructor for blob object by URI. .. code-block:: python from google.cloud import storage from google.cloud.storage.blob import Blob client = storage.Client() blob = Blob.from_string("gs://bucket/object", client=client) :type uri: str :param uri: The blob uri following a gs://bucket/object pattern. Both a bucket and object name is required to construct a blob object. :type client: :class:`~google.cloud.storage.client.Client` :param client: (Optional) The client to use. Application code should *always* pass ``client``. :rtype: :class:`google.cloud.storage.blob.Blob` :returns: The blob object created. r)Bucketz&URI pattern must be gs://bucket/objectrfrE object_name)google.cloud.storage.bucketrz_GS_URL_REGEX_PATTERNmatchr\group)clsurirjrzr~rRrUrUrV from_strings  zBlob.from_stringGETFhttpcCs>| durd} n| dvrtd|dus|r|rtd|dur'|| } | j}t|jdd}|r=t||jj}d|}n|rJt||}d|}n d|jjd|}| dur`|| } | j} | dkrgt }nt }|j durt |j }| duryi} | dkrd }||| |<n| ||| |||||||||| | ||d S) aJGenerates a signed URL for this blob. .. note:: If you are on Google Compute Engine, you can't generate a signed URL using GCE service account. If you'd like to be able to generate a signed URL from GCE, you can use a standard service account from a JSON file rather than a GCE service account. If you have a blob that you want to allow access to for a set amount of time, you can use this method to generate a URL that is only valid within a certain time period. See a [code sample](https://cloud.google.com/storage/docs/samples/storage-generate-signed-url-v4#storage_generate_signed_url_v4-python). This is particularly useful if you don't want publicly accessible blobs, but don't want to require users to explicitly log in. If ``bucket_bound_hostname`` is set as an argument of :attr:`api_access_endpoint`, ``https`` works only if using a ``CDN``. :type expiration: Union[Integer, datetime.datetime, datetime.timedelta] :param expiration: Point in time when the signed URL should expire. If a ``datetime`` instance is passed without an explicit ``tzinfo`` set, it will be assumed to be ``UTC``. :type api_access_endpoint: str :param api_access_endpoint: (Optional) URI base, for instance "https://storage.googleapis.com". If not specified, the client's api_endpoint will be used. Incompatible with bucket_bound_hostname. :type method: str :param method: The HTTP verb that will be used when requesting the URL. :type content_md5: str :param content_md5: (Optional) The MD5 hash of the object referenced by ``resource``. :type content_type: str :param content_type: (Optional) The content type of the object referenced by ``resource``. :type response_disposition: str :param response_disposition: (Optional) Content disposition of responses to requests for the signed URL. For example, to enable the signed URL to initiate a file of ``blog.png``, use the value ``'attachment; filename=blob.png'``. :type response_type: str :param response_type: (Optional) Content type of responses to requests for the signed URL. Ignored if content_type is set on object/blob metadata. :type generation: str :param generation: (Optional) A value that indicates which generation of the resource to fetch. :type headers: dict :param headers: (Optional) Additional HTTP headers to be included as part of the signed URLs. See: https://cloud.google.com/storage/docs/xml-api/reference-headers Requests using the signed URL *must* pass the specified header (name and value) with each request for the URL. :type query_parameters: dict :param query_parameters: (Optional) Additional query parameters to be included as part of the signed URLs. See: https://cloud.google.com/storage/docs/xml-api/reference-headers#query :type client: :class:`~google.cloud.storage.client.Client` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the blob's bucket. :type credentials: :class:`google.auth.credentials.Credentials` :param credentials: (Optional) The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. :type version: str :param version: (Optional) The version of signed credential to create. Must be one of 'v2' | 'v4'. :type service_account_email: str :param service_account_email: (Optional) E-mail address of the service account. :type access_token: str :param access_token: (Optional) Access token for a service account. :type virtual_hosted_style: bool :param virtual_hosted_style: (Optional) If true, then construct the URL relative the bucket's virtual hostname, e.g., '.storage.googleapis.com'. Incompatible with bucket_bound_hostname. :type bucket_bound_hostname: str :param bucket_bound_hostname: (Optional) If passed, then construct the URL relative to the bucket-bound hostname. Value can be a bare or with scheme, e.g., 'example.com' or 'http://example.com'. Incompatible with api_access_endpoint and virtual_hosted_style. See: https://cloud.google.com/storage/docs/request-endpoints#cname :type scheme: str :param scheme: (Optional) If ``bucket_bound_hostname`` is passed as a bare hostname, use this value as the scheme. ``https`` will work only when using a CDN. Defaults to ``"http"``. :raises: :exc:`ValueError` when version is invalid or mutually exclusive arguments are used. :raises: :exc:`TypeError` when expiration is not a valid type. :raises: :exc:`AttributeError` if credentials is not an instance of :class:`google.auth.credentials.Signing`. :rtype: str :returns: A signed URL you can use to access the resource until expiration. Nv2)rv4z%'version' must be either 'v2' or 'v4'zmThe bucket_bound_hostname argument is not compatible with either api_access_endpoint or virtual_hosted_style.rqrr/zX-Goog-Encryption-Algorithm) resource expirationapi_access_endpointmethod content_md5 content_type response_typeresponse_dispositionrIheadersquery_parametersservice_account_email access_token)r\_require_clientrvr`rAr%rRr _credentialsr!r"rOrlupdateupper)rQrrrrrrrrIrrrj credentialsversionrrvirtual_hosted_stylebucket_bound_hostnameschemerurhelperencryption_headers v2_copy_onlyrUrUrVgenerate_signed_urlsp        zBlob.generate_signed_urlc Cs||}|j} d| d<| dur| | d<t| ||||di} t| ||dz|j|j| | || ddWd Sty?YdSw) aCDetermines whether or not this blob exists. If :attr:`user_project` is set on the bucket, bills the API request to that project. :type client: :class:`~google.cloud.storage.client.Client` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the blob's bucket. :type if_etag_match: Union[str, Set[str]] :param if_etag_match: (Optional) See :ref:`using-if-etag-match` :type if_etag_not_match: Union[str, Set[str]] :param if_etag_not_match: (Optional) See :ref:`using-if-etag-not-match` :type if_generation_match: long :param if_generation_match: (Optional) See :ref:`using-if-generation-match` :type if_generation_not_match: long :param if_generation_not_match: (Optional) See :ref:`using-if-generation-not-match` :type if_metageneration_match: long :param if_metageneration_match: (Optional) See :ref:`using-if-metageneration-match` :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) See :ref:`using-if-metageneration-not-match` :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :type soft_deleted: bool :param soft_deleted: (Optional) If True, looks for a soft-deleted object. Will only return True if the object exists and is in a soft-deleted state. :attr:`generation` is required to be set on the blob if ``soft_deleted`` is set to True. See: https://cloud.google.com/storage/docs/soft-delete :rtype: bool :returns: True if the blob exists in Cloud Storage. rAfieldsN softDeletedif_generation_matchif_generation_not_matchif_metageneration_matchif_metageneration_not_match if_etag_matchif_etag_not_match query_paramsrtimeoutretry_target_objectFT)rrprr _get_resourcerhr) rQrjrrrrrrrr soft_deletedrrrUrUrVexistss: B z Blob.existsc Cs&|jj|j||j||||||d dS)aDeletes a blob from Cloud Storage. If :attr:`user_project` is set on the bucket, bills the API request to that project. :type client: :class:`~google.cloud.storage.client.Client` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the blob's bucket. :type if_generation_match: long :param if_generation_match: (Optional) See :ref:`using-if-generation-match` :type if_generation_not_match: long :param if_generation_not_match: (Optional) See :ref:`using-if-generation-not-match` :type if_metageneration_match: long :param if_metageneration_match: (Optional) See :ref:`using-if-metageneration-match` :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) See :ref:`using-if-metageneration-not-match` :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :raises: :class:`google.cloud.exceptions.NotFound` (propagated from :meth:`google.cloud.storage.bucket.Bucket.delete_blob`). )rjrIrrrrrrN)rR delete_blobrArI)rQrjrrrrrrrUrUrVdeletes1 z Blob.deletecCs||}|jS)aReturn the client's transport. :type client: :class:`~google.cloud.storage.client.Client` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the blob's bucket. :rtype transport: :class:`~google.auth.transport.requests.AuthorizedSession` :returns: The transport (with credentials) that will make authenticated requests. )r_http)rQrjrUrUrV_get_transport(s zBlob._get_transportc Csg}|jdur%t|j}tj||jtd}|jdur$|d|jdfn|j}|j dur5|d|j ft |||||dt ||S)aGet the download URL for the current blob. If the ``media_link`` has been loaded, it will be used, otherwise the URL will be constructed from the current blob's path (and possibly generation) to avoid a round trip. :type client: :class:`~google.cloud.storage.client.Client` :param client: The client to use. :type if_generation_match: long :param if_generation_match: (Optional) See :ref:`using-if-generation-match` :type if_generation_not_match: long :param if_generation_not_match: (Optional) See :ref:`using-if-generation-not-match` :type if_metageneration_match: long :param if_metageneration_match: (Optional) See :ref:`using-if-metageneration-match` :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) See :ref:`using-if-metageneration-not-match` :rtype: str :returns: The download URL for the current blob. N)hostnamerh api_versionrIdrnr) media_link_get_host_name _connection_DOWNLOAD_URL_TEMPLATErwrhr$rIappendrkr_add_query_parameters) rQrjrrrrname_value_pairsrbase_urlrUrUrV_get_download_url8s($     zBlob._get_download_urlcCs|jdd|jd<|jdd|jt<|jdd|jd<|jdd|jd<|jd d|jd <|jd d|jd <|jd d|jd<|jdd|jd<|jdd}|ri}|dD]}td|}|rt|\}}|||<q`|dd|jd<|dd|jd<dSdS)a2Extract headers from a non-chunked request's http object. This avoids the need to make a second request for commonly used headers. :type response: :class requests.models.Response :param response: The server response from downloading a non-chunked file zContent-EncodingNr;z Content-Typez Cache-Controlr9zX-Goog-Storage-ClassrCzContent-Languager<ETagetagzX-goog-generationrIzX-goog-metagenerationmetagenerationz X-Goog-Hash,z (crc32c|md5)=([\w\d/\+/]+={0,3})r=md5r?)rgetrP_CONTENT_TYPE_FIELDsplitrer~groups)rQresponse x_goog_hashdigestsencoded_digestr~rdigestrUrUrV_extract_headers_from_downloadss<        z#Blob._extract_headers_from_downloadrc Cst| } |jdur+|rt} nt} | |||||| d} | | _| j||d}||dS| r7t| }t ||rr?NOrigin) r1rrrrr:rLrrr) rAr/rBrr;r[ resumable_urlr rKrL)rQrr/originrjrrr1rrrrrrr: fake_streamr3rrNrUrUrVcreate_resumable_upload_session! sB   z$Blob.create_resumable_upload_sessioncCsX||}i}|jdur|j|d<|dur||d<|j|jd|||dd}t|S)aRetrieve the IAM policy for the object. .. note:: Blob- / object-level IAM support does not yet exist and methods currently call an internal ACL backend not providing any utility beyond the blob's :attr:`acl` at this time. The API may be enhanced in the future and is currently undocumented. Use :attr:`acl` for managing object access control. If :attr:`user_project` is set on the bucket, bills the API request to that project. :type client: :class:`~google.cloud.storage.client.Client` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current object's bucket. :type requested_policy_version: int or ``NoneType`` :param requested_policy_version: (Optional) The version of IAM policies to request. If a policy with a condition is requested without setting this, the server will return an error. This must be set to a value of 3 to retrieve IAM policies containing conditions. This is to prevent client code that isn't aware of IAM conditions from interpreting and modifying policies incorrectly. The service might return a policy with version lower than the one that was requested, based on the feature syntax in the policy fetched. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :rtype: :class:`google.api_core.iam.Policy` :returns: the policy instance, based on the resource returned from the ``getIamPolicy`` API request. NrnoptionsRequestedPolicyVersion/iamrrrr)rrkrrhr from_api_repr)rQrjrequested_policy_versionrrrrrUrUrVget_iam_policy s 1    zBlob.get_iam_policyc Cs`||}i}|jdur|j|d<|jd}|}|j|d<|j|||||dd}t|S)aUpdate the IAM policy for the bucket. .. note:: Blob- / object-level IAM support does not yet exist and methods currently call an internal ACL backend not providing any utility beyond the blob's :attr:`acl` at this time. The API may be enhanced in the future and is currently undocumented. Use :attr:`acl` for managing object access control. If :attr:`user_project` is set on the bucket, bills the API request to that project. :type policy: :class:`google.api_core.iam.Policy` :param policy: policy instance used to update bucket's IAM policy. :type client: :class:`~google.cloud.storage.client.Client` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :rtype: :class:`google.api_core.iam.Policy` :returns: the policy instance, based on the resource returned from the ``setIamPolicy`` API request. Nrnr` resourceIdra)rrkrh to_api_repr _put_resourcerrb) rQpolicyrjrrrrhrrrUrUrVset_iam_policy s )     zBlob.set_iam_policycCsR||}d|i}|jdur|j|d<|jd}|j||||dd}|dgS)aNAPI call: test permissions .. note:: Blob- / object-level IAM support does not yet exist and methods currently call an internal ACL backend not providing any utility beyond the blob's :attr:`acl` at this time. The API may be enhanced in the future and is currently undocumented. Use :attr:`acl` for managing object access control. If :attr:`user_project` is set on the bucket, bills the API request to that project. :type permissions: list of string :param permissions: the permissions to check :type client: :class:`~google.cloud.storage.client.Client` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the current bucket. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` :rtype: list of string :returns: the permissions returned by the ``testIamPermissions`` API request. permissionsNrnz/iam/testPermissionsra)rrkrhrr)rQrjrjrrrrhresprUrUrVtest_iam_permissionsU s %    zBlob.test_iam_permissionsc C,|j|jj|||||||ddS)a'Update blob's ACL, granting read access to anonymous users. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the blob's bucket. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type if_generation_match: long :param if_generation_match: (Optional) See :ref:`using-if-generation-match` :type if_generation_not_match: long :param if_generation_not_match: (Optional) See :ref:`using-if-generation-not-match` :type if_metageneration_match: long :param if_metageneration_match: (Optional) See :ref:`using-if-metageneration-match` :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) See :ref:`using-if-metageneration-not-match` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` rjrrrrrrN)rdall grant_readsaverQrjrrrrrrrUrUrV make_public * zBlob.make_publicc Crm)a(Update blob's ACL, revoking read access for anonymous users. :type client: :class:`~google.cloud.storage.client.Client` or ``NoneType`` :param client: (Optional) The client to use. If not passed, falls back to the ``client`` stored on the blob's bucket. :type timeout: float or tuple :param timeout: (Optional) The amount of time, in seconds, to wait for the server response. See: :ref:`configuring_timeouts` :type if_generation_match: long :param if_generation_match: (Optional) See :ref:`using-if-generation-match` :type if_generation_not_match: long :param if_generation_not_match: (Optional) See :ref:`using-if-generation-not-match` :type if_metageneration_match: long :param if_metageneration_match: (Optional) See :ref:`using-if-metageneration-match` :type if_metageneration_not_match: long :param if_metageneration_not_match: (Optional) See :ref:`using-if-metageneration-not-match` :type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy :param retry: (Optional) How to retry the RPC. See: :ref:`configuring_retries` rnN)rdro revoke_readrqrrrUrUrV make_private rtzBlob.make_privatecCs:t|}||}i} t|tr$tjttdd|dur tt |}d}t|tr3tjt tddd}|durr?rgzipzaccept-encodingrr)rrrN)rAr/rBrrrlrOrrrrrrrr rKrL)rQrrjrrrrrrrrrrrrrrrrrrNrUrUrVrusZ p     zBlob._prep_and_do_downloadcC |jd}|durt|SdS)aNumber of underlying components that make up this object. See https://cloud.google.com/storage/docs/json_api/v1/objects :rtype: int or ``NoneType`` :returns: The component count (in case of a composed object) or ``None`` if the blob's resource has not been loaded from the server. This property will not be set on objects not created via ``compose``. componentCountNrPrr)rQcomponent_countrUrUrVr zBlob.component_countcC |jdS)a|Retrieve the ETag for the object. See [`RFC 2616 (etags)`](https://tools.ietf.org/html/rfc2616#section-3.11) and [`API reference docs`](https://cloud.google.com/storage/docs/json_api/v1/objects). :rtype: str or ``NoneType`` :returns: The blob etag or ``None`` if the blob's resource has not been loaded from the server. rrPrrXrUrUrVr)s z Blob.etageventBasedHoldcCr)a#Retrieve the generation for the object. See https://cloud.google.com/storage/docs/json_api/v1/objects :rtype: int or ``NoneType`` :returns: The generation of the blob or ``None`` if the blob's resource has not been loaded from the server. rINr)rQrIrUrUrVrI@ zBlob.generationcCr)adRetrieve the ID for the object. See https://cloud.google.com/storage/docs/json_api/v1/objects The ID consists of the bucket name, object name, and generation number. :rtype: str or ``NoneType`` :returns: The ID of the blob or ``None`` if the blob's resource has not been loaded from the server. idrrXrUrUrVrNs zBlob.idr?cCr)a,Retrieve the media download URI for the object. See https://cloud.google.com/storage/docs/json_api/v1/objects :rtype: str or ``NoneType`` :returns: The media link for the blob or ``None`` if the blob's resource has not been loaded from the server. mediaLinkrrXrUrUrVrj zBlob.media_linkcCt|jdS)aRetrieve arbitrary/application specific metadata for the object. See https://cloud.google.com/storage/docs/json_api/v1/objects :setter: Update arbitrary/application specific metadata for the object. :getter: Retrieve arbitrary/application specific metadata for the object. :rtype: dict or ``NoneType`` :returns: The metadata associated with the blob or ``None`` if the property is not set. r@rdeepcopyrPrrXrUrUrVr@vsz Blob.metadatacCs*|dur dd|D}|d|dS)aMUpdate arbitrary/application specific metadata for the object. Values are stored to GCS as strings. To delete a key, set its value to None and call blob.patch(). See https://cloud.google.com/storage/docs/json_api/v1/objects :type value: dict :param value: The blob metadata to set. NcSs&i|]\}}||durt|ndqSN)str).0kvrUrUrV s&z!Blob.metadata..r@)itemsrr]rUrUrVr@s cCr)a+Retrieve the metageneration for the object. See https://cloud.google.com/storage/docs/json_api/v1/objects :rtype: int or ``NoneType`` :returns: The metageneration of the blob or ``None`` if the blob's resource has not been loaded from the server. rNr)rQrrUrUrVrrzBlob.metagenerationcCr)a*Retrieve info about the owner of the object. See https://cloud.google.com/storage/docs/json_api/v1/objects :rtype: dict or ``NoneType`` :returns: Mapping of owner's role/ID, or ``None`` if the blob's resource has not been loaded from the server. ownerrrXrUrUrVrs z Blob.ownercCr)aWRetrieve timestamp at which the object's retention period expires. See https://cloud.google.com/storage/docs/json_api/v1/objects :rtype: :class:`datetime.datetime` or ``NoneType`` :returns: Datetime object parsed from RFC3339 valid timestamp, or ``None`` if the property is not set locally. retentionExpirationTimeNrPrrr]rUrUrVretention_expiration_timerzBlob.retention_expiration_timecCr)aRetrieve the URI for the object. See https://cloud.google.com/storage/docs/json_api/v1/objects :rtype: str or ``NoneType`` :returns: The self link for the blob or ``None`` if the blob's resource has not been loaded from the server. selfLinkrrXrUrUrV self_linkrzBlob.self_linkcCr)aSize of the object, in bytes. See https://cloud.google.com/storage/docs/json_api/v1/objects :rtype: int or ``NoneType`` :returns: The size of the blob or ``None`` if the blob's resource has not been loaded from the server. r/Nr)rQr/rUrUrVr/rz Blob.sizecCr)aResource name of Cloud KMS key used to encrypt the blob's contents. :rtype: str or ``NoneType`` :returns: The resource name or ``None`` if no Cloud KMS key was used, or the blob's resource has not been loaded from the server. rHrrXrUrUrVrGs zBlob.kms_key_namecCs|d|dS)zSet KMS encryption key for object. :type value: str or ``NoneType`` :param value: new KMS key name (None to clear any existing key). rHN)rr]rUrUrVrGsrC temporaryHoldcCr)aRetrieve the timestamp at which the object was deleted. See https://cloud.google.com/storage/docs/json_api/v1/objects :rtype: :class:`datetime.datetime` or ``NoneType`` :returns: Datetime object parsed from RFC3339 valid timestamp, or ``None`` if the blob's resource has not been loaded from the server (see :meth:`reload`). If the blob has not been deleted, this will never be set. timeDeletedNrr]rUrUrV time_deletedrzBlob.time_deletedcCr)aRetrieve the timestamp at which the object was created. See https://cloud.google.com/storage/docs/json_api/v1/objects :rtype: :class:`datetime.datetime` or ``NoneType`` :returns: Datetime object parsed from RFC3339 valid timestamp, or ``None`` if the blob's resource has not been loaded from the server (see :meth:`reload`). timeCreatedNrr]rUrUrV time_created zBlob.time_createdcCr)aRetrieve the timestamp at which the object was updated. See https://cloud.google.com/storage/docs/json_api/v1/objects :rtype: :class:`datetime.datetime` or ``NoneType`` :returns: Datetime object parsed from RFC3339 valid timestamp, or ``None`` if the blob's resource has not been loaded from the server (see :meth:`reload`). rNrr]rUrUrVr-rz Blob.updatedcCr)a|Retrieve the custom time for the object. See https://cloud.google.com/storage/docs/json_api/v1/objects :rtype: :class:`datetime.datetime` or ``NoneType`` :returns: Datetime object parsed from RFC3339 valid timestamp, or ``None`` if the blob's resource has not been loaded from the server (see :meth:`reload`). r>Nrr]rUrUrV custom_time<rzBlob.custom_timecCs |durt|}|d|dS)aSet the custom time for the object. Once set on the server side object, this value can't be unset, but may only changed to a custom datetime in the future. If :attr:`custom_time` must be unset, either perform a rewrite operation or upload the data again. See https://cloud.google.com/storage/docs/json_api/v1/objects :type value: :class:`datetime.datetime` :param value: new value Nr>)rrr]rUrUrVrKscCs|jdi}t||S)zRetrieve the retention configuration for this object. :rtype: :class:`Retention` :returns: an instance for managing the object's retention configuration. rB)rPr Retentionrb)rQrrUrUrVrB_s zBlob.retentioncCr)a9If this object has been soft-deleted, returns the time at which it became soft-deleted. :rtype: :class:`datetime.datetime` or ``NoneType`` :returns: (readonly) The time that the object became soft-deleted. Note this property is only set for soft-deleted objects. softDeleteTimeNr)rQsoft_delete_timerUrUrVri zBlob.soft_delete_timecCr)aHIf this object has been soft-deleted, returns the time at which it will be permanently deleted. :rtype: :class:`datetime.datetime` or ``NoneType`` :returns: (readonly) The time that the object will be permanently deleted. Note this property is only set for soft-deleted objects. hardDeleteTimeNr)rQhard_delete_timerUrUrVrvrzBlob.hard_delete_time)NNNNr)NNrNNNNNNNNNNNNFNr)NN)rNNNNN)h__name__ __module__ __qualname____doc__rZr[r.r,r*r)r+r-STORAGE_CLASSESrKpropertyrRrLsetterrF staticmethodrcrdrgrhrjrkrmrpry classmethodrrr(r0rr2rrrrrrrrrrrrrr r4r;r=rErOrPrUrVrXr^rdr1rirlr3rsrvrrrrr cache_controlcontent_dispositioncontent_encodingcontent_languagerrr=rrrevent_based_holdrIrmd5_hashrr@rrrrr/rG storage_classtemporary_holdrrrrrBrr __classcell__rUrUrSrVrDsT"                a k = ;0 x   ~ r y !1 8 W  4 6      6 G > 8 7 8   "  #  %                        rDcCst|ds|jS|S)zReturns the host name from the given connection. :type connection: :class:`~google.cloud.storage._http.Connection` :param connection: The connection object. :rtype: str :returns: The host name. get_api_base_url_for_mtls)hasattr API_BASE_URLr) connectionrUrUrVrs rFcCsh|duriSt|}t|}t|}t|}|r d}nd}|dd|dt||dt|iS)akBuilds customer encryption key headers :type key: bytes :param key: 32 byte key to build request key and hash. :type source: bool :param source: If true, return headers for the "source" blob; otherwise, return headers for the "destination" blob. :rtype: dict :returns: dict of HTTP headers being sent in request. NzX-Goog-Copy-Source-Encryption-zX-Goog-Encryption- AlgorithmAES256Keyz Key-Sha256)rhashlibsha256rbase64 b64encoder)rrkey_hashprefixrUrUrVrls     rl~cCst|dd}t||dS)aURL-quote a string. If the value is unicode, this method first UTF-8 encodes it as bytes and then quotes the bytes. (In Python 3, ``urllib.parse.quote`` does this encoding automatically, but in Python 2, non-ASCII characters cannot be quoted.) :type value: str or bytes :param value: The value to be URL-quoted. :type safe: bytes :param safe: Bytes *not* to be quoted. By default, includes only ``b'~'``. :rtype: str :returns: The encoded value (bytes in Python 2, unicode in Python 3). r rWrr)rr)r^rsrUrUrVr`s  r`cCs|r |dtjdSdS)zRewind the stream if desired. :type stream: IO[bytes] :param stream: A bytes IO object open for reading. :type rewind: bool :param rewind: Indicates if we should seek to the beginning of the stream. rN)seekrSEEK_SET)rrFrUrUrVrHs rHcCsV|j}|jr|jdt|}nt|}|jjd|jjd|}tj|j||d)aRRe-wrap and raise an ``InvalidResponse`` exception. :type error: :exc:`google.resumable_media.InvalidResponse` :param error: A caught exception from the ``google-resumable-media`` library. :raises: :class:`~google.cloud.exceptions.GoogleCloudError` corresponding to the failed status code z:  )r) rtextrrrurlrfrom_http_status status_code)errorr error_messagemessagerUrUrVrLs  rLcCsJt|dkr|St|\}}}}}t|}||t|||t||fS)aeAdd one query parameter to a base URL. :type base_url: string :param base_url: Base URL (may already contain query parameters) :type name_value_pairs: list of (string, string) tuples. :param name_value_pairs: Names and values of the query parameters to add :rtype: string :returns: URL with additional query strings appended. r)r*rrextendr r)rrrnetlocrhqueryfragrUrUrVrs  rcseZdZdZ   dfdd ZeddZeddZed d Z e j d d Z ed d Z e j dd Z eddZ Z S)raMap an object's retention configuration. :type blob: :class:`Blob` :params blob: blob for which this retention configuration applies to. :type mode: str or ``NoneType`` :params mode: (Optional) The mode of the retention configuration, which can be either Unlocked or Locked. See: https://cloud.google.com/storage/docs/object-lock :type retain_until_time: :class:`datetime.datetime` or ``NoneType`` :params retain_until_time: (Optional) The earliest time that the object can be deleted or replaced, which is the retention configuration set for this object. :type retention_expiration_time: :class:`datetime.datetime` or ``NoneType`` :params retention_expiration_time: (Optional) The earliest time that the object can be deleted, which depends on any retention configuration set for the object and any retention policy set for the bucket that contains the object. This value should normally only be set by the back-end API. NcsRd|i}|dur t|}||d<|durt|}||d<tt||||_dS)NrretainUntilTimer)rrJrrK_blob)rQblobrretain_until_timerrrSrUrVrKs zRetention.__init__cCs||}|||S)adFactory: construct instance from resource. :type blob: :class:`Blob` :params blob: Blob for which this retention configuration applies to. :type resource: dict :param resource: mapping as returned from API call. :rtype: :class:`Retention` :returns: Retention configuration created from resource. )r)rrrinstancerUrUrVrb1s zRetention.from_api_reprcCrW)zBlob for which this retention configuration applies to. :rtype: :class:`Blob` :returns: the instance's blob. )rrXrUrUrVrBrYzRetention.blobcCs |dS)zThe mode of the retention configuration. Options are 'Unlocked' or 'Locked'. :rtype: string :returns: The mode of the retention configuration, which can be either set to 'Unlocked' or 'Locked'. r)rrXrUrUrVrKs zRetention.modecCs||d<|jd|dS)NrrB)rrr]rUrUrVrTscC|d}|dur t|SdS)aThe earliest time that the object can be deleted or replaced, which is the retention configuration set for this object. :rtype: :class:`datetime.datetime` or ``NoneType`` :returns: Datetime object parsed from RFC3339 valid timestamp, or ``None`` if the blob's resource has not been loaded from the server (see :meth:`reload`). rNrrr]rUrUrVrY zRetention.retain_until_timecCs*|durt|}||d<|jd|dS)zSet the retain_until_time for the object retention configuration. :type value: :class:`datetime.datetime` :param value: The earliest time that the object can be deleted or replaced. NrrB)rrrr]rUrUrVrgscCr)agThe earliest time that the object can be deleted, which depends on any retention configuration set for the object and any retention policy set for the bucket that contains the object. :rtype: :class:`datetime.datetime` or ``NoneType`` :returns: (readonly) The earliest time that the object can be deleted. rNr)rQrrUrUrVrsrz#Retention.retention_expiration_time)NNN)rrrrrKrrbrrrrrrrrUrUrSrVrs(       r)F)r)jrrrriorrloggingrrr email.parserr urllib.parserrrrr rgoogler google.resumable_media.requestsr r r rrrgoogle.api_core.iamr google.cloudrgoogle.cloud._helpersrrrrgoogle.cloud.exceptionsrgoogle.cloud.storage._helpersrrrrrrrrr google.cloud.storage._signingr!r"r#r$r%google.cloud.storage.aclr&r'google.cloud.storage.constantsr(r)r*r+r,r-r.google.cloud.storage.retryr/r0r1r2r3google.cloud.storage.fileior4r5rr_BASE_UPLOAD_TEMPLATEr-r8rrr+rr{r|r}r~rcompiler}r7rC getLoggerrrrDrrlr`rHrLrr rrUrUrUrVs"                                                       !