`threading.md`

599 строк · 73.7 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.7/library/threading.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`threading`](https://python-all.ru/3.7/library/threading.html#module-threading) – параллелизм на основе потоков89**Исходный код:** [Lib/threading.py](https://python-all.ru/src/3.7/Lib/threading.py)1011---1213Этот модуль предоставляет высокоуровневые интерфейсы для работы с потоками поверх низкоуровневого модуля [`_thread`](https://python-all.ru/3.7/library/_thread.html#module-_thread). Смотрите также модуль [`queue`](https://python-all.ru/3.7/library/queue.html#module-queue).1415Изменено в версии 3.7: Ранее этот модуль был опциональным, теперь он всегда доступен.1617> **Примечание**18>19> Хотя они не перечислены ниже, имена `camelCase`, которые использовались для некоторых методов и функций в этом модуле в серии Python 2.x, по-прежнему поддерживаются этим модулем.2021**Особенность реализации CPython:** В CPython из-за [глобальной блокировки интерпретатора](https://python-all.ru/3.7/glossary.html#term-global-interpreter-lock) только один поток может выполнять код Python одновременно (хотя некоторые библиотеки, ориентированные на производительность, могут обойти это ограничение). Если вы хотите, чтобы ваше приложение лучше использовало вычислительные ресурсы многоядерных машин, рекомендуется использовать [`multiprocessing`](https://python-all.ru/3.7/library/multiprocessing.html#module-multiprocessing) или [`concurrent.futures.ProcessPoolExecutor`](https://python-all.ru/3.7/library/concurrent.futures.html#concurrent.futures.ProcessPoolExecutor). Однако многопоточность всё ещё является подходящей моделью, если нужно запустить несколько задач с интенсивным вводом-выводом одновременно.2223Этот модуль определяет следующие функции:2425#### `threading.active_count()`2627Возвращает количество [`Thread`](https://python-all.ru/3.7/library/threading.html#threading.Thread) объектов, которые сейчас активны. Возвращённое число равно длине списка, возвращаемого [`enumerate()`](https://python-all.ru/3.7/library/threading.html#threading.enumerate).2829#### `threading.current_thread()`3031Возвращает текущий [`Thread`](https://python-all.ru/3.7/library/threading.html#threading.Thread) объект, соответствующий потоку управления вызывающего кода. Если поток управления вызывающего кода не был создан через модуль [`threading`](https://python-all.ru/3.7/library/threading.html#module-threading), возвращается фиктивный объект потока с ограниченной функциональностью.3233#### `threading.get_ident()`3435Возвращает «идентификатор потока» текущего потока. Это ненулевое целое число. Его значение не имеет прямого смысла; оно предназначено как уникальная метка, используемая, например, для индексации словаря с данными, специфичными для потока. Идентификаторы потоков могут быть переиспользованы, когда один поток завершается, а другой создаётся.3637Новое в версии 3.3.3839#### `threading.enumerate()`4041Возвращает список всех активных на данный момент объектов [`Thread`](https://python-all.ru/3.7/library/threading.html#threading.Thread). Список включает потоки-демоны, фиктивные объекты потоков, созданные [`current_thread()`](https://python-all.ru/3.7/library/threading.html#threading.current_thread), и главный поток. Из него исключены завершённые потоки и потоки, которые ещё не были запущены.4243#### `threading.main_thread()`4445Возвращает основной объект [`Thread`](https://python-all.ru/3.7/library/threading.html#threading.Thread). В обычных условиях главный поток – это поток, с которого был запущен интерпретатор Python.4647Новое в версии 3.4.4849#### `threading.settrace(func)`5051Устанавливает трассировочную функцию для всех потоков, запущенных из модуля [`threading`](https://python-all.ru/3.7/library/threading.html#module-threading). Функция *func* будет передана в [`sys.settrace()`](https://python-all.ru/3.7/library/sys.html#sys.settrace) для каждого потока перед вызовом его метода [`run()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.run).5253#### `threading.setprofile(func)`5455Устанавливает профилирующую функцию для всех потоков, запущенных из модуля [`threading`](https://python-all.ru/3.7/library/threading.html#module-threading). Функция *func* будет передана в [`sys.setprofile()`](https://python-all.ru/3.7/library/sys.html#sys.setprofile) для каждого потока перед вызовом его метода [`run()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.run).5657#### `threading.stack_size([size])`5859Возвращает размер стека потока, используемый при создании новых потоков. Необязательный аргумент *size* задаёт размер стека для впоследствии создаваемых потоков и должен быть равен 0 (используется платформенное или настроенное значение по умолчанию) или положительному целому числу не менее 32 768 (32 КиБ). Если *size* не указан, используется 0. Если изменение размера стека не поддерживается, возбуждается [`RuntimeError`](https://python-all.ru/3.7/library/exceptions.html#RuntimeError). Если указанный размер стека некорректен, возбуждается [`ValueError`](https://python-all.ru/3.7/library/exceptions.html#ValueError), а размер стека остаётся без изменений. 32 КиБ – это минимально поддерживаемый размер стека, достаточный для самого интерпретатора. Имейте в виду, что на некоторых платформах могут быть особые ограничения на значения размера стека, например, требование минимального размера больше 32 КиБ или выделения памяти кратно размеру системной страницы памяти – за более подробной информацией следует обращаться к документации платформы (обычно используются страницы по 4 КиБ; при отсутствии более точных сведений рекомендуется задавать размер стека кратно 4096).6061[Доступность](https://python-all.ru/3.7/library/intro.html#availability): Windows, системы с POSIX-потоками.6263Этот модуль также определяет следующую константу:6465#### `threading.TIMEOUT_MAX`6667Максимально допустимое значение для параметра *timeout* блокирующих функций ([`Lock.acquire()`](https://python-all.ru/3.7/library/threading.html#threading.Lock.acquire), [`RLock.acquire()`](https://python-all.ru/3.7/library/threading.html#threading.RLock.acquire), [`Condition.wait()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.wait) и т.д.). Указание тайм-аута, превышающего это значение, вызовет исключение [`OverflowError`](https://python-all.ru/3.7/library/exceptions.html#OverflowError).6869Новое в версии 3.2.7071Этот модуль определяет ряд классов, которые подробно описаны в разделах ниже.7273Дизайн этого модуля основан на модели потоков Java, хотя и нестрого. Однако если в Java блокировки и условные переменные являются базовым поведением каждого объекта, то в Python это отдельные объекты. Класс [`Thread`](https://python-all.ru/3.7/library/threading.html#threading.Thread) в Python поддерживает подмножество поведения класса Thread из Java; в настоящее время отсутствуют приоритеты, группы потоков, а потоки нельзя уничтожать, останавливать, приостанавливать, возобновлять или прерывать. Статические методы класса Thread из Java, если они реализованы, отображаются на функции уровня модуля.7475Все описанные ниже методы выполняются атомарно.7677## Локальные данные потока7879Локальные данные потока – это данные, значения которых привязаны к конкретному потоку. Для управления такими данными достаточно создать экземпляр [`local`](https://python-all.ru/3.7/library/threading.html#threading.local) (или подкласса) и сохранять в нём атрибуты.8081```python82mydata = threading.local()83mydata.x = 184```8586Значения экземпляра будут разными для разных потоков.8788#### `class threading.local`8990Класс, представляющий данные, локальные для потока.9192Подробнее и с большим количеством примеров см. строку документации модуля `_threading_local`.9394## Объекты потоков9596Класс [`Thread`](https://python-all.ru/3.7/library/threading.html#threading.Thread) представляет собой активность, выполняемую в отдельном потоке управления. Есть два способа определить активность: передать вызываемый объект в конструктор или переопределить метод [`run()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.run) в подклассе. Никакие другие методы (кроме конструктора) не должны переопределяться в подклассе. Иными словами, переопределяйте *только* методы `__init__()` и [`run()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.run) этого класса.9798После создания объекта потока его активность должна быть запущена вызовом метода [`start()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.start) этого потока. Это вызывает метод [`run()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.run) в отдельном потоке управления.99100После запуска активности поток считается «живым». Он перестаёт быть живым, когда завершается его метод [`run()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.run) – либо нормально, либо из-за необработанного исключения. Метод [`is_alive()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.is_alive) проверяет, жив ли поток.101102Другие потоки могут вызывать метод [`join()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.join) потока. Это блокирует вызывающий поток до тех пор, пока поток, чей метод [`join()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.join) вызывается, не завершится.103104У потока есть имя. Имя можно передать конструктору, а также прочитать или изменить через атрибут [`name`](https://python-all.ru/3.7/library/threading.html#threading.Thread.name).105106Поток может быть помечен как «фоновый поток». Смысл этого флага в том, что вся программа Python завершается, когда остаются только фоновые потоки. Начальное значение наследуется от создающего потока. Флаг можно установить через свойство [`daemon`](https://python-all.ru/3.7/library/threading.html#threading.Thread.daemon) или аргумент конструктора *daemon*.107108> **Примечание**109>110> Фоновые потоки принудительно останавливаются при завершении программы. Их ресурсы (такие как открытые файлы, транзакции базы данных и т.п.) могут быть не освобождены должным образом. Если нужно, чтобы потоки завершались корректно, сделайте их не фоновыми и используйте подходящий механизм уведомлений, например [`Event`](https://python-all.ru/3.7/library/threading.html#threading.Event).111112Существует объект «главный поток»; он соответствует начальному потоку управления в программе Python. Это не фоновый поток.113114Существует вероятность создания «фиктивных объектов потоков» (dummy thread objects). Это объекты потоков, соответствующие «внешним потокам» (alien threads) – потокам управления, запущенным за пределами модуля threading, например напрямую из кода на C. Фиктивные объекты потоков имеют ограниченную функциональность: они всегда считаются активными и демоническими, и их нельзя [`join()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.join). Они никогда не удаляются, так как невозможно определить завершение внешних потоков.115116#### `class threading.Thread(group=None, target=None, name=None, args=(), kwargs={}, *, daemon=None)`117118Этот конструктор всегда следует вызывать с именованными аргументами. Аргументы:119120*group* должен быть `None`; зарезервирован для будущего расширения, когда будет реализован класс `ThreadGroup`.121122*target* – это вызываемый объект, который будет вызван методом [`run()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.run). По умолчанию `None`, то есть ничего не вызывается.123124*name* – это имя потока. По умолчанию создаётся уникальное имя вида «Поток-*N*», где *N* – небольшое десятичное число.125126*args* – кортеж аргументов для вызова целевой функции. По умолчанию равен `()`.127128*kwargs* – это словарь именованных аргументов для вызова target. По умолчанию `{}`.129130Если не `None`, параметр *daemon* явно задаёт, является ли поток демоническим. Если `None` (по умолчанию), свойство демоничности наследуется от текущего потока.131132Если подкласс переопределяет конструктор, он должен обязательно вызвать конструктор базового класса (`Thread.__init__()`) перед любыми другими действиями с потоком.133134Изменено в версии 3.3: Добавлен аргумент *daemon*.135136#### `start()`137138Запускает выполнение потока.139140Этот метод должен вызываться не более одного раза для каждого объекта потока. Он обеспечивает вызов метода [`run()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.run) объекта в отдельном потоке управления.141142Этот метод возбуждает исключение [`RuntimeError`](https://python-all.ru/3.7/library/exceptions.html#RuntimeError), если вызван более одного раза для одного и того же объекта потока.143144#### `run()`145146Метод, представляющий действие потока.147148Этот метод можно переопределить в подклассе. Стандартный метод [`run()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.run) вызывает вызываемый объект, переданный конструктору объекта в качестве аргумента *target* (если он задан), с позиционными и именованными аргументами, взятыми соответственно из аргументов *args* и *kwargs*.149150#### `join(timeout=None)`151152Ожидает завершения потока. Блокирует вызывающий поток до тех пор, пока поток, у которого вызван метод [`join()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.join), не завершится – либо нормально, либо из-за необработанного исключения – или пока не истечёт заданный тайм-аут.153154Если аргумент *timeout* указан и не равен `None`, он должен быть числом с плавающей запятой, задающим тайм-аут для операции в секундах (или долях секунды). Поскольку [`join()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.join) всегда возвращает `None`, после [`join()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.join) необходимо вызвать [`is_alive()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.is_alive), чтобы определить, произошёл ли тайм-аут – если поток всё ещё жив, вызов [`join()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.join) был прерван по тайм-ауту.155156Если аргумент *timeout* отсутствует или равен `None`, операция блокируется до завершения потока.157158Поток можно [`join()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.join) много раз.159160[`join()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.join) возбуждает [`RuntimeError`](https://python-all.ru/3.7/library/exceptions.html#RuntimeError), если предпринимается попытка присоединиться к текущему потоку, так как это привело бы к взаимоблокировке. Также ошибочно [`join()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.join) поток до его запуска, и попытки сделать это возбуждают то же исключение.161162#### `name`163164Строка, используемая только для идентификации. Она не имеет семантического значения. Разным потокам можно задать одно и то же имя. Начальное имя устанавливается конструктором.165166#### `getName()`167168#### `setName()`169170Устаревший API геттера/сеттера для [`name`](https://python-all.ru/3.7/library/threading.html#threading.Thread.name); вместо этого используйте его напрямую как свойство.171172#### `ident`173174«Идентификатор потока» этого потока или `None`, если поток не был запущен. Это ненулевое целое число. См. функцию [`get_ident()`](https://python-all.ru/3.7/library/threading.html#threading.get_ident). Идентификаторы потоков могут быть повторно использованы, когда поток завершается и создаётся другой поток. Идентификатор доступен даже после завершения потока.175176#### `is_alive()`177178Возвращает, жив ли поток.179180Этот метод возвращает `True` непосредственно перед началом выполнения метода [`run()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.run) и до завершения метода [`run()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.run). Функция модуля [`enumerate()`](https://python-all.ru/3.7/library/threading.html#threading.enumerate) возвращает список всех живых потоков.181182#### `daemon`183184Логическое значение, указывающее, является ли данный поток демоном (True) или нет (False). Это значение должно быть установлено до вызова [`start()`](https://python-all.ru/3.7/library/threading.html#threading.Thread.start), иначе будет вызвано исключение [`RuntimeError`](https://python-all.ru/3.7/library/exceptions.html#RuntimeError). Его начальное значение наследуется от создавшего потока; главный поток не является потоком-демоном, поэтому все потоки, созданные в главном потоке, по умолчанию имеют [`daemon`](https://python-all.ru/3.7/library/threading.html#threading.Thread.daemon) = `False`.185186Вся программа Python завершается, когда не остаётся ни одного живого потока, не являющегося демоном.187188#### `isDaemon()`189190#### `setDaemon()`191192Устаревший API геттера/сеттера для [`daemon`](https://python-all.ru/3.7/library/threading.html#threading.Thread.daemon); вместо этого используйте его напрямую как свойство.193194## Объекты блокировки195196Примитивная блокировка – это примитив синхронизации, который при захвате не принадлежит какому-либо определённому потоку. В Python в настоящее время это самый низкоуровневый доступный примитив синхронизации, реализованный непосредственно в расширении модуля [`_thread`](https://python-all.ru/3.7/library/_thread.html#module-_thread).197198Примитивная блокировка может находиться в одном из двух состояний: «захвачена» или «свободна». Она создаётся в свободном состоянии. У неё есть два основных метода: [`acquire()`](https://python-all.ru/3.7/library/threading.html#threading.Lock.acquire) и [`release()`](https://python-all.ru/3.7/library/threading.html#threading.Lock.release). Когда состояние свободно, вызов [`acquire()`](https://python-all.ru/3.7/library/threading.html#threading.Lock.acquire) переводит его в захваченное и немедленно возвращается. Когда состояние захвачено, [`acquire()`](https://python-all.ru/3.7/library/threading.html#threading.Lock.acquire) блокируется до тех пор, пока вызов [`release()`](https://python-all.ru/3.7/library/threading.html#threading.Lock.release) в другом потоке не переведёт его в свободное; затем вызов [`acquire()`](https://python-all.ru/3.7/library/threading.html#threading.Lock.acquire) снова устанавливает захваченное состояние и возвращается. Метод [`release()`](https://python-all.ru/3.7/library/threading.html#threading.Lock.release) следует вызывать только в захваченном состоянии; он переводит состояние в свободное и немедленно возвращается. При попытке освободить свободную блокировку будет возбуждено [`RuntimeError`](https://python-all.ru/3.7/library/exceptions.html#RuntimeError).199200Блокировки также поддерживают [протокол контекстного менеджера](https://python-all.ru/3.7/library/threading.html#with-locks).201202Когда несколько потоков заблокированы в [`acquire()`](https://python-all.ru/3.7/library/threading.html#threading.Lock.acquire) в ожидании перехода состояния в свободное, только один поток продолжает выполнение, когда вызов [`release()`](https://python-all.ru/3.7/library/threading.html#threading.Lock.release) переводит состояние в свободное; какой именно из ожидающих потоков продолжит, не определено и может различаться в разных реализациях.203204Все методы выполняются атомарно.205206#### `class threading.Lock`207208Класс, реализующий объекты примитивной блокировки. Как только поток захватил блокировку, последующие попытки захватить её блокируются до тех пор, пока она не будет освобождена; любой поток может освободить её.209210Отметим, что `Lock` – это фабричная функция, возвращающая экземпляр наиболее эффективной версии конкретного класса блокировки, поддерживаемой платформой.211212#### `acquire(blocking=True, timeout=-1)`213214Захватывает блокировку, блокирующую или неблокирующую.215216При вызове с аргументом *blocking*, установленным в `True` (по умолчанию), блокируется до тех пор, пока блокировка не станет свободной, затем устанавливает её в захваченное состояние и возвращает `True`.217218При вызове с аргументом *blocking*, установленным в `False`, не блокируется. Если вызов с *blocking*, установленным в `True`, должен был бы заблокироваться, немедленно возвращает `False`; в противном случае устанавливает блокировку в захваченное состояние и возвращает `True`.219220Если при вызове аргументу *timeout* с плавающей запятой задано положительное значение, блокировка происходит на время не более указанного *timeout* секунд, пока не будет получена блокировка. Значение *timeout*, равное `-1`, означает бесконечное ожидание. Запрещено указывать *timeout*, когда *blocking* равно false.221222Возвращаемое значение равно `True`, если блокировка успешно захвачена, и `False` в противном случае (например, если *timeout* истёк).223224Изменено в версии 3.2: Параметр *timeout* является новым.225226Изменено в версии 3.2: Теперь захват блокировки может быть прерван сигналами в POSIX, если базовая реализация потоков это поддерживает.227228#### `release()`229230Освобождает блокировку. Может вызываться из любого потока, а не только из того, который захватил блокировку.231232Когда блокировка установлена, сбрасывает её в снятое состояние и возвращает управление. Если другие потоки заблокированы в ожидании освобождения блокировки, ровно одному из них разрешается продолжить работу.233234При вызове на не заблокированной блокировке возбуждается исключение [`RuntimeError`](https://python-all.ru/3.7/library/exceptions.html#RuntimeError).235236Возвращаемое значение отсутствует.237238#### `locked()`239240Возвращает true, если блокировка получена.241242## Объекты RLock243244Повторно входимая блокировка – это примитив синхронизации, который может быть захвачен одним и тем же потоком несколько раз. Внутри она использует понятия «поток-владелец» и «уровень рекурсии» в дополнение к состоянию «заблокировано/разблокировано», используемому простыми блокировками. В заблокированном состоянии блокировкой владеет какой-то поток; в разблокированном состоянии ею не владеет ни один поток.245246Чтобы захватить блокировку, поток вызывает её метод [`acquire()`](https://python-all.ru/3.7/library/threading.html#threading.RLock.acquire); этот метод возвращает управление, когда поток получает блокировку. Чтобы освободить блокировку, поток вызывает её метод [`release()`](https://python-all.ru/3.7/library/threading.html#threading.Lock.release). Пары вызовов [`acquire()`](https://python-all.ru/3.7/library/threading.html#threading.Lock.acquire)/[`release()`](https://python-all.ru/3.7/library/threading.html#threading.Lock.release) могут быть вложенными; только последний [`release()`](https://python-all.ru/3.7/library/threading.html#threading.Lock.release) ( [`release()`](https://python-all.ru/3.7/library/threading.html#threading.Lock.release) самой внешней пары) переводит блокировку в состояние «свободна» и позволяет другому потоку, заблокированному в [`acquire()`](https://python-all.ru/3.7/library/threading.html#threading.Lock.acquire), продолжить работу.247248Рекурсивные блокировки также поддерживают [протокол контекстного менеджера](https://python-all.ru/3.7/library/threading.html#with-locks).249250#### `class threading.RLock`251252Этот класс реализует объекты повторно входимой блокировки. Повторно входимая блокировка должна быть освобождена тем же потоком, который её захватил. После того как поток захватил повторно входимую блокировку, этот же поток может захватить её снова без блокировки; при этом поток должен освободить её один раз за каждый захват.253254Обратите внимание, что `RLock` на самом деле является фабричной функцией, которая возвращает экземпляр наиболее эффективной версии конкретного класса RLock, поддерживаемой платформой.255256#### `acquire(blocking=True, timeout=-1)`257258Захватывает блокировку, блокирующую или неблокирующую.259260При вызове без аргументов: если этот поток уже владеет блокировкой, увеличить уровень рекурсии на единицу и немедленно вернуться. В противном случае, если блокировкой владеет другой поток, блокироваться до тех пор, пока блокировка не будет освобождена. Как только блокировка освобождена (не принадлежит ни одному потоку), захватить владение, установить уровень рекурсии в единицу и вернуться. Если несколько потоков заблокированы в ожидании освобождения блокировки, только один из них сможет захватить владение. В этом случае возвращаемого значения нет.261262Если при вызове аргументу *blocking* задано значение true, поведение такое же, как при вызове без аргументов, и возвращается `True`.263264Если при вызове аргументу *blocking* задано значение false, блокировка не происходит. Если вызов без аргументов привёл бы к блокировке, сразу возвращается `False`; в противном случае поведение такое же, как при вызове без аргументов, и возвращается `True`.265266Если при вызове аргументу *timeout* с плавающей запятой задано положительное значение, блокировка происходит на время не более указанного *timeout* секунд, пока не будет получена блокировка. Возвращается `True`, если блокировка была получена, и false, если истекло время ожидания.267268Изменено в версии 3.2: Параметр *timeout* является новым.269270#### `release()`271272Освобождает блокировку, уменьшая уровень рекурсии. Если после уменьшения он становится нулевым, сбрасывает блокировку в разблокированное состояние (не принадлежит ни одному потоку), и, если другие потоки заблокированы в ожидании освобождения блокировки, ровно одному из них разрешается продолжить. Если после уменьшения уровень рекурсии всё ещё ненулевой, блокировка остаётся заблокированной и принадлежит вызывающему потоку.273274Вызывайте этот метод только тогда, когда вызывающий поток владеет блокировкой. Возбуждается исключение [`RuntimeError`](https://python-all.ru/3.7/library/exceptions.html#RuntimeError), если этот метод вызван, когда блокировка не захвачена.275276Возвращаемое значение отсутствует.277278## Объекты Condition279280Переменная условия всегда связана с какой-либо блокировкой; её можно передать, или же она будет создана по умолчанию. Передача блокировки полезна, когда несколько переменных условия должны совместно использовать одну и ту же блокировку. Блокировка является частью объекта условия: не нужно отслеживать её отдельно.281282Переменная условия подчиняется [протоколу менеджера контекста](https://python-all.ru/3.7/library/threading.html#with-locks): использование выражения `with` захватывает связанную блокировку на время выполнения вложенного блока. Методы [`acquire()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.acquire) и [`release()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.release) также вызывают соответствующие методы связанной блокировки.283284Остальные методы должны вызываться, когда связанная блокировка удерживается. Метод [`wait()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.wait) освобождает блокировку, а затем блокируется, пока другой поток не пробудит его вызовом [`notify()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify) или [`notify_all()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify_all). После пробуждения метод [`wait()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.wait) повторно захватывает блокировку и возвращает управление. Также можно указать тайм-аут.285286Метод [`notify()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify) пробуждает один из потоков, ожидающих переменную условия, если таковые имеются. Метод [`notify_all()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify_all) пробуждает все потоки, ожидающие переменную условия.287288Примечание: методы [`notify()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify) и [`notify_all()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify_all) не освобождают блокировку; это означает, что пробуждённый поток (или потоки) не вернутся из своего вызова [`wait()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.wait) немедленно, а только когда поток, вызвавший [`notify()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify) или [`notify_all()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify_all), наконец откажется от владения блокировкой.289290Типичный стиль программирования с использованием переменных условия использует блокировку для синхронизации доступа к некоторому общему состоянию; потоки, заинтересованные в определённом изменении состояния, многократно вызывают [`wait()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.wait), пока не увидят желаемое состояние, в то время как потоки, изменяющие состояние, вызывают [`notify()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify) или [`notify_all()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify_all), когда они изменяют состояние таким образом, что это может быть желаемым состоянием для одного из ожидающих. Например, следующий код представляет собой общую ситуацию «производитель-потребитель» с неограниченной ёмкостью буфера:291292```python293# Потребить один элемент294with cv:295    while not an_item_is_available():296        cv.wait()297    get_an_available_item()298299# Произвести один элемент300with cv:301    make_an_item_available()302    cv.notify()303```304305Цикл `while`, проверяющий условие приложения, необходим, потому что [`wait()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.wait) может вернуться после произвольно долгого времени, и условие, которое вызвало вызов [`notify()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify), может больше не выполняться. Это присуще многопоточному программированию. Метод [`wait_for()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.wait_for) можно использовать для автоматизации проверки условия и упрощения расчёта тайм-аутов:306307```python308# Потребить элемент309with cv:310    cv.wait_for(an_item_is_available)311    get_an_available_item()312```313314Чтобы выбрать между [`notify()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify) и [`notify_all()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify_all), подумайте, может ли одно изменение состояния быть интересным только одному или нескольким ожидающим потокам. Например, в типичной ситуации «производитель-потребитель» добавление одного элемента в буфер требует пробуждения только одного потока-потребителя.315316#### `class threading.Condition(lock=None)`317318Этот класс реализует объекты переменной условия. Переменная условия позволяет одному или нескольким потокам ожидать, пока другой поток не уведомит их.319320Если аргумент *lock* передан и не равен `None`, он должен быть объектом [`Lock`](https://python-all.ru/3.7/library/threading.html#threading.Lock) или [`RLock`](https://python-all.ru/3.7/library/threading.html#threading.RLock) и используется в качестве базовой блокировки. В противном случае создаётся новый объект [`RLock`](https://python-all.ru/3.7/library/threading.html#threading.RLock), который используется в качестве базовой блокировки.321322Изменено в версии 3.3: изменён с фабричной функции на класс.323324#### `acquire(*args)`325326Захватывает базовую блокировку. Этот метод вызывает соответствующий метод базовой блокировки; возвращаемое значение – то, что возвращает этот метод.327328#### `release()`329330Освобождает базовую блокировку. Этот метод вызывает соответствующий метод базовой блокировки; возвращаемое значение отсутствует.331332#### `wait(timeout=None)`333334Ожидает до получения уведомления или до наступления тайм-аута. Если вызывающий поток не захватил блокировку при вызове этого метода, возбуждается [`RuntimeError`](https://python-all.ru/3.7/library/exceptions.html#RuntimeError).335336Этот метод освобождает базовую блокировку, а затем блокируется до тех пор, пока не будет пробуждён вызовом [`notify()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify) или [`notify_all()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify_all) для той же переменной условия в другом потоке, или пока не наступит необязательный тайм-аут. После пробуждения или истечения тайм-аута он повторно захватывает блокировку и возвращает управление.337338Если аргумент *timeout* присутствует и не равен `None`, он должен быть числом с плавающей точкой, задающим время ожидания операции в секундах (или его долях).339340Если базовая блокировка является [`RLock`](https://python-all.ru/3.7/library/threading.html#threading.RLock), она не освобождается с помощью метода [`release()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.release), поскольку это может не разблокировать блокировку, если она была захвачена несколько раз рекурсивно. Вместо этого используется внутренний интерфейс класса [`RLock`](https://python-all.ru/3.7/library/threading.html#threading.RLock), который действительно разблокирует её, даже если она была рекурсивно захвачена несколько раз. Затем используется другой внутренний интерфейс для восстановления уровня рекурсии при повторном захвате блокировки.341342Возвращаемое значение равно `True`, если только заданный *timeout* не истёк; в этом случае оно равно `False`.343344Изменено в версии 3.2: Ранее метод всегда возвращал `None`.345346#### `wait_for(predicate, timeout=None)`347348Ожидает, пока условие не станет истинным. *predicate* должен быть вызываемым объектом, результат которого будет интерпретироваться как булево значение. Можно указать *timeout*, задающий максимальное время ожидания.349350Этот вспомогательный метод может многократно вызывать [`wait()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.wait) до тех пор, пока предикат не будет удовлетворён или пока не наступит тайм-аут. Возвращаемое значение – последнее возвращаемое значение предиката; оно будет равно `False`, если время ожидания истекло.351352Если не учитывать возможность тайм-аута, вызов этого метода примерно эквивалентен следующему коду:353354```python355while not predicate():356    cv.wait()357```358359Следовательно, применяются те же правила, что и для [`wait()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.wait): блокировка должна быть захвачена при вызове и повторно захватывается при возврате. Предикат вычисляется при удерживаемой блокировке.360361Новое в версии 3.2.362363#### `notify(n=1)`364365По умолчанию пробуждает один поток, ожидающий на этом условии, если таковой имеется. Если вызывающий поток не захватил блокировку на момент вызова этого метода, возникает [`RuntimeError`](https://python-all.ru/3.7/library/exceptions.html#RuntimeError).366367Этот метод пробуждает не более *n* потоков, ожидающих на переменной условия; если ни один поток не ожидает, он ничего не делает.368369Текущая реализация пробуждает ровно *n* потоков, если ожидает не менее *n* потоков. Однако полагаться на такое поведение небезопасно. В будущем оптимизированная реализация может иногда пробуждать более *n* потоков.370371Примечание: пробуждённый поток на самом деле не возвращается из вызова [`wait()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.wait), пока не сможет повторно захватить блокировку. Поскольку [`notify()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify) не освобождает блокировку, это должен сделать его вызывающий код.372373#### `notify_all()`374375Пробуждает все потоки, ожидающие на этом условии. Этот метод действует как [`notify()`](https://python-all.ru/3.7/library/threading.html#threading.Condition.notify), но пробуждает все ожидающие потоки вместо одного. Если вызывающий поток не захватил блокировку на момент вызова этого метода, возникает [`RuntimeError`](https://python-all.ru/3.7/library/exceptions.html#RuntimeError).376377## Объекты Semaphore378379Это один из старейших примитивов синхронизации в истории компьютерных наук, изобретённый ранним нидерландским учёным Эдсгером В. Дейкстрой (он использовал имена `P()` и `V()` вместо [`acquire()`](https://python-all.ru/3.7/library/threading.html#threading.Semaphore.acquire) и [`release()`](https://python-all.ru/3.7/library/threading.html#threading.Semaphore.release)).380381Семафор управляет внутренним счётчиком, который уменьшается при каждом вызове [`acquire()`](https://python-all.ru/3.7/library/threading.html#threading.Semaphore.acquire) и увеличивается при каждом вызове [`release()`](https://python-all.ru/3.7/library/threading.html#threading.Semaphore.release). Счётчик никогда не может стать меньше нуля; когда [`acquire()`](https://python-all.ru/3.7/library/threading.html#threading.Semaphore.acquire) обнаруживает, что он равен нулю, он блокируется, ожидая, пока другой поток вызовет [`release()`](https://python-all.ru/3.7/library/threading.html#threading.Semaphore.release).382383Семафоры также поддерживают [протокол менеджера контекста](https://python-all.ru/3.7/library/threading.html#with-locks).384385#### `class threading.Semaphore(value=1)`386387Этот класс реализует объекты семафоров. Семафор управляет атомарным счётчиком, представляющим количество вызовов [`release()`](https://python-all.ru/3.7/library/threading.html#threading.Semaphore.release) минус количество вызовов [`acquire()`](https://python-all.ru/3.7/library/threading.html#threading.Semaphore.acquire) плюс начальное значение. Метод [`acquire()`](https://python-all.ru/3.7/library/threading.html#threading.Semaphore.acquire) при необходимости блокируется, пока не сможет вернуться, не сделав счётчик отрицательным. Если не указано, *value* по умолчанию равно 1.388389Необязательный аргумент задаёт начальное *value* для внутреннего счётчика; по умолчанию оно равно `1`. Если указанное *value* меньше 0, возникает [`ValueError`](https://python-all.ru/3.7/library/exceptions.html#ValueError).390391Изменено в версии 3.3: изменён с фабричной функции на класс.392393#### `acquire(blocking=True, timeout=None)`394395Захватывает семафор.396397При вызове без аргументов:398399- Если внутренний счётчик больше нуля при входе, уменьшить его на единицу и немедленно вернуть `True`.400- Если внутренний счётчик равен нулю при входе, блокироваться до пробуждения вызовом [`release()`](https://python-all.ru/3.7/library/threading.html#threading.Semaphore.release). После пробуждения (когда счётчик станет больше 0) уменьшить счётчик на 1 и вернуть `True`. Каждый вызов [`release()`](https://python-all.ru/3.7/library/threading.html#threading.Semaphore.release) пробуждает ровно один поток. На порядок пробуждения потоков полагаться не следует.401402Если при вызове *blocking* задано значение false, блокировка не происходит. Если вызов без аргументов привёл бы к блокировке, сразу возвращается `False`; в противном случае поведение такое же, как при вызове без аргументов, и возвращается `True`.403404При вызове с *timeout*, отличным от `None`, он будет блокироваться не более *timeout* секунд. Если acquire не завершится успешно за это время, вернуть `False`. В противном случае вернуть `True`.405406Изменено в версии 3.2: Параметр *timeout* является новым.407408#### `release()`409410Освобождает семафор, увеличивая внутренний счётчик на единицу. Когда он был равен нулю при входе и другой поток ожидает, когда он снова станет больше нуля, пробуждает этот поток.411412#### `class threading.BoundedSemaphore(value=1)`413414Класс, реализующий объекты ограниченного семафора. Ограниченный семафор проверяет, что его текущее значение не превышает начальное. Если превышает, возникает [`ValueError`](https://python-all.ru/3.7/library/exceptions.html#ValueError). В большинстве ситуаций семафоры используются для защиты ресурсов с ограниченной ёмкостью. Если семафор освобождается слишком много раз, это признак ошибки. Если не указано, *value* по умолчанию равно 1.415416Изменено в версии 3.3: изменён с фабричной функции на класс.417418### [`Semaphore`](https://python-all.ru/3.7/library/threading.html#threading.Semaphore) Пример419420Семафоры часто используются для защиты ресурсов с ограниченной ёмкостью, например, сервера базы данных. В любой ситуации, когда размер ресурса фиксирован, следует использовать ограниченный семафор. Перед запуском рабочих потоков главный поток инициализирует семафор:421422```python423maxconnections = 5424# ...425pool_sema = BoundedSemaphore(value=maxconnections)426```427428После запуска рабочие потоки вызывают методы acquire и release семафора, когда им нужно подключиться к серверу:429430```python431with pool_sema:432    conn = connectdb()433    try:434        # ... использовать соединение ...435    finally:436        conn.close()437```438439Использование ограниченного семафора снижает вероятность того, что ошибка программирования, приводящая к освобождению семафора большее количество раз, чем его захват, останется незамеченной.440441## Объекты Event442443Это один из простейших механизмов взаимодействия между потоками: один поток сигнализирует о событии, а другие потоки ожидают его.444445Объект события управляет внутренним флагом, который можно установить в true с помощью метода [`set()`](https://python-all.ru/3.7/library/threading.html#threading.Event.set) и сбросить в false с помощью метода [`clear()`](https://python-all.ru/3.7/library/threading.html#threading.Event.clear). Метод [`wait()`](https://python-all.ru/3.7/library/threading.html#threading.Event.wait) блокируется до тех пор, пока флаг не станет true.446447#### `class threading.Event`448449Класс, реализующий объекты событий. Событие управляет флагом, который можно установить в true методом [`set()`](https://python-all.ru/3.7/library/threading.html#threading.Event.set) и сбросить в false методом [`clear()`](https://python-all.ru/3.7/library/threading.html#threading.Event.clear). Метод [`wait()`](https://python-all.ru/3.7/library/threading.html#threading.Event.wait) блокируется до тех пор, пока флаг не станет true. Изначально флаг равен false.450451Изменено в версии 3.3: изменён с фабричной функции на класс.452453#### `is_set()`454455Возвращает `True` тогда и только тогда, когда внутренний флаг равен true.456457#### `set()`458459Устанавливает внутренний флаг в true. Все потоки, ожидающие его установки, пробуждаются. Потоки, вызывающие [`wait()`](https://python-all.ru/3.7/library/threading.html#threading.Event.wait) после того, как флаг стал true, не будут блокироваться вовсе.460461#### `clear()`462463Сбрасывает внутренний флаг в false. После этого потоки, вызывающие [`wait()`](https://python-all.ru/3.7/library/threading.html#threading.Event.wait), будут блокироваться до тех пор, пока не будет вызван [`set()`](https://python-all.ru/3.7/library/threading.html#threading.Event.set), чтобы снова установить внутренний флаг в true.464465#### `wait(timeout=None)`466467Блокирует выполнение до тех пор, пока внутренний флаг не станет истинным. Если при входе внутренний флаг уже истинен, немедленно возвращает управление. В противном случае блокируется, пока другой поток не вызовет [`set()`](https://python-all.ru/3.7/library/threading.html#threading.Event.set) для установки флага в истинное значение, или пока не истечёт указанный период ожидания.468469Когда аргумент timeout присутствует и не равен `None`, он должен быть числом с плавающей запятой, задающим время ожидания операции в секундах (или их долях).470471Этот метод возвращает `True` в том и только в том случае, если внутренний флаг был установлен в истину – либо до вызова wait, либо после его начала. Таким образом, он всегда возвращает `True`, за исключением случая, когда задан timeout и операция превышает время ожидания.472473Изменено в версии 3.1: Ранее метод всегда возвращал `None`.474475## Объекты Timer476477Этот класс представляет действие, которое должно быть выполнено только по прошествии определённого времени – таймер. [`Timer`](https://python-all.ru/3.7/library/threading.html#threading.Timer) является подклассом [`Thread`](https://python-all.ru/3.7/library/threading.html#threading.Thread) и, таким образом, служит примером создания пользовательских потоков.478479Таймеры запускаются, как и потоки, вызовом метода `start()`. Таймер можно остановить (до начала его действия) вызовом метода [`cancel()`](https://python-all.ru/3.7/library/threading.html#threading.Timer.cancel). Интервал, который таймер будет ждать перед выполнением действия, может не совпадать в точности с интервалом, указанным пользователем.480481Например:482483```python484def hello():485    print("hello, world")486487t = Timer(30.0, hello)488t.start()  # через 30 секунд будет выведено "hello, world"489```490491#### `class threading.Timer(interval, function, args=None, kwargs=None)`492493Создаёт таймер, который запустит *function* с аргументами *args* и именованными аргументами *kwargs* по прошествии *interval* секунд. Если *args* равен `None` (значение по умолчанию), будет использован пустой список. Если *kwargs* равен `None` (значение по умолчанию), будет использован пустой словарь.494495Изменено в версии 3.3: изменён с фабричной функции на класс.496497#### `cancel()`498499Останавливает таймер и отменяет выполнение его действия. Это сработает, только если таймер всё ещё находится в стадии ожидания.500501## Объекты Barrier502503Новое в версии 3.2.504505Этот класс предоставляет простой примитив синхронизации для использования фиксированным числом потоков, которым нужно ждать друг друга. Каждый из потоков пытается пройти барьер, вызывая метод [`wait()`](https://python-all.ru/3.7/library/threading.html#threading.Barrier.wait), и блокируется до тех пор, пока все потоки не вызовут [`wait()`](https://python-all.ru/3.7/library/threading.html#threading.Barrier.wait). После этого потоки освобождаются одновременно.506507Барьер можно использовать повторно любое количество раз для того же числа потоков.508509В качестве примера приведён простой способ синхронизации потоков клиента и сервера:510511```python512b = Barrier(2, timeout=5)513514def server():515    start_server()516    b.wait()517    while True:518        connection = accept_connection()519        process_server_connection(connection)520521def client():522    b.wait()523    while True:524        connection = make_connection()525        process_client_connection(connection)526```527528#### `class threading.Barrier(parties, action=None, timeout=None)`529530Создаёт объект барьера для *parties* потоков. *action*, если задан, – это вызываемый объект, который будет вызван одним из потоков при освобождении. *timeout* – значение тайм-аута по умолчанию, если не указано другое для метода [`wait()`](https://python-all.ru/3.7/library/threading.html#threading.Barrier.wait).531532#### `wait(timeout=None)`533534Пройти барьер. Когда все потоки-участники барьера вызовут эту функцию, они все освобождаются одновременно. Если указан *timeout*, он используется с приоритетом перед любым значением, переданным конструктору класса.535536Возвращаемое значение – целое число в диапазоне от 0 до *parties* – 1, различное для каждого потока. Это можно использовать для выбора потока, который выполнит специальные вспомогательные действия, например:537538```python539i = barrier.wait()540if i == 0:541    # Выводить это должен только один поток542    print("passed the barrier")543```544545Если конструктору был передан *action*, один из потоков вызовет его перед освобождением. Если этот вызов вызовет ошибку, барьер переводится в состояние сбоя.546547Если вызов истекает по таймауту, барьер переводится в сломанное состояние.548549Этот метод может вызвать исключение [`BrokenBarrierError`](https://python-all.ru/3.7/library/threading.html#threading.BrokenBarrierError), если барьер сломан или сброшен, пока поток ожидает.550551#### `reset()`552553Возвращает барьер в исходное пустое состояние. Любые потоки, ожидающие его, получат исключение [`BrokenBarrierError`](https://python-all.ru/3.7/library/threading.html#threading.BrokenBarrierError).554555Обратите внимание, что использование этой функции может потребовать внешней синхронизации, если есть другие потоки, состояние которых неизвестно. Если барьер сломан, возможно, лучше просто оставить его и создать новый.556557#### `abort()`558559Переводит барьер в сломанное состояние. Это приводит к тому, что все активные или будущие вызовы [`wait()`](https://python-all.ru/3.7/library/threading.html#threading.Barrier.wait) завершаются с ошибкой [`BrokenBarrierError`](https://python-all.ru/3.7/library/threading.html#threading.BrokenBarrierError). Используйте это, например, если один из потоков необходимо прервать, чтобы избежать взаимоблокировки приложения.560561Возможно, предпочтительнее просто создать барьер с разумным значением *timeout*, чтобы автоматически защититься от сбоя одного из потоков.562563#### `parties`564565Количество потоков, необходимое для прохождения барьера.566567#### `n_waiting`568569Количество потоков, ожидающих в данный момент на барьере.570571#### `broken`572573Логическое значение, которое равно `True`, если барьер находится в сломанном состоянии.574575#### `exception threading.BrokenBarrierError`576577Это исключение, подкласс [`RuntimeError`](https://python-all.ru/3.7/library/exceptions.html#RuntimeError), вызывается, когда объект [`Barrier`](https://python-all.ru/3.7/library/threading.html#threading.Barrier) сбрасывается или ломается.578579## Использование блокировок, условий и семафоров в операторе `with`580581Все объекты, предоставляемые этим модулем, которые имеют методы `acquire()` и `release()`, могут использоваться как контекстные менеджеры для оператора [`with`](https://python-all.ru/3.7/reference/compound_stmts.html#with). Метод `acquire()` будет вызываться при входе в блок, а `release()` – при выходе из блока. Поэтому следующий фрагмент:582583```python584with some_lock:585    # выполнить какие-то действия...586```587588эквивалентно:589590```python591some_lock.acquire()592try:593    # выполнить какие-то действия...594finally:595    some_lock.release()596```597598В настоящее время объекты [`Lock`](https://python-all.ru/3.7/library/threading.html#threading.Lock), [`RLock`](https://python-all.ru/3.7/library/threading.html#threading.RLock), [`Condition`](https://python-all.ru/3.7/library/threading.html#threading.Condition), [`Semaphore`](https://python-all.ru/3.7/library/threading.html#threading.Semaphore) и [`BoundedSemaphore`](https://python-all.ru/3.7/library/threading.html#threading.BoundedSemaphore) могут использоваться как контекстные менеджеры оператора [`with`](https://python-all.ru/3.7/reference/compound_stmts.html#with).599