/usr/lib/rads/venv/lib/python3.13/site-packages/s3transfer/__pycache__
Edit: /usr/lib/rads/venv/lib/python3.13/site-packages/s3transfer/__pycache__/processpool.cpython-313.pyc (41416B)
jҍ S r SSKrSSKrSSKrSSKrSSKrSSKrSSKJr SSK r
SSK J r SSK
JrJr SSKJrJrJr SSKJrJr SSKJrJr SS KJrJ r J r J r J r J r \RB " \"5 r#S
r$\RJ " S / S Q5 r&\RJ " S
/ SQ5 r'\RP S 5 r)S r* " S S5 r+ " S S5 r, " S S\5 r- " S S\5 r. " S S5 r/ " S S 5 r0 " S S 5 r1 " S S \5 r2\2Rg S \05 " S! S"\Rh 5 r5 " S# S$\55 r6 " S% S&\55 r7g)'aC Speeds up S3 throughput by using processes
Getting Started
===============
The :class:`ProcessPoolDownloader` can be used to download a single file by
calling :meth:`ProcessPoolDownloader.download_file`:
.. code:: python
from s3transfer.processpool import ProcessPoolDownloader
with ProcessPoolDownloader() as downloader:
downloader.download_file('mybucket', 'mykey', 'myfile')
This snippet downloads the S3 object located in the bucket ``mybucket`` at the
key ``mykey`` to the local file ``myfile``. Any errors encountered during the
transfer are not propagated. To determine if a transfer succeeded or
failed, use the `Futures`_ interface.
The :class:`ProcessPoolDownloader` can be used to download multiple files as
well:
.. code:: python
from s3transfer.processpool import ProcessPoolDownloader
with ProcessPoolDownloader() as downloader:
downloader.download_file('mybucket', 'mykey', 'myfile')
downloader.download_file('mybucket', 'myotherkey', 'myotherfile')
When running this snippet, the downloading of ``mykey`` and ``myotherkey``
happen in parallel. The first ``download_file`` call does not block the
second ``download_file`` call. The snippet blocks when exiting
the context manager and blocks until both downloads are complete.
Alternatively, the ``ProcessPoolDownloader`` can be instantiated
and explicitly be shutdown using :meth:`ProcessPoolDownloader.shutdown`:
.. code:: python
from s3transfer.processpool import ProcessPoolDownloader
downloader = ProcessPoolDownloader()
downloader.download_file('mybucket', 'mykey', 'myfile')
downloader.download_file('mybucket', 'myotherkey', 'myotherfile')
downloader.shutdown()
For this code snippet, the call to ``shutdown`` blocks until both
downloads are complete.
Additional Parameters
=====================
Additional parameters can be provided to the ``download_file`` method:
* ``extra_args``: A dictionary containing any additional client arguments
to include in the
`GetObject
`_
API request. For example:
.. code:: python
from s3transfer.processpool import ProcessPoolDownloader
with ProcessPoolDownloader() as downloader:
downloader.download_file(
'mybucket', 'mykey', 'myfile',
extra_args={'VersionId': 'myversion'})
* ``expected_size``: By default, the downloader will make a HeadObject
call to determine the size of the object. To opt-out of this additional
API call, you can provide the size of the object in bytes:
.. code:: python
from s3transfer.processpool import ProcessPoolDownloader
MB = 1024 * 1024
with ProcessPoolDownloader() as downloader:
downloader.download_file(
'mybucket', 'mykey', 'myfile', expected_size=2 * MB)
Futures
=======
When ``download_file`` is called, it immediately returns a
:class:`ProcessPoolTransferFuture`. The future can be used to poll the state
of a particular transfer. To get the result of the download,
call :meth:`ProcessPoolTransferFuture.result`. The method blocks
until the transfer completes, whether it succeeds or fails. For example:
.. code:: python
from s3transfer.processpool import ProcessPoolDownloader
with ProcessPoolDownloader() as downloader:
future = downloader.download_file('mybucket', 'mykey', 'myfile')
print(future.result())
If the download succeeds, the future returns ``None``:
.. code:: python
None
If the download fails, the exception causing the failure is raised. For
example, if ``mykey`` did not exist, the following error would be raised
.. code:: python
botocore.exceptions.ClientError: An error occurred (404) when calling the HeadObject operation: Not Found
.. note::
:meth:`ProcessPoolTransferFuture.result` can only be called while the
``ProcessPoolDownloader`` is running (e.g. before calling ``shutdown`` or
inside the context manager).
Process Pool Configuration
==========================
By default, the downloader has the following configuration options:
* ``multipart_threshold``: The threshold size for performing ranged downloads
in bytes. By default, ranged downloads happen for S3 objects that are
greater than or equal to 8 MB in size.
* ``multipart_chunksize``: The size of each ranged download in bytes. By
default, the size of each ranged download is 8 MB.
* ``max_request_processes``: The maximum number of processes used to download
S3 objects. By default, the maximum is 10 processes.
To change the default configuration, use the :class:`ProcessTransferConfig`:
.. code:: python
from s3transfer.processpool import ProcessPoolDownloader
from s3transfer.processpool import ProcessTransferConfig
config = ProcessTransferConfig(
multipart_threshold=64 * 1024 * 1024, # 64 MB
max_request_processes=50
)
downloader = ProcessPoolDownloader(config=config)
Client Configuration
====================
The process pool downloader creates ``botocore`` clients on your behalf. In
order to affect how the client is created, pass the keyword arguments
that would have been used in the :meth:`botocore.Session.create_client` call:
.. code:: python
from s3transfer.processpool import ProcessPoolDownloader
from s3transfer.processpool import ProcessTransferConfig
downloader = ProcessPoolDownloader(
client_kwargs={'region_name': 'us-west-2'})
This snippet ensures that all clients created by the ``ProcessPoolDownloader``
are using ``us-west-2`` as their region.
N)deepcopy)Config)MAXINT BaseManager)ALLOWED_DOWNLOAD_ARGSMBPROCESS_USER_AGENT)CancelledErrorRetriesExceededError)BaseTransferFutureBaseTransferMeta) S3_RETRYABLE_DOWNLOAD_ERRORSCallArgsOSUtilscalculate_num_partscalculate_range_parametercreate_nested_clientSHUTDOWNDownloadFileRequest transfer_idbucketkeyfilename
extra_args
expected_size GetObjectJob)r r r
temp_filenamer offsetr c # r # [ 5 n S v [ R " [ R U 5 g 7fN)"_add_ignore_handler_for_interruptssignalSIGINT)original_handlers I/usr/lib/rads/venv/lib/python3.13/site-packages/s3transfer/processpool.py
ignore_ctrl_cr' s$ 9;
MM&--!12s 57c h [ R " [ R [ R 5 $ r! )r# r$ SIG_IGN r& r" r" s == 77r+ c 0 \ rS rSrS\- S\- S4S jrSrg)ProcessTransferConfigi
c ( Xl X l X0l g)aE Configuration for the ProcessPoolDownloader
:param multipart_threshold: The threshold for which ranged downloads
occur.
:param multipart_chunksize: The chunk size of each ranged download.
:param max_request_processes: The maximum number of processes that
will be making S3 API transfer-related requests at a time.
N)multipart_thresholdmultipart_chunksizemax_request_processes)selfr1 r2 r3 s r& __init__ ProcessTransferConfig.__init__ s $7 #6 %:"r+ )r3 r2 r1 N)__name__
__module__ __qualname____firstlineno__r r5 __static_attributes__r* r+ r& r- r- s F F ;r+ r- c \ rS rSrSS jr SS jrS rS rS rS r S r
S
r S r S r
S
rS rS rS rS rS rS rSrg)ProcessPoolDownloaderi% Nc b Uc 0 n[ U5 U l X l Uc [ 5 U l [ R
" S5 U l [ R
" S5 U l [ 5 U l SU l
[ R " 5 U l
SU l SU l SU l / U l g)am Downloads S3 objects using process pools
:type client_kwargs: dict
:param client_kwargs: The keyword arguments to provide when
instantiating S3 clients. The arguments must match the keyword
arguments provided to the
`botocore.session.Session.create_client()` method.
:type config: ProcessTransferConfig
:param config: Configuration for the downloader
Ni F)
ClientFactory_client_factory_transfer_configr- multiprocessingQueue_download_request_queue
_worker_queuer _osutil_started threadingLock _start_lock_manager_transfer_monitor
_submitter_workers)r4
client_kwargsconfigs r& r5 ProcessPoolDownloader.__init__& s M ,] ; & >$9$;D !'6'<'>+
!%
r+ c @ U R 5 Uc 0 nU R U5 U R R 5 n[ UUUUUUS9n[
R
SU5 U R R U5 [ UUUUUS9nU R Xh5 n U $ )a Downloads the object's contents to a file
:type bucket: str
:param bucket: The name of the bucket to download from
:type key: str
:param key: The name of the key to download from
:type filename: str
:param filename: The name of a file to download to.
:type extra_args: dict
:param extra_args: Extra arguments that may be passed to the
client operation
:type expected_size: int
:param expected_size: The expected size in bytes of the download. If
provided, the downloader will not call HeadObject to determine the
object's size and use the provided value instead. The size is
needed to determine whether to do a multipart download.
:rtype: s3transfer.futures.TransferFuture
:returns: Transfer future representing the download
r z%Submitting download file request: %s.)r r r r r ) _start_if_needed_validate_all_known_argsrL notify_new_transferr loggerdebugrD putr _get_transfer_future)
r4 r r r r r r download_file_request call_argsfutures
r&
download_file#ProcessPoolDownloader.download_fileG s 6
J %%j1,,@@B 3# !'
!
35J
$$(()>? !'
**;B
r+ c $ U R 5 g)zXShutdown the downloader
It will wait till all downloads are complete before returning.
N)_shutdown_if_neededr4 s r& shutdown ProcessPoolDownloader.shutdown} s
"r+ c U $ r! r* ra s r& __enter__ ProcessPoolDownloader.__enter__ s r+ c [ U[ 5 ( a' U R b U R R 5 U R 5 g r! )
isinstanceKeyboardInterruptrL notify_cancel_all_in_progressrb )r4 exc_type exc_valueargss r& __exit__ ProcessPoolDownloader.__exit__ s7 i!2 3 3%%1&&DDF
r+ c U R U R ( d U R 5 S S S 5 g ! , ( d f g = fr! )rJ rG _startra s r& rS &ProcessPoolDownloader._start_if_needed s'
==
"8
Ac r U R 5 U R 5 U R 5 SU l g )NT) _start_transfer_monitor_manager_start_submitter_start_get_object_workersrG ra s r& rq ProcessPoolDownloader._start s- ,,. &&(
r+ c v U H3 nU[ ; d M SR [ 5 n[ SU SU 35 e g )Nz, zInvalid extra_args key 'z', must be one of: )r join
ValueError)r4 providedkwarg
download_argss r& rT .ProcessPoolDownloader._validate_all_known_args sG E 11 $ *? @
.ug 6''4o7 r+ c @ [ X!S9n[ U R US9nU$ )N)r[ r )monitormeta)ProcessPoolTransferMetaProcessPoolTransferFuturerL )r4 r r[ r r\ s r& rY *ProcessPoolDownloader._get_transfer_future s- &
+**
r+ c [ R S5 [ 5 U l U R R [
5 U R R
5 U l g )Nz$Starting the TransferMonitorManager.)rV rW TransferMonitorManagerrK startr" TransferMonitorrL ra s r& ru 5ProcessPoolDownloader._start_transfer_monitor_manager sC ;<.0
>?!% !>!>!@ r+ c [ R S5 [ U R U R U R
U R U R U R S9U l U R R 5 g )Nz Starting the GetObjectSubmitter.)transfer_configclient_factorytransfer_monitorosutildownload_request_queue worker_queue) rV rW GetObjectSubmitterrA r@ rL rF rD rE rM r ra s r& rv &ProcessPoolDownloader._start_submitter sa 78, 1 1 // ! 3 3<<#'#?#? ++
r+ c b [ R SU R R 5 [ U R R 5 Hb n[ U R U R U R U R S9nUR 5 U R R U5 Md g )Nz Starting %s GetObjectWorkers.)queuer r r )
rV rW rA r3 rangeGetObjectWorkerrE r@ rL rF r rN appendr4 _workers r& rw /ProcessPoolDownloader._start_get_object_workers s + ! ! 7 7
t,,BBCA$(( # 3 3!%!7!7|| F
LLN MM ( Dr+ c U R U R ( a U R 5 S S S 5 g ! , ( d f g = fr! )rJ rG _shutdownra s r& r` )ProcessPoolDownloader._shutdown_if_needed s(
}}
rs c r U R 5 U R 5 U R 5 SU l g )NF)_shutdown_submitter _shutdown_get_object_workers"_shutdown_transfer_monitor_managerrG ra s r& r ProcessPoolDownloader._shutdown s- " ))+ //1
r+ c b [ R S5 U R R 5 g )Nz)Shutting down the TransferMonitorManager.)rV rW rK rb ra s r& r 8ProcessPoolDownloader._shutdown_transfer_monitor_manager s @A
r+ c [ R S5 U R R [ 5 U R
R
5 g )Nz%Shutting down the GetObjectSubmitter.)rV rW rD rX SHUTDOWN_SIGNALrM rz ra s r& r )ProcessPoolDownloader._shutdown_submitter s3 <= $$(( 9 r+ c [ R S5 U R H" nU R R [
5 M$ U R H nUR
5 M g )Nz#Shutting down the GetObjectWorkers.)rV rW rN rE rX r rz r s r& r 2ProcessPoolDownloader._shutdown_get_object_workers sH :; A " "? 3 mmF KKM $r+ ) r@ rD rK rF rJ rG rM rA rL rE rN )NN)r7 r8 r9 r: r5 r] rb re rn rS rq rT rY ru rv rw r` r r r r r; r* r+ r& r= r= % sa D EI4l#
A
) !
!
r+ r= c < \ rS rSrS r\S 5 rS rS rS r Sr
g) r i c Xl X l g)a0 The future associated to a submitted process pool transfer request
:type monitor: TransferMonitor
:param monitor: The monitor associated to the process pool downloader
:type meta: ProcessPoolTransferMeta
:param meta: The metadata associated to the request. This object
is visible to the requester.
N)_monitor_meta)r4 r r s r& r5 "ProcessPoolTransferFuture.__init__ s
r+ c U R $ r! )r ra s r& r ProcessPoolTransferFuture.meta s zzr+ c ` U R R U R R 5 $ r! )r is_doner r ra s r& done ProcessPoolTransferFuture.done s! }}$$TZZ%;%;< D ! !+ . NNa N __s :A
A c 4 U R U R $ )zDetermine a particular transfer is complete
:param transfer_id: Unique identifier for the transfer
:return: True, if done. False, otherwise.
)r r r s r& r TransferMonitor.is_donea s $$[1666r+ c > U R U R 5 g)zaNotify a particular transfer is complete
:param transfer_id: Unique identifier for the transfer
N)r set_doner s r& notify_doneTransferMonitor.notify_donei s
k*335r+ c U R U R 5 U R U R nU( a Ueg)zPoll for the result of a transfer
:param transfer_id: Unique identifier for the transfer
:return: If the transfer succeeded, it will return the result. If the
transfer failed, it will raise the exception associated to the
failure.
N)r wait_till_done exceptionr4 r r s r& r TransferMonitor.poll_for_resultp s<
k*99;))+6@@ Or+ c * X R U l g)zNotify an exception was encountered for a transfer
:param transfer_id: Unique identifier for the transfer
:param exception: The exception encountered for that transfer
Nr r r s r& r TransferMonitor.notify_exception~ s 8A k*4r+ c U R R 5 H% nUR ( a M [ 5 Ul M' g r! )r valuesr r
r )r4 transfer_states r& rj -TransferMonitor.notify_cancel_all_in_progress s2 " 3 3 : : [ TU ] 5 Xl S U l g r! )superr5 r@ _client)r4 r __class__s r& r5 BaseS3TransferProcess.__init__ s
- r+ c U R R 5 U l [ 5 U R 5 S S S 5 g ! , ( d f g = fr! )r@ r r, r' _do_runra s r& runBaseS3TransferProcess.run s4 ++99;
_
LLN __s A
Ac [ S5 e)Nz _do_run())NotImplementedErrorra s r& r0 BaseS3TransferProcess._do_run s
!+..r+ )r, r@ ) r7 r8 r9 r: r5 r1 r0 r;
__classcell__r- s @r& r) r) s
"/ /r+ r) c X ^ \ rS rSrU 4S jrS rS rS rS rS r S r
S r S
r S r
U =r$ ) r i c ` > [ TU ] U5 Xl X0l X@l XPl X`l g)a Submit GetObjectJobs to fulfill a download file request
:param transfer_config: Configuration for transfers.
:param client_factory: ClientFactory for creating S3 clients.
:param transfer_monitor: Monitor for notifying and retrieving state
of transfer.
:param osutil: OSUtils object to use for os-related behavior when
performing the transfer.
:param download_request_queue: Queue to retrieve download file
requests.
:param worker_queue: Queue to submit GetObjectJobs for workers
to perform.
N)r+ r5 rA rL rF rD rE )r4 r r r r r r r- s r& r5 GetObjectSubmitter.__init__ s/ , ( / !1 '=$ )r+ c U R R 5 nU[ :X a [ R S5 g U R U5 MN ! [ ak n[ R SUUSS9 U R R UR U5 U R R UR 5 S nANrS nAff = f)NTz#Submitter shutdown signal received.zFException caught when submitting jobs for download file request %s: %sexc_info) rD r r rV rW _submit_get_object_jobs ExceptionrL r r r )r4 rZ es r& r0 GetObjectSubmitter._do_run s $($@$@$D$D$F !$7 BC
,,-BC
3) ! &&77)55q &&22)55
s A
CA!C Cc U R U5 nU R X5 nX R R : a U R X5 g U R XU5 g r! ) _get_size_allocate_temp_filerA r1 _submit_single_get_object_job _submit_ranged_get_object_jobsr4 rZ sizer s r& r> *GetObjectSubmitter._submit_get_object_jobs0 sZ ~~ 34 001FM
'';; ; . .%
/ /%d
r+ c UR nUc@ U R R " SUR UR S.UR
D6S nU$ )NBucketKey
ContentLengthr* )r r, head_objectr r r )r4 rZ r s r& rC GetObjectSubmitter._get_size< s` -;;
LL 4 4 ,33)-- (22 M
r+ c U R R UR 5 nU R R X25 U$ r! )rF get_temp_filenamer allocaterG s r& rD &GetObjectSubmitter._allocate_temp_fileF s9 66 ! * *
m2 r+ c
U R UR S5 U R UR UR UR USUR
UR S9 g )Nr r r r r r r r r )_notify_jobs_to_completer _submit_get_object_jobr r r r )r4 rZ r s r& rE 0GetObjectSubmitter._submit_single_get_object_jobM sa
%%&;&G&GK ##-99(//%))',77*33 $
r+ c z U R R n[ X45 nU R UR U5 [ U5 Ho nXd- n[
XFU5 nSU0n U R UR 5 U R UR UR UR UUU UR S9 Mq g )NRangerV )
rA r2 r rW r r r updater rX r r r )
r4 rZ r rH part_size num_partsir range_parameterget_object_kwargss
r& rF 1GetObjectSubmitter._submit_ranged_get_object_jobs[ s ))== '8 %% ! - -y
y!A]F 7i O ")/ : $ $%:%E%E F ' ' 1 = =,33)-- + ,.77
(
"r+ c L U R R [ S0 UD65 g )Nr* )rE rX r )r4 get_object_job_kwargss r& rX )GetObjectSubmitter._submit_get_object_jobt s | D.C DEr+ c h [ R SUU5 U R R X5 g )Nz3Notifying %s job(s) to complete for transfer_id %s.)rV rW rL r )r4 r r s r& rW +GetObjectSubmitter._notify_jobs_to_completew s0 A
??
r+ )rD rF rA rL rE )r7 r8 r9 r: r5 r0 r> rC rD rE rF rX rW r; r6 r7 s @r& r r s6 *:.
2F
r+ r c Z ^ \ rS rSrSrS\- rU 4S jrS rS r S r
S r S r S
r
S rU =r$ ) r i c T > [ TU ] U5 Xl X l X0l X@l g)a Fulfills GetObjectJobs
Downloads the S3 object, writes it to the specified file, and
renames the file to its final location if it completes the final
job for a particular transfer.
:param queue: Queue for retrieving GetObjectJob's
:param client_factory: ClientFactory for creating S3 clients
:param transfer_monitor: Monitor for notifying
:param osutil: OSUtils object to use for os-related behavior when
performing the transfer.
N)r+ r5 _queuer@ rL rF )r4 r r r r r- s r& r5 GetObjectWorker.__init__ s( ( - !1 r+ c U R R 5 nU[ :X a [ R S5 g U R
R
UR 5 ( d U R U5 O[ R SU5 U R
R UR 5 n[ R SUUR 5 U( d1 U R UR UR UR 5 GM
)Nz Worker shutdown signal received.zBSkipping get object job %s because there was a previous exception.z%%s jobs remaining for transfer_id %s.)
rl r r rV rW rL r r _run_get_object_jobr _finalize_downloadr r )r4 job remainings r& r0 GetObjectWorker._do_run s ++//#Co% ?@))77HH((- !
..BBI
LL7
''OOS%6%6 - r+ c 6 U R UR UR UR UR UR
S9 g ! [ aF n[ R SUUSS9 U R R UR U5 S nAg S nAff = f)N)r r r r r zBException caught when downloading object for get object job %s: %sTr< ) _do_get_objectr r r r r r? rV rW rL r r )r4 rq r@ s r& ro #GetObjectWorker._run_get_object_job s H zzGG ! / / >>zz
H LL(
" " 3 3COOQ G G Hs AA
B22 0
# :E&& !
"#
#s 3A
B(&BBc ^ ^ [ US5 nUR U5 [ UU 4S jS5 nU H nUR U5 M S S S 5 g ! , ( d f g = f)Nzrb+c : > T R TR 5 $ r! )read
_IO_CHUNKSIZE)bodyr4 s r& 0GetObjectWorker._write_to_file.. s $))D,>,>"?r+ r+ )openseekiterwrite)r4 r r r fchunkschunks ` ` r& r{ GetObjectWorker._write_to_file sH
(E
"a
FF6N?EF #
"
"s =A
A#c U R R U5 ( a U R R U5 OU R XU5 U R R U5 g r! )rL r rF remove_file_do_file_renamer )r4 r r r s r& rp "GetObjectWorker._finalize_download sO ! ! / / < < LL $ $] 3 X F **;7r+ c U R R X#5 g ! [ a@ nU R R X5 U R R U5 S nAg S nAff = fr! )rF rename_filer? rL r r )r4 r r r r@ s r& r GetObjectWorker._do_file_rename sR 4 LL $ $] = 4 " " 3 3K C LL $ $] 3 3 4s
A(6A##A()r@ rF rl rL )r7 r8 r9 r: ry r r r5 r0 ro ru r{ rp r r; r6 r7 s @r& r r s< MFM &6H&3* 84 4r+ r )8r collections
contextlibloggingrB r# rH copyr botocore.sessionr botocore.configr s3transfer.compatr r s3transfer.constantsr r r s3transfer.exceptionsr
r s3transfer.futuresr r
s3transfer.utilsr r r r r r getLoggerr7 rV r
namedtupler r contextmanagerr' r" r- r= r r r? r r r registerProcessr) r r r* r+ r& r sU un
" 1 N N F C
8 $
",,
%% " 3 3 8 ; ;,C CL-
2 -
`" . "*J J2]O ]O@-* -*` [ 1? C/O 3 3 /6D
. D
No4+ o4r+