HEX

File: //home/arjun/projects/env/lib/python3.10/site-packages/s3transfer/__pycache__/utils.cpython-310.pyc
o

+we~j�@s�ddlZddlZddlZddlZddlZddlZddlZddlZddlZddl	m
Z
ddlmZm
Z
ddlmZmZmZdZdZdZe�e�Zejee
efZd/d	d
�Zdd�Zd
d�Zdd�Z	d0dd�Zdd�Zdd�Z dd�Z!Gdd�d�Z"Gdd�d�Z#Gdd�d�Z$Gdd �d �Z%Gd!d"�d"�Z&Gd#d$�d$�Z'Gd%d&�d&�Z(Gd'd(�d(e)�Z*Gd)d*�d*�Z+Gd+d,�d,e+�Z,Gd-d.�d.�Z-dS)1�N)�defaultdict)�IncompleteReadError�ReadTimeoutError)�SOCKET_ERROR�	fallocate�rename_filei'liP�cCsd�dd�t|�D��S)N�css�|]	}t�tj�VqdS�N)�random�choice�string�	hexdigits)�.0�_�r�I/home/arjun/projects/env/lib/python3.10/site-packages/s3transfer/utils.py�	<genexpr>.s�z(random_file_extension.<locals>.<genexpr>)�join�range)�
num_digitsrrr�random_file_extension-srcK�*|dvrt|jd�r|j��dSdSdS)N��	PutObject�
UploadPart�signal_not_transferring)�hasattr�bodyr��request�operation_name�kwargsrrrr1�

��rcKr)Nr�signal_transferring)rrr$rrrrr$8r#r$cCstt�|t|���Sr
)�int�math�ceil�float)�size�	part_sizerrr�calculate_num_parts?sr+cCsN||}||dkrd}|durt|d�}n||d}d|�d|��}|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	Nzbytes=�-)�str)r*�
part_index�	num_parts�
total_size�start_range�	end_range�range_paramrrr�calculate_range_parameterCs�r5cCsDg}|jjjD]}d|}t||�r|�tjt||�|d��q|S)aRetrieves 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.
    �on_)�future)�meta�	call_args�subscribersr�append�	functools�partial�getattr)�transfer_future�
callback_type�	callbacks�
subscriber�
callback_namerrr�
get_callbacksas

���rDcCs |r|D]	}||d�qdSdS)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)rArF�callbackrrr�invoke_progress_callbacks~s
�rHcCs*i}|��D]\}}||vr|||<q|S)aoGets 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)�
original_dict�whitelisted_keys�
filtered_dict�key�valuerrr�get_filtered_dict�s�rOc@seZdZdd�ZdS)�CallArgscKs"|��D]
\}}t|||�qdS)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)rI�setattr)�selfr"�argrNrrr�__init__�s�zCallArgs.__init__N)�__name__�
__module__�__qualname__rTrrrrrP�srPc@s(eZdZdZdd�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.
    cO�||_||_||_dSr
��_func�_args�_kwargs)rR�func�argsr"rrrrT�s
zFunctionContainer.__init__cCsd�|j|j|j�S)Nz'Function: {} with args {} and kwargs {})�formatr[r\r]�rRrrr�__repr__�s�zFunctionContainer.__repr__cCs|j|ji|j��Sr
rZrarrr�__call__�szFunctionContainer.__call__N)rUrVrW�__doc__rTrbrcrrrrrX�s
rXc@s<eZdZdZdd�Zedd��Zdd�Zdd	�Zd
d�Z	dS)
�CountCallbackInvokerz�An abstraction to invoke a callback when a shared count reaches zero

    :param callback: Callback invoke when finalized count reaches zero
    cCs t��|_||_d|_d|_dS)NrF)�	threading�Lock�_lock�	_callback�_count�
_is_finalized�rRrGrrrrT�s

zCountCallbackInvoker.__init__cC�0|j�|jWd�S1swYdSr
�rhrjrarrr�
current_count�s$�z"CountCallbackInvoker.current_countcCsH|j�|jrtd��|jd7_Wd�dS1swYdS)zIncrement the count by onez;Counter has been finalized it can no longer be incremented.r,N)rhrk�RuntimeErrorrjrarrr�	increment�s�"�zCountCallbackInvoker.incrementcCs�|j�5|jdkr
td��|jd8_|jr(|jdkr0|��Wd�dSWd�dSWd�dS1s;wYdS)zDecrement the count by onerz,Counter is at zero. It cannot dip below zeror,N)rhrjrprkrirarrr�	decrement�s
�
��"�zCountCallbackInvoker.decrementcCsT|j�d|_|jdkr|��Wd�dSWd�dS1s#wYdS)z�Finalize the counter

        Once finalized, the counter never be incremented and the callback
        can be invoked once the count reaches zero
        TrN)rhrkrjrirarrr�finalize�s

�"�zCountCallbackInvoker.finalizeN)
rUrVrWrdrT�propertyrorqrrrsrrrrre�s

rec@s\eZdZdZdd�Zdd�Z	ddd�Zd	d
�Zdd�Zd
d�Z	dd�Z
dd�Zdd�ZdS)�OSUtils�cCstj�|�Sr
)�os�path�getsize�rR�filenamerrr�
get_file_size��zOSUtils.get_file_sizecCstj||||dd�S)NF)�enable_callbacks)�
ReadFileChunk�
from_filename)rRr{�
start_byter)rArrr�open_file_chunk_reader�s
�zOSUtils.open_file_chunk_readerNcCst||||d|d�S)NF)rAr~�close_callbacks)r)rR�fileobj�
chunk_size�full_file_sizerAr�rrr�#open_file_chunk_reader_from_fileobj�s�z+OSUtils.open_file_chunk_reader_from_fileobjcCs
t||�Sr
)�open)rRr{�moderrrr��
zOSUtils.opencCs&zt�|�WdStyYdSw)z+Remove a file, noop if file does not exist.N)rw�remove�OSErrorrzrrr�remove_files
�zOSUtils.remove_filecCst||�dSr
)r)rR�current_filename�new_filenamerrrrszOSUtils.rename_filecCsXtj�|�sdSt�|�j}t�|�rdSt�|�rdSt�|�r#dSt�|�r*dSdS)aChecks 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)	rwrx�exists�stat�st_mode�S_ISCHR�S_ISBLK�S_ISFIFO�S_ISSOCK)�clsr{r�rrr�is_special_files



zOSUtils.is_special_filecCsLtjt�}tj�|�}tj�|�}|d|jt|��|}tj�||�Sr
)	rw�extseprrx�dirname�basename�_MAX_FILENAME_LEN�lenr)rRr{�suffixrx�name�
temp_filenamerrr�get_temp_filename;s
zOSUtils.get_temp_filenamecCs\z |�|d��}t||�Wd�WdS1swYWdSty-|�|��w)N�wb)r�rr�r�)rRr{r)�frrr�allocateBs&�
�zOSUtils.allocater
)
rUrVrWr�r|r�r�r�r�rr�r�r�rrrrru�s
�	ruc@sleZdZddefdd�Zdd�Zedd��Zdd
d�Zdd
�Z	ddd�Z
dd�Zdd�Zdd�Z
dd�Zd	S)�DeferredOpenFiler�rbcCs"||_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)rRr{r�r��
open_functionrrrrTLs

zDeferredOpenFile.__init__cCs@|jdur|�|j|j�|_|jdkr|j�|j�dSdSdS�Nr)r�r�r�r�r��seekrarrr�_open_if_neededgs

�z DeferredOpenFile._open_if_neededcC�|jSr
)r�rarrrr�mszDeferredOpenFile.nameNcCs|��|j�|�Sr
)r�r��read)rR�amountrrrr�qszDeferredOpenFile.readcCs|��|j�|�dSr
)r�r��write)rR�datarrrr�uszDeferredOpenFile.writecCs|��|j�||�dSr
)r�r�r�)rR�where�whencerrrr�yszDeferredOpenFile.seekcCs|jdur|jS|j��Sr
)r�r��tellrarrrr�}s

zDeferredOpenFile.tellcCs|jr
|j��dSdSr
)r��closerarrrr��s�zDeferredOpenFile.closecCs|��|Sr
)r�rarrr�	__enter__�szDeferredOpenFile.__enter__cO�|��dSr
�r��rRr_r"rrr�__exit__�r}zDeferredOpenFile.__exit__r
�r)rUrVrWr�rTr�rtr�r�r�r�r�r�r�r�rrrrr�Ks


r�c@s�eZdZ			d"dd�Ze		d#dd��Zdd�Zd$d	d
�Zdd�Zd
d�Z	dd�Z
dd�Zd%dd�Zdd�Z
dd�Zdd�Zdd�Zdd�Zd d!�ZdS)&rNTcCsf||_|j��|_|j|j||j|d�|_d|_||_|dur"g|_||_||_|dur1||_dSdS)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_sizer��actual_file_sizerN)	r�r�r��_calculate_file_size�_size�_amount_read�
_callbacks�_callbacks_enabled�_close_callbacks)rRr�r�r�rAr~r�rrrrT�s"*�
�zReadFileChunk.__init__cCs4t|d�}|�|�t�|���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�)r�r�rw�fstat�fileno�st_size)r�r{r�r�rAr~r��	file_sizerrrr��s
"
zReadFileChunk.from_filenamecCs||}t||�Sr
)�min)rRr�r�r�r��max_chunk_sizerrrr��s
z"ReadFileChunk._calculate_file_sizecCslt|j|jd�}|dur|}nt||�}|j�|�}|jt|�7_|jdur4|jr4t	|jt|��|Sr�)
�maxr�r�r�r�r�r�r�r�rH)rRr��amount_left�amount_to_readr�rrrr��s
zReadFileChunk.readcC�&|��t|jd�r|j��dSdS)Nr$)�enable_callbackrr�r$rarrrr$��z!ReadFileChunk.signal_transferringcCr�)Nr)�disable_callbackrr�rrarrrr
r�z%ReadFileChunk.signal_not_transferringcC�
d|_dS�NT�r�rarrrr�r�zReadFileChunk.enable_callbackcCr�)NFr�rarrrr�r�zReadFileChunk.disable_callbackrcCs�|dvrtd|�d���||j7}|dkr||j7}n	|dkr$||j7}|j�t||j��|jdurT|jrTtt	||j|j�d�}t	|j|j�}||}t
|j|d�t||jd�|_dS)N)rr,�zinvalid whence (z, should be 0, 1 or 2)r,r�rrE)�
ValueErrorr�r�r�r�r�r�r�r�r�rH)rRr�r��
bounded_where�bounded_amount_readr�rrrr�s 

�zReadFileChunk.seekcCs0|jdur|jr|jD]}|�q|j��dSr
)r�r�r�r�rlrrrr�-s
zReadFileChunk.closecCr�r
)r�rarrrr�3szReadFileChunk.tellcCr�r
)r�rarrr�__len__6szReadFileChunk.__len__cCs|Sr
rrarrrr�>szReadFileChunk.__enter__cOr�r
r�r�rrrr�Ar}zReadFileChunk.__exit__cCstg�Sr
)�iterrarrr�__iter__DszReadFileChunk.__iter__)NTNr�r
r�)rUrVrWrT�classmethodr�r�r�r$rr�r�r�r�r�r�r�r�r�rrrrr�s,
�=�&

rc@s"eZdZdZddd�Zdd�ZdS)�StreamReaderProgressz<Wrapper for a read only stream that adds progress callbacks.NcCs"||_||_|durg|_dSdSr
)�_streamr�)rR�streamrArrrrTPs

�zStreamReaderProgress.__init__cOs&|jj|i|��}t|jt|��|Sr
)r�r�rHr�r�)rRr_r"rNrrrr�VszStreamReaderProgress.readr
)rUrVrWrdrTr�rrrrr�Ms
r�c@seZdZdS)�NoResourcesAvailableN)rUrVrWrrrrr�\sr�c@s&eZdZdd�Zd	dd�Zdd�ZdS)
�
TaskSemaphorecCst�|�|_dS)zqA semaphore for the purpose of limiting the number of tasks

        :param count: The size of semaphore
        N)rf�	Semaphore�
_semaphore�rR�countrrrrTaszTaskSemaphore.__init__TcCs(t�d|�|j�|�std|��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 acquired.

        :returns: A token (can be None) to use when releasing the semaphore
        �Acquiring %s�Cannot acquire tag '%s'N)�logger�debugr��acquirer�)rR�tag�blockingrrrr�hs�zTaskSemaphore.acquirecCs$t�d|�d|���|j��dS)atRelease 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 �/N)r�r�r��release)rRr��
acquire_tokenrrrr�xs	zTaskSemaphore.releaseN�T)rUrVrWrTr�r�rrrrr�`s
r�c@s2eZdZdZdd�Zdd�Zddd�Zd	d
�ZdS)
�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.

    cCs8||_tt�|_i|_t��|_t�|j�|_	i|_
dSr
)rjrr%�_tag_sequences�_lowest_sequencerfrgrh�	Condition�
_condition�_pending_releaser�rrrrT�s


zSlidingWindowSemaphore.__init__cCrmr
rnrarrrro�s$�z$SlidingWindowSemaphore.current_countTcCs�t�d|�|j��zB|jdkr(|std|��|jdkr(|j��|jdks|j|}|dkr6||j|<|j|d7<|jd8_|W|j�	�S|j�	�w)Nr�rr�r,)
r�r�r�r�rjr��waitr�r�r�)rRr�r��sequence_numberrrrr��s 




�

zSlidingWindowSemaphore.acquirecCsN|}t�d||�|j��z�||jvrtd|��|j|}|j||krf|j|d7<|jd7_|j��|j	�
|g�}|re|j||dkrb|��|j|d7<|jd7_nn|sDn+|j||krs|kr�nn|j	�|g��
|�|j	|jdd�ntd||f��W|j��dSW|j��dS|j��w)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�r�r�rj�notifyr��get�pop�
setdefaultr;�sortr�)rRr�r�r��max_sequence�queuedrrrr��sD



�������zSlidingWindowSemaphore.releaseNr�)rUrVrWrdrTror�r�rrrrr��s

r�c@s6eZdZeeefdd�Zd
dd�Zdd�Zdd	�Z	dS)�ChunksizeAdjustercCrYr
)�max_size�min_size�	max_parts)rRrrrrrrrT�s
zChunksizeAdjuster.__init__NcCs"|}|dur|�||�}|�|�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)rR�current_chunksizer��	chunksizerrr�adjust_chunksize�s
z"ChunksizeAdjuster.adjust_chunksizecCsL||jkrt�d|j|f�|jS||jkr$t�d|j|f�|jS|S)Nz@Chunksize greater than maximum chunksize. Setting to %s from %s.z=Chunksize less than minimum chunksize. Setting to %s from %s.)rr�r�r)rRr
rrrr	s
��
��z.ChunksizeAdjuster._adjust_for_chunksize_limitscCsj|}tt�|t|���}||jkr&|d9}tt�|t|���}||jks||kr3t�d||f�|S)Nr�z[Chunksize would result in the number of parts exceeding the maximum. Setting to %s from %s.)r%r&r'r(rr�r�)rRr
r�rr0rrrrs

���z'ChunksizeAdjuster._adjust_for_max_partsr
)
rUrVrW�MAX_SINGLE_UPLOAD_SIZE�MIN_UPLOAD_CHUNKSIZE�	MAX_PARTSrTrr	rrrrrr�s
�

r)rr
).r<�loggingr&rwr�socketr�r
rf�collectionsr�botocore.exceptionsrr�s3transfer.compatrrrrr
r�	getLoggerrUr��timeout�S3_RETRYABLE_DOWNLOAD_ERRORSrrr$r+r5rDrHrOrPrXrerur�rr��	Exceptionr�r�r�rrrrr�<module>sT
�

�2XC@%b