File: //usr/lib/python3/dist-packages/s3transfer/__pycache__/download.cpython-310.pyc
o
�y�`�m � @ s� d dl Z d dlZd dlZd dlmZ d dlmZ d dlmZ d dl m
Z
d dl m Z d dl m
Z
d dl mZ d d l mZ d d
l mZ d d l mZ d d l mZ d d
l mZ d dl mZ d dlmZ d dlmZ e �e�ZG dd� de�Z G dd� de �Z G dd� de �Z G dd� de �Z G dd� de �Z G dd � d e�Z!G d d � d e�Z"G d d � d e"�Z#G d!d"� d"e�Z$G d#d$� d$e�Z%G d%d&� d&e�Z&G d'd(� d(e�Z'G d)d*� d*e�Z(G d+d,� d,e�Z)G d-d.� d.e�Z*dS )/� N)�six��seekable)�RetriesExceededError��IN_MEMORY_DOWNLOAD_TAG)� S3_RETRYABLE_DOWNLOAD_ERRORS)�
get_callbacks)�invoke_progress_callbacks)�calculate_num_parts)�calculate_range_parameter)�FunctionContainer)�CountCallbackInvoker)�StreamReaderProgress)�DeferredOpenFile)�Task)�SubmissionTaskc @ sT e Zd ZdZdd� Zedd� �Zdd� Zdd � Zd
d � Z d d
� Z
dd� Z dd� Z dS )�DownloadOutputManagera� Base manager class for handling various types of files for downloads
This class is typically used for the DownloadSubmissionTask class to help
determine the following:
* Provides the fileobj to write to downloads to
* Get a task to complete once everything downloaded has been written
The answers/implementations differ for the various types of file outputs
that may be accepted. All implementations must subclass and override
public methods from this class.
c C s || _ || _|| _d S �N)�_osutil�_transfer_coordinator� _io_executor��self�osutil�transfer_coordinator� io_executor� r �5/usr/lib/python3/dist-packages/s3transfer/download.py�__init__4 s
z DownloadOutputManager.__init__c C � t d��)ae Determines if the target for the download is compatible with manager
:param download_target: The target for which the upload will write
data to.
:param osutil: The os utility to be used for the transfer
:returns: True if the manager can handle the type of target specified
otherwise returns False.
z must implement is_compatible()��NotImplementedError��cls�download_targetr r r r �
is_compatible9 s z#DownloadOutputManager.is_compatiblec C s dS )z�Get the tag (if any) to associate all GetObjectTasks
:rtype: s3transfer.futures.TaskTag
:returns: The tag to associate all GetObjectTasks with
Nr �r r r r �get_download_task_tagG s z+DownloadOutputManager.get_download_task_tagc C r )a Get file-like object to use for io writes in the io executor
:type transfer_future: s3transfer.futures.TransferFuture
:param transfer_future: The future associated with upload request
returns: A file-like object to write to
z*must implement get_fileobj_for_io_writes()r! �r �transfer_futurer r r �get_fileobj_for_io_writesO s z/DownloadOutputManager.get_fileobj_for_io_writesc C s | j �| j| �|||�� dS )a Queue IO write for submission to the IO executor.
This method accepts an IO executor and information about the
downloaded data, and handles submitting this to the IO executor.
This method may defer submission to the IO executor if necessary.
N)r �submitr �get_io_write_task�r �fileobj�data�offsetr r r �queue_file_io_taskY s �z(DownloadOutputManager.queue_file_io_taskc C s t | j|||d�d�S )a Get an IO write task for the requested set of data
This task can be ran immediately or be submitted to the IO executor
for it to run.
:type fileobj: file-like object
:param fileobj: The file-like object to write to
:type data: bytes
:param data: The data to write out
:type offset: integer
:param offset: The offset to write the data to in the file-like object
:returns: An IO task to be used to write data to a file-like object
)r/ r0 r1 �� main_kwargs)� IOWriteTaskr r. r r r r- g s ��z'DownloadOutputManager.get_io_write_taskc C r )a� Get the final io task to complete the download
This is needed because based on the architecture of the TransferManager
the final tasks will be sent to the IO executor, but the executor
needs a final task for it to signal that the transfer is done and
all done callbacks can be run.
:rtype: s3transfer.tasks.Task
:returns: A final task to completed in the io executor
z"must implement get_final_io_task()r! r' r r r �get_final_io_task� s �z'DownloadOutputManager.get_final_io_taskc C s$ t |d| jjd�}| j�|j� |S )N�wb)�mode�
open_function)r r �openr �add_failure_cleanup�close)r �filename�fr r r �_get_fileobj_from_filename� s
�z0DownloadOutputManager._get_fileobj_from_filenameN)
�__name__�
__module__� __qualname__�__doc__r � classmethodr& r( r+ r2 r- r6 r? r r r r r ' s
r c s@ e Zd Z� fdd�Zedd� �Zdd� Zdd� Zd d
� Z� Z S ) � DownloadFilenameOutputManagerc s* t t| ��|||� d | _d | _d | _d S r )�superrE r �_final_filename�_temp_filename�
_temp_fileobjr �� __class__r r r � s
�
z&DownloadFilenameOutputManager.__init__c C s t |tj�S r )�
isinstancer � string_typesr# r r r r& � s z+DownloadFilenameOutputManager.is_compatiblec C s. |j jj}|| _| j�|�| _| �� | _| jS r ) �meta� call_argsr/ rG r �get_temp_filenamerH �_get_temp_fileobjrI )r r* r/ r r r r+ � s
z7DownloadFilenameOutputManager.get_fileobj_for_io_writesc C s t | j| j| j| jd�dd�S )N)r/ �final_filenamer T)r r4 �is_final)�IORenameFileTaskr rI rG r r' r r r r6 � s ��z/DownloadFilenameOutputManager.get_final_io_taskc C s$ | � | j�}| j�| jj| j� |S r )r? rH r r; r � remove_file)r r> r r r rQ � s
�z/DownloadFilenameOutputManager._get_temp_fileobj)
r@ rA rB r rD r& r+ r6 rQ �
__classcell__r r rJ r rE � s
rE c @ s( e Zd Zedd� �Zdd� Zdd� ZdS )� DownloadSeekableOutputManagerc C s t |�S r r r# r r r r& � s z+DownloadSeekableOutputManager.is_compatiblec C �
|j jjS r �rN rO r/ r) r r r r+ � �
z7DownloadSeekableOutputManager.get_fileobj_for_io_writesc C � t | jd�S �N)r ��CompleteDownloadNOOPTaskr r' r r r r6 � s �z/DownloadSeekableOutputManager.get_final_io_taskN)r@ rA rB rD r& r+ r6 r r r r rW � s
rW c sX e Zd Z d� fdd� Zedd� �Zdd� Zdd � Zd
d � Z� fd d
�Z dd� Z
� Z S )� DownloadNonSeekableOutputManagerNc s6 t t| ��|||� |d u rt� }|| _t�� | _d S r )rF r_ r �
DeferQueue� _defer_queue� threading�Lock�_io_submit_lock�r r r r � defer_queuerJ r r r � s
�z)DownloadNonSeekableOutputManager.__init__c C s
t |d�S )N�write)�hasattrr# r r r r& � rZ z.DownloadNonSeekableOutputManager.is_compatiblec C s t S r r r' r r r r( � � z6DownloadNonSeekableOutputManager.get_download_task_tagc C rX r rY r) r r r r+ � s
z:DownloadNonSeekableOutputManager.get_fileobj_for_io_writesc C r[ r\ r] r' r r r r6 � s �z2DownloadNonSeekableOutputManager.get_final_io_taskc sr | j �, | j�||�}|D ]}|d }t�d|d |� tt| ��|||� q
W d � d S 1 s2w Y d S )Nr0 z%Queueing IO offset %s for fileobj: %sr1 )rd ra �request_writes�logger�debugrF r_ r2 )r r/ r0 r1 �writesrg rJ r r r2 � s ����"�z3DownloadNonSeekableOutputManager.queue_file_io_taskc C s t | j||d�d�S )N)r/ r0 r3 )�IOStreamingWriteTaskr r. r r r r- � s ��z2DownloadNonSeekableOutputManager.get_io_write_taskr ) r@ rA rB r rD r& r( r+ r6 r2 r- rV r r rJ r r_ � s �
r_ c s< e Zd Z d
� fdd� Zedd� �Zdd� Zdd � Z� ZS ) �$DownloadSpecialFilenameOutputManagerNc s t t| ��||||� d | _d S r )rF ro r �_fileobjre rJ r r r � s
�
z-DownloadSpecialFilenameOutputManager.__init__c C s t |tj�o
|�|�S r )rL r rM �is_special_filer# r r r r& s �z2DownloadSpecialFilenameOutputManager.is_compatiblec C s |j jj}| �|�| _| jS r )rN rO r/ r? rp )r r* r= r r r r+ s
z>DownloadSpecialFilenameOutputManager.get_fileobj_for_io_writesc C s t | jdd| jid�S )NTr/ )r rS r4 )� IOCloseTaskr rp r' r r r r6 s
�z6DownloadSpecialFilenameOutputManager.get_final_io_taskr ) r@ rA rB r rD r& r+ r6 rV r r rJ r ro � s �
ro c @ sD e Zd ZdZdd� Z ddd�Zdd� Zd d
� Zd d � Zd
d� Z dS )�DownloadSubmissionTaskz/Task for submitting tasks to execute a downloadc C sH t tttg}|jjj}|D ] }|�||�r| S q
td|t |�f ��)a� Retrieves a class for managing output for a download
:type transfer_future: s3transfer.futures.TransferFuture
:param transfer_future: The transfer future for the request
:type osutil: s3transfer.utils.OSUtils
:param osutil: The os utility associated to the transfer
:rtype: class of DownloadOutputManager
:returns: The appropriate class to use for managing a specific type of
input for downloads.
z'Output %s of type: %s is not supported.)
ro rE rW r_ rN rO r/ r& � RuntimeError�type)r r* r � download_manager_resolver_chainr/ �download_manager_clsr r r � _get_download_output_manager_cls s �
���z7DownloadSubmissionTask._get_download_output_manager_clsNc
C s� |j jdu r"|jd|j jj|j jjd�|j jj��}|j �|d � | �||�|| j |�} |j j|j
k rB| � |||||| ||� dS | � |||||| ||� dS )a
:param client: The client associated with the transfer manager
:type config: s3transfer.manager.TransferConfig
:param config: The transfer config associated with the transfer
manager
:type osutil: s3transfer.utils.OSUtil
:param osutil: The os utility associated to the transfer manager
:type request_executor: s3transfer.futures.BoundedExecutor
:param request_executor: The request executor associated with the
transfer manager
:type io_executor: s3transfer.futures.BoundedExecutor
:param io_executor: The io executor associated with the
transfer manager
:type transfer_future: s3transfer.futures.TransferFuture
:param transfer_future: The transfer future associated with the
transfer request that tasks are being submitted for
:type bandwidth_limiter: s3transfer.bandwidth.BandwidthLimiter
:param bandwidth_limiter: The bandwidth limiter to use when
downloading streams
N��Bucket�Key�
ContentLengthr )
rN �size� head_objectrO �bucket�key�
extra_args�provide_transfer_sizerx r �multipart_threshold�_submit_download_request� _submit_ranged_download_request)
r �client�configr �request_executorr r* �bandwidth_limiter�response�download_output_managerr r r �_submit5 s2 �����
�
�z DownloadSubmissionTask._submitc C sp |j j} |�|�}
t|d�} |�� } |�� }
| jj|t| j|| j | j
|
| j | |j ||j
|d�
|
gd�| d� d S )N�progress)
r� r r� r/ r� � callbacks� max_attemptsr� � io_chunksizer� �r r4 �done_callbacks��tag)rN rO r+ r r( r6 r r, � ImmediatelyWriteIOGetObjectTaskr r� r� �num_download_attemptsr� )r r� r� r r� r r� r* r� rO r/ �progress_callbacks�get_object_tag�
final_taskr r r r� k s4 �
� �
�z/DownloadSubmissionTask._submit_download_requestc C s� |j j} t|d�}
|�|�} |j} t|j j| �}
|�� }t| � ||��}t
|
�D ]9}t | ||
�}d|i}|� | j
� |�� | jj|t| j|| j| j| ||
|j|| ||j|d� |jgd�|d� q(|�� d S )Nr� �Range) r� r r� r/ r� r� r� � start_indexr� r� r� r� r� )rN rO r r+ �multipart_chunksizer r} r( r �&_get_final_io_task_submission_callback�ranger �updater� � incrementr r, �
GetObjectTaskr r� r� r� � decrement�finalize)r r� r� r r� r r� r* r� rO r� r/ � part_size� num_partsr� �finalize_download_invoker�i�range_parameterr� r r r r� � sR
��� � �
�� z6DownloadSubmissionTask._submit_ranged_download_requestc C s |� � }t| jj||�S r )r6 r
r r, )r �download_managerr r� r r r r� � s
�z=DownloadSubmissionTask._get_final_io_task_submission_callbackc C s6 || }||d kr
d}n|| d }d||f }|S )N� � z bytes=%s-%sr )r r� �
part_indexr� � start_range� end_range� range_paramr r r �_calculate_range_param� s z-DownloadSubmissionTask._calculate_range_paramr )
r@ rA rB rC rx r� r� r� r� r� r r r r rs s
�6*? rs c @ s e Zd Z ddd�Zdd� ZdS )r� r Nc C s� d} t |�D ]j}
zC|
}|jd||d�|��}t|d |�}| r&| �|| j�}t|| �}|D ]}| j�� sC| �||||� |t|�7 }q- W dS W dS t yp } zt
j d||
|dd� |} t ||
| � W Y d}~qd}~ww t
| ��)a� Downloads an object and places content into io queue
:param client: The client to use when calling GetObject
:param bucket: The bucket to download from
:param key: The key to download from
:param fileobj: The file handle to write content to
:param exta_args: Any extra arguements to include in GetObject request
:param callbacks: List of progress callbacks to invoke on download
:param max_attempts: The number of retries to do when downloading
:param download_output_manager: The download output manager associated
with the current download.
:param io_chunksize: The size of each io chunk to read from the
download stream and queue in the io queue.
:param start_index: The location in the file to start writing the
content of the key to.
:param bandwidth_limiter: The bandwidth limiter to use when throttling
the downloading of data in streams.
Nry �BodyzCRetrying exception caught (%s), retrying request, (attempt %s / %s)T)�exc_infor )r� �
get_objectr �get_bandwith_limited_streamr �DownloadChunkIterator�done�
_handle_io�lenr rk rl r
r )r r� r r� r/ r� r� r� r� r� r� r� �last_exceptionr� �
current_indexr� �streaming_body�chunks�chunk�er r r �_main� sP �����
�
�� �� zGetObjectTask._mainc C s |� |||� d S r )r2 )r r� r/ r� �indexr r r r� # s zGetObjectTask._handle_io)r N)r@ rA rB r� r� r r r r r� � s
� =r� c @ � e Zd ZdZdd� ZdS )r� a GetObjectTask that immediately writes to the provided file object
This is useful for downloads where it is known only one thread is
downloading the object so there is no reason to go through the
overhead of using an IO queue and executor.
c C s |� |||�}|� d S r )r- )r r� r/ r� r� �taskr r r r� . s
z*ImmediatelyWriteIOGetObjectTask._handle_ioN)r@ rA rB rC r� r r r r r� ' s r� c @ s e Zd Zdd� ZdS )r5 c C s |� |� |�|� dS )z�Pulls off an io queue to write contents to a file
:param fileobj: The file handle to write content to
:param data: The data to write
:param offset: The offset to write the data to.
N)�seekrg r. r r r r� 4 s
zIOWriteTask._mainN)r@ rA rB r� r r r r r5 3 s r5 c @ r� )rn z/Task for writing data to a non-seekable stream.c C s |� |� dS )z�Write data to a fileobj.
Data will be written directly to the fileboj without
any prior seeking.
:param fileobj: The fileobj to write content to
:param data: The data to write
N)rg )r r/ r0 r r r r� B s
zIOStreamingWriteTask._mainN�r@ rA rB rC r� r r r r rn ? s rn c @ r� )rT a A task to rename a temporary file to its final filename
:param fileobj: The file handle that content was written to.
:param final_filename: The final name of the file to rename to
upon completion of writing the contents.
:param osutil: OS utility
c C s |� � |�|j|� d S r )r< � rename_file�name)r r/ rR r r r r r� W s zIORenameFileTask._mainNr� r r r r rT O s rT c @ r� )rr ziA task to close out a file once the download is complete.
:param fileobj: The fileobj to close.
c C s |� � d S r )r< )r r/ r r r r� a s zIOCloseTask._mainNr� r r r r rr \ s rr c s0 e Zd ZdZ d� fdd� Zdd� Z� ZS ) r^ z�A NOOP task to serve as an indicator that the download is complete
Note that the default for is_final is set to True because this should
always be the last task.
NTc s t t| �j|||||d� d S )N)r r4 �pending_main_kwargsr� rS )rF r^ r )r r r4 r� r� rS rJ r r r k s
�z!CompleteDownloadNOOPTask.__init__c C s d S r r r' r r r r� v ri z CompleteDownloadNOOPTask._main)NNNT)r@ rA rB rC r r� rV r r rJ r r^ e s � r^ c @ s( e Zd Zdd� Zdd� Zdd� ZeZdS )r� c C s || _ || _d| _dS )z�Iterator to chunk out a downloaded S3 stream
:param body: A readable file-like object
:param chunksize: The amount to read each time
r N)�_body�
_chunksize�
_num_reads)r �body� chunksizer r r r { s
z DownloadChunkIterator.__init__c C s | S r r r' r r r �__iter__� ri z DownloadChunkIterator.__iter__c C s8 | j �| j�}| jd7 _|r|S | jdkr|S t� �)Nr� )r� �readr� r� �
StopIteration)r r� r r r �__next__� s
z DownloadChunkIterator.__next__N)r@ rA rB r r� r� �nextr r r r r� z s
r� c @ s e Zd ZdZdd� Zdd� ZdS )r` a" IO queue that defers write requests until they are queued sequentially.
This class is used to track IO data for a *single* fileobj.
You can send data to this queue, and it will defer any IO write requests
until it has the next contiguous block available (starting at 0).
c C s g | _ t� | _d| _d S )Nr )�_writes�set�_pending_offsets� _next_offsetr' r r r r � s
zDeferQueue.__init__c C s� || j k rg S g }|| jv rg S t�| j||f� | j�|� | jr^| jd d | j kr^t�| j�}|�|d |d d�� | j�|d � | j t |d �7 _ | jr^| jd d | j ks,|S )a� Request any available writes given new incoming data.
You call this method by providing new data along with the
offset associated with the data. If that new data unlocks
any contiguous writes that can now be submitted, this
method will return all applicable writes.
This is done with 1 method call so you don't have to
make two method calls (put(), get()) which acquires a lock
each method call.
r r� )r1 r0 )
r� r� �heapq�heappushr� �add�heappop�append�remover� )r r1 r0 rm �
next_writer r r rj � s
�zDeferQueue.request_writesN)r@ rA rB rC r rj r r r r r` � s r` )+�loggingrb r� �botocore.compatr �s3transfer.compatr �s3transfer.exceptionsr �s3transfer.futuresr �s3transfer.utilsr r r
r r r
r r r �s3transfer.tasksr r � getLoggerr@ rk �objectr rE rW r_ ro rs r� r� r5 rn rT rr r^ r� r` r r r r �<module> sF
q(- PB