Dashboard
PHP:
8.2.30
OS:
Linux
User:
dh_nv8b2m
/
/
usr
/
lib
/
python3
/
dist-packages
/
boto
/
s3
/
__pycache__
📤 Upload
📝 New File
📁 New Folder
Close
Editing: bucket.cpython-310.pyc
o ckF[7 � @ st d dl Z d dl mZ d dlmZ d dlmZ d dlmZmZm Z d dl m Z d dl m Z d dlmZ d d lmZ d d lmZ d d lmZ d d lmZ d d lmZ d dlmZ d dlmZ d dlmZ d dl m Z d dl m Z d dl m!Z! d dl"m#Z# d dl$Z d dl%Z d dl&Z'd dl(Z'd dl)Z)d dl*Z*d dl+m,Z, d dl-m.Z.m/Z/m0Z0m1Z1 G dd� de2�Z3g d�Z4G dd� de2�Z5dS ) � N)�handler)� ResultSet)�BotoClientError)�Policy�CannedACLStrings�Grant)�Key)�Prefix)� DeleteMarker)�MultiPartUpload)�CompleteMultiPartUpload)�MultiDeleteResult)�Error��BucketListResultSet�� VersionedBucketListResultSet�� MultiPartUploadListResultSet)� Lifecycle)�Tags)�CORSConfiguration)� BucketLogging)�website)� defaultdict)�BytesIO�six�StringIO�urllibc @ sl e Zd Zedd� �Zded< ded< ded< d ed < d ed < d ed< ded< ded< ded< edd� �ZdS )�S3WebsiteEndpointTranslatec C s dS )Nzs3-website-us-east-1� r r r �0/usr/lib/python3/dist-packages/boto/s3/bucket.py�<lambda>: s z#S3WebsiteEndpointTranslate.<lambda>zs3-website-eu-west-1z eu-west-1zs3-website.eu-central-1z eu-central-1zs3-website-us-west-1z us-west-1zs3-website-us-west-2z us-west-2zs3-website-sa-east-1z sa-east-1zs3-website-ap-northeast-1zap-northeast-1zs3-website-ap-southeast-1zap-southeast-1zs3-website-ap-southeast-2zap-southeast-2zs3-website.cn-north-1z cn-north-1c C s | j | S �N)� trans_region)�self�regr r r! �translate_regionE s z+S3WebsiteEndpointTranslate.translate_regionN)�__name__� __module__� __qualname__r r$ � classmethodr' r r r r! r 8 s r )�READ�WRITE�READ_ACP� WRITE_ACP� FULL_CONTROLc @ sd e Zd ZdZdZdZdZdZddefdd�Z d d � Z d d � Z d d� Z dd� Z dd� Zdd� Zd�dd�Z d�dd�Zdd� Z d�d d �Z d�d d �Z d�d!d"�Zd�d#d$�Z d�d%d&�Zd'd(� Zd�d)d*�Zd�d+d,�Zd-d.� Zd�d/d0�Z d�d1d2�Z 4d�d5d6�Z d�d7d8�Z d�d9d:�Z d�d;d<�Z! 4 d�d>d?�Z" d�d@dA�Z#d�dBdC�Z$ Dd�dEdF�Z%d�dGdH�Z&d�dIdJ�Z' d�dKdL�Z( d�dMdN�Z)d�dOdP�Z* d�dQdR�Z+ 4 d�dSdT�Z,d�dUdV�Z-d�dWdX�Z.d�dYdZ�Z/ d�d[d\�Z0d�d]d^�Z1d�d_d`�Z2d�dadb�Z3d�dcdd�Z4d�dfdg�Z5 4 d�dhdi�Z6d�djdk�Z7d�dldm�Z8d�dndo�Z9d�dpdq�Z: d�drds�Z;d�dtdu�Z<d�dvdw�Z=d�dxdy�Z>d�dzd{�Z?d�d|d}�Z@d�d~d�ZAd�d�d��ZBd�d�� ZCd�d�d��ZDd�d�d��ZEd�d�d��ZFd�d�d��ZGd�d�d��ZHd�d�d��ZId�d�d��ZJd�d�d��ZK 4 4 d�d�d��ZL d�d�d��ZMd�d�d��ZNd�d�d��ZOd�d�d��ZPd�d�d��ZQd�d�d��ZRd�d�d��ZSd�d�d��ZTdS )��Bucketz.http://acs.amazonaws.com/groups/s3/LogDeliveryz�<?xml version="1.0" encoding="UTF-8"?> <RequestPaymentConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Payer>%s</Payer> </RequestPaymentConfiguration>z�<?xml version="1.0" encoding="UTF-8"?> <VersioningConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Status>%s</Status> <MfaDelete>%s</MfaDelete> </VersioningConfiguration>z <Status>([A-Za-z]+)</Status>z"<MfaDelete>([A-Za-z]+)</MfaDelete>Nc C s || _ || _|| _d S r# )�name� connection� key_class)r% r3 r2 r4 r r r! �__init__^ s zBucket.__init__c C s d| j S )Nz <Bucket: %s>)r2 �r% r r r! �__repr__c s zBucket.__repr__c C s t t| ��S r# )�iterr r6 r r r! �__iter__f s zBucket.__iter__c C s | � |�d uS r# ��get_key�r% �key_namer r r! � __contains__i s zBucket.__contains__c C s d S r# r )r% r2 �attrsr3 r r r! � startElementl s zBucket.startElementc C s4 |dkr || _ d S |dkr|| _d S t| ||� d S )N�Name� CreationDate)r2 � creation_date�setattr)r% r2 �valuer3 r r r! � endElemento s zBucket.endElementc C s || _ dS )a Set the Key class associated with this bucket. By default, this would be the boto.s3.key.Key class but if you want to subclass that for some reason this allows you to associate your new class with a bucket so that when you call bucket.new_key() or when you get a listing of keys in the bucket you will get an instances of your key class rather than the default. :type key_class: class :param key_class: A subclass of Key that can be more specific N)r4 )r% r4 r r r! � set_key_classw s zBucket.set_key_classc C s | j ||d�S )z� Deprecated: Please use get_key method. :type key_name: string :param key_name: The name of the key to retrieve :rtype: :class:`boto.s3.key.Key` :returns: A Key object from this bucket. ��headersr: )r% r= rI r r r! �lookup� s z Bucket.lookupTc C s� |du r|s |s |rt d��| �|�S g }|r |�d| � |r7t�|�D ]\}}|�d|tj�|�f � q%| �|||�\} } | S )a Check to see if a particular key exists within the bucket. This method uses a HEAD request to check for the existence of the key. Returns: An instance of a Key object or None :param key_name: The name of the key to retrieve :type key_name: string :param headers: The headers to send when retrieving the key :type headers: dict :param version_id: :type version_id: string :param response_headers: A dictionary containing HTTP headers/values that will override any headers associated with the stored object in the response. See http://goo.gl/EWOPb for details. :type response_headers: dict :param validate: Verifies whether the key exists. If ``False``, this will not hit the service, constructing an in-memory object. Default is ``True``. :type validate: bool :rtype: :class:`boto.s3.key.Key` :returns: A Key object from this bucket. Fz=When providing 'validate=False', no other params are allowed.� versionId=%s�%s=%s) r �new_key�appendr � iteritemsr �parse�quote�_get_key_internal) r% r= rI � version_id�response_headers�validate� query_args_l�rk�rv�key�respr r r! r; � s � zBucket.get_keyc C s d� |�pd }| jjd| j|||d�}|�� |jd dkry| �| �}| jj}tj � |j |�|_ t jD ]}|�|�|j|�� �dd�< q3|�d�} | rTt|�d��|_nd |_||_|�|� |�|� |�|� |�|� |�|�� � ||fS |jd kr�d |fS | jj�|j|j d ��) N�&�HEAD�rI � query_args�d � �-�_zcontent-lengthr i� � ) �joinr3 � make_requestr2 �read�statusr4 �provider�boto�utils�get_aws_metadata�msg�metadatar � base_fields� getheader�__dict__�lower�replace�int�size�handle_version_headers�handle_encryption_headers�handle_restore_headers�handle_storage_class_header�handle_addl_headers� getheaders�storage_response_error�reason) r% r= rI rV r^ �response�krh �field�clenr r r! rR � s: � � �zBucket._get_key_internalrc c C s t | |||||d�S )a� List key objects within a bucket. This returns an instance of an BucketListResultSet that automatically handles all of the result paging, etc. from S3. You just need to keep iterating until there are no more results. Called with no arguments, this will return an iterator object across all keys within the bucket. The Key objects returned by the iterator are obtained by parsing the results of a GET on the bucket, also known as the List Objects request. The XML returned by this request contains only a subset of the information about each key. Certain metadata fields such as Content-Type and user metadata are not available in the XML. Therefore, if you want these additional metadata fields you will have to do a HEAD request on the Key in the bucket. :type prefix: string :param prefix: allows you to limit the listing to a particular prefix. For example, if you call the method with prefix='/foo/' then the iterator will only cycle through the keys that begin with the string '/foo/'. :type delimiter: string :param delimiter: can be used in conjunction with the prefix to allow you to organize and browse your keys hierarchically. See http://goo.gl/Xx63h for more details. :type marker: string :param marker: The "marker" of where you are in the result set :param encoding_type: Requests Amazon S3 to encode the response and specifies the encoding method to use. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. Valid options: ``url`` :type encoding_type: string :rtype: :class:`boto.s3.bucketlistresultset.BucketListResultSet` :return: an instance of a BucketListResultSet that handles paging, etc �� encoding_typer )r% �prefix� delimiter�markerrI r� r r r! �list� s 0�z Bucket.listc C s t | ||||||d�S )a� List version objects within a bucket. This returns an instance of an VersionedBucketListResultSet that automatically handles all of the result paging, etc. from S3. You just need to keep iterating until there are no more results. Called with no arguments, this will return an iterator object across all keys within the bucket. :type prefix: string :param prefix: allows you to limit the listing to a particular prefix. For example, if you call the method with prefix='/foo/' then the iterator will only cycle through the keys that begin with the string '/foo/'. :type delimiter: string :param delimiter: can be used in conjunction with the prefix to allow you to organize and browse your keys hierarchically. See: http://aws.amazon.com/releasenotes/Amazon-S3/213 for more details. :type key_marker: string :param key_marker: The "marker" of where you are in the result set :param encoding_type: Requests Amazon S3 to encode the response and specifies the encoding method to use. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. Valid options: ``url`` :type encoding_type: string :rtype: :class:`boto.s3.bucketlistresultset.BucketListResultSet` :return: an instance of a BucketListResultSet that handles paging, etc r� r )r% r� r� � key_marker�version_id_markerrI r� r r r! � list_versions s +�zBucket.list_versionsc C s t | ||||d�S )a� List multipart upload objects within a bucket. This returns an instance of an MultiPartUploadListResultSet that automatically handles all of the result paging, etc. from S3. You just need to keep iterating until there are no more results. :type key_marker: string :param key_marker: The "marker" of where you are in the result set :type upload_id_marker: string :param upload_id_marker: The upload identifier :param encoding_type: Requests Amazon S3 to encode the response and specifies the encoding method to use. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. Valid options: ``url`` :type encoding_type: string :rtype: :class:`boto.s3.bucketlistresultset.MultiPartUploadListResultSet` :return: an instance of a BucketListResultSet that handles paging, etc r� r )r% r� �upload_id_markerrI r� r r r! �list_multipart_uploadsM s �z Bucket.list_multipart_uploadsc C s� g }|r |� |� t|�� dd� d�D ]B\}}|d u r q|�dd�}|dkr(d}t|tjtjf �s7t�|�}t|tj�sB|� d�}|rU|� d t j � |�t j � |�f � qd � |�S ) Nc S s | d S )Nr r )�xr r r! r" v s z,Bucket._get_all_query_args.<locals>.<lambda>)rY rb ra �maxkeyszmax-keys�utf-8rL r[ )rN �sorted�itemsrr � isinstancer � string_types� binary_type� text_type�encoder rP rQ rd )r% �params�initial_query_string�pairsrY rE r r r! �_get_all_query_argsp s( �� zBucket._get_all_query_argsc K s� | j ||d�}| jjd| j||d�}|�� }tj�|� |jdkr>t |�}t � || �} t |t �s5|�d�}tj�|| � |S | jj�|j|j|��)N)r� �GETr] �� r� )r� r3 re r2 rf ri �log�debugrg r r � XmlHandlerr� �bytesr� �xml�sax� parseStringrh r{ r| ) r% � element_mapr� rI r� r^ r} �body�rs�hr r r! �_get_all� s( � � �zBucket._get_allc C s" |D ] }||vrt d| ��qdS )z� Checks that all named arguments are in the specified list of names. :type kwargs: dict :param kwargs: Dictionary of kwargs to validate. :type names: list :param names: List of possible named arguments. zInvalid argument "%s"!N)� TypeError)r% �kwargs�names�kwargr r r! �validate_kwarg_names� s ��zBucket.validate_kwarg_namesc K s4 | � |g d�� | jd| jfdtfgd|fi |��S )a� A lower-level method for listing contents of a bucket. This closely models the actual S3 API and requires you to manually handle the paging of results. For a higher-level method that handles the details of paging for you, you can use the list method. :type max_keys: int :param max_keys: The maximum number of keys to retrieve :type prefix: string :param prefix: The prefix of the keys you want to retrieve :type marker: string :param marker: The "marker" of where you are in the result set :type delimiter: string :param delimiter: If this optional, Unicode string parameter is included with your request, then keys that contain the same string between the prefix and the first occurrence of the delimiter will be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. :param encoding_type: Requests Amazon S3 to encode the response and specifies the encoding method to use. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. Valid options: ``url`` :type encoding_type: string :rtype: ResultSet :return: The result from S3 listing the keys requested )r� �max_keysr� r� r� r� �Contents�CommonPrefixesrc )r� r� r4 r �r% rI r� r r r! � get_all_keys� s ) ���zBucket.get_all_keysc K s4 | � |� | jd| jfdtfdtfgd|fi |��S )ah A lower-level, version-aware method for listing contents of a bucket. This closely models the actual S3 API and requires you to manually handle the paging of results. For a higher-level method that handles the details of paging for you, you can use the list method. :type max_keys: int :param max_keys: The maximum number of keys to retrieve :type prefix: string :param prefix: The prefix of the keys you want to retrieve :type key_marker: string :param key_marker: The "marker" of where you are in the result set with respect to keys. :type version_id_marker: string :param version_id_marker: The "marker" of where you are in the result set with respect to version-id's. :type delimiter: string :param delimiter: If this optional, Unicode string parameter is included with your request, then keys that contain the same string between the prefix and the first occurrence of the delimiter will be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. :param encoding_type: Requests Amazon S3 to encode the response and specifies the encoding method to use. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. Valid options: ``url`` :type encoding_type: string :rtype: ResultSet :return: The result from S3 listing the keys requested �Versionr� r �versions)� validate_get_all_versions_paramsr� r4 r r r� r r r! �get_all_versions� s - ���zBucket.get_all_versionsc C s | � |g d�� dS )z� Validate that the parameters passed to get_all_versions are valid. Overridden by subclasses that allow a different set of parameters. :type params: dict :param params: Parameters to validate. )r� r� r� r� r� r� r� N)r� )r% r� r r r! r� s �z'Bucket.validate_get_all_versions_paramsc K s2 | � |g d�� | jdtfdtfgd|fi |��S )a~ A lower-level, version-aware method for listing active MultiPart uploads for a bucket. This closely models the actual S3 API and requires you to manually handle the paging of results. For a higher-level method that handles the details of paging for you, you can use the list method. :type max_uploads: int :param max_uploads: The maximum number of uploads to retrieve. Default value is 1000. :type key_marker: string :param key_marker: Together with upload_id_marker, this parameter specifies the multipart upload after which listing should begin. If upload_id_marker is not specified, only the keys lexicographically greater than the specified key_marker will be included in the list. If upload_id_marker is specified, any multipart uploads for a key equal to the key_marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload_id_marker. :type upload_id_marker: string :param upload_id_marker: Together with key-marker, specifies the multipart upload after which listing should begin. If key_marker is not specified, the upload_id_marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key_marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload_id_marker. :type encoding_type: string :param encoding_type: Requests Amazon S3 to encode the response and specifies the encoding method to use. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. Valid options: ``url`` :type delimiter: string :param delimiter: Character you use to group keys. All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response. :type prefix: string :param prefix: Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) :rtype: ResultSet :return: The result from S3 listing the uploads requested )� max_uploadsr� r� r� r� r� �Uploadr� �uploads)r� r� r r r� r r r! �get_all_multipart_uploads s C ���z Bucket.get_all_multipart_uploadsc C s |st d��| �| |�S )z� Creates a new key :type key_name: string :param key_name: The name of the key to create :rtype: :class:`boto.s3.key.Key` or subclass :returns: An instance of the newly created key object � Empty key names are not allowed)� ValueErrorr4 r< r r r! rM e s zBucket.new_keyr� Fc C s | j j||| j||||d�S )N)rI � force_httprT �expires_in_absolute)r3 � generate_urlr2 )r% � expires_in�methodrI r� rT r� r r r! r� s s �zBucket.generate_urlc sJ t |�� t����jj�d�� ������fdd�}||�r# ||�s �S )a� Deletes a set of keys using S3's Multi-object delete API. If a VersionID is specified for that key then that version is removed. Returns a MultiDeleteResult Object, which contains Deleted and Error elements for each key you ask to delete. :type keys: list :param keys: A list of either key_names or (key_name, versionid) pairs or a list of Key instances. :type quiet: boolean :param quiet: In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion, the operation does not return any information about the delete in the response body. :type mfa_token: tuple or list of strings :param mfa_token: A tuple or list consisting of the serial number from the MFA device and the current value of the six-digit token associated with the device. This value is required anytime you are deleting versioned objects from a bucket that has the MFADelete option on the bucket. :returns: An instance of MultiDeleteResult �deletec s� | pi } d}|d7 }�r|d7 }d}|dk r�zt � �}W n ty% Y npw t|tj�r1|}d }nEt|t�rAt|�dkrA|\}}n5t|t�sKt|t�rU|j rU|j }|j }n!t|t �r`|j }d}nt |�}d}d }t |||d �}�j�|� q|d 7 }|d tjj�|� 7 }|r�|d | 7 }|d7 }|dk s|d7 }|dkr�dS |�d�}t|�} tj�| �} | d | d< d| d< �r�d���| �j< �jj d�j | �|d�} | � � } | j dkr�t � ���} t| t!�s�| �d�} tj�"| | � |dkS ��#| j | j$| ��)Nz&<?xml version="1.0" encoding="UTF-8"?>z<Delete>z<Quiet>true</Quiet>r i� r` � PrefixSkipped�InvalidArgumentz0Invalid. No delete action taken for this object.)�code�message� z<Object><Key>%s</Key>z<VersionId>%s</VersionId>z </Object>z </Delete>Fr� � Content-MD5�text/xml� Content-Type� �POST)rI r^ �datar� )%�next� StopIterationr� r r� �tuple�lenr r r2 rS r �reprr �errorsrN r� r� �saxutils�escaper� r ri rj � compute_md5rd � mfa_headerr3 re rf rg r r� r� r� r{ r| )�hdrsr� �countrY r= rS r� r� �error�fp�md5r} r� r� ��ikeys� mfa_tokenrh r^ �quiet�resultr% r r! � delete_keys2� sz � � � �z(Bucket.delete_keys.<locals>.delete_keys2)r8 r r3 rh )r% �keysr� r� rI r� r r� r! � delete_keys| s =�zBucket.delete_keysc C s |st d��| j||||dd�S )a� Deletes a key from the bucket. If a version_id is provided, only that version of the key will be deleted. :type key_name: string :param key_name: The key name to delete :type version_id: string :param version_id: The version ID (optional) :type mfa_token: tuple or list of strings :param mfa_token: A tuple or list consisting of the serial number from the MFA device and the current value of the six-digit token associated with the device. This value is required anytime you are deleting versioned objects from a bucket that has the MFADelete option on the bucket. :rtype: :class:`boto.s3.key.Key` or subclass :returns: A key object holding information on what was deleted. The Caller can see if a delete_marker was created or removed and what version_id the delete created or removed. r� N)rI rS r� rV )r� �_delete_key_internal)r% r= rI rS r� r r r! � delete_key� s �zBucket.delete_keyc C s� |pg }| j j}|r|�d| � d�|�pd }|r&|s i }d�|�||j< | j jd| j|||d�}|�� } |jdkrD|� |j|j | ��| � | �} || _| � |� | � |�� � | S )NrK r[ r� �DELETEr] �� )r3 rh rN rd r� re r2 rf rg r{ r| r4 ru ry rz ) r% r= rI rS r� rV rh r^ r} r� r~ r r r! r� � s. � � zBucket._delete_key_internal�STANDARDc C s� | pi } | j j} tj�|�}|r(| j|kr| } n | j j|d| d�} | j|| d�} |r/d| | j< d|t j � |�f }|rA|d| 7 }t |�| | j < | jrR|rR|| | j< |durdd| | j< tj�| || �} n| skd | | j< | j jd | j|| | d �}|�� }|jd kr�| �|�}t�|| �}t|t�s�|�d �}tj� ||� t |d�r�| � |j |j |��|�!|� |�"|�#� � |r�| �$| |� |S | �%|j|j&|��)a� Create a new key in the bucket by copying another existing key. :type new_key_name: string :param new_key_name: The name of the new key :type src_bucket_name: string :param src_bucket_name: The name of the source bucket :type src_key_name: string :param src_key_name: The name of the source key :type src_version_id: string :param src_version_id: The version id for the key. This param is optional. If not specified, the newest version of the key will be copied. :type metadata: dict :param metadata: Metadata to be associated with new key. If metadata is supplied, it will replace the metadata of the source key being copied. If no metadata is supplied, the source key's metadata will be copied to the new key. :type storage_class: string :param storage_class: The storage class of the new key. By default, the new key will use the standard storage class. Possible values are: STANDARD | REDUCED_REDUNDANCY :type preserve_acl: bool :param preserve_acl: If True, the ACL from the source key will be copied to the destination key. If False, the destination key will have the default ACL. Note that preserving the ACL in the new key object will require two additional API calls to S3, one to retrieve the current ACL and one to set that ACL on the new object. If you don't care about the ACL, a value of False will be significantly more efficient. :type encrypt_key: bool :param encrypt_key: If True, the new copy of the object will be encrypted on the server-side by S3 and will be stored in an encrypted form while at rest in S3. :type headers: dict :param headers: A dictionary of header name/value pairs. :type query_args: string :param query_args: A string of additional querystring arguments to append to the request :rtype: :class:`boto.s3.key.Key` or subclass :returns: An instance of the newly created key object F)rU rI rH �AES256z%s/%sz ?versionId=%sN�REPLACE�COPY�PUTr] r� r� r )'r3 rh ri rj �get_utf8_valuer2 � get_bucket� get_xml_acl� server_side_encryption_headerr rP rQ �str�copy_source_header�storage_class_header�metadata_directive_header� merge_metare rf rg rM r r� r� r� r� r� r� r� �hasattr�storage_copy_error�Code�Messageru ry rz � set_xml_aclr{ r| )r% � new_key_name�src_bucket_name� src_key_namerm �src_version_id� storage_class� preserve_acl� encrypt_keyrI r^ rh � src_bucket�acl�srcr} r� rY r� r r r! �copy_key sX 9 � � �zBucket.copy_keyc C s� |t v sJ �|r||| jjj< n| jjj|i}d}|r!|d| 7 }| jjd| j|||d�}|�� }|jdkrA| jj�|j|j |��d S )Nr � &versionId=%sr� r] r� ) r r3 rh � acl_headerre r2 rf rg r{ r| �r% �acl_strr= rI rS r^ r} r� r r r! �set_canned_acl| s � ��zBucket.set_canned_aclc C sX d}|r |d| 7 }| j jd| j|||d�}|�� }|jdkr*| j j�|j|j|��|S )Nr r r� �r^ rI r� �r3 re r2 rf rg rh r{ r| )r% r= rI rS r^ r} r� r r r! r� � s � �zBucket.get_xml_aclr c C sj |r|d| 7 }t |t�s|�d�}| jjd| j||||d�}|�� }|jdkr3| jj� |j|j |��d S )Nr r� r� �r� r^ rI r� � r� r� r� r3 re r2 rf rg rh r{ r| r r r r! r� � s � ��zBucket.set_xml_aclc C s6 t |t�r| �|�� |||� d S | �||||� d S r# )r� r r� �to_xmlr )r% � acl_or_strr= rI rS r r r! �set_acl� s ��zBucket.set_aclc C s� d}|r |d| 7 }| j jd| j|||d�}|�� }|jdkr<t| �}t�|| �}t|t �s3|� d�}t j � ||� |S | j j�|j|j|��)Nr r r� r r� r� )r3 re r2 rf rg r r r� r� r� r� r� r� r� rh r{ r| ) r% r= rI rS r^ r} r� �policyr� r r r! �get_acl� s$ � �zBucket.get_aclc C sz |st d��|}|r|d| 7 }t|t�s|�d�}| jjd| j||||d�}|�� }|jdkr;| jj � |j|j |��dS )a� Set a subresource for a bucket or key. :type subresource: string :param subresource: The subresource to set. :type value: string :param value: The value of the subresource. :type key_name: string :param key_name: The key to operate on, or None to operate on the bucket. :type headers: dict :param headers: Additional HTTP headers to include in the request. :type src_version_id: string :param src_version_id: Optional. The version id of the key to operate on. If not specified, operate on the newest version. z,set_subresource called with subresource=Noner r� r� r r� N) r� r� r� r� r3 re r2 rf rg rh r{ r| ) r% � subresourcerE r= rI rS r^ r} r� r r r! �set_subresource� s$ � ��zBucket.set_subresourcec C sd |st d��|}|r|d| 7 }| jjd| j|||d�}|�� }|jdkr0| jj�|j|j|��|S )a~ Get a subresource for a bucket or key. :type subresource: string :param subresource: The subresource to get. :type key_name: string :param key_name: The key to operate on, or None to operate on the bucket. :type headers: dict :param headers: Additional HTTP headers to include in the request. :type src_version_id: string :param src_version_id: Optional. The version id of the key to operate on. If not specified, operate on the newest version. :rtype: string :returns: The value of the subresource. z,get_subresource called with subresource=Noner r� r r� ) r� r3 re r2 rf rg rh r{ r| )r% r r= rI rS r^ r} r� r r r! �get_subresource� s � �zBucket.get_subresourcec C s6 | j d|d� |r| D ] }| j d|j|d� q d S d S )Nz public-readrH )r r2 )r% � recursiverI rY r r r! � make_public s �zBucket.make_publicc C sh |t vr | jj�d| ��| j|d�}|j�||� | j||d� |r0| D ] }|j|||d� q%dS dS )a! Convenience method that provides a quick way to add an email grant to a bucket. This method retrieves the current ACL, creates a new grant based on the parameters passed in, adds that grant to the ACL and then PUT's the new ACL back to S3. :type permission: string :param permission: The permission being granted. Should be one of: (READ, WRITE, READ_ACP, WRITE_ACP, FULL_CONTROL). :type email_address: string :param email_address: The email address associated with the AWS account your are granting the permission to. :type recursive: boolean :param recursive: A boolean value to controls whether the command will apply the grant to all keys within the bucket or not. The default value is False. By passing a True value, the call will iterate through all keys in the bucket and apply the same grant to each key. CAUTION: If you have a lot of keys, this could take a long time! �Unknown Permission: %srH N)� S3Permissionsr3 rh �storage_permissions_errorr r �add_email_grantr )r% � permission� email_addressr rI r rY r r r! r s � �zBucket.add_email_grantc C sn |t vr | jj�d| ��| j|d�}|jj|||d� | j||d� |r3| D ] }|j||||d� q'dS dS )a� Convenience method that provides a quick way to add a canonical user grant to a bucket. This method retrieves the current ACL, creates a new grant based on the parameters passed in, adds that grant to the ACL and then PUT's the new ACL back to S3. :type permission: string :param permission: The permission being granted. Should be one of: (READ, WRITE, READ_ACP, WRITE_ACP, FULL_CONTROL). :type user_id: string :param user_id: The canonical user id associated with the AWS account your are granting the permission to. :type recursive: boolean :param recursive: A boolean value to controls whether the command will apply the grant to all keys within the bucket or not. The default value is False. By passing a True value, the call will iterate through all keys in the bucket and apply the same grant to each key. CAUTION: If you have a lot of keys, this could take a long time! :type display_name: string :param display_name: An option string containing the user's Display Name. Only required on Walrus. r rH )� display_name)rI r N)r r3 rh r r r �add_user_grantr )r% r �user_idr rI r r rY r r r! r : s � � ��zBucket.add_user_grantc C s | j |d�}|jjS �NrH )r r �grants)r% rI r r r r! � list_grantsb s zBucket.list_grantsc C sz | j jd| j|dd�}|�� }|jdkr2t| �}t�|| �}t|t �s(|� d�}t j � ||� |jS | j j�|j|j|��)z� Returns the LocationConstraint for the bucket. :rtype: str :return: The LocationConstraint for the bucket or the empty string if no constraint was specified when bucket was created. r� �locationr] r� r� )r3 re r2 rf rg r r r� r� r� r� r� r� r� �LocationConstraintrh r{ r| )r% rI r} r� r� r� r r r! � get_locationf s � �zBucket.get_locationc C s\ |}t |t�s |�d�}| jjd| j|d|d�}|�� }|jdkr#dS | jj� |j|j |��)a� Set logging on a bucket directly to the given xml string. :type logging_str: unicode string :param logging_str: The XML for the bucketloggingstatus which will be set. The string will be converted to utf-8 before it is sent. Usually, you will obtain this XML from the BucketLogging object. :rtype: bool :return: True if ok or raises an exception. r� r� �loggingr r� Tr )r% � logging_strrI r� r} r r r! �set_xml_logging} s � �zBucket.set_xml_loggingc C s0 t |t�r|j}t|||d�}| j|�� |d�S )a- Enable logging on a bucket. :type target_bucket: bucket or string :param target_bucket: The bucket to log to. :type target_prefix: string :param target_prefix: The prefix which should be prepended to the generated log files written to the target_bucket. :type grants: list of Grant objects :param grants: A list of extra permissions which will be granted on the log files which are created. :rtype: bool :return: True if ok or raises an exception. )�targetr� r# rH )r� r1 r2 r r* r )r% � target_bucket� target_prefixr# rI �bloggingr r r! �enable_logging� s �zBucket.enable_loggingc C s t � }| j|�� |d�S )zx Disable logging on a bucket. :rtype: bool :return: True if ok or raises an exception. rH )r r* r )r% rI r. r r r! �disable_logging� s zBucket.disable_loggingc C sv | j jd| jd|d�}|�� }|jdkr0t� }t�|| �}t|t �s'|� d�}t j � ||� |S | j j�|j|j|��)z� Get the logging status for this bucket. :rtype: :class:`boto.s3.bucketlogging.BucketLogging` :return: A BucketLogging object for this bucket. r� r( r r� r� )r3 re r2 rf rg r r r� r� r� r� r� r� r� rh r{ r| )r% rI r} r� r. r� r r r! �get_logging_status� s � �zBucket.get_logging_statusc C sV | j |d�}tdd| jd�}tdd| jd�}|j�|� |j�|� | j||d� dS )z� Setup the current bucket as a logging target by granting the necessary permissions to the LogDelivery group to write log files to this bucket. rH r- �Group)r �type�urir. N)r r � LoggingGroupr � add_grantr )r% rI r �g1�g2r r r! �set_as_logging_target� s z Bucket.set_as_logging_targetc C �B | j jd| jd|d�}|�� }|jdkr|S | j j�|j|j|��)Nr� �requestPaymentr r� r �r% rI r} r� r r r! �get_request_payment� s � �zBucket.get_request_payment� BucketOwnerc C sN | j | }| jjd| j|d|d�}|�� }|jdkr dS | jj�|j|j|��)Nr� r; r r� T) �BucketPaymentBodyr3 re r2 rf rg rh r{ r| )r% �payerrI r� r} r r r! �set_request_payment� s � �zBucket.set_request_paymentc C s� |rd}nd}|r d}nd}| j ||f }|r'|si }| jj}d�|�||j< | jjd| j|d|d�} | �� }| jdkr>d S | jj� | j| j |��) a� Configure versioning for this bucket. ..note:: This feature is currently in beta. :type versioning: bool :param versioning: A boolean indicating whether version is enabled (True) or disabled (False). :type mfa_delete: bool :param mfa_delete: A boolean indicating whether the Multi-Factor Authentication Delete feature is enabled (True) or disabled (False). If mfa_delete is enabled then all Delete operations will require the token from your MFA device to be passed in the request. :type mfa_token: tuple or list of strings :param mfa_token: A tuple or list consisting of the serial number from the MFA device and the current value of the six-digit token associated with the device. This value is required when you are changing the status of the MfaDelete property of the bucket. �Enabled� Suspended�Disabledr� r� � versioningr r� T) �VersioningBodyr3 rh rd r� re r2 rf rg r{ r| ) r% rE � mfa_deleter� rI �ver�mfar� rh r} r r r! �configure_versioning� s* � �zBucket.configure_versioningc C s� | j jd| jd|d�}|�� }t|tj�s|�d�}tj � |� |j dkrIi }t � | j|�}|r7|�d�|d< t � | j|�}|rG|�d�|d< |S | j j�|j |j|��) a� Returns the current status of versioning on the bucket. :rtype: dict :returns: A dictionary containing a key named 'Versioning' that can have a value of either Enabled, Disabled, or Suspended. Also, if MFADelete has ever been enabled on the bucket, the dictionary will contain a key named 'MFADelete' which will have a value of either Enabled or Suspended. r� rE r r� r� r� � Versioning� MfaDelete)r3 re r2 rf r� r r� �decoderi r� r� rg �re�search� VersionRE�group� MFADeleteRErh r{ r| )r% rI r} r� �drH rI r r r! �get_versioning_status s& � �z Bucket.get_versioning_statusc C s� |� � }t|�}tj�|�}|du ri }|d |d< d|d< | jjd| j|�� d|d�}|� � }|j d kr7d S | jj � |j |j |��) z� Configure lifecycle for this bucket. :type lifecycle_config: :class:`boto.s3.lifecycle.Lifecycle` :param lifecycle_config: The lifecycle configuration you want to configure for this bucket. Nr� r� r� r� r� � lifecycler r� T)r r ri rj r� r3 re r2 �getvaluerf rg rh r{ r| )r% �lifecycle_configrI r� r� r� r} r� r r r! �configure_lifecycle> s$ � �zBucket.configure_lifecyclec C s� | j jd| jd|d�}|�� }tj�|� |jdkr6t� }t � || �}t |t �s-|� d�}tj�||� |S | j j�|j|j|��)z� Returns the current lifecycle configuration on the bucket. :rtype: :class:`boto.s3.lifecycle.Lifecycle` :returns: A LifecycleConfig object that describes all current lifecycle rules in effect for the bucket. r� rU r r� r� )r3 re r2 rf ri r� r� rg r r r� r� r� r� r� r� r� rh r{ r| )r% rI r} r� rU r� r r r! �get_lifecycle_configY s � �zBucket.get_lifecycle_configc C �N | j jd| jd|d�}|�� }tj�|� |jdkr dS | j j� |j|j |��)zF Removes all lifecycle configuration from the bucket. r� rU r r� T� r3 re r2 rf ri r� r� rg rh r{ r| r< r r r! � delete_lifecycle_configurationp � � �z%Bucket.delete_lifecycle_configurationc C s t �||||�}| j||d�S )a� Configure this bucket to act as a website :type suffix: str :param suffix: Suffix that is appended to a request that is for a "directory" on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html). The suffix must not be empty and must not include a slash character. :type error_key: str :param error_key: The object key name to use when a 4XX class error occurs. This is optional. :type redirect_all_requests_to: :class:`boto.s3.website.RedirectLocation` :param redirect_all_requests_to: Describes the redirect behavior for every request to this bucket's website endpoint. If this value is non None, no other values are considered when configuring the website configuration for the bucket. This is an instance of ``RedirectLocation``. :type routing_rules: :class:`boto.s3.website.RoutingRules` :param routing_rules: Object which specifies conditions and redirects that apply when the conditions are met. rH )r �WebsiteConfiguration�set_website_configuration)r% �suffix� error_key�redirect_all_requests_to� routing_rulesrI �configr r r! �configure_website s �zBucket.configure_websitec C � | j |�� |d�S )zn :type config: boto.s3.website.WebsiteConfiguration :param config: Configuration data rH )� set_website_configuration_xmlr )r% rd rI r r r! r_ � s �z Bucket.set_website_configurationc C sD | j jd| j|d|d�}|�� }|jdkrdS | j j�|j|j|��)z Upload xml website configurationr� r r r� Tr )r% r� rI r} r� r r r! rg � s � �z$Bucket.set_website_configuration_xmlc C s | � |�d S )a Returns the current status of website configuration on the bucket. :rtype: dict :returns: A dictionary containing a Python representation of the XML response from S3. The overall structure is: * WebsiteConfiguration * IndexDocument * Suffix : suffix that is appended to request that is for a "directory" on the website endpoint * ErrorDocument * Key : name of object to serve when an error occurs r )�"get_website_configuration_with_xml�r% rI r r r! �get_website_configuration� s z Bucket.get_website_configurationc C s2 | j |d�}t�� }t�|| �}tj�||� |S )ziGet the website configuration as a :class:`boto.s3.website.WebsiteConfiguration` object. rH )� get_website_configuration_xmlr r^ r r� r� r� r� )r% rI � config_xmlrd r� r r r! � get_website_configuration_obj� s z$Bucket.get_website_configuration_objc C s6 | j |d�}tj�� }tj�|d�}|�|� ||fS )a� Returns the current status of website configuration on the bucket as unparsed XML. :rtype: 2-Tuple :returns: 2-tuple containing: 1) A dictionary containing a Python representation of the XML response. The overall structure is: * WebsiteConfiguration * IndexDocument * Suffix : suffix that is appended to request that is for a "directory" on the website endpoint * ErrorDocument * Key : name of object to serve when an error occurs 2) unparsed XML describing the bucket's website configuration rH N)rk ri � jsonresponse�Elementr� rP )r% rI r� �er� r r r! rh � s z)Bucket.get_website_configuration_with_xmlc C sT | j jd| jd|d�}|�� �d�}tj�|� |jdkr(| j j � |j|j |��|S )z!Get raw website configuration xmlr� r r r� r� ) r3 re r2 rf rM ri r� r� rg rh r{ r| r< r r r! rk � s � �z$Bucket.get_website_configuration_xmlc C rZ )zD Removes all website configuration from the bucket. r� r r r� Tr[ r< r r r! � delete_website_configuration s � �z#Bucket.delete_website_configurationc C sH | j g}|�t�| �� �� |�d�| jj�d�dd� �� d�|�S )z� Returns the fully qualified hostname to use is you want to access this bucket as a website. This doesn't validate whether the bucket has been correctly configured as a website or not. �.���N) r2 rN r r' r' rd r3 �host�split)r% �lr r r! �get_website_endpoint s " zBucket.get_website_endpointc C r: )z� Returns the JSON policy associated with the bucket. The policy is returned as an uninterpreted JSON string. r� r r r� r r< r r r! � get_policy s � �zBucket.get_policyc C sN | j jd| j|d|d�}|�� }|jdkr |jdkr dS | j j�|j|j|��)z� Add or replace the JSON policy associated with the bucket. :type policy: str :param policy: The JSON policy as a string. r� r r r� r� Tr )r% r rI r} r� r r r! � set_policy+ s � �zBucket.set_policyc C sN | j jd| jdd|d�}|�� }|jdkr |jdkr dS | j j�|j|j|��)Nr� z/?policyr r r� r� Tr r< r r r! � delete_policy= s � �zBucket.delete_policyc C s| t |�}tj�|�}|du ri }|d |d< d|d< | jjd| j|�� d|d�}|�� }|j d kr3d S | jj � |j |j |��) a Set the CORS (Cross-Origin Resource Sharing) for a bucket. :type cors_xml: str :param cors_xml: The XML document describing your desired CORS configuration. See the S3 documentation for details of the exact syntax required. Nr� r� r� r� r� �corsr r� T) r ri rj r� r3 re r2 rV rf rg rh r{ r| )r% �cors_xmlrI r� r� r} r� r r r! � set_cors_xmlI s" � �zBucket.set_cors_xmlc C s | � |�� �S )a Set the CORS for this bucket given a boto CORSConfiguration object. :type cors_config: :class:`boto.s3.cors.CORSConfiguration` :param cors_config: The CORS configuration you want to configure for this bucket. )r} r )r% � cors_configrI r r r! �set_corsc s zBucket.set_corsc C sN | j jd| jd|d�}|�� }tj�|� |jdkr |S | j j� |j|j |��)zb Returns the current CORS configuration on the bucket as an XML document. r� r{ r r� r[ r< r r r! � get_cors_xmln s � �zBucket.get_cors_xmlc C s. | � |�}t� }t�|| �}tj�||� |S )z� Returns the current CORS configuration on the bucket. :rtype: :class:`boto.s3.cors.CORSConfiguration` :returns: A CORSConfiguration object that describes all current CORS rules in effect for the bucket. )r� r r r� r� r� r� )r% rI r� r{ r� r r r! �get_cors} s zBucket.get_corsc C rZ )zA Removes all CORS configuration from the bucket. r� r{ r r� Tr[ r< r r r! � delete_cors� r] zBucket.delete_corsc C s� d}| j j}|p i }|r|||j< |r |j} | r d|| < |r#d||j< |du r)i }tj�||| j j�}| j jd| j |||d�} | � � } tj � | � | j dkrkt| �} t�| | �} t| t�sb| �d�} tj�| | � | S | j j�| j | j| ��) a Start a multipart upload operation. .. note:: Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage. :type key_name: string :param key_name: The name of the key that will ultimately result from this multipart upload operation. This will be exactly as the key appears in the bucket after the upload process has been completed. :type headers: dict :param headers: Additional HTTP headers to send and store with the resulting key in S3. :type reduced_redundancy: boolean :param reduced_redundancy: In multipart uploads, the storage class is specified when initiating the upload, not when uploading individual parts. So if you want the resulting key to use the reduced redundancy storage class set this flag when you initiate the upload. :type metadata: dict :param metadata: Any metadata that you would like to set on the key that results from the multipart upload. :type encrypt_key: bool :param encrypt_key: If True, the new copy of the object will be encrypted on the server-side by S3 and will be stored in an encrypted form while at rest in S3. :type policy: :class:`boto.s3.acl.CannedACLStrings` :param policy: A canned ACL policy that will be applied to the new key (once completed) in S3. r� �REDUCED_REDUNDANCYr� Nr� r r� r� )r3 rh r r� r� ri rj r� re r2 rf r� r� rg r r r� r� r� r� r� r� r� r{ r| )r% r= rI �reduced_redundancyrm r r r^ rh r� r} r� rZ r� r r r! �initiate_multipart_upload� s@ . �� �z Bucket.initiate_multipart_uploadc C s� d| }|du r i }d|d< | j jd| j||||d�}d}|�� �d�}|�d �d kr-d }tj�|� |j d krn|snt | �} t � | | �} t |t�sN|�d�}tj�|| � | �| �} | �|� | �|� | j| _| j| _| S | j j�|j |j|��) z8 Complete a multipart upload operation. � uploadId=%sNr� r� r� )r^ rI r� Fr� z<Error>r Tr� )r3 re r2 rf rM �findri r� r� rg r r r� r� r� r� r� r� r� r4 ru rv rS � encryptedrh r{ r| ) r% r= � upload_id�xml_bodyrI r^ r} �contains_errorr� rZ r� r~ r r r! �complete_multipart_upload� s8 � �z Bucket.complete_multipart_uploadc C sX d| }| j jd| j|||d�}|�� }tj�|� |jdkr*| j j� |j|j |��dS )z� To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty. r� r� r r� Nr[ )r% r= r� rI r^ r} r� r r r! �cancel_multipart_upload s � ��z Bucket.cancel_multipart_uploadc C s | j j| j|d�S r" )r3 � delete_bucketr2 ri r r r! r� ! � z Bucket.deletec C sB | � |�}t� }t�|| �}t|t�s|�d�}tj� ||� |S )Nr� ) � get_xml_tagsr r r� r� r� r� r� r� r� )r% rI r} �tagsr� r r r! �get_tags$ s zBucket.get_tagsc C r: )Nr� �taggingr r� r r< r r r! r� - s � �zBucket.get_xml_tagsr� c C s� |d u ri }t j�t|��}|d |d< d|d< t|t�s"|�d�}| jjd| j |||d�}|� � }|j dkrB| jj � |j |j|��d S ) Nr� r� r� r� r� r� r r� T)ri rj r� r r� r� r� r3 re r2 rf rg rh r{ r| )r% �tag_strrI r^ r� r} r� r r r! � set_xml_tags8 s$ � �zBucket.set_xml_tagsc C rf r" )r� r )r% r� rI r r r! �set_tagsJ r� zBucket.set_tagsc C rZ )Nr� r� r r� Tr[ r< r r r! � delete_tagsM s � �zBucket.delete_tagsr# )NNNT)rc rc rc NN)rc rc rc rc NN)rc rc NN)rc )rc N)r� NFNF)FNN)NNN)NNNN)NNr� FFNN)rc NN)rc NNr )FN)r> N)NNNNN)NFNFN)Nr� )Ur( r) r* r5 r? rF rP rR r r5 r7 r9 r> r@ rF rG rJ r; rR r� r� r� r� r� r� r� r� r� r� rM r� r� r� r� r r r� r� r r r r r r r r$ r' r* r/ r0 r1 r9 r= rA rJ rT rX rY r\ re r_ rg rj rm rh rk rq rw rx ry rz r} r r� r� r� r� r� r� r� r� r� r� r� r� r r r r! r1 L s� �3& �3 �0 � # � 03 J � ` � � �f � � �' � % �" � ( � � 0 � $ ! �Q � ' r1 )6ri r �boto.resultsetr �boto.exceptionr � boto.s3.aclr r r � boto.s3.keyr �boto.s3.prefixr �boto.s3.deletemarkerr �boto.s3.multipartr r �boto.s3.multideleter r �boto.s3.bucketlistresultsetr r r �boto.s3.lifecycler �boto.s3.taggingr � boto.s3.corsr �boto.s3.bucketloggingr �boto.s3r �boto.jsonresponse� boto.utils�xml.saxr� �xml.sax.saxutilsrN �base64� collectionsr � boto.compatr r r r �objectr r r1 r r r r! �<module> s>
Save
Cancel