File: //usr/lib/python3.6/site-packages/s3transfer/__pycache__/utils.cpython-36.pyc
3
\��_�g � @ s� d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlZd dlZd dl Z d dl
Z
d dl m Z d dl
mZ d dl
mZ d dlmZ d dlmZ d dlmZ d dlmZ d Zd6Zd8Zeje�ZejeeefZ d9dd�Z dd� Z dd� Z dd� Z d:dd�Z!dd� Z"dd � Z#d d � 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/d0� d0e%�Z/G d1d2� d2e/�Z0G d3d4� d4e%�Z1dS );� N)� defaultdict)�IncompleteReadError)�ReadTimeoutError)� SOCKET_ERROR)� rename_file)�seekable)� fallocatei' � i � � � c C s dj dd� t| �D ��S )N� c s s | ]}t jtj�V qd S )N)�randomZchoice�stringZ hexdigits)�.0�_� r �/usr/lib/python3.6/utils.py� <genexpr>2 s z(random_file_extension.<locals>.<genexpr>)�join�range)Z
num_digitsr r r �random_file_extension1 s r c K s" |dkr t | jd�r | jj� d S )N� PutObject�
UploadPart�signal_not_transferring)r r )�hasattr�bodyr )�request�operation_name�kwargsr r r r 5 s r c K s" |dkr t | jd�r | jj� d S )Nr r �signal_transferring)r r )r r r )r r r r r r r ; s r c C s t tj| t|� ��S )N)�int�math�ceil�float)�size� part_sizer r r �calculate_num_partsA s r' c C sJ || }||d kr.d}|dk r:t |d �}n || d }d||f }|S )a� Calculate the range parameter for multipart downloads/copies
:type part_size: int
:param part_size: The size of the part
:type part_index: int
:param part_index: The index for which this parts starts. This index starts
at zero
:type num_parts: int
:param num_parts: The total number of parts in the transfer
:returns: The value to use for Range parameter on downloads or
the CopySourceRange parameter for copies
� r
Nz bytes=%s-%s)�str)r& Z
part_index� num_partsZ
total_sizeZ start_rangeZ end_rangeZ range_paramr r r �calculate_range_parameterE s r+ c C sH g }x>| j jjD ]0}d| }t||�r|jtjt||�| d�� qW |S )a Retrieves callbacks from a subscriber
:type transfer_future: s3transfer.futures.TransferFuture
:param transfer_future: The transfer future the subscriber is associated
to.
:type callback_type: str
:param callback_type: The type of callback to retrieve from the subscriber.
Valid types include:
* 'queued'
* 'progress'
* 'done'
:returns: A list of callbacks for the type specified. All callbacks are
preinjected with the transfer future.
Zon_)Zfuture)�meta� call_argsZ subscribersr �append� functools�partial�getattr)Ztransfer_futureZ
callback_type� callbacksZ
subscriberZ
callback_namer r r �
get_callbacksb s
r3 c C s |r x| D ]}||d� q
W dS )a� Calls all progress callbacks
:param callbacks: A list of progress callbacks to invoke
:param bytes_transferred: The number of bytes transferred. This is passed
to the callbacks. If no bytes were transferred the callbacks will not
be invoked because no progress was achieved. It is also possible
to receive a negative amount which comes from retrying a transfer
request.
)�bytes_transferredNr )r2 r4 �callbackr r r �invoke_progress_callbacks� s
r6 c C s. i }x$| j � D ]\}}||kr|||< qW |S )ao Gets a dictionary filtered by whitelisted keys
:param original_dict: The original dictionary of arguments to source keys
and values.
:param whitelisted_key: A list of keys to include in the filtered
dictionary.
:returns: A dictionary containing key/values from the original dictionary
whose key was included in the whitelist
)�items)Z
original_dictZwhitelisted_keysZ
filtered_dict�key�valuer r r �get_filtered_dict� s
r: c @ s e Zd Zdd� ZdS )�CallArgsc K s& x |j � D ]\}}t| ||� q
W dS )z�A class that records call arguments
The call arguments must be passed as keyword arguments. It will set
each keyword argument as an attribute of the object along with its
associated value.
N)r7 �setattr)�selfr �argr9 r r r �__init__� s zCallArgs.__init__N)�__name__�
__module__� __qualname__r? r r r r r; � s r; c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �FunctionContainerz�An object that contains a function and any args or kwargs to call it
When called the provided function will be called with provided args
and kwargs.
c O s || _ || _|| _d S )N)�_func�_args�_kwargs)r= �func�argsr r r r r? � s zFunctionContainer.__init__c C s d| j | j| jf S )Nz'Function: %s with args %s and kwargs %s)rD rE rF )r= r r r �__repr__� s zFunctionContainer.__repr__c C s | j | j| j�S )N)rD rE rF )r= r r r �__call__� s zFunctionContainer.__call__N)r@ rA rB �__doc__r? rI rJ r r r r rC � s rC c @ s< e Zd ZdZdd� Zedd� �Zdd� Zdd � Zd
d � Z d S )
�CountCallbackInvokerz�An abstraction to invoke a callback when a shared count reaches zero
:param callback: Callback invoke when finalized count reaches zero
c C s t j� | _|| _d| _d| _d S )Nr F)� threading�Lock�_lock� _callback�_count�
_is_finalized)r= r5 r r r r? � s
z CountCallbackInvoker.__init__c C s | j � | jS Q R X d S )N)rO rQ )r= r r r �
current_count� s z"CountCallbackInvoker.current_countc
C s2 | j �" | jrtd��| jd7 _W dQ R X dS )zIncrement the count by onez;Counter has been finalized it can no longer be incremented.r( N)rO rR � RuntimeErrorrQ )r= r r r � increment� s
z CountCallbackInvoker.incrementc
C sN | j �> | jdkrtd��| jd8 _| jr@| jdkr@| j� W dQ R X dS )zDecrement the count by oner z,Counter is at zero. It cannot dip below zeror( N)rO rQ rT rR rP )r= r r r � decrement� s
z CountCallbackInvoker.decrementc C s. | j � d| _| jdkr | j� W dQ R X dS )z�Finalize the counter
Once finalized, the counter never be incremented and the callback
can be invoked once the count reaches zero
Tr N)rO rR rQ rP )r= r r r �finalize� s
z CountCallbackInvoker.finalizeN)
r@ rA rB rK r? �propertyrS rU rV rW r r r r rL � s
rL c @ sZ e Zd ZdZdd� Zdd� Zddd�Zd d
� Zd d � Zd
d� Z dd� Z
dd� Z dd� Z dS )�OSUtils� c C s t jj|�S )N)�os�path�getsize)r= �filenamer r r �
get_file_size� s zOSUtils.get_file_sizec C s t j||||dd�S )NF)�enable_callbacks)�
ReadFileChunk�
from_filename)r= r^ �
start_byter% r2 r r r �open_file_chunk_reader� s z OSUtils.open_file_chunk_readerNc C s t ||||d|d�S )NF)r2 r` �close_callbacks)ra )r= �fileobj�
chunk_size�full_file_sizer2 re r r r �#open_file_chunk_reader_from_fileobj� s z+OSUtils.open_file_chunk_reader_from_fileobjc C s
t ||�S )N)�open)r= r^ �moder r r rj s z OSUtils.openc C s( yt j|� W n tk
r" Y nX dS )z+Remove a file, noop if file does not exist.N)r[ �remove�OSError)r= r^ r r r � remove_file s zOSUtils.remove_filec C s t ||� d S )N)r )r= Zcurrent_filenameZ new_filenamer r r r s zOSUtils.rename_filec C sX t jj|�sdS t j|�j}tj|�r*dS tj|�r8dS tj|�rFdS tj|�rTdS dS )a Checks to see if a file is a special UNIX file.
It checks if the file is a character special device, block special
device, FIFO, or socket.
:param filename: Name of the file
:returns: True if the file is a special file. False, if is not.
FT) r[ r\ �exists�stat�st_mode�S_ISCHR�S_ISBLK�S_ISFIFO�S_ISSOCK)�clsr^ rk r r r �is_special_file s
zOSUtils.is_special_filec C sL t jt� }t jj|�}t jj|�}|d | jt|� � | }t jj||�S )N) r[ �extsepr r\ �dirname�basename�_MAX_FILENAME_LEN�lenr )r= r^ �suffixr\ �nameZ
temp_filenamer r r �get_temp_filename0 s
zOSUtils.get_temp_filenamec C sP y&| j |d��}t||� W d Q R X W n$ ttfk
rJ | j|� � Y nX d S )N�wb)rj r rm �IOErrorrn )r= r^ r% �fr r r �allocate7 s
zOSUtils.allocate)N)
r@ rA rB r{ r_ rd ri rj rn r rw r r� r r r r rY � s
rY c @ sj e Zd Zddefdd�Zdd� Zedd� �Zdd
d �Zd d
� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zd S )�DeferredOpenFiler �rbc C s" || _ d| _|| _|| _|| _dS )a� A class that defers the opening of a file till needed
This is useful for deferring opening of a file till it is needed
in a separate thread, as there is a limit of how many open files
there can be in a single thread for most operating systems. The
file gets opened in the following methods: ``read()``, ``seek()``,
and ``__enter__()``
:type filename: str
:param filename: The name of the file to open
:type start_byte: int
:param start_byte: The byte to seek to when the file is opened.
:type mode: str
:param mode: The mode to use to open the file
:type open_function: function
:param open_function: The function to use to open the file
N)� _filename�_fileobj� _start_byte�_mode�_open_function)r= r^ rc rk Z
open_functionr r r r? A s
zDeferredOpenFile.__init__c C s8 | j d kr4| j| j| j�| _ | jdkr4| j j| j� d S )Nr )r� r� r� r� r� �seek)r= r r r �_open_if_needed\ s
z DeferredOpenFile._open_if_neededc C s | j S )N)r� )r= r r r r~ b s zDeferredOpenFile.nameNc C s | j � | jj|�S )N)r� r� �read)r= �amountr r r r� f s zDeferredOpenFile.readc C s | j � | jj|� d S )N)r� r� �write)r= �datar r r r� j s zDeferredOpenFile.writec C s | j � | jj|� d S )N)r� r� r� )r= �wherer r r r� n s zDeferredOpenFile.seekc C s | j d kr| jS | j j� S )N)r� r� �tell)r= r r r r� r s
zDeferredOpenFile.tellc C s | j r| j j� d S )N)r� �close)r= r r r r� w s zDeferredOpenFile.closec C s | j � | S )N)r� )r= r r r � __enter__{ s zDeferredOpenFile.__enter__c O s | j � d S )N)r� )r= rH r r r r �__exit__ s zDeferredOpenFile.__exit__)N)r@ rA rB rj r? r� rX r~ r� r� r� r� r� r� r� r r r r r� @ s
r� c @ s� e Zd Zd!dd�Zed"dd��Zdd� Zd#d d
�Zd d � Zd
d� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zdd� Zdd � Zd d � Zd d � ZdS )$ra NTc C sb || _ | j j� | _| j| j || j|d�| _d| _|| _|dkrDg | _|| _|| _|dkr^|| _dS )a�
Given a file object shown below::
|___________________________________________________|
0 | | full_file_size
|----chunk_size---|
f.tell()
:type fileobj: file
:param fileobj: File like object
:type chunk_size: int
:param chunk_size: The max chunk size to read. Trying to read
pass the end of the chunk size will behave like you've
reached the end of the file.
:type full_file_size: int
:param full_file_size: The entire content length associated
with ``fileobj``.
:type callbacks: A list of function(amount_read)
:param callbacks: Called whenever data is read from this object in the
order provided.
:type enable_callbacks: boolean
:param enable_callbacks: True if to run callbacks. Otherwise, do not
run callbacks
:type close_callbacks: A list of function()
:param close_callbacks: Called when close is called. The function
should take no arguments.
)�requested_sizerc �actual_file_sizer N) r� r� r� �_calculate_file_size�_size� _amount_read�
_callbacks�_callbacks_enabled�_close_callbacks)r= rf rg rh r2 r` re r r r r? � s # zReadFileChunk.__init__c C s4 t |d�}|j|� tj|j� �j}| |||||�S )a[ Convenience factory function to create from a filename.
:type start_byte: int
:param start_byte: The first byte from which to start reading.
:type chunk_size: int
:param chunk_size: The max chunk size to read. Trying to read
pass the end of the chunk size will behave like you've
reached the end of the file.
:type full_file_size: int
:param full_file_size: The entire content length associated
with ``fileobj``.
:type callbacks: function(amount_read)
:param callbacks: Called whenever data is read from this object.
:type enable_callbacks: bool
:param enable_callbacks: Indicate whether to invoke callback
during read() calls.
:rtype: ``ReadFileChunk``
:return: A new instance of ``ReadFileChunk``
r� )rj r� r[ �fstat�fileno�st_size)rv r^ rc rg r2 r` r� � file_sizer r r rb � s
zReadFileChunk.from_filenamec C s || }t ||�S )N)�min)r= rf r� rc r� Zmax_chunk_sizer r r r� � s z"ReadFileChunk._calculate_file_sizec C sj |d kr| j | j }nt| j | j |�}| jj|�}| jt|�7 _| jd k rf| jrft| jt|�� |S )N) r� r� r� r� r� r| r� r� r6 )r= r� Zamount_to_readr� r r r r� � s zReadFileChunk.readc C s" | j � t| jd�r | jj� d S )Nr )�enable_callbackr r� r )r= r r r r � s z!ReadFileChunk.signal_transferringc C s" | j � t| jd�r | jj� d S )Nr )�disable_callbackr r� r )r= r r r r � s z%ReadFileChunk.signal_not_transferringc C s
d| _ d S )NT)r� )r= r r r r� � s z ReadFileChunk.enable_callbackc C s
d| _ d S )NF)r� )r= r r r r� � s z ReadFileChunk.disable_callbackc C s@ | j j| j| � | jd k r6| jr6t| j|| j d� || _d S )N)r4 )r� r� r� r� r� r6 r� )r= r� r r r r� � s
zReadFileChunk.seekc C s4 | j d k r&| jr&x| j D ]
}|� qW | jj� d S )N)r� r� r� r� )r= r5 r r r r� � s
zReadFileChunk.closec C s | j S )N)r� )r= r r r r� s zReadFileChunk.tellc C s | j S )N)r� )r= r r r �__len__ s zReadFileChunk.__len__c C s | S )Nr )r= r r r r� s zReadFileChunk.__enter__c O s | j � d S )N)r� )r= rH r r r r r� s zReadFileChunk.__exit__c C s t g �S )N)�iter)r= r r r �__iter__ s zReadFileChunk.__iter__)NTN)NT)N)r@ rA rB r? � classmethodrb r� r� r r r� r� r� r� r� r� r� r� r� r r r r ra � s"
0
ra c @ s" e Zd ZdZddd�Zdd� ZdS )�StreamReaderProgressz<Wrapper for a read only stream that adds progress callbacks.Nc C s || _ || _|d krg | _d S )N)�_streamr� )r= �streamr2 r r r r? s z StreamReaderProgress.__init__c O s" | j j||�}t| jt|�� |S )N)r� r� r6 r� r| )r= rH r r9 r r r r� & s zStreamReaderProgress.read)N)r@ rA rB rK r? r� r r r r r� s
r� c @ s e Zd ZdS )�NoResourcesAvailableN)r@ rA rB r r r r r� , s r� c @ s& e Zd Zdd� Zd dd�Zdd� ZdS )
�
TaskSemaphorec C s t j|�| _dS )zqA semaphore for the purpose of limiting the number of tasks
:param count: The size of semaphore
N)rM Z Semaphore�
_semaphore)r= �countr r r r? 1 s zTaskSemaphore.__init__Tc C s( t jd|� | jj|�s$td| ��dS )a� Acquire the semaphore
:param tag: A tag identifying what is acquiring the semaphore. Note
that this is not really needed to directly use this class but is
needed for API compatibility with the SlidingWindowSemaphore
implementation.
:param block: If True, block until it can be acquired. If False,
do not block and raise an exception if cannot be aquired.
:returns: A token (can be None) to use when releasing the semaphore
z Acquiring %szCannot acquire tag '%s'N)�logger�debugr� �acquirer� )r= �tag�blockingr r r r� 8 s zTaskSemaphore.acquirec C s t jd||f � | jj� dS )at Release the semaphore
:param tag: A tag identifying what is releasing the semaphore
:param acquire_token: The token returned from when the semaphore was
acquired. Note that this is not really needed to directly use this
class but is needed for API compatibility with the
SlidingWindowSemaphore implementation.
zReleasing acquire %s/%sN)r� r� r� �release)r= r� �
acquire_tokenr r r r� H s zTaskSemaphore.releaseN)T)r@ rA rB r? r� r� r r r r r� 0 s
r� c @ s2 e Zd ZdZdd� Zdd� Zd dd�Zd d
� Zd S )
�SlidingWindowSemaphorea� A semaphore used to coordinate sequential resource access.
This class is similar to the stdlib BoundedSemaphore:
* It's initialized with a count.
* Each call to ``acquire()`` decrements the counter.
* If the count is at zero, then ``acquire()`` will either block until the
count increases, or if ``blocking=False``, then it will raise
a NoResourcesAvailable exception indicating that it failed to acquire the
semaphore.
The main difference is that this semaphore is used to limit
access to a resource that requires sequential access. For example,
if I want to access resource R that has 20 subresources R_0 - R_19,
this semaphore can also enforce that you only have a max range of
10 at any given point in time. You must also specify a tag name
when you acquire the semaphore. The sliding window semantics apply
on a per tag basis. The internal count will only be incremented
when the minimum sequence number for a tag is released.
c C s8 || _ tt�| _i | _tj� | _tj| j�| _ i | _
d S )N) rQ r r! �_tag_sequences�_lowest_sequencerM rN rO Z Condition�
_condition�_pending_release)r= r� r r r r? k s
z SlidingWindowSemaphore.__init__c C s | j � | jS Q R X d S )N)rO rQ )r= r r r rS u s z$SlidingWindowSemaphore.current_countTc
C s� t jd|� | jj� zv| jdkrN|s4td| ��nx| jdkrL| jj� q6W | j| }|dkrj|| j|< | j| d7 < | jd8 _|S | jj � X d S )Nz Acquiring %sr zCannot acquire tag '%s'r( )
r� r� r� r� rQ r� �waitr� r� r� )r= r� r� �sequence_numberr r r r� y s
z SlidingWindowSemaphore.acquirec
C s< |}t jd||� | jj� �z || jkr6td| ��| j| }| j| |kr�| j| d7 < | jd7 _| jj� | j j
|g �}x�|r�| j| |d kr�|j � | j| d7 < | jd7 _q�P q�W nX| j| | k o�|k n �r| j j |g �j
|� | j | jdd� ntd||f ��W d | jj� X d S )NzReleasing acquire %s/%sz$Attempted to release unknown tag: %sr( T)�reversez;Attempted to release unknown sequence number %s for tag: %s���)r� r� r� r� r� �
ValueErrorr� rQ Znotifyr� �get�pop�
setdefaultr. �sortr� )r= r� r� r� Z max_sequenceZqueuedr r r r� � s4
z SlidingWindowSemaphore.releaseN)T)r@ rA rB rK r? rS r� r� r r r r r� U s
r� c @ s6 e Zd Zeeefdd�Zd
dd�Zdd� Zdd � Z dS ) �ChunksizeAdjusterc C s || _ || _|| _d S )N)�max_size�min_size� max_parts)r= r� r� r� r r r r? � s zChunksizeAdjuster.__init__Nc C s" |}|dk r| j ||�}| j|�S )a� Get a chunksize close to current that fits within all S3 limits.
:type current_chunksize: int
:param current_chunksize: The currently configured chunksize.
:type file_size: int or None
:param file_size: The size of the file to upload. This might be None
if the object being transferred has an unknown size.
:returns: A valid chunksize that fits within configured limits.
N)�_adjust_for_max_parts� _adjust_for_chunksize_limits)r= �current_chunksizer� � chunksizer r r �adjust_chunksize� s z"ChunksizeAdjuster.adjust_chunksizec C sP || j kr$tjd| j |f � | j S || jk rHtjd| j|f � | jS |S d S )Nz@Chunksize greater than maximum chunksize. Setting to %s from %s.z=Chunksize less than minimum chunksize. Setting to %s from %s.)r� r� r� r� )r= r� r r r r� � s
z.ChunksizeAdjuster._adjust_for_chunksize_limitsc C sf |}t tj|t|� ��}x,|| jkrF|d9 }t tj|t|� ��}q W ||krbtjd||f � |S )Nr z[Chunksize would result in the number of parts exceeding the maximum. Setting to %s from %s.)r! r" r# r$ r� r� r� )r= r� r� r� r* r r r r� � s z'ChunksizeAdjuster._adjust_for_max_parts)N)
r@ rA rB �MAX_SINGLE_UPLOAD_SIZE�MIN_UPLOAD_CHUNKSIZE� MAX_PARTSr? r� r� r� r r r r r� � s
r� i @l i i P )r )N)2r Ztimer/ r" r[ Zsocketrp r ZloggingrM �io� collectionsr Zbotocore.exceptionsr r Zs3transfer.compatr r r r r� r� r� Z getLoggerr@ r� ZtimeoutZ S3_RETRYABLE_DOWNLOAD_ERRORSr r r r' r+ r3 r6 r: �objectr; rC rL rY r� ra r� � Exceptionr� r� r� r� r r r r �<module>
sT
0OC %_