U O8c~j@sddlZddlZddlZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z m Z ddlmZmZmZdZdZdZeeZejee e fZd/d d Zd d Zd dZddZd0ddZddZddZ ddZ!GdddZ"GdddZ#GdddZ$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)1N) defaultdict)IncompleteReadErrorReadTimeoutError) SOCKET_ERROR fallocate rename_filei'liPcCsdddt|DS)Ncss|]}ttjVqdSN)randomchoicestring hexdigits).0_r4/tmp/pip-unpacked-wheel-6hpttf6a/s3transfer/utils.py .sz(random_file_extension..)joinrange)Z num_digitsrrrrandom_file_extension-srcKs"|dkrt|jdr|jdS)NZ PutObjectZ UploadPartsignal_not_transferring)hasattrbodyrrequestZoperation_namekwargsrrrr1s  rcKs"|dkrt|jdr|jdS)Nrsignal_transferring)rrrrrrrr8s  rcCstt|t|Sr )intmathceilfloat)size part_sizerrrcalculate_num_parts?sr%cCsN||}||dkr.d}|dk r:t|d}n ||d}d|d|}|S)aCalculate 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$Z part_index num_partsZ total_sizeZ start_rangeZ end_rangeZ range_paramrrrcalculate_range_parameterCs  r*cCsDg}|jjjD]0}d|}t||r|tjt|||dq|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_)future)metaZ call_argsZ subscribersrappend functoolspartialgetattr)Ztransfer_futureZ callback_type callbacks subscriberZ callback_namerrr get_callbacksas r3cCs|r|D]}||dqdS)aCalls 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)r1r5callbackrrrinvoke_progress_callbacks~s r7cCs*i}|D]\}}||kr |||<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)Z original_dictZwhitelisted_keysZ filtered_dictkeyvaluerrrget_filtered_dicts  r;c@seZdZddZdS)CallArgscKs"|D]\}}t|||qdS)zA 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)r8setattr)selfrargr:rrr__init__szCallArgs.__init__N)__name__ __module__ __qualname__r@rrrrr<sr<c@s(eZdZdZddZddZddZdS) FunctionContainerzAn 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. cOs||_||_||_dSr _func_args_kwargs)r>funcargsrrrrr@szFunctionContainer.__init__cCsd|j|j|jS)Nz'Function: {} with args {} and kwargs {})formatrFrGrHr>rrr__repr__s zFunctionContainer.__repr__cCs|j|j|jSr rErLrrr__call__szFunctionContainer.__call__N)rArBrC__doc__r@rMrNrrrrrDsrDc@s<eZdZdZddZeddZddZdd Zd d Z d S) CountCallbackInvokerzAn 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) threadingLock_lock _callback_count _is_finalizedr>r6rrrr@s zCountCallbackInvoker.__init__c Cs$|j|jW5QRSQRXdSr rSrUrLrrr current_countsz"CountCallbackInvoker.current_countc Cs2|j"|jrtd|jd7_W5QRXdS)zIncrement the count by onez;Counter has been finalized it can no longer be incremented.r&N)rSrV RuntimeErrorrUrLrrr increments zCountCallbackInvoker.incrementc CsN|j>|jdkrtd|jd8_|jr@|jdkr@|W5QRXdS)zDecrement the count by onerz,Counter is at zero. It cannot dip below zeror&N)rSrUrZrVrTrLrrr decrements zCountCallbackInvoker.decrementc Cs.|jd|_|jdkr |W5QRXdS)zFinalize the counter Once finalized, the counter never be incremented and the callback can be invoked once the count reaches zero TrN)rSrVrUrTrLrrrfinalizes zCountCallbackInvoker.finalizeN) rArBrCrOr@propertyrYr[r\r]rrrrrPs   rPc@sZeZdZdZddZddZdddZd d Zd d Zd dZ ddZ ddZ ddZ dS)OSUtilscCs tj|Sr )ospathgetsizer>filenamerrr get_file_sizeszOSUtils.get_file_sizecCstj||||ddS)NF)enable_callbacks) ReadFileChunk from_filename)r>re start_byter#r1rrropen_file_chunk_readerszOSUtils.open_file_chunk_readerNcCst||||d|dS)NF)r1rgclose_callbacks)rh)r>fileobj chunk_sizefull_file_sizer1rlrrr#open_file_chunk_reader_from_fileobjsz+OSUtils.open_file_chunk_reader_from_fileobjcCs t||Sr )open)r>remoderrrrqsz OSUtils.opencCs(zt|Wntk r"YnXdS)z+Remove a file, noop if file does not exist.N)raremoveOSErrorrdrrr remove_fileszOSUtils.remove_filecCst||dSr )r)r>Zcurrent_filenameZ new_filenamerrrrszOSUtils.rename_filecCsXtj|sdSt|j}t|r*dSt|r8dSt|rFdSt|rTdSdS)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) rarbexistsstatst_modeS_ISCHRS_ISBLKS_ISFIFOS_ISSOCK)clsrerrrrris_special_files      zOSUtils.is_special_filecCsLtjt}tj|}tj|}|d|jt||}tj||Sr ) raextseprrbdirnamebasename_MAX_FILENAME_LENlenr)r>resuffixrbnameZ temp_filenamerrrget_temp_filename;s    zOSUtils.get_temp_filenamec CsLz&||d}t||W5QRXWn tk rF||YnXdS)Nwb)rqrrtru)r>rer#frrrallocateBs  zOSUtils.allocate)N) rArBrCrrfrkrprqrurr~rrrrrrr_s  r_c@sleZdZddefddZddZeddZdd d Zd d Z dddZ ddZ ddZ ddZ ddZd S)DeferredOpenFilerrbcCs"||_d|_||_||_||_dS)aA 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>rerjrrZ open_functionrrrr@Ls zDeferredOpenFile.__init__cCs8|jdkr4||j|j|_|jdkr4|j|jdSNr)rrrrrseekrLrrr_open_if_neededgs  z DeferredOpenFile._open_if_neededcCs|jSr )rrLrrrrmszDeferredOpenFile.nameNcCs||j|Sr )rrread)r>amountrrrrqszDeferredOpenFile.readcCs||j|dSr )rrwrite)r>datarrrruszDeferredOpenFile.writecCs||j||dSr )rrr)r>wherewhencerrrryszDeferredOpenFile.seekcCs|jdkr|jS|jSr )rrtellrLrrrr}s zDeferredOpenFile.tellcCs|jr|jdSr )rcloserLrrrrszDeferredOpenFile.closecCs ||Sr )rrLrrr __enter__szDeferredOpenFile.__enter__cOs |dSr rr>rJrrrr__exit__szDeferredOpenFile.__exit__)N)r)rArBrCrqr@rr^rrrrrrrrrrrrrKs   rc@seZdZd"ddZed#ddZddZd$d d Zd d Zd dZ ddZ ddZ d%ddZ ddZ ddZddZddZddZd d!ZdS)&rhNTcCsb||_|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_sizerjactual_file_sizerN) rrr_calculate_file_size_size _amount_read _callbacks_callbacks_enabled_close_callbacks)r>rmrnror1rgrlrrrr@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)rqrrafstatfilenost_size)r}rerjrnr1rgr file_sizerrrris"  zReadFileChunk.from_filenamecCs||}t||Sr )min)r>rmrrjrZmax_chunk_sizerrrrsz"ReadFileChunk._calculate_file_sizecCslt|j|jd}|dkr |}n t||}|j|}|jt|7_|jdk rh|jrht |jt||Sr) maxrrrrrrrrr7)r>rZ amount_leftZamount_to_readrrrrrs  zReadFileChunk.readcCs"|t|jdr|jdS)Nr)enable_callbackrrrrLrrrrs z!ReadFileChunk.signal_transferringcCs"|t|jdr|jdS)Nr)disable_callbackrrrrLrrrr s z%ReadFileChunk.signal_not_transferringcCs d|_dS)NTrrLrrrrszReadFileChunk.enable_callbackcCs d|_dS)NFrrLrrrrszReadFileChunk.disable_callbackrcCs|dkrtd|d||j7}|dkr6||j7}n|dkrH||j7}|jt||j|jdk r|jrtt ||j|jd}t |j|j}||}t |j|dt||jd|_dS)N)rr&zinvalid whence (z, should be 0, 1 or 2)r&rrr4) ValueErrorrrrrrrrrrr7)r>rrZ bounded_whereZbounded_amount_readrrrrrs"   zReadFileChunk.seekcCs0|jdk r"|jr"|jD] }|q|jdSr )rrrrrWrrrr-s zReadFileChunk.closecCs|jSr )rrLrrrr3szReadFileChunk.tellcCs|jSr )rrLrrr__len__6szReadFileChunk.__len__cCs|Sr rrLrrrr>szReadFileChunk.__enter__cOs |dSr rrrrrrAszReadFileChunk.__exit__cCstgSr )iterrLrrr__iter__DszReadFileChunk.__iter__)NTN)NT)N)r)rArBrCr@ classmethodrirrrrrrrrrrrrrrrrrrhs* = &  rhc@s"eZdZdZdddZddZdS)StreamReaderProgresszstreamr1rrrr@PszStreamReaderProgress.__init__cOs"|jj||}t|jt||Sr )rrr7rr)r>rJrr:rrrrVszStreamReaderProgress.read)N)rArBrCrOr@rrrrrrMs rc@s eZdZdS)NoResourcesAvailableN)rArBrCrrrrr\src@s&eZdZddZd ddZddZdS) TaskSemaphorecCst||_dS)zqA semaphore for the purpose of limiting the number of tasks :param count: The size of semaphore N)rQ Semaphore _semaphorer>countrrrr@aszTaskSemaphore.__init__TcCs(td||j|s$td|dS)aAcquire 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 %sCannot acquire tag '%s'N)loggerdebugracquirer)r>tagblockingrrrrhs  zTaskSemaphore.acquirecCs$td|d||jdS)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)rrrrelease)r>r acquire_tokenrrrrxs zTaskSemaphore.releaseN)T)rArBrCr@rrrrrrr`s rc@s2eZdZdZddZddZd ddZd d Zd S) SlidingWindowSemaphoreaA 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 ) rUrr_tag_sequences_lowest_sequencerQrRrS Condition _condition_pending_releaserrrrr@s   zSlidingWindowSemaphore.__init__c Cs$|j|jW5QRSQRXdSr rXrLrrrrYsz$SlidingWindowSemaphore.current_countTcCstd||jzv|jdkrJ|s4td|n|jdkrJ|jq4|j|}|dkrf||j |<|j|d7<|jd8_|WS|jXdS)Nrrrr&) rrrrrrUrwaitrr)r>rrsequence_numberrrrrs       zSlidingWindowSemaphore.acquirecCs8|}td|||jz||jkr6td||j|}|j||kr|j|d7<|jd7_|j |j |g}|r|j||dkr| |j|d7<|jd7_qqqnX|j||kr|krnn(|j |g||j |jddntd||fW5|jXdS)NzReleasing acquire %s/%sz$Attempted to release unknown tag: %sr&T)reversez;Attempted to release unknown sequence number %s for tag: %s)rrrrrrrrrUnotifyrgetpop setdefaultr-sort)r>rrrZ max_sequenceZqueuedrrrrs:      zSlidingWindowSemaphore.releaseN)T)rArBrCrOr@rYrrrrrrrs   rc@s6eZdZeeefddZd ddZddZdd Z dS) ChunksizeAdjustercCs||_||_||_dSr )max_sizemin_size max_parts)r>rrrrrrr@szChunksizeAdjuster.__init__NcCs"|}|dk r|||}||S)aGet 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 chunksizerrradjust_chunksizes  z"ChunksizeAdjuster.adjust_chunksizecCsP||jkr$td|j|f|jS||jkrHtd|j|f|jS|SdS)Nz@Chunksize greater than maximum chunksize. Setting to %s from %s.z=Chunksize less than minimum chunksize. Setting to %s from %s.)rrrr)r>rrrrrs  z.ChunksizeAdjuster._adjust_for_chunksize_limitscCsb|}tt|t|}||jkrD|d9}tt|t|}q||kr^td||f|S)Nrz[Chunksize would result in the number of parts exceeding the maximum. Setting to %s from %s.)rr r!r"rrr)r>rrrr)rrrrs z'ChunksizeAdjuster._adjust_for_max_parts)N) rArBrCMAX_SINGLE_UPLOAD_SIZEMIN_UPLOAD_CHUNKSIZE MAX_PARTSr@rrrrrrrrs r)r)N).r.loggingr rar socketrwr rQ collectionsrZbotocore.exceptionsrrZs3transfer.compatrrrrrr getLoggerrArtimeoutZS3_RETRYABLE_DOWNLOAD_ERRORSrrrr%r*r3r7r;r<rDrPr_rrhr Exceptionrrrrrrrr sR     2XC@%b