Содержание страницы
17.2. multiprocessing – Параллелизм на основе процессов¶multiprocessing – Process-based parallelism
Исходный код: Lib/multiprocessing/
17.2.1. Введение¶Introduction
multiprocessing – это пакет, который поддерживает порождение процессов с помощью
API, похожего на модуль threading. Пакет multiprocessing
обеспечивает как локальный, так и удалённый параллелизм, эффективно обходя
Глобальную блокировку интерпретатора, используя подпроцессы вместо потоков. Благодаря
этому модуль multiprocessing позволяет программисту полностью
использовать несколько процессоров на данной машине. Он работает как на Unix, так и
на Windows.
Модуль multiprocessing также предоставляет API, у которых нет
аналогов в модуле threading. Яркий пример – объект Pool, который предоставляет удобный способ
распараллеливания выполнения функции для нескольких входных значений,
распределяя входные данные между процессами (параллелизм данных). Следующий
пример демонстрирует обычную практику определения таких функций в модуле,
чтобы дочерние процессы могли успешно импортировать этот модуль. Этот базовый пример
параллелизма данных с использованием Pool,
from multiprocessing import Pool
def f(x):
return x*x
if __name__ == '__main__':
with Pool(5) as p:
print(p.map(f, [1, 2, 3]))
будет выводить на стандартный вывод
[1, 4, 9]
17.2.1.1. Класс Process¶The Process class
В multiprocessing процессы порождаются созданием объекта Process
и последующим вызовом его метода start(). Process
следует API threading.Thread. Простой пример многопроцессной программы:
from multiprocessing import Process
def f(name):
print('hello', name)
if __name__ == '__main__':
p = Process(target=f, args=('bob',))
p.start()
p.join()
Чтобы показать идентификаторы задействованных процессов, вот расширенный пример:
from multiprocessing import Process
import os
def info(title):
print(title)
print('module name:', __name__)
print('parent process:', os.getppid())
print('process id:', os.getpid())
def f(name):
info('function f')
print('hello', name)
if __name__ == '__main__':
info('main line')
p = Process(target=f, args=('bob',))
p.start()
p.join()
Объяснение того, зачем нужна часть if __name__ == '__main__',
см. в руководстве по программированию.
17.2.1.2. Контексты и методы запуска¶Contexts and start methods
В зависимости от платформы multiprocessing поддерживает три способа
запуска процесса. Эти методы запуска:
- spawn
Родительский процесс запускает новый процесс интерпретатора Python. Дочерний процесс наследует только те ресурсы, которые необходимы для запуска метода
run()объектов процесса. В частности, ненужные файловые дескрипторы и дескрипторы (handles) родительского процесса не наследуются. Запуск процесса с помощью этого метода довольно медленный по сравнению с использованием fork или forkserver.Доступен на Unix и Windows. По умолчанию на Windows.
- fork
Родительский процесс использует
os.fork()для форка интерпретатора Python. Дочерний процесс в начале своего выполнения фактически идентичен родительскому процессу. Все ресурсы родительского процесса наследуются дочерним процессом. Обратите внимание, что безопасный форк многопоточного процесса проблематичен.Доступно только на Unix. По умолчанию используется на Unix.
- forkserver
Когда программа запускается и выбирает метод запуска forkserver, запускается серверный процесс. После этого каждый раз, когда требуется новый процесс, родительский процесс подключается к серверу и запрашивает создание (fork) нового процесса. Серверный процесс (fork server) является однопоточным, поэтому ему безопасно использовать
os.fork(). Ненужные ресурсы не наследуются.Доступно на платформах Unix, которые поддерживают передачу файловых дескрипторов через каналы Unix.
Изменено в версии 3.4: spawn добавлен на всех платформах Unix, а forkserver добавлен для некоторых платформ Unix. Дочерние процессы больше не наследуют все наследуемые дескрипторы родительского процесса в Windows.
На Unix при использовании методов запуска spawn или forkserver также запускается процесс отслеживатель семафоров, который отслеживает именованные семафоры, созданные процессами программы и оставшиеся без связи. Когда все процессы завершатся, отслеживатель семафоров удаляет все оставшиеся семафоры. Обычно их быть не должно, но если процесс был убит сигналом, могут остаться «утекшие» семафоры. (Удаление именованных семафоров – серьёзное дело, поскольку система допускает лишь ограниченное количество, и они не будут автоматически удалены до следующей перезагрузки.)
Для выбора метода запуска используется set_start_method() в
блоке if __name__ == '__main__' главного модуля. Например:
import multiprocessing as mp
def foo(q):
q.put('hello')
if __name__ == '__main__':
mp.set_start_method('spawn')
q = mp.Queue()
p = mp.Process(target=foo, args=(q,))
p.start()
print(q.get())
p.join()
set_start_method() не должен использоваться более одного раза в
программе.
В качестве альтернативы можно использовать get_context() для получения объекта
контекста. Объекты контекста имеют тот же API, что и модуль multiprocessing,
и позволяют использовать несколько методов запуска в одной
программе.
import multiprocessing as mp
def foo(q):
q.put('hello')
if __name__ == '__main__':
ctx = mp.get_context('spawn')
q = ctx.Queue()
p = ctx.Process(target=foo, args=(q,))
p.start()
print(q.get())
p.join()
Обратите внимание: объекты, связанные с одним контекстом, могут быть несовместимы с процессами другого контекста. В частности, блокировки, созданные с помощью контекста fork, нельзя передавать процессам, запущенным с помощью методов запуска spawn или forkserver.
Библиотека, которая хочет использовать определённый метод запуска, вероятно, должна
использовать get_context(), чтобы не мешать выбору
пользователя библиотеки.
17.2.1.3. Обмен объектами между процессами¶Exchanging objects between processes
multiprocessing поддерживает два типа каналов связи между
процессами:
Очереди
Класс
Queueявляется почти точной копиейqueue.Queue. Например:from multiprocessing import Process, Queue def f(q): q.put([42, None, 'hello']) if __name__ == '__main__': q = Queue() p = Process(target=f, args=(q,)) p.start() print(q.get()) # печатает "[42, None, 'hello']" p.join()Очереди потокобезопасны и безопасны для процессов.
Каналы
Функция
Pipe()возвращает пару объектов соединения, связанных каналом, который по умолчанию является дуплексным (двунаправленным). Например:from multiprocessing import Process, Pipe def f(conn): conn.send([42, None, 'hello']) conn.close() if __name__ == '__main__': parent_conn, child_conn = Pipe() p = Process(target=f, args=(child_conn,)) p.start() print(parent_conn.recv()) # печатает "[42, None, 'hello']" p.join()Два объекта соединения, возвращаемые
Pipe(), представляют два конца канала. Каждый объект соединения имеет методыsend()иrecv()(среди прочих). Обратите внимание: данные в канале могут быть повреждены, если два процесса (или потока) попытаются одновременно читать или писать в один и тот же конец канала. Разумеется, нет риска повреждения, если процессы одновременно используют разные концы канала.
17.2.1.4. Синхронизация между процессами¶Synchronization between processes
multiprocessing содержит эквиваленты всех примитивов синхронизации
из threading. Например, можно использовать блокировку, чтобы гарантировать,
что только один процесс одновременно выводит на стандартный вывод:
from multiprocessing import Process, Lock
def f(l, i):
l.acquire()
try:
print('hello world', i)
finally:
l.release()
if __name__ == '__main__':
lock = Lock()
for num in range(10):
Process(target=f, args=(lock, num)).start()
Без использования блокировки вывод от разных процессов может полностью перепутаться.
17.2.1.6. Использование пула процессов¶Using a pool of workers
Класс Pool представляет пул рабочих
процессов. Он имеет методы, которые позволяют передавать задачи рабочим
процессам несколькими различными способами.
Например:
from multiprocessing import Pool, TimeoutError
import time
import os
def f(x):
return x*x
if __name__ == '__main__':
# запустить 4 рабочих процесса
with Pool(processes=4) as pool:
# печатает "[0, 1, 4,..., 81]"
print(pool.map(f, range(10)))
# печатает те же числа в произвольном порядке
for i in pool.imap_unordered(f, range(10)):
print(i)
# вычисляет "f(20)" асинхронно
res = pool.apply_async(f, (20,)) # выполняется *только* в одном процессе
print(res.get(timeout=1)) # печатает "400"
# вычисляет "os.getpid()" асинхронно
res = pool.apply_async(os.getpid, ()) # выполняется *только* в одном процессе
print(res.get(timeout=1)) # печатает PID этого процесса
# запуск нескольких асинхронных вычислений *может* задействовать больше процессов
multiple_results = [pool.apply_async(os.getpid, ()) for i in range(4)]
print([res.get(timeout=1) for res in multiple_results])
# заставить один рабочий процесс спать 10 секунд
res = pool.apply_async(time.sleep, (10,))
try:
print(res.get(timeout=1))
except TimeoutError:
print("We lacked patience and got a multiprocessing.TimeoutError")
print("For the moment, the pool remains available for more work")
# выход из блока 'with' остановил пул
print("Now the pool is closed and no longer available")
Обратите внимание: методы пула должны использоваться только тем процессом, который его создал.
Примечание
Для функциональности этого пакета требуется, чтобы модуль __main__ был
импортируемым дочерними процессами. Это описано в Рекомендациях по программированию,
но стоит упомянуть об этом и здесь. Это означает, что некоторые примеры, такие
как примеры multiprocessing.pool.Pool, не будут работать в
интерактивном интерпретаторе. Например:
>>> from multiprocessing import Pool
>>> p = Pool(5)
>>> def f(x):
... return x*x
...
>>> p.map(f, [1,2,3])
Process PoolWorker-1:
Process PoolWorker-2:
Process PoolWorker-3:
Traceback (most recent call last):
Traceback (most recent call last):
Traceback (most recent call last):
AttributeError: 'module' object has no attribute 'f'
AttributeError: 'module' object has no attribute 'f'
AttributeError: 'module' object has no attribute 'f'
(Если попробовать это сделать, на самом деле будут выведены три полные трассировки стека, перемешанные в полу-случайном порядке, и затем, возможно, придётся как-то остановить главный процесс.)
17.2.2. Справочник¶Reference
Пакет multiprocessing в основном повторяет API модуля
threading.
17.2.2.1. Process и исключения¶Process and exceptions
-
class
multiprocessing.Process(group=None, target=None, name=None, args=(), kwargs={}, *, daemon=None)¶ Объекты Process представляют активность, выполняемую в отдельном процессе. Класс
Processимеет эквиваленты всех методовthreading.Thread.Конструктор всегда следует вызывать с именованными аргументами. group всегда должен быть
None; он существует только для совместимости сthreading.Thread. target – это вызываемый объект, который будет вызван методомrun(). По умолчаниюNone, то есть ничего не вызывается. name – это имя процесса (см.nameдля подробностей). args – кортеж аргументов для вызова целевой функции. kwargs – это словарь именованных аргументов для вызова целевой функции. Если указан, аргумент только по ключевому слову daemon устанавливает флаг процессаdaemonвTrueилиFalse. ЕслиNone(по умолчанию), этот флаг будет унаследован от создающего процесса.По умолчанию в target не передаётся никаких аргументов.
Если подкласс переопределяет конструктор, он должен вызывать конструктор базового класса (
Process.__init__()) перед любыми другими действиями над процессом.Изменено в версии 3.3: Добавлен аргумент daemon.
-
run()¶ Метод, представляющий активность процесса.
Этот метод можно переопределить в подклассе. Стандартный метод
run()вызывает вызываемый объект, переданный конструктору объекта в качестве аргумента target, если он есть, с позиционными и именованными аргументами, взятыми из аргументов args и kwargs соответственно.
-
start()¶ Запускает активность процесса.
Этот метод должен быть вызван не более одного раза для каждого объекта процесса. Он обеспечивает вызов метода
run()объекта в отдельном процессе.
-
join([timeout])¶ Если необязательный аргумент timeout равен
None(по умолчанию), метод блокируется до завершения процесса, у которого вызывается методjoin(). Если timeout – положительное число, блокировка длится не более timeout секунд. Обратите внимание: метод возвращаетNone, если процесс завершился или истекло время ожидания. Проверьтеexitcodeпроцесса, чтобы определить, завершился ли он.Процесс может быть присоединён много раз.
Процесс не может присоединить сам себя, так как это приведёт к взаимоблокировке. Попытка вызвать join для процесса до его запуска является ошибкой.
-
name¶ Имя процесса. Имя – это строка, используемая только для идентификации. Оно не имеет семантического значения. Несколько процессов могут иметь одно и то же имя.
Начальное имя устанавливается конструктором. Если явное имя не передано конструктору, создаётся имя вида ‘Process-N1:N2:…:Nk’, где каждая Nk – это N-й дочерний процесс своего родителя.
-
is_alive()¶ Возвращает, жив ли процесс.
Грубо говоря, объект процесса живёт с момента возврата метода
start()до завершения дочернего процесса.
-
daemon¶ Флаг демона процесса (логическое значение). Должен быть установлен до вызова
start().Начальное значение наследуется от создающего процесса.
Когда процесс завершается, он пытается завершить все свои дочерние процессы-демоны.
Обратите внимание, что процессу-демону не разрешается создавать дочерние процессы. Иначе процесс-демон оставил бы своих потомков осиротевшими, если бы он был завершён при выходе своего родительского процесса. Кроме того, это не демоны или службы Unix, а обычные процессы, которые будут завершены (и не присоединены), если не-демонические процессы завершились.
В дополнение к API
threading.ThreadобъектыProcessтакже поддерживают следующие атрибуты и методы:-
pid¶ Возвращает идентификатор процесса. До запуска процесса это будет
None.
-
exitcode¶ Код завершения дочернего процесса. Он будет равен
None, если процесс ещё не завершён. Отрицательное значение -N означает, что дочерний процесс был завершён сигналом N.
-
authkey¶ Ключ аутентификации процесса (байтовая строка).
При инициализации
multiprocessingглавному процессу назначается случайная строка с помощьюos.urandom().При создании объекта
Processон наследует ключ аутентификации своего родительского процесса, хотя его можно изменить, установивauthkeyв другую байтовую строку.См. Ключи аутентификации.
-
sentinel¶ Числовой дескриптор системного объекта, который становится «готов» по завершении процесса.
Это значение можно использовать для ожидания нескольких событий одновременно с помощью
multiprocessing.connection.wait(). В противном случае вызовjoin()проще.В Windows это дескриптор ОС, который можно использовать с семейством
WaitForSingleObjectиWaitForMultipleObjectsвызовов API. В Unix это файловый дескриптор, который можно использовать с примитивами из модуляselect.Новое в версии 3.3.
-
terminate()¶ Завершает процесс. На Unix это делается с помощью сигнала
SIGTERM; на Windows используетсяTerminateProcess(). Обратите внимание, что обработчики выхода и блоки finally и т.д. выполняться не будут.Обратите внимание, что процессы-потомки не будут завершены – они просто станут осиротевшими.
Предупреждение
Если этот метод используется, когда связанный процесс использует канал или очередь, то канал или очередь могут быть повреждены и стать непригодными для использования другими процессами. Аналогично, если процесс захватил блокировку или семафор и т.п., то его завершение может привести к взаимной блокировке других процессов.
Обратите внимание: методы
start(),join(),is_alive(),terminate()иexitcodeдолжны вызываться только тем процессом, который создал объект процесса.Пример использования некоторых методов
Process:>>> import multiprocessing, time, signal >>> p = multiprocessing.Process(target=time.sleep, args=(1000,)) >>> print(p, p.is_alive()) <Process(Process-1, initial)> False >>> p.start() >>> print(p, p.is_alive()) <Process(Process-1, started)> True >>> p.terminate() >>> time.sleep(0.1) >>> print(p, p.is_alive()) <Process(Process-1, stopped[SIGTERM])> False >>> p.exitcode == -signal.SIGTERM True
-
-
exception
multiprocessing.ProcessError¶ Базовый класс всех исключений
multiprocessing.
-
exception
multiprocessing.BufferTooShort¶ Исключение, возбуждаемое
Connection.recv_bytes_into(), когда предоставленный буфер слишком мал для чтения сообщения.Если
eявляется экземпляромBufferTooShort, тоe.args[0]вернёт сообщение в виде байтовой строки.
-
exception
multiprocessing.AuthenticationError¶ Возбуждается при ошибке аутентификации.
-
exception
multiprocessing.TimeoutError¶ Возбуждается методами с тайм-аутом по истечении тайм-аута.
17.2.2.2. Каналы и очереди¶Pipes and Queues
При использовании нескольких процессов обычно применяется передача сообщений для взаимодействия между процессами, что позволяет избежать использования примитивов синхронизации, таких как блокировки.
Для передачи сообщений можно использовать Pipe() (для соединения между двумя процессами) или очередь (которая допускает несколько производителей и потребителей).
Типы Queue, SimpleQueue и JoinableQueue – это очереди с несколькими производителями и потребителями, работающие по принципу FIFO
и созданные по образцу класса queue.Queue из стандартной библиотеки. Они отличаются тем, что в Queue отсутствуют методы task_done() и join(), введённые в класс queue.Queue в Python 2.5.
Если используется JoinableQueue, то обязательно вызывайте JoinableQueue.task_done() для каждой задачи, извлечённой из очереди; в противном случае семафор, используемый для подсчёта незавершённых задач, может переполниться, что приведёт к возбуждению исключения.
Обратите внимание, что общую очередь также можно создать с помощью объекта-менеджера – см. Менеджеры.
Примечание
multiprocessing использует обычные исключения queue.Empty и queue.Full для сигнализации тайм-аута. Они недоступны в пространстве имён multiprocessing, поэтому их необходимо импортировать из queue.
Примечание
Когда объект помещается в очередь, он сериализуется с помощью модуля pickle, и фоновый поток позднее сбрасывает сериализованные данные в нижележащий канал. Это имеет некоторые неожиданные последствия, но обычно не вызывает практических трудностей – если это действительно беспокоит, можно вместо этого использовать очередь, созданную с помощью менеджера.
После помещения объекта в пустую очередь может пройти бесконечно малая задержка, прежде чем метод
empty()очереди вернётFalseиget_nowait()сможет вернуться без возбужденияqueue.Empty.Если несколько процессов помещают объекты в очередь, возможно получение объектов на другом конце не по порядку. Однако объекты, помещённые в очередь одним и тем же процессом, всегда будут идти друг за другом в ожидаемом порядке.
Предупреждение
Если процесс завершается принудительно с помощью Process.terminate() или os.kill() в то время, как он пытается использовать Queue, данные в очереди могут быть повреждены. Это может привести к тому, что любой другой процесс при попытке использовать очередь получит исключение.
Предупреждение
Как упоминалось выше, если дочерний процесс поместил элементы в очередь (и не использовал JoinableQueue.cancel_join_thread), он не завершится, пока все буферизованные элементы не будут сброшены в канал.
Это означает, что при попытке присоединиться к этому процессу может возникнуть взаимоблокировка, если не быть уверенным, что все помещённые в очередь элементы были потреблены. Аналогично, если дочерний процесс не является демоническим, родительский процесс может зависнуть при завершении, когда попытается присоединиться ко всем своим недемоническим потомкам.
Обратите внимание, что очередь, созданная с помощью менеджера, не имеет этой проблемы. См. Рекомендации по программированию.
Пример использования очередей для межпроцессного взаимодействия см. в разделе Примеры.
-
multiprocessing.Pipe([duplex])¶ Возвращает пару
(conn1, conn2)объектовConnection, представляющих концы канала.Если duplex равно
True(по умолчанию), то канал двунаправленный. Если duplex равноFalse, то канал однонаправленный:conn1можно использовать только для получения сообщений, аconn2– только для отправки.
-
class
multiprocessing.Queue([maxsize])¶ Возвращает общедоступную очередь для процессов, реализованную с помощью канала и нескольких блокировок/семафоров. Когда процесс впервые помещает элемент в очередь, запускается поток-загрузчик, который передаёт объекты из буфера в канал.
Обычные исключения
queue.Emptyиqueue.Fullиз модуляqueueстандартной библиотеки возбуждаются для сигнализации тайм-аутов.Queueреализует все методыqueue.Queue, за исключениемtask_done()иjoin().-
qsize()¶ Возвращает приблизительный размер очереди. Из-за семантики многопоточности/многопроцессности это число не является надёжным.
Обратите внимание, что это может вызвать
NotImplementedErrorна Unix-платформах, таких как Mac OS X, гдеsem_getvalue()не реализован.
-
empty()¶ Возвращает
True, если очередь пуста, иначеFalse. Из-за семантики многопоточности/многопроцессности это ненадёжно.
-
full()¶ Возвращает
True, если очередь заполнена, иначеFalse. Из-за семантики многопоточности/многопроцессности это ненадёжно.
-
put(obj[, block[, timeout]])¶ Помещает obj в очередь. Если необязательный аргумент block равен
True(по умолчанию) и timeout равенNone(по умолчанию), при необходимости блокируется до появления свободного места. Если timeout положительное число, блокируется не более чем на timeout секунд и возбуждает исключениеqueue.Full, если за это время свободное место не появилось. В противном случае (block равенFalse) помещает элемент в очередь, если свободное место доступно немедленно, иначе возбуждает исключениеqueue.Full(timeout в этом случае игнорируется).
-
put_nowait(obj)¶ Эквивалентно
put(obj, False).
-
get([block[, timeout]])¶ Удаляет и возвращает элемент из очереди. Если необязательный аргумент block равен
True(по умолчанию) и timeout равенNone(по умолчанию), при необходимости блокируется до появления элемента. Если timeout положительное число, блокируется не более чем на timeout секунд и возбуждает исключениеqueue.Empty, если за это время элемент не появился. В противном случае (block равенFalse) возвращает элемент, если он доступен немедленно, иначе возбуждает исключениеqueue.Empty(timeout в этом случае игнорируется).
-
get_nowait()¶ Эквивалентно
get(False).
multiprocessing.Queueимеет несколько дополнительных методов, отсутствующих вqueue.Queue. Обычно эти методы не нужны в большинстве кода:-
close()¶ Указывает, что текущий процесс больше не будет помещать данные в эту очередь. Фоновый поток завершится после того, как сбросит все буферизованные данные в канал. Этот метод вызывается автоматически при сборке мусора очереди.
-
join_thread()¶ Присоединяет фоновый поток. Этот метод можно использовать только после вызова
close(). Он блокируется до завершения фонового потока, гарантируя, что все данные из буфера сброшены в канал.По умолчанию, если процесс не является создателем очереди, при завершении он попытается присоединить фоновый поток очереди. Процесс может вызвать
cancel_join_thread(), чтобы сделатьjoin_thread()бездействующим.
-
cancel_join_thread()¶ Предотвращает блокировку
join_thread(). В частности, это предотвращает автоматическое присоединение фонового потока при завершении процесса – см.join_thread().Более подходящим именем для этого метода могло бы быть
allow_exit_without_flush(). Он, скорее всего, приведёт к потере поставленных в очередь данных, и почти наверняка вам не понадобится его использовать. Он нужен только в том случае, если текущий процесс должен немедленно завершиться, не дожидаясь сброса поставленных в очередь данных в нижележащий канал, и вас не волнует потеря данных.
Примечание
Функциональность этого класса требует работающей реализации общего семафора в хост-операционной системе. Без неё функциональность класса будет отключена, а попытки создать экземпляр
Queueприведут кImportError. См. bpo-3770 для дополнительной информации. То же самое относится и ко всем специализированным типам очередей, перечисленным ниже.-
-
class
multiprocessing.SimpleQueue¶ Это упрощённый тип
Queue, очень похожий наPipeс блокировкой.-
empty()¶ Возвращает
True, если очередь пуста, иначеFalse.
-
get()¶ Извлекает и возвращает элемент из очереди.
-
put(item)¶ Помещает item в очередь.
-
-
class
multiprocessing.JoinableQueue([maxsize])¶ JoinableQueue, подклассQueue, – это очередь, которая дополнительно имеет методыtask_done()иjoin().-
task_done()¶ Указывает, что ранее поставленная в очередь задача завершена. Используется потребителями очереди. Для каждого
get(), используемого для получения задачи, последующий вызовtask_done()сообщает очереди, что обработка задачи завершена.Если
join()в данный момент заблокирован, он возобновится, когда все элементы будут обработаны (то есть для каждого элемента, который былput()в очередь, был получен вызовtask_done()).Вызывает
ValueError, если вызывается больше раз, чем было помещено элементов в очередь.
-
join()¶ Блокируется до тех пор, пока все элементы в очереди не будут извлечены и обработаны.
Счётчик незавершённых задач увеличивается каждый раз, когда элемент добавляется в очередь. Счётчик уменьшается, когда потребитель вызывает
task_done(), чтобы указать, что элемент извлечён и вся работа над ним завершена. Когда счётчик незавершённых задач падает до нуля,join()разблокируется.
-
17.2.2.3. Разное¶Miscellaneous
-
multiprocessing.active_children()¶ Возвращает список всех активных дочерних процессов текущего процесса.
Вызов этой функции имеет побочный эффект – «присоединение» всех уже завершённых процессов.
-
multiprocessing.cpu_count()¶ Возвращает количество процессоров в системе.
Это число не равно количеству процессоров, которые текущий процесс может использовать. Количество доступных процессоров можно получить с помощью
len(os.sched_getaffinity(0))Может вызвать
NotImplementedError.См. также
-
multiprocessing.current_process()¶ Возвращает объект
Process, соответствующий текущему процессу.Аналог
threading.current_thread().
-
multiprocessing.freeze_support()¶ Добавляет поддержку для случая, когда программа, использующая
multiprocessing, была заморожена для создания исполняемого файла Windows. (Протестировано с py2exe, PyInstaller и cx_Freeze.)Эту функцию необходимо вызвать сразу после строки
if __name__ == '__main__'в главном модуле. Например:from multiprocessing import Process, freeze_support def f(): print('hello world!') if __name__ == '__main__': freeze_support() Process(target=f).start()
Если строка
freeze_support()опущена, то попытка запустить замороженный исполняемый файл вызоветRuntimeError.Вызов
freeze_support()не имеет эффекта при запуске на любой операционной системе, кроме Windows. Кроме того, если модуль запускается обычным образом интерпретатором Python в Windows (программа не была заморожена), тоfreeze_support()также не имеет эффекта.
-
multiprocessing.get_all_start_methods()¶ Возвращает список поддерживаемых методов запуска, первый из которых является методом по умолчанию. Возможными методами запуска являются
'fork','spawn'и'forkserver'. В Windows доступен только'spawn'. В Unix'fork'и'spawn'всегда поддерживаются, причём'fork'используется по умолчанию.Новое в версии 3.4.
-
multiprocessing.get_context(method=None)¶ Возвращает объект контекста, который имеет те же атрибуты, что и модуль
multiprocessing.Если method равен
None, то возвращается контекст по умолчанию. В противном случае method должен быть'fork','spawn','forkserver'.ValueErrorвызывается, если указанный метод запуска недоступен.Новое в версии 3.4.
-
multiprocessing.get_start_method(allow_none=False)¶ Возвращает имя метода запуска, используемого для запуска процессов.
Если метод запуска не был задан и allow_none равен false, то метод запуска фиксируется как используемый по умолчанию, и возвращается его название. Если метод запуска не был задан и allow_none равен true, то возвращается
None.Возвращаемое значение может быть
'fork','spawn','forkserver'илиNone.'fork'– значение по умолчанию на Unix, а'spawn'– значение по умолчанию на Windows.Новое в версии 3.4.
-
multiprocessing.set_executable()¶ Устанавливает путь к интерпретатору Python, используемому при запуске дочернего процесса. (По умолчанию используется
sys.executable). Встраивающим пользователям, вероятно, потребуется сделать что-то вродеset_executable(os.path.join(sys.exec_prefix, 'pythonw.exe'))
прежде чем они смогут создавать дочерние процессы.
Изменено в версии 3.4: Теперь поддерживается в Unix при использовании метода запуска
'spawn'.
-
multiprocessing.set_start_method(method)¶ Задаёт метод, который будет использоваться для запуска дочерних процессов. method может быть
'fork','spawn'или'forkserver'.Обратите внимание, что эта функция должна вызываться не более одного раза, и она должна быть защищена внутри блока
if __name__ == '__main__'главного модуля.Новое в версии 3.4.
Примечание
multiprocessing не содержит аналогов
threading.active_count(), threading.enumerate(),
threading.settrace(), threading.setprofile(),
threading.Timer или threading.local.
17.2.2.4. Объекты соединений¶Connection Objects
Объекты подключения позволяют отправлять и получать сериализуемые (picklable) объекты или строки. Их можно рассматривать как ориентированные на сообщения соединённые сокеты.
Объекты подключения обычно создаются с помощью
Pipe – см. также
Слушатели и клиенты.
-
class
multiprocessing.connection.Connection¶ -
send(obj)¶ Отправляет объект на другой конец подключения; его следует читать с помощью
recv().Объект должен быть сериализуемым. Очень большие сериализованные объекты (примерно 32 МБ+, хотя это зависит от ОС) могут вызвать исключение
ValueError.
-
recv()¶ Возвращает объект, отправленный с другого конца подключения с помощью
send(). Блокируется, пока не появятся данные для получения. ВызываетEOFError, если больше нечего получать и другой конец был закрыт.
-
fileno()¶ Возвращает файловый дескриптор или дескриптор (handle), используемый подключением.
-
close()¶ Закрывает подключение.
Вызывается автоматически при сборке мусора для подключения.
-
poll([timeout])¶ Возвращает, есть ли данные для чтения.
Если timeout не указан, то метод возвращается немедленно. Если timeout – число, то оно задаёт максимальное время блокировки в секундах. Если timeout равно
None, то используется бесконечное ожидание.Обратите внимание: с помощью
multiprocessing.connection.wait()можно одновременно опрашивать несколько объектов подключения.
-
send_bytes(buffer[, offset[, size]])¶ Отправляет байтовые данные из байтоподобного объекта как полное сообщение.
Если указан offset, то данные читаются с этой позиции в buffer. Если указан size, то из буфера будет прочитано соответствующее количество байт. Очень большие буферы (примерно 32 МБ+, хотя это зависит от ОС) могут вызвать исключение
ValueError
-
recv_bytes([maxlength])¶ Возвращает полное сообщение из байтовых данных, отправленное с другого конца подключения, в виде строки. Блокируется, пока не появятся данные для получения. Вызывает
EOFError, если больше нечего получать и другой конец закрыт.Если указан maxlength и сообщение длиннее maxlength, то вызывается
OSError, и подключение больше не будет доступно для чтения.
-
recv_bytes_into(buffer[, offset])¶ Читает в buffer полное сообщение с байтовыми данными, отправленное с другого конца соединения, и возвращает количество байтов в сообщении. Блокирует выполнение, пока не появится что-то для приёма. Возбуждает
EOFError, если больше нечего принимать и другой конец был закрыт.buffer должен быть доступным для записи байтоподобным объектом. Если задан offset, то сообщение будет записано в буфер, начиная с этой позиции. Offset должен быть неотрицательным целым числом, меньшим длины buffer (в байтах).
Если буфер слишком мал, то вызывается исключение
BufferTooShortи полное сообщение доступно какe.args[0], гдеeэкземпляр исключения.
Изменено в версии 3.3: Теперь объекты подключения могут передаваться между процессами с помощью
Connection.send()иConnection.recv().Новое в версии 3.3: Объекты Connection теперь поддерживают протокол управления контекстом – см. Типы менеджеров контекста.
__enter__()возвращает объект соединения, а__exit__()вызываетclose().-
Например:
>>> from multiprocessing import Pipe
>>> a, b = Pipe()
>>> a.send([1, 'hello', None])
>>> b.recv()
[1, 'hello', None]
>>> b.send_bytes(b'thank you')
>>> a.recv_bytes()
b'thank you'
>>> import array
>>> arr1 = array.array('i', range(5))
>>> arr2 = array.array('i', [0] * 10)
>>> a.send_bytes(arr1)
>>> count = b.recv_bytes_into(arr2)
>>> assert count == len(arr1) * arr1.itemsize
>>> arr2
array('i', [0, 1, 2, 3, 4, 0, 0, 0, 0, 0])
Предупреждение
Метод Connection.recv() автоматически десериализует полученные данные,
что может быть угрозой безопасности, если нельзя доверять процессу,
отправившему сообщение.
Поэтому, если объект подключения не был создан с помощью Pipe()
следует использовать методы recv() и send()
только после выполнения некоторой аутентификации. См.
Ключи аутентификации.
Предупреждение
Если процесс завершается принудительно во время чтения или записи в канал, данные в канале, скорее всего, повредятся, так как может стать невозможно определить границы сообщений.
17.2.2.5. Примитивы синхронизации¶Synchronization primitives
В целом, в многопроцессных программах примитивы синхронизации требуются не так часто, как в многопоточных. См. документацию модуля threading.
Обратите внимание, что примитивы синхронизации можно также создавать с помощью объекта менеджера – см. Менеджеры.
-
class
multiprocessing.Barrier(parties[, action[, timeout]])¶ Объект барьера: клон
threading.Barrier.Новое в версии 3.3.
-
class
multiprocessing.BoundedSemaphore([value])¶ Объект ограниченного семафора: близкий аналог
threading.BoundedSemaphore.Имеется единственное отличие от его близкого аналога: первый аргумент метода
acquireназывается block, что согласуется сLock.acquire().Примечание
На Mac OS X это неотличимо от
Semaphore, посколькуsem_getvalue()не реализован на этой платформе.
-
class
multiprocessing.Condition([lock])¶ Условная переменная: псевдоним для
threading.Condition.Если указана блокировка, то она должна быть объектом
LockилиRLockизmultiprocessing.Изменено в версии 3.3: Был добавлен метод
wait_for().
-
class
multiprocessing.Event¶ Клон
threading.Event.
-
class
multiprocessing.Lock¶ Нерекурсивный объект блокировки: близкий аналог
threading.Lock. Когда процесс или поток захватывает блокировку, последующие попытки захватить её из любого процесса или потока будут блокироваться до её освобождения; любой процесс или поток может её освободить. Концепции и поведениеthreading.Lockприменительно к потокам воспроизводятся здесь вmultiprocessing.Lockприменительно к процессам или потокам, за исключением отмеченных случаев.Обратите внимание, что
Lockна самом деле является фабричной функцией, которая возвращает экземплярmultiprocessing.synchronize.Lock, инициализированный контекстом по умолчанию.Lockподдерживает протокол менеджера контекста и поэтому может использоваться в операторахwith.-
acquire(block=True, timeout=None)¶ Захватывает блокировку, блокирующую или неблокирующую.
Если аргумент block установлен в
True(по умолчанию), вызов метода будет блокироваться, пока блокировка не окажется в разблокированном состоянии, затем установит её в заблокированное состояние и вернётTrue. Обратите внимание, что имя этого первого аргумента отличается от имени вthreading.Lock.acquire().Если аргумент block установлен в
False, вызов метода не блокируется. Если блокировка в данный момент находится в заблокированном состоянии, возвращаетсяFalse; в противном случае блокировка устанавливается в заблокированное состояние и возвращаетсяTrue.При вызове с положительным значением с плавающей точкой для timeout блокировка выполняется не дольше числа секунд, указанного в timeout, пока блокировку не удастся захватить. Вызовы с отрицательным значением timeout эквивалентны timeout, равному нулю. Вызовы со значением timeout равным
None(по умолчанию) устанавливают бесконечный период ожидания. Обратите внимание, что обработка отрицательных илиNoneзначений для timeout отличается от реализованного поведения вthreading.Lock.acquire(). Аргумент timeout не имеет практического значения, если аргумент block установлен вFalse, и поэтому игнорируется. ВозвращаетTrue, если блокировка была захвачена, илиFalse, если период ожидания истёк.
-
release()¶ Освобождает блокировку. Может вызываться из любого процесса или потока, а не только из того, который изначально захватил блокировку.
Поведение аналогично
threading.Lock.release()за исключением того, что при вызове на незаблокированной блокировке возбуждаетсяValueError.
-
-
class
multiprocessing.RLock¶ Объект рекурсивной блокировки: близкий аналог
threading.RLock. Рекурсивная блокировка должна быть освобождена тем же процессом или потоком, который её захватил. После того как процесс или поток захватил рекурсивную блокировку, тот же процесс или поток может захватить её снова без блокировки; этот процесс или поток должен освободить её по одному разу за каждый захват.Обратите внимание, что
RLockна самом деле является фабричной функцией, которая возвращает экземплярmultiprocessing.synchronize.RLock, инициализированный контекстом по умолчанию.RLockподдерживает протокол менеджера контекста и поэтому может использоваться в операторахwith.-
acquire(block=True, timeout=None)¶ Захватывает блокировку, блокирующую или неблокирующую.
При вызове с аргументом block, установленным в
True, блокируется до тех пор, пока блокировка не окажется в разблокированном состоянии (не принадлежит ни одному процессу или потоку), если только блокировка уже не принадлежит текущему процессу или потоку. Затем текущий процесс или поток получает владение блокировкой (если ещё не владеет ею), и уровень рекурсии внутри блокировки увеличивается на единицу, возвращая значениеTrue. Обратите внимание, что имеется несколько различий в поведении этого первого аргумента по сравнению с реализациейthreading.RLock.acquire(), начиная с названия самого аргумента.При вызове с аргументом block, установленным в
False, не блокируется. Если блокировка уже была захвачена (и, следовательно, принадлежит) другим процессом или потоком, текущий процесс или поток не получает владение, а уровень рекурсии внутри блокировки не изменяется, возвращая значениеFalse. Если блокировка находится в разблокированном состоянии, текущий процесс или поток получает владение, а уровень рекурсии увеличивается, возвращая значениеTrue.Использование и поведение аргумента timeout такие же, как в
Lock.acquire(). Обратите внимание, что некоторые из этих особенностей timeout отличаются от реализованного поведения вthreading.RLock.acquire().
-
release()¶ Освобождает блокировку, уменьшая уровень рекурсии. Если после уменьшения уровень рекурсии становится нулевым, переводит блокировку в разблокированное состояние (не принадлежит ни одному процессу или потоку), и если какие-либо другие процессы или потоки ожидают разблокировки, позволяет ровно одному из них продолжить. Если после уменьшения уровень рекурсии всё ещё ненулевой, блокировка остаётся заблокированной и принадлежащей вызывающему процессу или потоку.
Вызывайте этот метод только когда вызывающий процесс или поток владеет блокировкой. Исключение
AssertionErrorвозбуждается, если этот метод вызывается процессом или потоком, не являющимся владельцем, или если блокировка находится в разблокированном (непринадлежащем) состоянии. Обратите внимание, что тип возбуждаемого исключения в этой ситуации отличается от реализованного поведения вthreading.RLock.release().
-
-
class
multiprocessing.Semaphore([value])¶ Объект семафора: близкий аналог
threading.Semaphore.Имеется единственное отличие от его близкого аналога: первый аргумент метода
acquireназывается block, что согласуется сLock.acquire().
Примечание
На Mac OS X sem_timedwait не поддерживается, поэтому вызов acquire() с
тайм-аутом будет эмулировать поведение этой функции с помощью спящего цикла.
Примечание
Если сигнал SIGINT, сгенерированный Ctrl-C, поступает, когда главный поток блокирован вызовом BoundedSemaphore.acquire(), Lock.acquire(),
RLock.acquire(), Semaphore.acquire(), Condition.acquire()
или Condition.wait(), то вызов будет немедленно прерван и возбуждено KeyboardInterrupt.
Это отличается от поведения threading, где SIGINT игнорируется, пока выполняются эквивалентные блокирующие вызовы.
Примечание
Некоторые функции этого пакета требуют работающей реализации общего семафора в операционной системе. При её отсутствии модуль multiprocessing.synchronize будет отключён, а попытки импортировать его приведут к ImportError. См. bpo-3770 для получения дополнительной информации.
17.2.2.7. Менеджеры¶Managers
Менеджеры предоставляют способ создания данных, которыми можно обмениваться между разными процессами, в том числе по сети между процессами, выполняющимися на разных машинах. Объект менеджера управляет серверным процессом, который управляет разделяемыми объектами. Другие процессы могут получать доступ к разделяемым объектам через прокси.
Возвращает запущенный объект
SyncManager, который можно использовать для совместного использования объектов между процессами. Возвращаемый объект менеджера соответствует порождённому дочернему процессу и имеет методы, которые создают разделяемые объекты и возвращают соответствующие прокси.
Процессы менеджера завершаются, как только они будут собраны сборщиком мусора или завершится их родительский процесс. Классы менеджера определены в модуле multiprocessing.managers:
-
class
multiprocessing.managers.BaseManager([address[, authkey]])¶ Создает объект BaseManager.
После создания необходимо вызвать
start()илиget_server().serve_forever(), чтобы объект менеджера ссылался на запущенный процесс менеджера.address – адрес, на котором процесс менеджера ожидает новые подключения. Если address равно
None, то выбирается произвольный адрес.authkey – ключ аутентификации, который будет использоваться для проверки подлинности входящих подключений к серверному процессу. Если authkey равно
None, используетсяcurrent_process().authkey. В противном случае используется authkey, и он должен быть байтовой строкой.-
start([initializer[, initargs]])¶ Запускает подпроцесс для запуска менеджера. Если initializer не равно
None, то подпроцесс вызоветinitializer(*initargs)при запуске.
-
get_server()¶ Возвращает объект
Server, представляющий реальный сервер, управляемый менеджером. ОбъектServerподдерживает методserve_forever():>>> from multiprocessing.managers import BaseManager >>> manager = BaseManager(address=('', 50000), authkey=b'abc') >>> server = manager.get_server() >>> server.serve_forever()
Serverтакже имеет атрибутaddress.
-
connect()¶ Подключает локальный объект менеджера к удаленному процессу менеджера:
>>> from multiprocessing.managers import BaseManager >>> m = BaseManager(address=('127.0.0.1', 5000), authkey=b'abc') >>> m.connect()
-
shutdown()¶ Останавливает процесс, используемый менеджером. Это доступно только если
start()был использован для запуска серверного процесса.Этот метод можно вызывать несколько раз.
-
register(typeid[, callable[, proxytype[, exposed[, method_to_typeid[, create_method]]]]])¶ Метод класса, который можно использовать для регистрации типа или вызываемого объекта в классе менеджера.
typeid – это «идентификатор типа», который используется для идентификации определенного типа разделяемого объекта. Должен быть строкой.
callable – это вызываемый объект, используемый для создания объектов для данного идентификатора типа. Если экземпляр менеджера будет подключен к серверу с помощью метода
connect(), или если аргумент create_method равенFalse, то этот параметр можно оставить какNone.proxytype – это подкласс
BaseProxy, который используется для создания прокси для разделяемых объектов с данным typeid. ЕслиNone, то класс прокси создается автоматически.exposed используется для указания последовательности имен методов, к которым прокси для данного typeid должны иметь доступ через
BaseProxy._callmethod(). (Если exposed равноNone, то вместо него используетсяproxytype._exposed_, если он существует.) Если список exposed не указан, то все «публичные методы» разделяемого объекта будут доступны. (Здесь «публичный метод» означает любой атрибут, у которого есть метод__call__()и имя которого не начинается с'_'.)method_to_typeid – это отображение, используемое для указания возвращаемого типа тех открытых методов, которые должны возвращать прокси. Оно отображает имена методов в строки typeid. (Если method_to_typeid равно
None, то вместо него используетсяproxytype._method_to_typeid_, если он существует.) Если имя метода не является ключом этого отображения или отображение равноNone, то объект, возвращаемый методом, будет скопирован по значению.create_method определяет, следует ли создать метод с именем typeid, который можно использовать, чтобы указать серверному процессу создать новый разделяемый объект и вернуть для него прокси. По умолчанию
True.
Экземпляры
BaseManagerтакже имеют одно свойство только для чтения:-
address¶ Адрес, используемый менеджером.
Изменено в версии 3.3: Объекты Manager поддерживают протокол управления контекстом – см. Типы менеджеров контекста.
__enter__()запускает серверный процесс (если он еще не запущен), а затем возвращает объект менеджера.__exit__()вызываетshutdown().В предыдущих версиях
__enter__()не запускал серверный процесс менеджера, если он ещё не был запущен.-
-
class
multiprocessing.managers.SyncManager¶ Подкласс
BaseManager, который можно использовать для синхронизации процессов. Объекты этого типа возвращаютсяmultiprocessing.Manager().Его методы создают и возвращают объекты-прокси для ряда часто используемых типов данных, которые нужно синхронизировать между процессами. Сюда в первую очередь входят общие списки и словари.
-
Barrier(parties[, action[, timeout]])¶ Создать общий объект
threading.Barrierи вернуть для него прокси.Новое в версии 3.3.
-
BoundedSemaphore([value])¶ Создать общий объект
threading.BoundedSemaphoreи вернуть для него прокси.
-
Condition([lock])¶ Создать общий объект
threading.Conditionи вернуть прокси для него.Если блокировка предоставлена, то она должна быть прокси для объекта
threading.Lockилиthreading.RLock.Изменено в версии 3.3: Был добавлен метод
wait_for().
-
Event()¶ Создать общий объект
threading.Eventи вернуть прокси для него.
-
Lock()¶ Создать общий объект
threading.Lockи вернуть прокси для него.
-
Queue([maxsize])¶ Создать общий объект
queue.Queueи вернуть прокси для него.
-
RLock()¶ Создать общий объект
threading.RLockи вернуть прокси для него.
-
Semaphore([value])¶ Создать общий объект
threading.Semaphoreи вернуть прокси для него.
-
Array(typecode, sequence)¶ Создать массив и вернуть для него прокси.
-
Value(typecode, value)¶ Создать объект с атрибутом
value, доступным для записи, и вернуть прокси для него.
Изменено в версии 3.6: Общие объекты могут быть вложенными. Например, общий объект-контейнер, такой как общий список, может содержать другие общие объекты, и все они будут управляться и синхронизироваться
SyncManager.-
-
class
multiprocessing.managers.Namespace¶ Тип, который можно зарегистрировать с помощью
SyncManager.Объект пространства имён не имеет открытых методов, но имеет изменяемые атрибуты. Его представление показывает значения его атрибутов.
Однако при использовании прокси для объекта пространства имён атрибут, начинающийся с
'_', будет атрибутом прокси, а не атрибутом референта:>>> manager = multiprocessing.Manager() >>> Global = manager.Namespace() >>> Global.x = 10 >>> Global.y = 'hello' >>> Global._z = 12.3 # это атрибут прокси >>> print(Global) Namespace(x=10, y='hello')
17.2.2.7.1. Настраиваемые менеджеры¶Customized managers
Чтобы создать собственный менеджер, создаётся подкласс BaseManager и
используется метод класса register() для регистрации новых типов или
вызываемых объектов в классе менеджера. Например:
from multiprocessing.managers import BaseManager
class MathsClass:
def add(self, x, y):
return x + y
def mul(self, x, y):
return x * y
class MyManager(BaseManager):
pass
MyManager.register('Maths', MathsClass)
if __name__ == '__main__':
with MyManager() as manager:
maths = manager.Maths()
print(maths.add(4, 3)) # выводит 7
print(maths.mul(7, 8)) # выводит 56
17.2.2.7.2. Использование удалённого менеджера¶Using a remote manager
Можно запустить сервер менеджера на одной машине и позволить клиентам использовать его с других машин (при условии, что соответствующие брандмауэры это разрешают).
Выполнение следующих команд создаёт сервер для одной общей очереди, к которой удалённые клиенты могут обращаться:
>>> from multiprocessing.managers import BaseManager
>>> from queue import Queue
>>> queue = Queue()
>>> class QueueManager(BaseManager): pass
>>> QueueManager.register('get_queue', callable=lambda:queue)
>>> m = QueueManager(address=('', 50000), authkey=b'abracadabra')
>>> s = m.get_server()
>>> s.serve_forever()
Один клиент может получить доступ к серверу следующим образом:
>>> from multiprocessing.managers import BaseManager
>>> class QueueManager(BaseManager): pass
>>> QueueManager.register('get_queue')
>>> m = QueueManager(address=('foo.bar.org', 50000), authkey=b'abracadabra')
>>> m.connect()
>>> queue = m.get_queue()
>>> queue.put('hello')
Другой клиент также может использовать его:
>>> from multiprocessing.managers import BaseManager
>>> class QueueManager(BaseManager): pass
>>> QueueManager.register('get_queue')
>>> m = QueueManager(address=('foo.bar.org', 50000), authkey=b'abracadabra')
>>> m.connect()
>>> queue = m.get_queue()
>>> queue.get()
'hello'
Локальные процессы также могут получить доступ к этой очереди, используя приведённый выше код на клиенте для удалённого доступа к ней:
>>> from multiprocessing import Process, Queue
>>> from multiprocessing.managers import BaseManager
>>> class Worker(Process):
... def __init__(self, q):
... self.q = q
... super(Worker, self).__init__()
... def run(self):
... self.q.put('local hello')
...
>>> queue = Queue()
>>> w = Worker(queue)
>>> w.start()
>>> class QueueManager(BaseManager): pass
...
>>> QueueManager.register('get_queue', callable=lambda: queue)
>>> m = QueueManager(address=('', 50000), authkey=b'abracadabra')
>>> s = m.get_server()
>>> s.serve_forever()
17.2.2.8. Прокси-объекты¶Proxy Objects
Прокси – это объект, который ссылается на общий объект, находящийся (предположительно) в другом процессе. Общий объект называется референтом этого прокси. Несколько объектов-прокси могут иметь один и тот же референт.
Объект-прокси имеет методы, которые вызывают соответствующие методы его референта (хотя не каждый метод референта обязательно будет доступен через прокси). Таким образом, прокси можно использовать так же, как и его референт:
>>> from multiprocessing import Manager
>>> manager = Manager()
>>> l = manager.list([i*i for i in range(10)])
>>> print(l)
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
>>> print(repr(l))
<ListProxy object, typeid 'list' at 0x...>
>>> l[4]
16
>>> l[2:5]
[4, 9, 16]
Обратите внимание, что применение str() к прокси вернёт представление
референта, тогда как применение repr() вернёт представление
прокси.
Важная особенность объектов-прокси – они сериализуемы (picklable), поэтому их можно передавать между процессами. Таким образом, референт может содержать Объекты-прокси. Это допускает вложение управляемых списков, словарей и других Объектов-прокси:
>>> a = manager.list()
>>> b = manager.list()
>>> a.append(b) # референт a теперь содержит референт b
>>> print(a, b)
[<ListProxy object, typeid 'list' at ...>] []
>>> b.append('hello')
>>> print(a[0], b)
['hello'] ['hello']
Аналогично, прокси словарей и списков могут быть вложены друг в друга:
>>> l_outer = manager.list([ manager.dict() for i in range(2) ])
>>> d_first_inner = l_outer[0]
>>> d_first_inner['a'] = 1
>>> d_first_inner['b'] = 2
>>> l_outer[1]['c'] = 3
>>> l_outer[1]['z'] = 26
>>> print(l_outer[0])
{'a': 1, 'b': 2}
>>> print(l_outer[1])
{'c': 3, 'z': 26}
Если в референт входят стандартные (не прокси) объекты list или dict,
изменения этих изменяемых значений не будут распространяться
через менеджер, потому что прокси не может узнать, когда значения,
содержащиеся внутри, изменяются. Однако сохранение значения в прокси-контейнере
(что вызывает __setitem__ на объекте-прокси) распространяется через
менеджер, поэтому для эффективного изменения такого элемента можно присвоить
изменённое значение обратно в прокси-контейнер:
# создать прокси для списка и добавить изменяемый объект (словарь)
lproxy = manager.list()
lproxy.append({})
# теперь изменить словарь
d = lproxy[0]
d['a'] = 1
d['b'] = 2
# на данный момент изменения в d еще не синхронизированы, но при
# обновлении словаря прокси уведомляется об изменении
lproxy[0] = d
Этот подход, возможно, менее удобен, чем использование вложенных Объектов-прокси в большинстве случаев, но также демонстрирует степень контроля над синхронизацией.
Примечание
Типы прокси в multiprocessing не поддерживают сравнение
по значению. Так, например:
>>> manager.list([1,2,3]) == [1,2,3]
False
При сравнении следует просто использовать копию референта.
-
class
multiprocessing.managers.BaseProxy¶ Прокси-объекты являются экземплярами подклассов
BaseProxy.-
_callmethod(methodname[, args[, kwds]])¶ Вызывает метод референта прокси и возвращает результат.
Если
proxy– это прокси, чей референт –obj, то выражениеproxy._callmethod(methodname, args, kwds)
вычислит выражение
getattr(obj, methodname)(*args, **kwds)
в процессе менеджера.
Возвращаемое значение будет копией результата вызова или прокси для нового разделяемого объекта – см. документацию по аргументу method_to_typeid функции
BaseManager.register().Если при вызове возникло исключение, то оно повторно возбуждается с помощью
_callmethod(). Если в процессе менеджера возникло другое исключение, то оно преобразуется в исключениеRemoteErrorи возбуждается с помощью_callmethod().Обратите внимание, что исключение будет возбуждаться, если methodname не был экспонирован.
Пример использования
_callmethod():>>> l = manager.list(range(10)) >>> l._callmethod('__len__') 10 >>> l._callmethod('__getitem__', (slice(2, 7),)) # эквивалентно l[2:7] [2, 3, 4, 5, 6] >>> l._callmethod('__getitem__', (20,)) # эквивалентно l[20] Traceback (most recent call last): ... IndexError: list index out of range
-
_getvalue()¶ Возвращает копию референта.
Если референт не может быть сериализован (unpicklable), то это вызовет исключение.
-
__repr__()¶ Возвращает представление прокси-объекта.
-
__str__()¶ Возвращает представление референта.
-
17.2.2.8.1. Очистка¶Cleanup
Прокси-объект использует колбэк слабой ссылки: когда он собирается сборщиком мусора, он отменяет свою регистрацию у менеджера, которому принадлежит его референт.
Разделяемый объект удаляется из процесса менеджера, когда на него больше не ссылается ни один прокси.
17.2.2.9. Пулы процессов¶Process Pools
Можно создать пул процессов, который будет выполнять задачи, отправленные ему с помощью класса Pool.
-
class
multiprocessing.pool.Pool([processes[, initializer[, initargs[, maxtasksperchild[, context]]]]])¶ Объект пула процессов, который управляет пулом рабочих процессов, которым можно отправлять задачи. Он поддерживает асинхронные результаты с тайм-аутами и колбэками, а также имеет параллельную реализацию map.
processes – количество используемых рабочих процессов. Если processes равно
None, то используется число, возвращаемоеos.cpu_count().Если initializer не равно
None, то каждый рабочий процесс вызоветinitializer(*initargs)при запуске.maxtasksperchild – количество задач, которое рабочий процесс может выполнить до завершения и замены новым рабочим процессом, чтобы освободить неиспользуемые ресурсы. Значение по умолчанию maxtasksperchild равно
None, что означает, что рабочие процессы будут жить столько же, сколько и пул.context используется для указания контекста, в котором запускаются рабочие процессы. Обычно пул создаётся с помощью функции
multiprocessing.Pool()или методаPool()объекта контекста. В обоих случаях context устанавливается соответствующим образом.Обратите внимание, что методы объекта пула должны вызываться только тем процессом, который создал пул.
Новое в версии 3.2: maxtasksperchild
Новое в версии 3.4: context
Примечание
Рабочие процессы внутри
Poolобычно существуют в течение всего времени работы очереди пула. Часто используемый в других системах (например, Apache, mod_wsgi и т.д.) подход для освобождения ресурсов, удерживаемых рабочими процессами, заключается в том, чтобы позволить рабочему процессу в пуле выполнить только определённый объём работы, после чего он завершается, очищается, и на его место запускается новый процесс. Аргумент maxtasksperchild функцииPoolпредоставляет эту возможность конечному пользователю.-
apply(func[, args[, kwds]])¶ Вызывает func с аргументами args и именованными аргументами kwds. Блокируется до получения результата. Поскольку этот метод блокируется,
apply_async()лучше подходит для параллельного выполнения работы. Кроме того, func выполняется только в одном из рабочих процессов пула.
-
apply_async(func[, args[, kwds[, callback[, error_callback]]]])¶ Вариант метода
apply(), возвращающий объект результата.Если указан колбэк, то это должен быть вызываемый объект, принимающий один аргумент. Когда результат готов, к нему применяется колбэк, если только вызов не завершился ошибкой – в этом случае вместо него применяется колбэк ошибки.
Если указан error_callback, то это должен быть вызываемый объект, принимающий один аргумент. Если целевая функция завершается ошибкой, то error_callback вызывается с экземпляром исключения.
Колбэки должны завершаться немедленно, иначе поток, обрабатывающий результаты, будет заблокирован.
-
map(func, iterable[, chunksize])¶ Параллельный аналог встроенной функции
map()(однако поддерживает только один аргумент iterable). Блокирует выполнение до готовности результата.Этот метод разбивает итерируемый объект на несколько частей (chunks), которые отправляет в пул процессов как отдельные задачи. Приблизительный размер этих частей можно задать, установив chunksize в положительное целое число.
-
map_async(func, iterable[, chunksize[, callback[, error_callback]]])¶ Вариант метода
map(), возвращающий объект результата.Если указан колбэк, то это должен быть вызываемый объект, принимающий один аргумент. Когда результат готов, к нему применяется колбэк, если только вызов не завершился ошибкой – в этом случае вместо него применяется колбэк ошибки.
Если указан error_callback, то это должен быть вызываемый объект, принимающий один аргумент. Если целевая функция завершается ошибкой, то error_callback вызывается с экземпляром исключения.
Колбэки должны завершаться немедленно, иначе поток, обрабатывающий результаты, будет заблокирован.
-
imap(func, iterable[, chunksize])¶ Более ленивая версия
map().Аргумент chunksize совпадает с тем, что используется в методе
map(). Для очень длинных итерируемых объектов использование большого значения chunksize может привести к завершению задачи значительно быстрее, чем при использовании значения по умолчанию1.Кроме того, если chunksize равно
1, то методnext()итератора, возвращаемого методомimap(), имеет необязательный параметр timeout:next(timeout)возбудитmultiprocessing.TimeoutError, если результат не может быть возвращён в течение timeout секунд.
-
imap_unordered(func, iterable[, chunksize])¶ То же, что и
imap(), за исключением того, что порядок результатов из возвращаемого итератора считается произвольным. (Только когда есть только один рабочий процесс, порядок гарантированно будет «правильным».)
-
starmap(func, iterable[, chunksize])¶ Как
map(), за исключением того, что элементы iterable должны быть итерабельными объектами, которые распаковываются как аргументы.Таким образом, iterable из
[(1,2), (3, 4)]приводит к[func(1,2), func(3,4)].Новое в версии 3.3.
-
starmap_async(func, iterable[, chunksize[, callback[, error_callback]]])¶ Комбинация
starmap()иmap_async(), которая перебирает iterable из итерируемых объектов и вызывает func с распакованными итерируемыми объектами. Возвращает объект результата.Новое в версии 3.3.
-
close()¶ Предотвращает отправку новых задач в пул. После завершения всех задач рабочие процессы завершаются.
-
terminate()¶ Немедленно останавливает рабочие процессы, не дожидаясь завершения незаконченных задач. Когда объект пула будет собран сборщиком мусора,
terminate()будет вызван немедленно.
-
join()¶ Ожидает завершения рабочих процессов. Перед использованием
join()необходимо вызватьclose()илиterminate().
Новое в версии 3.3: Объекты Pool теперь поддерживают протокол управления контекстом – см.\nContext Manager Types.
__enter__()возвращает объект pool, а__exit__()вызываетterminate().-
-
class
multiprocessing.pool.AsyncResult¶ Класс результата, возвращаемого
Pool.apply_async()иPool.map_async().-
get([timeout])¶ Возвращает результат, когда он будет получен. Если timeout не равен
Noneи результат не поступает в течение timeout секунд, то вызываетсяmultiprocessing.TimeoutError. Если удалённый вызов вызвал исключение, то это исключение будет повторно возбужденоget().
-
wait([timeout])¶ Ожидает, пока результат не станет доступен или пока не пройдёт timeout секунд.
-
ready()¶ Возвращает, завершён ли вызов.
-
successful()¶ Возвращает, завершился ли вызов без возникновения исключения. Возбуждает
AssertionError, если результат ещё не готов.
-
Следующий пример демонстрирует использование пула:
from multiprocessing import Pool
import time
def f(x):
return x*x
if __name__ == '__main__':
with Pool(processes=4) as pool: # запустить 4 рабочих процесса
result = pool.apply_async(f, (10,)) # вычислить "f(10)" асинхронно в одном процессе
print(result.get(timeout=1)) # выводит "100", если компьютер не *очень* медленный
print(pool.map(f, range(10))) # выводит "[0, 1, 4,..., 81]"
it = pool.imap(f, range(10))
print(next(it)) # выводит "0"
print(next(it)) # выводит "1"
print(it.next(timeout=1)) # выводит "4", если компьютер не *очень* медленный
result = pool.apply_async(time.sleep, (10,))
print(result.get(timeout=1)) # вызывает multiprocessing.TimeoutError
17.2.2.10. Слушатели и клиенты¶Listeners and Clients
Обычно обмен сообщениями между процессами осуществляется с помощью очередей или объектов Connection, возвращаемых Pipe().
Однако модуль multiprocessing.connection обеспечивает дополнительную гибкость. По сути, он предоставляет высокоуровневый API, ориентированный на сообщения, для работы с сокетами или именованными каналами Windows. Также поддерживается аутентификация на основе дайджеста с использованием модуля hmac и опрос нескольких подключений одновременно.
-
multiprocessing.connection.deliver_challenge(connection, authkey)¶ Отправляет случайно сгенерированное сообщение на другой конец соединения и ожидает ответа.
Если ответ совпадает с дайджестом сообщения, используя authkey в качестве ключа, то на другой конец соединения отправляется приветственное сообщение. В противном случае возбуждается
AuthenticationError.
-
multiprocessing.connection.answer_challenge(connection, authkey)¶ Принимает сообщение, вычисляет дайджест сообщения, используя authkey в качестве ключа, а затем отправляет дайджест обратно.
Если приветственное сообщение не получено, то возбуждается
AuthenticationError.
-
multiprocessing.connection.Client(address[, family[, authkey]])¶ Пытается установить соединение с слушателем, использующим адрес address, возвращая
Connection.Тип соединения определяется аргументом family, но его обычно можно опустить, поскольку он обычно определяется по формату address. (См. Address Formats)
Если authkey задан и не None, он должен быть байтовой строкой и будет использоваться как секретный ключ для проверки подлинности на основе HMAC. Если authkey равно None, аутентификация не выполняется. В случае неудачи аутентификации возбуждается исключение
AuthenticationError. См. Ключи аутентификации.
-
class
multiprocessing.connection.Listener([address[, family[, backlog[, authkey]]]])¶ Обёртка для привязанного сокета или именованного канала Windows, который «прослушивает» подключения.
address – это адрес, который будет использоваться привязанным сокетом или именованным каналом объекта слушателя.
Примечание
Если используется адрес ‘0.0.0.0’, он не будет доступной точкой подключения в Windows. Если требуется доступная точка подключения, следует использовать ‘127.0.0.1’.
family – тип используемого сокета (или именованного канала). Может быть одной из строк
'AF_INET'(для TCP-сокета),'AF_UNIX'(для сокета домена Unix) или'AF_PIPE'(для именованного канала Windows). Из них гарантированно доступна только первая. Если family равноNone, то семейство определяется по формату address. Если address также равноNone, выбирается значение по умолчанию. По умолчанию выбирается семейство, которое считается самым быстрым из доступных. См. Форматы адресов. Обратите внимание: если family равно'AF_UNIX', а address равенNone, то сокет будет создан в частной временной директории, созданной с помощьюtempfile.mkstemp().Если объект listener использует сокет, то backlog (по умолчанию 1) передаётся методу
listen()сокета после его привязки.Если authkey задан и не None, он должен быть байтовой строкой и будет использоваться как секретный ключ для проверки подлинности на основе HMAC. Если authkey равно None, аутентификация не выполняется. В случае неудачи аутентификации возбуждается исключение
AuthenticationError. См. Ключи аутентификации.-
accept()¶ Принимает соединение на привязанном сокете или именованном канале объекта listener и возвращает объект
Connection. Если предпринята попытка аутентификации и она не удалась, возбуждаетсяAuthenticationError.
-
close()¶ Закрывает привязанный сокет или именованный канал объекта listener. Этот метод вызывается автоматически при сборке мусора listener'а. Однако рекомендуется вызывать его явно.
Объекты Listener имеют следующие свойства только для чтения:
-
address¶ Адрес, используемый объектом Listener.
-
last_accepted¶ Адрес, с которого поступило последнее принятое соединение. Если он недоступен, то равен
None.
Новое в версии 3.3: Объекты Listener теперь поддерживают протокол управления контекстом – см.\nContext Manager Types.
__enter__()возвращает объект listener, а__exit__()вызываетclose().-
-
multiprocessing.connection.wait(object_list, timeout=None)¶ Ожидает, пока объект из object_list не будет готов. Возвращает список тех объектов из object_list, которые готовы. Если timeout – число с плавающей точкой, вызов блокируется не более чем на указанное количество секунд. Если timeout равен
None, блокировка будет неограниченной. Отрицательный тайм-аут эквивалентен нулевому.Как в Unix, так и в Windows объект может появиться в object_list, если он
читаемый объект
Connection;подключенный и читаемый объект
socket.socket; или
Объект соединения или сокета готов, когда из него доступны для чтения данные или другой конец был закрыт.
Unix:
wait(object_list, timeout)почти эквивалентенselect.select(object_list, [], [], timeout). Разница в том, что еслиselect.select()прерван сигналом, он может возбудитьOSErrorс кодом ошибкиEINTR, тогда какwait()этого не сделает.Windows: Элемент в object_list должен быть либо целочисленным дескриптором, который ожидаем (согласно определению из документации функции Win32
WaitForMultipleObjects()), либо объектом с методомfileno(), возвращающим дескриптор сокета или канала. (Обратите внимание: дескрипторы каналов и сокетов не являются ожидаемыми дескрипторами.)Новое в версии 3.3.
Примеры
Следующий серверный код создаёт listener, который использует 'secret password' в качестве ключа аутентификации. Затем он ожидает соединения и отправляет некоторые данные клиенту:
from multiprocessing.connection import Listener
from array import array
address = ('localhost', 6000) # семейство определяется как 'AF_INET'
with Listener(address, authkey=b'secret password') as listener:
with listener.accept() as conn:
print('connection accepted from', listener.last_accepted)
conn.send([2.25, None, 'junk', float])
conn.send_bytes(b'hello')
conn.send_bytes(array('i', [42, 1729]))
Следующий код подключается к серверу и получает от него некоторые данные:
from multiprocessing.connection import Client
from array import array
address = ('localhost', 6000)
with Client(address, authkey=b'secret password') as conn:
print(conn.recv()) # => [2.25, None, 'junk', float]
print(conn.recv_bytes()) # => 'hello'
arr = array('i', [0, 0, 0, 0, 0])
print(conn.recv_bytes_into(arr)) # => 8
print(arr) # => array('i', [42, 1729, 0, 0, 0])
Следующий код использует wait() для ожидания сообщений от нескольких процессов одновременно:
import time, random
from multiprocessing import Process, Pipe, current_process
from multiprocessing.connection import wait
def foo(w):
for i in range(10):
w.send((i, current_process().name))
w.close()
if __name__ == '__main__':
readers = []
for i in range(4):
r, w = Pipe(duplex=False)
readers.append(r)
p = Process(target=foo, args=(w,))
p.start()
# Закрываем записывающий конец канала, чтобы убедиться, что
# p – единственный процесс, владеющий дескриптором канала. Это
# гарантирует, что когда p закроет свой дескриптор для записывающего конца,
# wait() немедленно сообщит, что читающий конец готов
w.close()
while readers:
for r in wait(readers):
try:
msg = r.recv()
except EOFError:
readers.remove(r)
else:
print(msg)
17.2.2.10.1. Форматы адресов¶Address Formats
Адрес
'AF_INET'– это кортеж вида(hostname, port), где hostname – строка, а port – целое число.Адрес
'AF_UNIX'– это строка, представляющая имя файла в файловой системе.- Адрес
'AF_PIPE'– это строка вида r'\.\pipe{PipeName}'. Чтобы использоватьClient()для подключения к именованному каналу на удалённом компьютере ServerName, следует использовать адрес видаr'\ServerName\pipe{PipeName}'.
- Адрес
Обратите внимание: любая строка, начинающаяся с двух обратных слешей, по умолчанию считается адресом 'AF_PIPE', а не 'AF_UNIX'.
17.2.2.11. Ключи аутентификации¶Authentication keys
При использовании Connection.recv полученные данные автоматически распиковываются. К сожалению, распиковка данных из ненадёжного источника представляет угрозу безопасности. Поэтому Listener и Client() используют модуль hmac для обеспечения дайджест-аутентификации.
Ключ аутентификации – это байтовая строка, которую можно рассматривать как пароль: после установления соединения обе стороны требуют доказательства, что другая сторона знает ключ аутентификации. (Демонстрация того, что обе стороны используют один и тот же ключ, не предполагает отправку ключа по соединению.)
Если запрошена аутентификация, но ключ аутентификации не указан, то используется возвращаемое значение current_process().authkey (см. Process). Это значение автоматически наследуется любым объектом Process, который создаёт текущий процесс. Это означает, что (по умолчанию) все процессы многопроцессной программы используют один ключ аутентификации, который можно применять для настройки соединений между ними.
Подходящие ключи аутентификации также можно сгенерировать с помощью os.urandom().
17.2.2.12. Логирование¶Logging
Доступна поддержка журналирования. Однако обратите внимание, что пакет logging не использует блокировки, разделяемые между процессами, поэтому сообщения от разных процессов могут перемешиваться (в зависимости от типа обработчика).
-
multiprocessing.get_logger()¶ Возвращает логгер, используемый модулем
multiprocessing. При необходимости создаётся новый.При первом создании логгер имеет уровень
logging.NOTSETи не имеет обработчика по умолчанию. Сообщения, отправленные этому логгеру, по умолчанию не распространяются на корневой логгер.Обратите внимание, что в Windows дочерние процессы наследуют только уровень логгера родительского процесса – любые другие настройки логгера не наследуются.
-
multiprocessing.log_to_stderr()¶ Эта функция вызывает
get_logger(), но помимо возврата регистратора, созданного get_logger, добавляет обработчик, который отправляет вывод наsys.stderr, используя формат'[%(levelname)s/%(processName)s] %(message)s'.
Ниже приведён пример сеанса с включённым журналированием:
>>> import multiprocessing, logging
>>> logger = multiprocessing.log_to_stderr()
>>> logger.setLevel(logging.INFO)
>>> logger.warning('doomed')
[WARNING/MainProcess] doomed
>>> m = multiprocessing.Manager()
[INFO/SyncManager-...] child process calling self.run()
[INFO/SyncManager-...] created temp directory /.../pymp-...
[INFO/SyncManager-...] manager serving at '/.../listener-...'
>>> del m
[INFO/MainProcess] sending shutdown message to manager
[INFO/SyncManager-...] manager exiting with exitcode 0
Полную таблицу уровней журналирования см. в модуле logging.
17.2.2.13. Модуль multiprocessing.dummy¶The multiprocessing.dummy module
multiprocessing.dummy воспроизводит API модуля multiprocessing, но является не более чем обёрткой вокруг модуля threading.
17.2.3. Рекомендации по программированию¶Programming guidelines
Существуют определённые рекомендации и идиомы, которых следует придерживаться при использовании multiprocessing.
17.2.3.1. Все методы запуска¶All start methods
Нижеследующее относится ко всем методам запуска.
Избегайте разделяемого состояния
По возможности следует стараться избегать передачи больших объёмов данных между процессами.
Вероятно, лучше всего ограничиться использованием очередей или каналов для связи между процессами, а не использовать низкоуровневые примитивы синхронизации.
Сериализуемость
Убедитесь, что аргументы методов прокси-объектов сериализуемы.
Потокобезопасность прокси
Не используйте прокси-объект из более чем одного потока, если не защищаете его блокировкой.
(С разными процессами, использующими один и тот же прокси, проблем не возникает.)
Присоединение процессов-зомби
В Unix, когда процесс завершается, но к нему не присоединились (joined), он становится зомби. Таких процессов не должно быть много, потому что каждый раз при запуске нового процесса (или вызове
active_children()) все завершённые процессы, к которым ещё не присоединились, будут присоединены. Кроме того, вызовProcess.is_aliveдля завершённого процесса присоединяет его. Тем не менее, рекомендуется явно присоединять все запущенные процессы.
Лучше наследовать, чем упаковывать/распаковывать
При использовании методов запуска spawn или forkserver многие типы из
multiprocessingдолжны быть упаковываемыми (picklable), чтобы дочерние процессы могли их использовать. Однако обычно следует избегать отправки разделяемых объектов другим процессам через каналы или очереди. Вместо этого стоит организовать программу так, чтобы процесс, которому требуется доступ к разделяемому ресурсу, созданному в другом месте, мог унаследовать его от родительского процесса.
Избегайте завершения процессов
Использование метода
Process.terminateдля остановки процесса может привести к тому, что любые разделяемые ресурсы (такие как блокировки, семафоры, каналы и очереди), которые в данный момент используются процессом, станут повреждёнными или недоступными для других процессов.Поэтому, вероятно, лучше рассматривать использование
Process.terminateтолько для процессов, которые никогда не используют разделяемые ресурсы.
Присоединение процессов, использующих очереди
Имейте в виду, что процесс, поместивший элементы в очередь, будет ждать перед завершением, пока все буферизованные элементы не будут переданы потоком «feeder» в нижележащий канал. (Дочерний процесс может вызвать метод
Queue.cancel_join_threadочереди, чтобы избежать такого поведения.)Это означает, что при использовании очереди нужно убедиться, что все элементы, помещённые в очередь, будут в конечном итоге удалены до того, как процесс будет присоединён. В противном случае нельзя быть уверенным, что процессы, поместившие элементы в очередь, завершатся. Также помните, что недемонические процессы присоединяются автоматически.
Пример, который приведёт к взаимоблокировке:
from multiprocessing import Process, Queue def f(q): q.put('X' * 1000000) if __name__ == '__main__': queue = Queue() p = Process(target=f, args=(queue,)) p.start() p.join() # это приводит к взаимоблокировке obj = queue.get()Исправление заключается в замене двух последних строк местами (или просто удалении строки с
p.join()).
Явная передача ресурсов дочерним процессам
В Unix при использовании метода запуска fork дочерний процесс может использовать общий ресурс, созданный в родительском процессе с помощью глобального ресурса. Однако лучше передавать объект в качестве аргумента конструктору дочернего процесса.
Помимо того, что это делает код (потенциально) совместимым с Windows и другими методами запуска, это также гарантирует, что пока дочерний процесс жив, объект не будет собран сборщиком мусора в родительском процессе. Это может быть важно, если некоторый ресурс освобождается при сборке мусора объекта в родительском процессе.
Так, например
from multiprocessing import Process, Lock def f(): ... do something using "lock" ... if __name__ == '__main__': lock = Lock() for i in range(10): Process(target=f).start()следует переписать как
from multiprocessing import Process, Lock def f(l): ... do something using "l" ... if __name__ == '__main__': lock = Lock() for i in range(10): Process(target=f, args=(lock,)).start()
Остерегайтесь замены sys.stdin на «файлоподобный объект»
multiprocessingизначально безусловно вызывал:os.close(sys.stdin.fileno())в методе
multiprocessing.Process._bootstrap()– это приводило к проблемам с процессами внутри процессов. Теперь это изменено на:sys.stdin.close() sys.stdin = open(os.open(os.devnull, os.O_RDONLY), closefd=False)Это решает основную проблему столкновения процессов друг с другом, приводящую к ошибке неверного файлового дескриптора, но вносит потенциальную опасность для приложений, которые заменяют
sys.stdin()на «файлоподобный объект» с буферизацией вывода. Опасность в том, что если несколько процессов вызовутclose()для этого файлоподобного объекта, одни и те же данные могут быть сброшены в объект несколько раз, что приведёт к повреждению.Если вы пишете файлоподобный объект и реализуете собственное кэширование, вы можете сделать его устойчивым к fork, сохраняя pid при каждом добавлении в кэш и сбрасывая кэш при изменении pid. Например:
@property def cache(self): pid = os.getpid() if pid != self._pid: self._pid = pid self._cache = [] return self._cacheДля получения дополнительной информации см. bpo-5155, bpo-5313 и bpo-5331
17.2.3.2. Методы запуска spawn и forkserver¶The spawn and forkserver start methods
Есть несколько дополнительных ограничений, которые не применяются к fork методу запуска.
Упаковываемость
Убедитесь, что все аргументы
Process.__init__()можно сериализовать с помощью pickle. Кроме того, если вы создаёте подклассProcess, убедитесь, что экземпляры будут сериализуемы при вызове методаProcess.start.
Глобальные переменные
Имейте в виду, что если код, выполняемый в дочернем процессе, попытается обратиться к глобальной переменной, то значение, которое он увидит (если оно есть), может не совпадать со значением в родительском процессе на момент вызова
Process.start.Однако глобальные переменные, которые представляют собой просто константы уровня модуля, не вызывают проблем.
Безопасный импорт главного модуля
Необходимо убедиться, что главный модуль может быть безопасно импортирован новым интерпретатором Python без непреднамеренных побочных эффектов (например, запуска нового процесса).
Например, при использовании методов запуска spawn или forkserver выполнение следующего модуля приведёт к ошибке
RuntimeError:from multiprocessing import Process def foo(): print('hello') p = Process(target=foo) p.start()Вместо этого следует защитить «точку входа» программы с помощью
if __name__ == '__main__':следующим образом:from multiprocessing import Process, freeze_support, set_start_method def foo(): print('hello') if __name__ == '__main__': freeze_support() set_start_method('spawn') p = Process(target=foo) p.start()(Строку
freeze_support()можно опустить, если программа будет запускаться обычным образом, а не как замороженное приложение.)Это позволяет только что порождённому интерпретатору Python безопасно импортировать модуль и затем выполнить функцию
foo()этого модуля.Аналогичные ограничения действуют, если пул или менеджер создаются в главном модуле.
17.2.4. Примеры¶Examples
Демонстрация создания и использования настраиваемых менеджеров и прокси:
from multiprocessing import freeze_support
from multiprocessing.managers import BaseManager, BaseProxy
import operator
##
class Foo:
def f(self):
print('you called Foo.f()')
def g(self):
print('you called Foo.g()')
def _h(self):
print('you called Foo._h()')
# Простая функция-генератор
def baz():
for i in range(10):
yield i*i
# Тип прокси для объектов-генераторов
class GeneratorProxy(BaseProxy):
_exposed_ = ['__next__']
def __iter__(self):
return self
def __next__(self):
return self._callmethod('__next__')
# Функция для возврата модуля operator
def get_operator_module():
return operator
##
class MyManager(BaseManager):
pass
# зарегистрировать класс Foo; сделать `f()` и `g()` доступными через прокси
MyManager.register('Foo1', Foo)
# зарегистрировать класс Foo; сделать `g()` и `_h()` доступными через прокси
MyManager.register('Foo2', Foo, exposed=('g', '_h'))
# зарегистрировать функцию-генератор baz; использовать `GeneratorProxy` для создания прокси
MyManager.register('baz', baz, proxytype=GeneratorProxy)
# зарегистрировать get_operator_module(); сделать публичные функции доступными через прокси
MyManager.register('operator', get_operator_module)
##
def test():
manager = MyManager()
manager.start()
print('-' * 20)
f1 = manager.Foo1()
f1.f()
f1.g()
assert not hasattr(f1, '_h')
assert sorted(f1._exposed_) == sorted(['f', 'g'])
print('-' * 20)
f2 = manager.Foo2()
f2.g()
f2._h()
assert not hasattr(f2, 'f')
assert sorted(f2._exposed_) == sorted(['g', '_h'])
print('-' * 20)
it = manager.baz()
for i in it:
print('<%d>' % i, end=' ')
print()
print('-' * 20)
op = manager.operator()
print('op.add(23, 45) =', op.add(23, 45))
print('op.pow(2, 94) =', op.pow(2, 94))
print('op._exposed_ =', op._exposed_)
##
if __name__ == '__main__':
freeze_support()
test()
Использование Pool:
import multiprocessing
import time
import random
import sys
#
# Функции, используемые тестовым кодом
#
def calculate(func, args):
result = func(*args)
return '%s says that %s%s = %s' % (
multiprocessing.current_process().name,
func.__name__, args, result
)
def calculatestar(args):
return calculate(*args)
def mul(a, b):
time.sleep(0.5 * random.random())
return a * b
def plus(a, b):
time.sleep(0.5 * random.random())
return a + b
def f(x):
return 1.0 / (x - 5.0)
def pow3(x):
return x ** 3
def noop(x):
pass
#
# Тестовый код
#
def test():
PROCESSES = 4
print('Creating pool with %d processes\n' % PROCESSES)
with multiprocessing.Pool(PROCESSES) as pool:
#
# Тесты
#
TASKS = [(mul, (i, 7)) for i in range(10)] + \
[(plus, (i, 8)) for i in range(10)]
results = [pool.apply_async(calculate, t) for t in TASKS]
imap_it = pool.imap(calculatestar, TASKS)
imap_unordered_it = pool.imap_unordered(calculatestar, TASKS)
print('Ordered results using pool.apply_async():')
for r in results:
print('\t', r.get())
print()
print('Ordered results using pool.imap():')
for x in imap_it:
print('\t', x)
print()
print('Unordered results using pool.imap_unordered():')
for x in imap_unordered_it:
print('\t', x)
print()
print('Ordered results using pool.map() --- will block till complete:')
for x in pool.map(calculatestar, TASKS):
print('\t', x)
print()
#
# Тестирование обработки ошибок
#
print('Testing error handling:')
try:
print(pool.apply(f, (5,)))
except ZeroDivisionError:
print('\tGot ZeroDivisionError as expected from pool.apply()')
else:
raise AssertionError('expected ZeroDivisionError')
try:
print(pool.map(f, list(range(10))))
except ZeroDivisionError:
print('\tGot ZeroDivisionError as expected from pool.map()')
else:
raise AssertionError('expected ZeroDivisionError')
try:
print(list(pool.imap(f, list(range(10)))))
except ZeroDivisionError:
print('\tGot ZeroDivisionError as expected from list(pool.imap())')
else:
raise AssertionError('expected ZeroDivisionError')
it = pool.imap(f, list(range(10)))
for i in range(10):
try:
x = next(it)
except ZeroDivisionError:
if i == 5:
pass
except StopIteration:
break
else:
if i == 5:
raise AssertionError('expected ZeroDivisionError')
assert i == 9
print('\tGot ZeroDivisionError as expected from IMapIterator.next()')
print()
#
# Тестирование тайм-аутов
#
print('Testing ApplyResult.get() with timeout:', end=' ')
res = pool.apply_async(calculate, TASKS[0])
while 1:
sys.stdout.flush()
try:
sys.stdout.write('\n\t%s' % res.get(0.02))
break
except multiprocessing.TimeoutError:
sys.stdout.write('.')
print()
print()
print('Testing IMapIterator.next() with timeout:', end=' ')
it = pool.imap(calculatestar, TASKS)
while 1:
sys.stdout.flush()
try:
sys.stdout.write('\n\t%s' % it.next(0.02))
except StopIteration:
break
except multiprocessing.TimeoutError:
sys.stdout.write('.')
print()
print()
if __name__ == '__main__':
multiprocessing.freeze_support()
test()
Пример использования очередей для передачи задач набору рабочих процессов и сбора результатов:
import time
import random
from multiprocessing import Process, Queue, current_process, freeze_support
#
# Функция, выполняемая рабочими процессами
#
def worker(input, output):
for func, args in iter(input.get, 'STOP'):
result = calculate(func, args)
output.put(result)
#
# Функция, используемая для вычисления результата
#
def calculate(func, args):
result = func(*args)
return '%s says that %s%s = %s' % \
(current_process().name, func.__name__, args, result)
#
# Функции, на которые ссылаются задачи
#
def mul(a, b):
time.sleep(0.5*random.random())
return a * b
def plus(a, b):
time.sleep(0.5*random.random())
return a + b
#
#
#
def test():
NUMBER_OF_PROCESSES = 4
TASKS1 = [(mul, (i, 7)) for i in range(20)]
TASKS2 = [(plus, (i, 8)) for i in range(10)]
# Создание очередей
task_queue = Queue()
done_queue = Queue()
# Отправка задач
for task in TASKS1:
task_queue.put(task)
# Запуск рабочих процессов
for i in range(NUMBER_OF_PROCESSES):
Process(target=worker, args=(task_queue, done_queue)).start()
# Получение и вывод результатов
print('Unordered results:')
for i in range(len(TASKS1)):
print('\t', done_queue.get())
# Добавить ещё задач с помощью `put()`
for task in TASKS2:
task_queue.put(task)
# Получить и вывести ещё несколько результатов
for i in range(len(TASKS2)):
print('\t', done_queue.get())
# Сообщить дочерним процессам об остановке
for i in range(NUMBER_OF_PROCESSES):
task_queue.put('STOP')
if __name__ == '__main__':
freeze_support()
test()