U
e5dzn @ s d Z dZddlZddlZddlmZ ddlZddlmZ ddlZ ddl
Zddl m Z ddl
Z
ddlZddlmZ ddlZddlZddlZe ZdaG d d
d
Zd d Zd
ZdZG dd deZ G dd dZ dd Z G dd de Z G dd de Z!G dd de Z"G dd d e Z#d d Z$d d Z%d1d!d"Z&d#d$ Z'd%d& Z(d'd( Z)da*da+d)d* Z,d+d, Z-G d-d. d.ej.Z/G d/d0 d0ej0Z1e2e dS )2a- Implements ProcessPoolExecutor.
The following diagram and text describe the data-flow through the system:
|======================= In-process =====================|== Out-of-process ==|
+----------+ +----------+ +--------+ +-----------+ +---------+
| | => | Work Ids | | | | Call Q | | Process |
| | +----------+ | | +-----------+ | Pool |
| | | ... | | | | ... | +---------+
| | | 6 | => | | => | 5, call() | => | |
| | | 7 | | | | ... | | |
| Process | | ... | | Local | +-----------+ | Process |
| Pool | +----------+ | Worker | | #1..n |
| Executor | | Thread | | |
| | +----------- + | | +-----------+ | |
| | <=> | Work Items | <=> | | <= | Result Q | <= | |
| | +------------+ | | +-----------+ | |
| | | 6: call() | | | | ... | | |
| | | future | | | | 4, result | | |
| | | ... | | | | 3, except | | |
+----------+ +------------+ +--------+ +-----------+ +---------+
Executor.submit() called:
- creates a uniquely numbered _WorkItem and adds it to the "Work Items" dict
- adds the id of the _WorkItem to the "Work Ids" queue
Local worker thread:
- reads work ids from the "Work Ids" queue and looks up the corresponding
WorkItem from the "Work Items" dict: if the work item has been cancelled then
it is simply removed from the dict, otherwise it is repackaged as a
_CallItem and put in the "Call Q". New _CallItems are put in the "Call Q"
until "Call Q" is full. NOTE: the size of the "Call Q" is kept small because
calls placed in the "Call Q" can no longer be cancelled with Future.cancel().
- reads _ResultItems from "Result Q", updates the future stored in the
"Work Items" dict and deletes the dict entry
Process #1..n:
- reads _CallItems from "Call Q", executes the calls, and puts the resulting
_ResultItems in "Result Q"
z"Brian Quinlan (brian@sweetapp.com) N)_base)Full)Queue)partialFc @ s, e Zd Zdd Zdd Zdd Zdd Zd S )
_ThreadWakeupc C s t jdd\| _| _d S )NF)Zduplex)mpZPipe_reader_writerself r 2/usr/lib64/python3.8/concurrent/futures/process.py__init__R s z_ThreadWakeup.__init__c C s | j | j d S N)r closer r
r r r
r U s
z_ThreadWakeup.closec C s | j d d S )N )r Z
send_bytesr
r r r
wakeupY s z_ThreadWakeup.wakeupc C s | j r| j q d S r )r ZpollZ
recv_bytesr
r r r
clear\ s
z_ThreadWakeup.clearN)__name__
__module__ __qualname__r r r r r r r r
r Q s r c C s@ da tt } | D ]\}}| q| D ]\}}| q*d S NT)_global_shutdownlist_threads_wakeupsitemsr join)r _
thread_wakeuptr r r
_python_exita s
r = c @ s e Zd Zdd Zdd ZdS )_RemoteTracebackc C s
|| _ d S r tb)r r% r r r
r z s z_RemoteTraceback.__init__c C s | j S r r$ r
r r r
__str__| s z_RemoteTraceback.__str__N)r r r r r& r r r r
r# y s r# c @ s e Zd Zdd Zdd ZdS )_ExceptionWithTracebackc C s0 t t|||}d|}|| _d| | _d S )N z
"""
%s""") tracebackformat_exceptiontyper excr% )r r, r% r r r
r s
z _ExceptionWithTraceback.__init__c C s t | j| jffS r ) _rebuild_excr, r% r
r r r
__reduce__ s z"_ExceptionWithTraceback.__reduce__N)r r r r r. r r r r
r' s r' c C s t || _| S r )r# __cause__)r, r% r r r
r- s
r- c @ s e Zd Zdd ZdS ) _WorkItemc C s || _ || _|| _|| _d S r )futurefnargskwargs)r r1 r2 r3 r4 r r r
r s z_WorkItem.__init__Nr r r r r r r r
r0 s r0 c @ s e Zd ZdddZdS ) _ResultItemNc C s || _ || _|| _d S r )work_id exceptionresult)r r7 r8 r9 r r r
r s z_ResultItem.__init__)NNr5 r r r r
r6 s r6 c @ s e Zd Zdd ZdS ) _CallItemc C s || _ || _|| _|| _d S r )r7 r2 r3 r4 )r r7 r2 r3 r4 r r r
r s z_CallItem.__init__Nr5 r r r r
r: s r: c s. e Zd ZdZd fdd Z fddZ ZS )
_SafeQueuez=Safe Queue set exception to the future object linked to a jobr c s || _ t j||d d S )N)ctx)pending_work_itemssuperr )r max_sizer< r= __class__r r
r s z_SafeQueue.__init__c sl t |trZtt|||j}tdd||_ | j
|j d }|d k rh|j
| nt || d S )Nz
"""
{}"""r( )
isinstancer: r) r* r+
__traceback__r# formatr r/ r= popr7 r1
set_exceptionr> _on_queue_feeder_error)r eobjr% work_itemr@ r r
rG s
z!_SafeQueue._on_queue_feeder_error)r )r r r __doc__r rG
__classcell__r r r@ r
r; s r; c g s, t | }tt|| }|s dS |V qdS )z, Iterates over zip()ed iterables in chunks. N)ziptuple itertoolsislice) chunksize iterablesitchunkr r r
_get_chunks s
rU c s fdd|D S )z Processes a chunk of an iterable passed to map.
Runs the function passed to map() on a chunk of the
iterable passed to map.
This function is run in a separate process.
c s g | ] } | qS r r ).0r3 r2 r r
s z"_process_chunk..r )r2 rT r rW r
_process_chunk s rY c
C s^ z| t|||d W n@ tk
rX } z"t||j}| t||d W 5 d}~X Y nX dS )z.Safely send back the given result or exception)r9 r8 r8 N)putr6
BaseExceptionr' rC ) result_queuer7 r9 r8 rH r, r r r
_sendback_result s
r^ c
C s |dk r t k
r } z t ||j }t
||j|d W 5 d}~X Y nX t
||j|d ~~q, 6: <_WorkItem...>, ...}
work_ids: A queue.Queue of work ids e.g. Queue([5, 6, ...]). Work ids
are consumed and the corresponding _WorkItems from
pending_work_items are transformed into _CallItems and put in
call_queue.
call_queue: A multiprocessing.Queue that will be filled with _CallItems
derived from _WorkItems.
NFr` T) Zfullrb queueZEmptyr1 Z set_running_or_notify_cancelr[ r: r2 r3 r4 )r= Zwork_idsre r7 rJ r r r
_add_call_item_to_queue s"
rk c
sJ dfdd} fdd}|j } |j }
| |
g} t|| dd D } tj| | }
d}d}| |
krz| }d }W q tk
r } zt t
|||j }W 5 d}~X Y qX n|
|
krd }d}| |rl| dk rd
_
d_dtd }|dk r td d
| d|_| D ]\}}|j| ~q(| D ]}| qR| dS t|tr| st|}| s| dS nL|dk r||jd}|dk r|j r|j|j n|j |j ~~| | r@z&dk rd_|s&| W dS W n t k
r> Y nX dq2dS )a, Manages the communication between this process and the worker processes.
This function is run in a local thread.
Args:
executor_reference: A weakref.ref to the ProcessPoolExecutor that owns
this thread. Used to determine if the ProcessPoolExecutor has been
garbage collected and that this function can exit.
process: A list of the ctx.Process instances used as
workers.
pending_work_items: A dict mapping work ids to _WorkItems e.g.
{5: <_WorkItem...>, 6: <_WorkItem...>, ...}
work_ids_queue: A queue.Queue of work ids e.g. Queue([5, 6, ...]).
call_queue: A ctx.Queue that will be filled with _CallItems
derived from _WorkItems for processing by the process workers.
result_queue: A ctx.SimpleQueue of _ResultItems generated by the
process workers.
thread_wakeup: A _ThreadWakeup to allow waking up the
queue_manager_thread from the main Thread and avoid deadlocks
caused by permanently locked queues.
Nc s t p d kp jS r )r _shutdown_threadr )executorr r
shutting_down@ s z/_queue_management_worker..shutting_downc s t dd D } | }d}||k r| dkrt|| D ]6}z d |d7 }W q: tk
rn Y qrY q:X q:t dd D } q D ] }| qd S )Nc s s | ]}| V qd S r Zis_aliverV pr r r
F s zD_queue_management_worker..shutdown_worker..r r! c s s | ]}| V qd S r ro rp r r r
rr R s )sumvaluesrangeZ
put_nowaitr r r )Zn_children_aliveZn_children_to_stopZn_sentinels_sentirq )re processesr r
shutdown_workerD s
z1_queue_management_worker..shutdown_workerc S s g | ]
}|j qS r )sentinelrp r r r
rX i s z,_queue_management_worker..TFzKA child process terminated abruptly, the process pool is not usable anymorez^A process in the process pool was terminated abruptly while the future was running or pending.z
'''
r( z''') r rk rt r Z
connectionwaitZrecvr\ r) r* r+ rC r _brokenrl BrokenProcessPoolr# r r/ r r1 rF Z terminaterB intAssertionErrorrE r7 r8 Z
set_resultr9 r )Zexecutor_referencerw r= Zwork_ids_queuere r] r rn rx Z
result_readerZ
wakeup_readerZreadersZworker_sentinelsZreadycauseZ is_brokenZ result_itemrH Zbper7 rJ rq r )re rm rw r
_queue_management_worker" s (
r c C sj t rtrttda ztd} W n ttfk
r< Y d S X | dkrJd S | dkrVd S d| attd S )NTSC_SEM_NSEMS_MAX z@system provides too few semaphores (%d available, 256 necessary))_system_limits_checked_system_limitedNotImplementedErrorrc sysconfAttributeError
ValueError)Z nsems_maxr r r
_check_system_limits s r c c s& | D ] }| |r| V qqdS )z
Specialized implementation of itertools.chain.from_iterable.
Each item in *iterable* should be a list. This function is
careful not to keep references to yielded objects.
N)reverserE )iterableZelementr r r
_chain_from_iterable_of_lists s r c @ s e Zd ZdZdS )r| zy
Raised when a process in a ProcessPoolExecutor terminated abruptly
while a future was in the running state.
N)r r r rK r r r r
r| s r| c st e Zd ZdddZdd Zdd Zd d
Zejjj e_ ejjj
e_
dd d fd
d
Z dddZ ejj j
e _
Z
S )ProcessPoolExecutorNr c C s t |dkr6t pd| _tjdkrntt| j| _n8|dkrHtdn tjdkrh|tkrhtdt || _|dkr~t
}|| _ |dk rt |st
d|| _|| _d| _i | _d| _t | _d| _d| _i | _| jt }t|| j | jd | _d
| j_ | | _ t | _!t" | _#dS ) aS Initializes a new ProcessPoolExecutor instance.
Args:
max_workers: The maximum number of processes that can be used to
execute the given calls. If None or not given then as many
worker processes will be created as the machine has processors.
mp_context: A multiprocessing context to launch the workers. This
object should provide SimpleQueue, Queue and Process.
initializer: A callable used to initialize worker processes.
initargs: A tuple of arguments to pass to the initializer.
Nr! Zwin32r z"max_workers must be greater than 0zmax_workers must be <= z initializer must be a callableF)r? r< r= T)$r rc cpu_count _max_workerssysplatformmin_MAX_WINDOWS_WORKERSr r Z get_context _mp_contextcallable TypeError _initializer _initargs_queue_management_thread
_processesrl threadingZLock_shutdown_lockr{ _queue_count_pending_work_itemsEXTRA_QUEUED_CALLSr; _call_queueZ
_ignore_epipeZ SimpleQueue
_result_queuerj r _work_idsr _queue_management_thread_wakeup)r Z max_workersZ
mp_contextrf rg Z
queue_sizer r r
r sP
z ProcessPoolExecutor.__init__c C sv | j d krr| jfdd}| tjtt| || j| j | j
| j | j | jfdd| _ d| j _
| j | jt| j < d S )Nc S s t jd | d S )Nz?Executor collected: triggering callback for QueueManager wakeup)r utildebugr )r r r r r
weakref_cbB s zFProcessPoolExecutor._start_queue_management_thread..weakref_cbZQueueManagerThread)targetr3 nameT)r r _adjust_process_countr ZThreadr weakrefrefr r r r r Zdaemonstartr )r r r r r
_start_queue_management_thread= s(
z2ProcessPoolExecutor._start_queue_management_threadc C sP t t| j| jD ]8}| jjt| j| j| j | j
fd}| || j|j < qd S )N)r r3 )
ru lenr r r ZProcessri r r r r r pid)r r rq r r r
r X s z)ProcessPoolExecutor._adjust_process_countc
O s
t | dkr| ^}}} nV| s&tdnHd|krZ|d}| ^}} dd l}|jdtdd ntdt | d |j |jrt|j|j rt
d t rt
d
t
}t||| |}||j|j< |j|j | jd7 _|j | |W 5 Q R S Q R X d S ) N zEdescriptor 'submit' of 'ProcessPoolExecutor' object needs an argumentr2 r z.Passing 'fn' as keyword argument is deprecated)
stacklevelz6submit expected at least 1 positional argument, got %dr! z*cannot schedule new futures after shutdownz6cannot schedule new futures after interpreter shutdown)r r rE warningswarnDeprecationWarningr r{ r| rl RuntimeErrorr r ZFuturer0 r r r r[ r r r )r3 r4 r r2 r fwr r r
submitc s<
zProcessPoolExecutor.submitr! )timeoutrQ c s: |dk rt dt jtt|t|d|i|d}t|S )aj Returns an iterator equivalent to map(fn, iter).
Args:
fn: A callable that will take as many arguments as there are
passed iterables.
timeout: The maximum number of seconds to wait. If None, then there
is no limit on the wait time.
chunksize: If greater than one, the iterables will be chopped into
chunks of size chunksize and submitted to the process pool.
If set to one, the items in the list will be sent one at a time.
Returns:
An iterator equivalent to: map(func, *iterables) but the calls may
be evaluated out-of-order.
Raises:
TimeoutError: If the entire result iterator could not be generated
before the given timeout.
Exception: If fn(*args) raises for any values.
r! zchunksize must be >= 1.rQ )r )r r> mapr rY rU r )r r2 r rQ rR Zresultsr@ r r
r s zProcessPoolExecutor.mapTc C s | j d| _W 5 Q R X | jr6| j |r6| j d | _| jd k rd| j |r^| j d | _d | _ d | _
| jr| j d | _d S r ) r rl r r r r r r Z join_threadr r )r rz r r r
shutdown s"
z ProcessPoolExecutor.shutdown)NNNr )T)r r r r r r r r Executor__text_signature__rK r r rL r r r@ r
r s
K $
r )NN)3rK
__author__atexitrc Zconcurrent.futuresr rj r Zmultiprocessingr Zmultiprocessing.connectionZmultiprocessing.queuesr r r functoolsr rO r r) WeakKeyDictionaryr r r r r r Exceptionr# r' r- objectr0 r6 r: r; rU rY r^ ri rk r r r r r ZBrokenExecutorr| r r registerr r r r
sV *
)& ! P