threading – параллелизм на основе потоков¶threading – Thread-based parallelism

Данные, локальные для потока¶Thread-local data

Данные, локальные для потока – это данные, значения которых привязаны к потоку. Если у вас есть данные, которые должны быть локальными для потока, создайте объект local и используйте его атрибуты:

>>> mydata = local()
>>> mydata.number = 42
>>> mydata.number
42

Также можно получить доступ к словарю объекта local:

>>> mydata.__dict__
{'number': 42}
>>> mydata.__dict__.setdefault('widgets', [])
[]
>>> mydata.widgets
[]

Если обратиться к данным из другого потока:

>>> log = []
>>> def f():
...     items = sorted(mydata.__dict__.items())
...     log.append(items)
...     mydata.number = 11
...     log.append(mydata.number)

>>> import threading
>>> thread = threading.Thread(target=f)
>>> thread.start()
>>> thread.join()
>>> log
[[], 11]

мы получим другие данные. Более того, изменения, сделанные в другом потоке, не влияют на данные, видимые в этом потоке:

>>> mydata.number
42

Разумеется, значения, получаемые из объекта local, включая их атрибут __dict__, относятся к тому потоку, который был текущим на момент чтения атрибута. По этой причине обычно не следует сохранять эти значения между потоками, так как они применимы только к тому потоку, из которого получены.

Можно создавать собственные объекты local, создавая подкласс класса local:

>>> class MyLocal(local):
...     number = 2
...     def __init__(self, /, **kw):
...         self.__dict__.update(kw)
...     def squared(self):
...         return self.number ** 2

Это может быть полезно для поддержки значений по умолчанию, методов и инициализации. Обратите внимание: если определить метод __init__(), он будет вызываться каждый раз, когда объект local используется в отдельном потоке. Это необходимо для инициализации словаря каждого потока.

Теперь, если создать объект local:

>>> mydata = MyLocal(color='red')

мы получим число по умолчанию:

>>> mydata.number
2

начальный цвет:

>>> mydata.color
'red'
>>> del mydata.color

и метод, работающий с данными:

>>> mydata.squared()
4

Как и раньше, можно обратиться к данным в отдельном потоке:

>>> log = []
>>> thread = threading.Thread(target=f)
>>> thread.start()
>>> thread.join()
>>> log
[[('color', 'red')], 11]

не затрагивая данные этого потока:

>>> mydata.number
2
>>> mydata.color
Traceback (most recent call last):
...
AttributeError: 'MyLocal' object has no attribute 'color'

Обратите внимание: подклассы могут определять __slots__, но они не являются локальными для потока. Они разделяются между потоками:

>>> class MyLocal(local):
...     __slots__ = 'number'

>>> mydata = MyLocal()
>>> mydata.number = 42
>>> mydata.color = 'red'

Итак, отдельный поток:

>>> thread = threading.Thread(target=f)
>>> thread.start()
>>> thread.join()

влияет на то, что мы видим:

>>> mydata.number
11

class threading.local¶

Класс, представляющий данные, локальные для потока.

Объекты потоков¶Thread objects

Класс Thread представляет собой активность, выполняемую в отдельном потоке управления. Есть два способа определить активность: передать вызываемый объект в конструктор или переопределить метод run() в подклассе. Никакие другие методы (кроме конструктора) не должны переопределяться в подклассе. Иными словами, переопределяйте только методы __init__() и run() этого класса.

После создания объекта потока его активность должна быть запущена вызовом метода start() этого потока. Это вызывает метод run() в отдельном потоке управления.

После запуска активности поток считается «живым». Он перестаёт быть живым, когда завершается его метод run() – либо нормально, либо из-за необработанного исключения. Метод is_alive() проверяет, жив ли поток.

Другие потоки могут вызывать метод join() потока. Это блокирует вызывающий поток до тех пор, пока поток, чей метод join() вызывается, не завершится.

У потока есть имя. Имя можно передать конструктору, а также прочитать или изменить через атрибут name.

Если метод run() вызывает исключение, для его обработки вызывается threading.excepthook(). По умолчанию threading.excepthook() молча игнорирует SystemExit.

Поток может быть помечен как «фоновый поток». Смысл этого флага в том, что вся программа Python завершается, когда остаются только фоновые потоки. Начальное значение наследуется от создающего потока. Флаг можно установить через свойство daemon или аргумент конструктора daemon.

Существует объект «главный поток»; он соответствует начальному потоку управления в программе Python. Это не фоновый поток.

Существует возможность создания «фиктивных объектов потоков». Это объекты потоков, соответствующие «внешним потокам» – потокам управления, запущенным вне модуля threading, например напрямую из кода на C. Фиктивные объекты потоков имеют ограниченную функциональность; они всегда считаются живыми и фоновыми, и их нельзя присоединить. Они никогда не удаляются, так как невозможно обнаружить завершение внешних потоков.

class threading.Thread(group=None, target=None, name=None, args=(), kwargs={}, *, daemon=None, context=None)¶

Этот конструктор всегда следует вызывать с именованными аргументами. Аргументы:

group должно быть None, так как он зарезервирован для будущих расширений, когда будет реализован класс ThreadGroup.

target – это вызываемый объект, который будет вызван методом run(). По умолчанию None, то есть ничего не вызывается.

name – это имя потока. По умолчанию создаётся уникальное имя вида «Thread-N», где N – небольшое десятичное число, или «Thread-N (target)», где «target» – это target.__name__, если указан аргумент target.

args – это список или кортеж аргументов для вызова target. По умолчанию ().

kwargs – это словарь именованных аргументов для вызова target. По умолчанию {}.

Если не None, параметр daemon явно задаёт, является ли поток демоническим. Если None (по умолчанию), свойство демоничности наследуется от текущего потока.

context – это значение Context, используемое при запуске потока. Значение по умолчанию – None, что означает, что поведение управляется флагом sys.flags.thread_inherit_context. Если флаг истинен, потоки запускаются с копией контекста вызывающего start(). Если ложен – с пустым контекстом. Чтобы явно запустить с пустым контекстом, передайте новый экземпляр Context(). Чтобы явно запустить с копией текущего контекста, передайте значение из copy_context(). По умолчанию флаг равен true для сборок со свободной многопоточностью и false в остальных случаях.

Если подкласс переопределяет конструктор, он должен обязательно вызвать конструктор базового класса (Thread.__init__()) перед любыми другими действиями с потоком.

Изменено в версии 3.3: Добавлен параметр daemon.

Изменено в версии 3.10: Используется имя target, если аргумент name опущен.

Изменено в версии 3.14: Добавлен параметр context.

start()¶

Запускает выполнение потока.

Этот метод должен вызываться не более одного раза для каждого объекта потока. Он обеспечивает вызов метода run() объекта в отдельном потоке управления.

Этот метод возбуждает исключение RuntimeError, если вызван более одного раза для одного и того же объекта потока.

Если поддерживается, устанавливает имя потока операционной системы в threading.Thread.name. Имя может быть усечено в зависимости от ограничений операционной системы на длину имени потока.

Изменено в версии 3.14: Устанавливает имя потока операционной системы.

run()¶

Метод, представляющий действие потока.

Этот метод можно переопределить в подклассе. Стандартный метод run() вызывает вызываемый объект, переданный конструктору объекта в качестве аргумента target (если он задан), с позиционными и именованными аргументами, взятыми соответственно из аргументов args и kwargs.

Использование списка или кортежа в качестве аргумента args, переданного методу Thread, может дать тот же эффект.

Пример:

>>> from threading import Thread
>>> t = Thread(target=print, args=[1])
>>> t.run()
1
>>> t = Thread(target=print, args=(1,))
>>> t.run()
1

join(timeout=None)¶

Ожидает завершения потока. Блокирует вызывающий поток до тех пор, пока поток, у которого вызван метод join(), не завершится – либо нормально, либо из-за необработанного исключения – или пока не истечёт заданный тайм-аут.

Если аргумент timeout присутствует и не равен None, он должен быть числом с плавающей точкой, задающим тайм-аут операции в секундах (или его долях). Поскольку join() всегда возвращает None, необходимо вызвать is_alive() после join(), чтобы определить, произошёл ли тайм-аут – если поток ещё жив, вызов join() превысил тайм-аут.

Если аргумент timeout отсутствует или равен None, операция блокируется до завершения потока.

Поток можно присоединить много раз.

join() возбуждает RuntimeError, если предпринимается попытка присоединиться к текущему потоку, так как это привело бы к взаимоблокировке. Также ошибочно join() поток до его запуска, и попытки сделать это возбуждают то же исключение.

Если предпринимается попытка присоединиться к выполняющемуся демоническому потоку на поздних этапах завершения работы Python, join() возбуждает исключение PythonFinalizationError.

Изменено в версии 3.14: Может возбуждать PythonFinalizationError.

name¶

Строка, используемая только для идентификации. Она не имеет семантического значения. Разным потокам можно задать одно и то же имя. Начальное имя устанавливается конструктором.

На некоторых платформах имя потока устанавливается на уровне операционной системы при запуске потока, чтобы оно отображалось в диспетчерах задач. Это имя может быть усечено для соответствия системному ограничению (например, 15 байт в Linux или 63 байта в macOS).

Изменения name отражаются на уровне ОС только при переименовании текущего выполняющегося потока. (Установка атрибута name другого потока обновляет только объект Thread в Python.)

getName()¶

setName()¶

Устаревший API геттера/сеттера для name; используйте его напрямую как свойство.

Устарело с версии 3.10.

ident¶

«Идентификатор потока» этого потока или None, если поток не был запущен. Это ненулевое целое число. См. функцию get_ident(). Идентификаторы потоков могут быть повторно использованы, когда поток завершается и создаётся другой поток. Идентификатор доступен даже после завершения потока.

native_id¶

Идентификатор потока (TID), назначенный ОС (ядром). Это неотрицательное целое число или None, если поток не был запущен. См. функцию get_native_id(). Это значение может использоваться для уникальной идентификации данного потока в масштабе системы (до завершения потока, после чего значение может быть повторно использовано ОС).

Примечание

Подобно идентификаторам процессов, идентификаторы потоков действительны (гарантированно уникальны в масштабе системы) только с момента создания потока до его завершения.

Доступность: Windows, FreeBSD, Linux, macOS, OpenBSD, NetBSD, AIX, DragonFlyBSD.

Добавлено в версии 3.8.

is_alive()¶

Возвращает, жив ли поток.

Этот метод возвращает True непосредственно перед началом выполнения метода run() и до завершения метода run(). Функция модуля enumerate() возвращает список всех живых потоков.

daemon¶

Логическое значение, указывающее, является ли этот поток демоном (True) или нет (False). Это должно быть установлено до вызова start(), иначе будет возбуждено RuntimeError. Его начальное значение наследуется от создающего потока; главный поток не является потоком-демоном, поэтому все потоки, созданные в главном потоке, по умолчанию имеют daemon = False.

Вся программа Python завершается, когда не остаётся ни одного живого потока, не являющегося демоном.

isDaemon()¶

setDaemon()¶

Устаревший API геттера/сеттера для daemon; используйте его напрямую как свойство.

Устарело с версии 3.10.

Объекты блокировки¶Lock objects

Примитивная блокировка – это примитив синхронизации, который при захвате не принадлежит какому-либо определённому потоку. В Python в настоящее время это самый низкоуровневый доступный примитив синхронизации, реализованный непосредственно в расширении модуля _thread.

Примитивная блокировка может находиться в одном из двух состояний: «захвачена» или «свободна». Она создаётся в свободном состоянии. У неё есть два основных метода: acquire() и release(). Когда состояние свободно, вызов acquire() переводит его в захваченное и немедленно возвращается. Когда состояние захвачено, acquire() блокируется до тех пор, пока вызов release() в другом потоке не переведёт его в свободное; затем вызов acquire() снова устанавливает захваченное состояние и возвращается. Метод release() следует вызывать только в захваченном состоянии; он переводит состояние в свободное и немедленно возвращается. При попытке освободить свободную блокировку будет возбуждено RuntimeError.

Блокировки также поддерживают протокол контекстного менеджера.

Когда несколько потоков заблокированы в acquire() в ожидании перехода состояния в свободное, только один поток продолжает выполнение, когда вызов release() переводит состояние в свободное; какой именно из ожидающих потоков продолжит, не определено и может различаться в разных реализациях.

Все методы выполняются атомарно.

class threading.Lock¶

Класс, реализующий объекты примитивной блокировки. Как только поток захватил блокировку, последующие попытки захватить её блокируются до тех пор, пока она не будет освобождена; любой поток может освободить её.

Изменено в версии 3.13: Lock теперь является классом. В более ранних версиях Python Lock была фабричной функцией, которая возвращала экземпляр внутреннего закрытого типа блокировки.

acquire(blocking=True, timeout=-1)¶

Захватывает блокировку, блокирующую или неблокирующую.

При вызове с аргументом blocking, установленным в True (по умолчанию), блокируется до тех пор, пока блокировка не станет свободной, затем устанавливает её в захваченное состояние и возвращает True.

При вызове с аргументом blocking, установленным в False, не блокируется. Если вызов с blocking, установленным в True, должен был бы заблокироваться, немедленно возвращает False; в противном случае устанавливает блокировку в захваченное состояние и возвращает True.

При вызове с аргументом timeout с плавающей запятой, установленным в положительное значение, блокируется на время, не превышающее количество секунд, указанное в timeout, и до тех пор, пока блокировка не может быть захвачена. Аргумент timeout, равный -1, означает неограниченное ожидание. Запрещается указывать timeout, когда blocking равно False.

Возвращаемое значение равно True, если блокировка успешно захвачена, и False в противном случае (например, если timeout истёк).

Изменено в версии 3.2: Параметр timeout является новым.

Изменено в версии 3.2: Теперь захват блокировки может быть прерван сигналами в POSIX, если базовая реализация потоков это поддерживает.

Изменено в версии 3.14: Теперь захват блокировки может быть прерван сигналами в Windows.

release()¶

Освобождает блокировку. Может вызываться из любого потока, а не только из того, который захватил блокировку.

Когда блокировка установлена, сбрасывает её в снятое состояние и возвращает управление. Если другие потоки заблокированы в ожидании освобождения блокировки, ровно одному из них разрешается продолжить работу.

При вызове на не заблокированной блокировке возбуждается исключение RuntimeError.

Возвращаемое значение отсутствует.

locked()¶

Возвращает True, если блокировка захвачена.

Объекты RLock¶RLock objects

Повторно входимая блокировка – это примитив синхронизации, который может быть захвачен одним и тем же потоком несколько раз. Внутри она использует понятия «поток-владелец» и «уровень рекурсии» в дополнение к состоянию «заблокировано/разблокировано», используемому простыми блокировками. В заблокированном состоянии блокировкой владеет какой-то поток; в разблокированном состоянии ею не владеет ни один поток.

Потоки вызывают метод acquire() блокировки, чтобы заблокировать её, и метод release(), чтобы разблокировать.

Пары вызовов acquire()/release() у RLock могут быть вложенными, в отличие от acquire()/release() у Lock. Только последний release() (release() самой внешней пары) сбрасывает блокировку в разблокированное состояние и позволяет другому потоку, заблокированному в acquire(), продолжить работу.

acquire()/release() должны использоваться парами: каждый вызов acquire должен сопровождаться release в том же потоке, который захватил блокировку. Если не вызвать release столько же раз, сколько была захвачена блокировка, это может привести к взаимоблокировке.

class threading.RLock¶

Этот класс реализует объекты повторно входимой блокировки. Повторно входимая блокировка должна быть освобождена тем же потоком, который её захватил. После того как поток захватил повторно входимую блокировку, этот же поток может захватить её снова без блокировки; при этом поток должен освободить её один раз за каждый захват.

Обратите внимание, что RLock на самом деле является фабричной функцией, которая возвращает экземпляр наиболее эффективной версии конкретного класса RLock, поддерживаемой платформой.

acquire(blocking=True, timeout=-1)¶

Захватывает блокировку, блокирующую или неблокирующую.

См. также

Использование RLock в качестве менеджера контекста

Рекомендуется вместо ручных вызовов acquire() и release(), когда это возможно.

При вызове с аргументом blocking, установленным в True (по умолчанию):

• Если ни один поток не владеет блокировкой, захватить блокировку и немедленно вернуть управление.

• Если другой поток владеет блокировкой, блокироваться до тех пор, пока не удастся захватить блокировку, или до истечения timeout, если он задан положительным числом с плавающей точкой.

• Если тот же поток владеет блокировкой, захватить блокировку снова и немедленно вернуть управление. В этом различие между Lock и RLock; Lock обрабатывает этот случай так же, как предыдущий, блокируясь до тех пор, пока блокировку не удастся захватить.

При вызове с аргументом blocking, установленным в False:

• Если ни один поток не владеет блокировкой, захватить блокировку и немедленно вернуть управление.

• Если другой поток владеет блокировкой, немедленно вернуть управление.

• Если тот же поток владеет блокировкой, захватить блокировку снова и немедленно вернуть управление.

Во всех случаях, если поток смог захватить блокировку, возвращает True. Если поток не смог захватить блокировку (например, если не ожидал или истекло время ожидания), возвращает False.

При многократном вызове, если не вызвать release() столько же раз, это может привести к взаимоблокировке. Рекомендуется использовать RLock в качестве менеджера контекста, а не вызывать acquire/release напрямую.

Изменено в версии 3.2: Параметр timeout является новым.

release()¶

Освобождает блокировку, уменьшая уровень рекурсии. Если после уменьшения он становится нулевым, сбрасывает блокировку в разблокированное состояние (не принадлежит ни одному потоку), и, если другие потоки заблокированы в ожидании освобождения блокировки, ровно одному из них разрешается продолжить. Если после уменьшения уровень рекурсии всё ещё ненулевой, блокировка остаётся заблокированной и принадлежит вызывающему потоку.

Вызывайте этот метод только в том случае, если вызывающий поток владеет блокировкой. Если этот метод вызывается, когда блокировка не захвачена, возбуждается RuntimeError.

Возвращаемое значение отсутствует.

locked()¶

Возвращает булево значение, указывающее, заблокирован ли данный объект в данный момент.

Добавлено в версии 3.14.

Объекты Condition¶Condition objects

Переменная условия всегда связана с какой-либо блокировкой; её можно передать, или же она будет создана по умолчанию. Передача блокировки полезна, когда несколько переменных условия должны совместно использовать одну и ту же блокировку. Блокировка является частью объекта условия: не нужно отслеживать её отдельно.

Переменная условия подчиняется протоколу менеджера контекста: использование выражения with захватывает связанную блокировку на время выполнения вложенного блока. Методы acquire() и release() также вызывают соответствующие методы связанной блокировки.

Остальные методы должны вызываться, когда связанная блокировка удерживается. Метод wait() освобождает блокировку, а затем блокируется, пока другой поток не пробудит его вызовом notify() или notify_all(). После пробуждения метод wait() повторно захватывает блокировку и возвращает управление. Также можно указать тайм-аут.

Метод notify() пробуждает один из потоков, ожидающих переменную условия, если таковые имеются. Метод notify_all() пробуждает все потоки, ожидающие переменную условия.

Примечание: методы notify() и notify_all() не освобождают блокировку; это означает, что пробуждённый поток (или потоки) не вернутся из своего вызова wait() немедленно, а только когда поток, вызвавший notify() или notify_all(), наконец откажется от владения блокировкой.

Типичный стиль программирования с использованием переменных условия использует блокировку для синхронизации доступа к некоторому общему состоянию; потоки, заинтересованные в определённом изменении состояния, многократно вызывают wait(), пока не увидят желаемое состояние, в то время как потоки, изменяющие состояние, вызывают notify() или notify_all(), когда они изменяют состояние таким образом, что это может быть желаемым состоянием для одного из ожидающих. Например, следующий код представляет собой общую ситуацию «производитель-потребитель» с неограниченной ёмкостью буфера:

# Потребить один элемент
with cv:
    while not an_item_is_available():
        cv.wait()
    get_an_available_item()

# Произвести один элемент
with cv:
    make_an_item_available()
    cv.notify()

Цикл while, проверяющий условие приложения, необходим, потому что wait() может вернуться после произвольно долгого времени, и условие, которое вызвало вызов notify(), может больше не выполняться. Это присуще многопоточному программированию. Метод wait_for() можно использовать для автоматизации проверки условия и упрощения расчёта тайм-аутов:

# Потребить элемент
with cv:
    cv.wait_for(an_item_is_available)
    get_an_available_item()

Чтобы выбрать между notify() и notify_all(), подумайте, может ли одно изменение состояния быть интересным только одному или нескольким ожидающим потокам. Например, в типичной ситуации «производитель-потребитель» добавление одного элемента в буфер требует пробуждения только одного потока-потребителя.

class threading.Condition(lock=None)¶

Этот класс реализует объекты переменной условия. Переменная условия позволяет одному или нескольким потокам ожидать, пока другой поток не уведомит их.

Если аргумент lock передан и не равен None, он должен быть объектом Lock или RLock и используется в качестве базовой блокировки. В противном случае создаётся новый объект RLock, который используется в качестве базовой блокировки.

Изменено в версии 3.3: изменён с фабричной функции на класс.

acquire(*args)¶

Захватывает базовую блокировку. Этот метод вызывает соответствующий метод базовой блокировки; возвращаемое значение – то, что возвращает этот метод.

release()¶

Освобождает базовую блокировку. Этот метод вызывает соответствующий метод базовой блокировки; возвращаемое значение отсутствует.

locked()¶

Возвращает булево значение, указывающее, заблокирован ли данный объект в данный момент.

Добавлено в версии 3.14.

wait(timeout=None)¶

Ожидает до получения уведомления или до наступления тайм-аута. Если вызывающий поток не захватил блокировку при вызове этого метода, возбуждается RuntimeError.

Этот метод освобождает базовую блокировку, а затем блокируется до тех пор, пока не будет пробуждён вызовом notify() или notify_all() для той же переменной условия в другом потоке, или пока не наступит необязательный тайм-аут. После пробуждения или истечения тайм-аута он повторно захватывает блокировку и возвращает управление.

Если аргумент timeout присутствует и не равен None, он должен быть числом с плавающей точкой, задающим тайм-аут для операции в секундах (или долях секунды).

Если базовая блокировка является RLock, она не освобождается с помощью метода release(), поскольку это может не разблокировать блокировку, если она была захвачена несколько раз рекурсивно. Вместо этого используется внутренний интерфейс класса RLock, который действительно разблокирует её, даже если она была рекурсивно захвачена несколько раз. Затем используется другой внутренний интерфейс для восстановления уровня рекурсии при повторном захвате блокировки.

Возвращаемое значение равно True, если только заданный timeout не истёк; в этом случае оно равно False.

Изменено в версии 3.2: Ранее метод всегда возвращал None.

wait_for(predicate, timeout=None)¶

Ожидает, пока условие не станет истинным. predicate должен быть вызываемым объектом, результат которого будет интерпретироваться как булево значение. Можно указать timeout, задающий максимальное время ожидания.

Этот вспомогательный метод может многократно вызывать wait() до тех пор, пока предикат не будет удовлетворён или пока не наступит тайм-аут. Возвращаемое значение – последнее возвращаемое значение предиката; оно будет равно False, если время ожидания истекло.

Если не учитывать возможность тайм-аута, вызов этого метода примерно эквивалентен следующему коду:

while not predicate():
    cv.wait()

Следовательно, применяются те же правила, что и для wait(): блокировка должна быть захвачена при вызове и повторно захватывается при возврате. Предикат вычисляется при удерживаемой блокировке.

Добавлено в версии 3.2.

notify(n=1)¶

По умолчанию пробуждает один поток, ожидающий на этом условии, если таковой имеется. Если вызывающий поток не захватил блокировку на момент вызова этого метода, возникает RuntimeError.

Этот метод пробуждает не более n потоков, ожидающих на переменной условия; если ни один поток не ожидает, он ничего не делает.

Текущая реализация пробуждает ровно n потоков, если ожидает не менее n потоков. Однако полагаться на такое поведение небезопасно. В будущем оптимизированная реализация может иногда пробуждать более n потоков.

Примечание: пробуждённый поток на самом деле не возвращается из вызова wait(), пока не сможет повторно захватить блокировку. Поскольку notify() не освобождает блокировку, это должен сделать его вызывающий код.

notify_all()¶

Пробуждает все потоки, ожидающие на этом условии. Этот метод действует как notify(), но пробуждает все ожидающие потоки вместо одного. Если вызывающий поток не захватил блокировку на момент вызова этого метода, возникает RuntimeError.

Метод notifyAll – устаревший псевдоним для этого метода.

Объекты семафоров¶Semaphore objects

Это один из старейших примитивов синхронизации в истории компьютерных наук, изобретённый ранним нидерландским учёным Эдсгером В. Дейкстрой (он использовал имена P() и V() вместо acquire() и release()).

Семафор управляет внутренним счётчиком, который уменьшается при каждом вызове acquire() и увеличивается при каждом вызове release(). Счётчик никогда не может стать меньше нуля; когда acquire() обнаруживает, что он равен нулю, он блокируется, ожидая, пока другой поток вызовет release().

Семафоры также поддерживают протокол менеджера контекста.

class threading.Semaphore(value=1)¶

Этот класс реализует объекты семафоров. Семафор управляет атомарным счётчиком, представляющим количество вызовов release() минус количество вызовов acquire() плюс начальное значение. Метод acquire() при необходимости блокируется, пока не сможет вернуться, не сделав счётчик отрицательным. Если не указано, value по умолчанию равно 1.

Необязательный аргумент задаёт начальное value для внутреннего счётчика; по умолчанию оно равно 1. Если указанное value меньше 0, возникает ValueError.

Изменено в версии 3.3: изменён с фабричной функции на класс.

acquire(blocking=True, timeout=None)¶

Захватывает семафор.

При вызове без аргументов:

• Если внутренний счётчик больше нуля при входе, уменьшить его на единицу и немедленно вернуть True.

• Если внутренний счётчик равен нулю при входе, блокироваться до пробуждения вызовом release(). После пробуждения (когда счётчик станет больше 0) уменьшить счётчик на 1 и вернуть True. Каждый вызов release() пробуждает ровно один поток. На порядок пробуждения потоков полагаться не следует.

При вызове с blocking, установленным в False, не блокироваться. Если вызов без аргументов заблокировался бы, немедленно вернуть False; в противном случае сделать то же, что и при вызове без аргументов, и вернуть True.

При вызове с timeout, отличным от None, он будет блокироваться не более timeout секунд. Если acquire не завершится успешно за это время, вернуть False. В противном случае вернуть True.

Изменено в версии 3.2: Параметр timeout является новым.

release(n=1)¶

Освобождает семафор, увеличивая внутренний счётчик на n. Если на входе он был равен нулю, и другие потоки ожидают его увеличения, пробуждает n из этих потоков.

Изменено в версии 3.9: Добавлен параметр n для освобождения нескольких ожидающих потоков одновременно.

class threading.BoundedSemaphore(value=1)¶

Класс, реализующий объекты ограниченного семафора. Ограниченный семафор проверяет, что его текущее значение не превышает начальное. Если превышает, возникает ValueError. В большинстве ситуаций семафоры используются для защиты ресурсов с ограниченной ёмкостью. Если семафор освобождается слишком много раз, это признак ошибки. Если не указано, value по умолчанию равно 1.

Изменено в версии 3.3: изменён с фабричной функции на класс.

Semaphore пример¶Semaphore example

Семафоры часто используются для защиты ресурсов с ограниченной ёмкостью, например, сервера базы данных. В любой ситуации, когда размер ресурса фиксирован, следует использовать ограниченный семафор. Перед запуском рабочих потоков главный поток инициализирует семафор:

maxconnections = 5
# ...
pool_sema = BoundedSemaphore(value=maxconnections)

После запуска рабочие потоки вызывают методы acquire и release семафора, когда им нужно подключиться к серверу:

with pool_sema:
    conn = connectdb()
    try:
        # ... использовать соединение ...
    finally:
        conn.close()

Использование ограниченного семафора снижает вероятность того, что ошибка программирования, приводящая к освобождению семафора большее количество раз, чем его захват, останется незамеченной.

Объекты событий¶Event objects

Это один из простейших механизмов взаимодействия между потоками: один поток сигнализирует о событии, а другие потоки ожидают его.

Объект события управляет внутренним флагом, который можно установить в true с помощью метода set() и сбросить в false с помощью метода clear(). Метод wait() блокируется до тех пор, пока флаг не станет true.

class threading.Event¶

Класс, реализующий объекты событий. Событие управляет флагом, который можно установить в true методом set() и сбросить в false методом clear(). Метод wait() блокируется до тех пор, пока флаг не станет true. Изначально флаг равен false.

Изменено в версии 3.3: изменён с фабричной функции на класс.

is_set()¶

Возвращает True тогда и только тогда, когда внутренний флаг равен true.

Метод isSet – устаревший псевдоним для этого метода.

set()¶

Устанавливает внутренний флаг в true. Все потоки, ожидающие его установки, пробуждаются. Потоки, вызывающие wait() после того, как флаг стал true, не будут блокироваться вовсе.

clear()¶

Сбрасывает внутренний флаг в false. После этого потоки, вызывающие wait(), будут блокироваться до тех пор, пока не будет вызван set(), чтобы снова установить внутренний флаг в true.

wait(timeout=None)¶

Блокируется до тех пор, пока внутренний флаг равен false, и не истёк переданный тайм-аут (если он задан). Возвращаемое значение указывает причину, по которой этот блокирующий метод вернул управление: True – если возврат произошёл из-за установки внутреннего флага в true, или False – если был задан тайм-аут и внутренний флаг не стал true за указанное время ожидания.

Если аргумент timeout присутствует и не равен None, он должен быть числом с плавающей запятой, задающим время ожидания операции в секундах (или долях секунды).

Изменено в версии 3.1: Ранее метод всегда возвращал None.

Объекты таймеров¶Timer objects

Этот класс представляет действие, которое должно быть выполнено только по прошествии определённого времени – таймер. Timer является подклассом Thread и, таким образом, служит примером создания пользовательских потоков.

Таймеры запускаются, как и потоки, вызовом метода Timer.start. Таймер можно остановить (до начала его действия) вызовом метода cancel(). Интервал, который таймер будет ждать перед выполнением действия, может не совпадать в точности с интервалом, указанным пользователем.

Например:

def hello():
    print("hello, world")

t = Timer(30.0, hello)
t.start()  # через 30 секунд будет выведено "hello, world"

class threading.Timer(interval, function, args=None, kwargs=None)¶

Создаёт таймер, который запустит function с аргументами args и именованными аргументами kwargs по прошествии interval секунд. Если args равен None (значение по умолчанию), будет использован пустой список. Если kwargs равен None (значение по умолчанию), будет использован пустой словарь.

Изменено в версии 3.3: изменён с фабричной функции на класс.

cancel()¶

Останавливает таймер и отменяет выполнение его действия. Это сработает, только если таймер всё ещё находится в стадии ожидания.

Объекты барьеров¶Barrier objects

Этот класс предоставляет простой примитив синхронизации для использования фиксированным числом потоков, которым нужно ждать друг друга. Каждый из потоков пытается пройти барьер, вызывая метод wait(), и блокируется до тех пор, пока все потоки не вызовут wait(). После этого потоки освобождаются одновременно.

Барьер можно использовать повторно любое количество раз для того же числа потоков.

В качестве примера приведён простой способ синхронизации потоков клиента и сервера:

b = Barrier(2, timeout=5)

def server():
    start_server()
    b.wait()
    while True:
        connection = accept_connection()
        process_server_connection(connection)

def client():
    b.wait()
    while True:
        connection = make_connection()
        process_client_connection(connection)

class threading.Barrier(parties, action=None, timeout=None)¶

Создаёт объект барьера для parties потоков. action, если задан, – это вызываемый объект, который будет вызван одним из потоков при освобождении. timeout – значение тайм-аута по умолчанию, если не указано другое для метода wait().

wait(timeout=None)¶

Пройти барьер. Когда все потоки-участники барьера вызовут эту функцию, они все освобождаются одновременно. Если указан timeout, он используется с приоритетом перед любым значением, переданным конструктору класса.

Возвращаемое значение – целое число в диапазоне от 0 до parties – 1, различное для каждого потока. Это можно использовать для выбора потока, который выполнит специальные вспомогательные действия, например:

i = barrier.wait()
if i == 0:
    # Выводить это должен только один поток
    print("passed the barrier")

Если конструктору был передан action, один из потоков вызовет его перед освобождением. Если этот вызов вызовет ошибку, барьер переводится в состояние сбоя.

Если вызов истекает по таймауту, барьер переводится в сломанное состояние.

Этот метод может вызвать исключение BrokenBarrierError, если барьер сломан или сброшен, пока поток ожидает.

reset()¶

Возвращает барьер в исходное пустое состояние. Любые потоки, ожидающие его, получат исключение BrokenBarrierError.

Обратите внимание, что использование этой функции может потребовать внешней синхронизации, если есть другие потоки, состояние которых неизвестно. Если барьер сломан, возможно, лучше просто оставить его и создать новый.

abort()¶

Переводит барьер в сломанное состояние. Это приводит к тому, что любые активные или будущие вызовы wait() завершатся ошибкой с BrokenBarrierError. Используйте это, например, если один из потоков необходимо прервать, чтобы избежать взаимоблокировки приложения.

Возможно, предпочтительнее просто создать барьер с разумным значением timeout, чтобы автоматически защититься от сбоя одного из потоков.

parties¶

Количество потоков, необходимое для прохождения барьера.

n_waiting¶

Количество потоков, ожидающих в данный момент на барьере.

broken¶

Логическое значение, которое равно True, если барьер находится в сломанном состоянии.

exception threading.BrokenBarrierError¶

Это исключение, подкласс RuntimeError, вызывается, когда объект Barrier сбрасывается или ломается.