threading — 基于线程的并行 ¶

线程本地数据 ¶

Thread-local data is data whose values are thread specific. To manage thread-local data, just create an instance of local (or a subclass) and store attributes on it:

mydata = threading.local()
mydata.x = 1
								

实例的值异于单独线程。

class threading. local ¶

表示线程本地数据的类。

For more details and extensive examples, see the documentation string of the _threading_local 模块。

线程对象 ¶

Thread class represents an activity that is run in a separate thread of control. There are two ways to specify the activity: by passing a callable object to the constructor, or by overriding the run() method in a subclass. No other methods (except for the constructor) should be overridden in a subclass. In other words, only override the __init__() and run() methods of this class.

Once a thread object is created, its activity must be started by calling the thread’s start() method. This invokes the run() method in a separate thread of control.

Once the thread’s activity is started, the thread is considered ‘alive’. It stops being alive when its run() method terminates – either normally, or by raising an unhandled exception. The is_alive() method tests whether the thread is alive.

其它线程可以调用线程的 join() method. This blocks the calling thread until the thread whose join() method is called is terminated.

A thread has a name. The name can be passed to the constructor, and read or changed through the name 属性。

若 run() method raises an exception, threading.excepthook() is called to handle it. By default, threading.excepthook() ignores silently SystemExit .

A thread can be flagged as a “daemon thread”. The significance of this flag is that the entire Python program exits when only daemon threads are left. The initial value is inherited from the creating thread. The flag can be set through the daemon property or the daemon 构造函数自变量。

There is a “main thread” object; this corresponds to the initial thread of control in the Python program. It is not a daemon thread.

There is the possibility that “dummy thread objects” are created. These are thread objects corresponding to “alien threads”, which are threads of control started outside the threading module, such as directly from C code. Dummy thread objects have limited functionality; they are always considered alive and daemonic, and cannot be join() ed. They are never deleted, since it is impossible to detect the termination of alien threads.

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

始终应采用关键词自变量调用此构造函数。自变量：

group 应该为 None ；预留以供未来扩展当 ThreadGroup 类被实现。

target is the callable object to be invoked by the run() method. Defaults to None ，意味着什么都不调用。

name is the thread name. By default, a unique name is constructed of the form “Thread- N ” where N is a small decimal number.

args is the argument tuple for the target invocation. Defaults to () .

kwargs is a dictionary of keyword arguments for the target invocation. Defaults to {} .

If not None , daemon explicitly sets whether the thread is daemonic. If None (the default), the daemonic property is inherited from the current thread.

若子类覆盖构造函数，它必须确保援引基类构造函数 ( Thread.__init__() ) 在对其它线程做任何事情之前。

3.3 版改变： 添加 daemon 自变量。

start ( ) ¶

启动线程活动。

It must be called at most once per thread object. It arranges for the object’s run() method to be invoked in a separate thread of control.

此方法将引发 RuntimeError if called more than once on the same thread object.

run ( ) ¶

表示线程活动的方法。

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with positional and keyword arguments taken from the args and kwargs arguments, respectively.

join ( timeout=None ) ¶

Wait until the thread terminates. This blocks the calling thread until the thread whose join() method is called terminates – either normally or through an unhandled exception – or until the optional timeout occurs.

当 timeout 自变量存在且非 None , it should be a floating point number specifying a timeout for the operation in seconds (or fractions thereof). As join() always returns None , you must call is_alive() after join() to decide whether a timeout happened – if the thread is still alive, the join() call timed out.

当 timeout argument is not present or None , the operation will block until the thread terminates.

A thread can be join() ed many times.

join() 引发 RuntimeError if an attempt is made to join the current thread as that would cause a deadlock. It is also an error to join() a thread before it has been started and attempts to do so raise the same exception.

name ¶

A string used for identification purposes only. It has no semantics. Multiple threads may be given the same name. The initial name is set by the constructor.

getName ( ) ¶

setName ( ) ¶

旧的 Getter/Setter API 为 name ；直接将其用作代替特性。

ident ¶

The ‘thread identifier’ of this thread or None if the thread has not been started. This is a nonzero integer. See the get_ident() function. Thread identifiers may be recycled when a thread exits and another thread is created. The identifier is available even after the thread has exited.

native_id ¶

The native integral thread ID of this thread. This is a non-negative integer, or None if the thread has not been started. See the get_native_id() function. This represents the Thread ID ( TID ) as assigned to the thread by the OS (kernel). Its value may be used to uniquely identify this particular thread system-wide (until the thread terminates, after which the value may be recycled by the OS).

注意

Similar to Process IDs, Thread IDs are only valid (guaranteed unique system-wide) from the time the thread is created until the thread has been terminated.

可用性 : Requires get_native_id() 函数。

3.8 版新增。

is_alive ( ) ¶

返回线程是否存活。

此方法返回 True just before the run() method starts until just after the run() method terminates. The module function enumerate() returns a list of all alive threads.

daemon ¶

A boolean value indicating whether this thread is a daemon thread (True) or not (False). This must be set before start() is called, otherwise RuntimeError is raised. Its initial value is inherited from the creating thread; the main thread is not a daemon thread and therefore all threads created in the main thread default to daemon = False .

The entire Python program exits when no alive non-daemon threads are left.

isDaemon ( ) ¶

setDaemon ( ) ¶

旧的 Getter/Setter API 为 daemon ；直接将其用作代替特性。

锁对象 ¶

原语锁是锁定时不属于特定线程的同步原语。在 Python 中，它目前是可用的最低级同步原语，直接实现通过 _thread 扩展模块。

原语锁处于锁定或解锁 2 种状态之一。它是在解锁状态下创建的。它拥有 2 个基本方法， acquire() and release() 。当在解锁状态时， acquire() 将状态改为锁定并立即返回。当在锁定状态时， acquire() 阻塞直到调用 release() 在另一线程中将其改为解锁，然后 acquire() 调用将它重置为锁定并返回。 release() 方法只应在锁定状态下调用；它将状态改为解锁并立即返回。若试图释放未锁定的锁， RuntimeError 会被引发。

锁还支持 上下文管理协议 .

当多个阻塞线程在 acquire() 等待状态变为解锁，仅一线程继续进行当 release() 调用将状态重置为解锁；哪个等待线程继续执行未定义，且可能因实现而异。

所有方法以原子方式执行。

class threading. Lock ¶

实现原语锁对象的类。一旦线程有获得锁，会阻塞后续获得尝试，直到它被释放；任何线程都可以释放它。

注意， Lock 实际是返回平台支持具体 Lock 类的最有效版本实例的工厂函数。

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

获得锁，阻塞或非阻塞。

当援引采用 blocking 自变量设为 True (默认)，阻塞直到锁被解锁，然后将其设为锁定并返回 True .

当援引采用 blocking 自变量设为 False ，不阻塞。若调用采用 blocking 设为 True 将阻塞，返回 False 立即；否则，将锁设为锁定并返回 True .

当被援引采用浮点 timeout argument set to a positive value, block for at most the number of seconds specified by timeout and as long as the lock cannot be acquired. A timeout argument of -1 specifies an unbounded wait. It is forbidden to specify a timeout when blocking 为 False。

返回值为 True 若成功获取锁， False 若不 (例如若 timeout 过期)。

3.2 版改变： timeout 参数是新的。

3.2 版改变： Lock acquisition can now be interrupted by signals on POSIX if the underlying threading implementation supports it.

release ( ) ¶

Release a lock. This can be called from any thread, not only the thread which has acquired the lock.

When the lock is locked, reset it to unlocked, and return. If any other threads are blocked waiting for the lock to become unlocked, allow exactly one of them to proceed.

当在解锁锁援引时， RuntimeError 被引发。

没有返回值。

locked ( ) ¶

返回 True 若获得锁。

RLock 对象 ¶

可重入锁是可以被同一线程多次获得的同步原语。在内部，它使用 owning thread (拥有线程) 和 recursion level (递归级别) 概念，除原语锁使用的锁定/解锁状态外。在锁定状态下，某个线程拥有锁；在解锁状态下，没有线程拥有它。

为锁定锁，线程调用它的 acquire() 方法；这返回，一旦线程拥有锁。为解锁锁，线程调用它的 release() 方法。 acquire() / release() 调用对可以嵌套；才最后 release() ( release() of the outermost pair) resets the lock to unlocked and allows another thread blocked in acquire() to proceed.

可重入锁还支持 上下文管理协议 .

class threading. RLock ¶

This class implements reentrant lock objects. A reentrant lock must be released by the thread that acquired it. Once a thread has acquired a reentrant lock, the same thread may acquire it again without blocking; the thread must release it once for each time it has acquired it.

注意， RLock is actually a factory function which returns an instance of the most efficient version of the concrete RLock class that is supported by the platform.

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

获得锁，阻塞或非阻塞。

When invoked without arguments: if this thread already owns the lock, increment the recursion level by one, and return immediately. Otherwise, if another thread owns the lock, block until the lock is unlocked. Once the lock is unlocked (not owned by any thread), then grab ownership, set the recursion level to one, and return. If more than one thread is blocked waiting until the lock is unlocked, only one at a time will be able to grab ownership of the lock. There is no return value in this case.

当援引采用 blocking argument set to true, do the same thing as when called without arguments, and return True .

当援引采用 blocking argument set to false, do not block. If a call without an argument would block, return False immediately; otherwise, do the same thing as when called without arguments, and return True .

当被援引采用浮点 timeout argument set to a positive value, block for at most the number of seconds specified by timeout and as long as the lock cannot be acquired. Return True 若已获得锁，False 若已消耗超时。

3.2 版改变： timeout 参数是新的。

release ( ) ¶

Release a lock, decrementing the recursion level. If after the decrement it is zero, reset the lock to unlocked (not owned by any thread), and if any other threads are blocked waiting for the lock to become unlocked, allow exactly one of them to proceed. If after the decrement the recursion level is still nonzero, the lock remains locked and owned by the calling thread.

Only call this method when the calling thread owns the lock. A RuntimeError is raised if this method is called when the lock is unlocked.

没有返回值。

条件对象 ¶

条件变量始终关联某种锁；这可以传入 (或默认创建) 一个。传入一个很有用，当几个条件变量必须共享同一锁时。锁属于条件对象：不必单独追踪它。

条件变量服从 上下文管理协议 ：使用 with 语句可在封闭块持续时间内获得关联锁。 acquire() and release() 方法还调用关联锁的相应方法。

Other methods must be called with the associated lock held. The wait() method releases the lock, and then blocks until another thread awakens it by calling notify() or notify_all() . Once awakened, wait() re-acquires the lock and returns. It is also possible to specify a timeout.

notify() method wakes up one of the threads waiting for the condition variable, if any are waiting. The notify_all() method wakes up all threads waiting for the condition variable.

注意： notify() and notify_all() 方法不会释放锁；这意味着线程 (或被唤醒线程) 将不会返回从其 wait() 调用立即，但仅当线程调用 notify() or notify_all() 最后会放弃锁的所有权。

The typical programming style using condition variables uses the lock to synchronize access to some shared state; threads that are interested in a particular change of state call wait() repeatedly until they see the desired state, while threads that modify the state call notify() or notify_all() when they change the state in such a way that it could possibly be a desired state for one of the waiters. For example, the following code is a generic producer-consumer situation with unlimited buffer capacity:

# Consume one item
with cv:
    while not an_item_is_available():
        cv.wait()
    get_an_available_item()
# Produce one item
with cv:
    make_an_item_available()
    cv.notify()
								

while loop checking for the application’s condition is necessary because wait() can return after an arbitrary long time, and the condition which prompted the notify() call may no longer hold true. This is inherent to multi-threaded programming. The wait_for() method can be used to automate the condition checking, and eases the computation of timeouts:

# Consume an item
with cv:
    cv.wait_for(an_item_is_available)
    get_an_available_item()
								

To choose between notify() and notify_all() , consider whether one state change can be interesting for only one or several waiting threads. E.g. in a typical producer-consumer situation, adding one item to the buffer only needs to wake up one consumer thread.

class threading. Condition ( lock=None ) ¶

This class implements condition variable objects. A condition variable allows one or more threads to wait until they are notified by another thread.

若 lock 自变量有给定且不是 None ，它必须是 Lock or RLock 对象，且它被用作底层锁。否则，新的 RLock 对象被创建并用作底层锁。

3.3 版改变： 从工厂函数变为类。

acquire ( *args ) ¶

Acquire the underlying lock. This method calls the corresponding method on the underlying lock; the return value is whatever that method returns.

release ( ) ¶

Release the underlying lock. This method calls the corresponding method on the underlying lock; there is no return value.

wait ( timeout=None ) ¶

等待直到被通知或直到发生超时为止。若调用此方法时调用线程尚未获得锁， RuntimeError 被引发。

此方法释放底层锁，然后阻塞直到被唤醒由 notify() or notify_all() 调用对于在另一线程中的的相同条件变量，或直到发生可选超时为止。一旦被唤醒或超时，它重新获得锁并返回。

当 timeout 自变量存在且非 None ，它应该是以秒 (或其分数) 为单位指定操作超时的浮点数。

当底层锁为 RLock ，它不会被释放使用 release() 方法，由于这可能实际并未被解锁，当多次递归获得锁时。相反，内部接口的 RLock 类的使用，这真的会被解锁，即使已递归获得几次。然后使用另一内部接口恢复递归级别，当重新获得锁时。

返回值为 True 除非给定 timeout 过期，在这种情况下为 False .

3.2 版改变： 以前，方法总是返回 None .

wait_for ( predicate , timeout=None ) ¶

等待直到条件被评估为 True 止。 predicate 应该是其结果将被解释成布尔值的可调用。 timeout 可以提供最大给定等待时间。

This utility method may call wait() repeatedly until the predicate is satisfied, or until a timeout occurs. The return value is the last return value of the predicate and will evaluate to False if the method timed out.

Ignoring the timeout feature, calling this method is roughly equivalent to writing:

while not predicate():
    cv.wait()
												

Therefore, the same rules apply as with wait() : The lock must be held when called and is re-acquired on return. The predicate is evaluated with the lock held.

3.2 版新增。

notify ( n=1 ) ¶

By default, wake up one thread waiting on this condition, if any. If the calling thread has not acquired the lock when this method is called, a RuntimeError 被引发。

This method wakes up at most n of the threads waiting for the condition variable; it is a no-op if no threads are waiting.

The current implementation wakes up exactly n threads, if at least n threads are waiting. However, it’s not safe to rely on this behavior. A future, optimized implementation may occasionally wake up more than n threads.

Note: an awakened thread does not actually return from its wait() call until it can reacquire the lock. Since notify() does not release the lock, its caller should.

notify_all ( ) ¶

Wake up all threads waiting on this condition. This method acts like notify() , but wakes up all waiting threads instead of one. If the calling thread has not acquired the lock when this method is called, a RuntimeError 被引发。

信号量对象 ¶

This is one of the oldest synchronization primitives in the history of computer science, invented by the early Dutch computer scientist Edsger W. Dijkstra (he used the names P() and V() 而不是 acquire() and release() ).

A semaphore manages an internal counter which is decremented by each acquire() call and incremented by each release() call. The counter can never go below zero; when acquire() finds that it is zero, it blocks, waiting until some other thread calls release() .

信号量还支持 上下文管理协议 .

class threading. Semaphore ( value=1 ) ¶

This class implements semaphore objects. A semaphore manages an atomic counter representing the number of release() calls minus the number of acquire() calls, plus an initial value. The acquire() method blocks if necessary until it can return without making the counter negative. If not given, value defaults to 1.

The optional argument gives the initial value for the internal counter; it defaults to 1 。若 value given is less than 0, ValueError 被引发。

3.3 版改变： 从工厂函数变为类。

acquire ( blocking=True , timeout=None ) ¶

获得信号量。

在没有自变量的情况下援引时：

• If the internal counter is larger than zero on entry, decrement it by one and return True immediately.

• If the internal counter is zero on entry, block until awoken by a call to release() . Once awoken (and the counter is greater than 0), decrement the counter by 1 and return True . Exactly one thread will be awoken by each call to release() . The order in which threads are awoken should not be relied on.

When invoked with blocking set to false, do not block. If a call without an argument would block, return False immediately; otherwise, do the same thing as when called without arguments, and return True .

当援引采用 timeout 除了 None , it will block for at most timeout seconds. If acquire does not complete successfully in that interval, return False 。返回 True 否则。

3.2 版改变： timeout 参数是新的。

release ( n=1 ) ¶

Release a semaphore, incrementing the internal counter by n . When it was zero on entry and other threads are waiting for it to become larger than zero again, wake up n of those threads.

3.9 版改变： 添加 n parameter to release multiple waiting threads at once.

class threading. BoundedSemaphore ( value=1 ) ¶

Class implementing bounded semaphore objects. A bounded semaphore checks to make sure its current value doesn’t exceed its initial value. If it does, ValueError is raised. In most situations semaphores are used to guard resources with limited capacity. If the semaphore is released too many times it’s a sign of a bug. If not given, value defaults to 1.

3.3 版改变： 从工厂函数变为类。

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

with pool_sema:
    conn = connectdb()
    try:
        # ... use connection ...
    finally:
        conn.close()
									

事件对象 ¶

This is one of the simplest mechanisms for communication between threads: one thread signals an event and other threads wait for it.

An event object manages an internal flag that can be set to true with the set() method and reset to false with the clear() 方法。 wait() method blocks until the flag is true.

class threading. 事件 ¶

Class implementing event objects. An event manages a flag that can be set to true with the set() method and reset to false with the clear() 方法。 wait() method blocks until the flag is true. The flag is initially false.

3.3 版改变： 从工厂函数变为类。

is_set ( ) ¶

返回 True if and only if the internal flag is true.

set ( ) ¶

Set the internal flag to true. All threads waiting for it to become true are awakened. Threads that call wait() once the flag is true will not block at all.

clear ( ) ¶

Reset the internal flag to false. Subsequently, threads calling wait() 将阻塞直到 set() is called to set the internal flag to true again.

wait ( timeout=None ) ¶

Block until the internal flag is true. If the internal flag is true on entry, return immediately. Otherwise, block until another thread calls set() to set the flag to true, or until the optional timeout occurs.

When the timeout argument is present and not None ，它应该是以秒 (或其分数) 为单位指定操作超时的浮点数。

此方法返回 True if and only if the internal flag has been set to true, either before the wait call or after the wait starts, so it will always return True except if a timeout is given and the operation times out.

3.1 版改变： 以前，方法总是返回 None .

计时器对象 ¶

This class represents an action that should be run only after a certain amount of time has passed — a timer. Timer 是子类对于 Thread and as such also functions as an example of creating custom threads.

Timers are started, as with threads, by calling their start() method. The timer can be stopped (before its action has begun) by calling the cancel() method. The interval the timer will wait before executing its action may not be exactly the same as the interval specified by the user.

例如：

def hello():
    print("hello, world")
t = Timer(30.0, hello)
t.start()  # after 30 seconds, "hello, world" will be printed
								

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

Create a timer that will run function 采用自变量 args 和关键词自变量 kwargs , after interval seconds have passed. If args is None (the default) then an empty list will be used. If kwargs is None (the default) then an empty dict will be used.

3.3 版改变： 从工厂函数变为类。

cancel ( ) ¶

Stop the timer, and cancel the execution of the timer’s action. This will only work if the timer is still in its waiting stage.

屏障对象 ¶

This class provides a simple synchronization primitive for use by a fixed number of threads that need to wait for each other. Each of the threads tries to pass the barrier by calling the wait() method and will block until all of the threads have made their wait() calls. At this point, the threads are released simultaneously.

The barrier can be reused any number of times for the same number of threads.

As an example, here is a simple way to synchronize a client and server thread:

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 ) ¶

Create a barrier object for parties number of threads. An action , when provided, is a callable to be called by one of the threads when they are released. timeout is the default timeout value if none is specified for the wait() 方法。

wait ( timeout=None ) ¶

Pass the barrier. When all the threads party to the barrier have called this function, they are all released simultaneously. If a timeout is provided, it is used in preference to any that was supplied to the class constructor.

The return value is an integer in the range 0 to parties – 1, different for each thread. This can be used to select a thread to do some special housekeeping, e.g.:

i = barrier.wait()
if i == 0:
    # Only one thread needs to print this
    print("passed the barrier")
												

If an action was provided to the constructor, one of the threads will have called it prior to being released. Should this call raise an error, the barrier is put into the broken state.

If the call times out, the barrier is put into the broken state.

此方法可能引发 BrokenBarrierError exception if the barrier is broken or reset while a thread is waiting.

reset ( ) ¶

Return the barrier to the default, empty state. Any threads waiting on it will receive the BrokenBarrierError 异常。

Note that using this function may require some external synchronization if there are other threads whose state is unknown. If a barrier is broken it may be better to just leave it and create a new one.

abort ( ) ¶

Put the barrier into a broken state. This causes any active or future calls to wait() to fail with the BrokenBarrierError . Use this for example if one of the threads needs to abort, to avoid deadlocking the application.

It may be preferable to simply create the barrier with a sensible timeout value to automatically guard against one of the threads going awry.

parties ¶

The number of threads required to pass the barrier.

n_waiting ¶

The number of threads currently waiting in the barrier.

broken ¶

A boolean that is True if the barrier is in the broken state.

exception threading. BrokenBarrierError ¶

此异常是子类化的 RuntimeError ，被引发当 Barrier object is reset or broken.

使用锁、条件和信号量在 with 语句 ¶

All of the objects provided by this module that have acquire() and release() methods can be used as context managers for a with statement. The acquire() method will be called when the block is entered, and release() will be called when the block is exited. Hence, the following snippet:

with some_lock:
    # do something...
								

相当于：

some_lock.acquire()
try:
    # do something...
finally:
    some_lock.release()
								

目前， Lock , RLock , Condition , Semaphore ，和 BoundedSemaphore objects may be used as with statement context managers.