Python多线程编程方式2 threading库的介绍

http://www.cnblogs.com/huxi/archive/2010/06/26/1765808.html

Python多线程编程方式2 threading库的介绍

1. threading

# 返回当前的线程变量。

threading.currentThread()

# 返回一个包含正在运行的线程的list。

# 正在运行指线程启动后、结束前，不包括启动前和终止后的线程。 

threading.enumerate()

# 返回正在运行的线程数量，与len(threading.enumerate())有相同的结果。

threading.activeCount()

threading模块提供的类：  

Thread,  Lock,  Rlock,  Condition,  [Bounded]Semaphore,  Event,  Timer,  local.

2. Thread

Thread是线程类，有两种使用方法，直接传入要运行的方法或从Thread继承并重载run()：

#!/usr/bin/env python
#example1.py
#use UTF-8
#Python 3.3.0
import threading 
# 方法1：将要执行的方法作为参数传给Thread的构造方法
def func():
    print('func() passed to Thread')
	
t = threading.Thread(target=func)
t.start()

##################################################

#!/usr/bin/env python
#example2.py
#use UTF-8
#Python 3.3.0
import threading 

# 方法2：从Thread继承，并重写run()
class MyThread(threading.Thread):
    def run(self):
        print('MyThread extended from Thread')
 
t = MyThread()
t.start()

构造方法： 

Thread(group=None, target=None, name=None, args=(), kwargs={}) 

group:  线程组，目前还没有实现，库引用中提示必须是None； 

target:  要执行的方法； 

name:  线程名； 

args/kwargs:  要传入方法的参数。

实例方法： 

isAlive():  返回线程是否在运行。正在运行指启动后、终止前。 

get/setName(name):  获取/设置线程名。 

is/setDaemon(bool):  获取/设置是否守护线程。初始值从创建该线程的线程继承。当没有非守护线程仍在运行时，程序将终止。 

start():  启动线程。 

join([timeout]):  阻塞当前上下文环境的线程，直到调用此方法的线程终止或到达指定的timeout（可选参数）。

一个使用join()的例子：

#!/usr/bin/env python
#example3.py
#use UTF-8
#Python 3.3.0
#线程join例子
import threading
import time
 
def context(tJoin):
    print('in threadContext.')
    tJoin.start()
    
    # 将阻塞tContext直到threadJoin终止。
    tJoin.join()
    
    # tJoin终止后继续执行。
    print('out threadContext.')
 
def join():
    print('in threadJoin.')
    time.sleep(1)
    print('out threadJoin.')
 
tJoin = threading.Thread(target=join)
tContext = threading.Thread(target=context, args=(tJoin,))
 
tContext.start()

运行结果：
in threadContext. 
in threadJoin. 
out threadJoin. 
out threadContext.

3. Lock

        Lock（指令锁）是可用的最低级的同步指令。Lock处于锁定状态时，不被特定的线程拥有。Lock包含两种状态——锁定和非锁定，以及两个基本的方法。可以认为Lock有一个锁定池，当线程请求锁定时，将线程至于池中，直到获得锁定后出池。池中的线程处于状态图中的同步阻塞状态。

构造方法： 

Lock()

实例方法： 

acquire([timeout]): 使线程进入同步阻塞状态，尝试获得锁定。 

release(): 释放锁。使用前线程必须已获得锁定，否则将抛出异常。

#!/usr/bin/env python
#example4.py
#use UTF-8
#Python 3.3.0
#功能: Lock的使用
import threading
import time

data = 0
lock = threading.Lock()
 
def func():
	global data					#说明是全局变量
	print('%s acquire lock...' % threading.currentThread().getName())

	# 调用acquire([timeout])时，线程将一直阻塞，
	# 直到获得锁定或者直到timeout秒后（timeout参数可选）。
	# 返回是否获得锁。
	if lock.acquire():
		print('%s get the lock.' % threading.currentThread().getName())
		data += 1
		time.sleep(2)
		print('%s release lock...' % threading.currentThread().getName())

		# 调用release()将释放锁。
		lock.release()

t1 = threading.Thread(target=func)
t2 = threading.Thread(target=func)
t3 = threading.Thread(target=func)
t1.start()
t2.start()
t3.start()

输出:
Thread-1 acquire lock...
Thread-1 get the lock.
Thread-2 acquire lock...
Thread-3 acquire lock...
Thread-1 release lock...
Thread-2 get the lock.
Thread-2 release lock...
Thread-3 get the lock.
Thread-3 release lock...

4. RLock

RLock（可重入锁）是一个可以被同一个线程请求多次的同步指令。RLock使用了“拥有的线程”和“递归等级”的概念，处于锁定状态时，RLock被某个线程拥有。拥有RLock的线程可以再次调用acquire()，释放锁时需要调用release()相同次数。

可以认为RLock包含一个锁定池和一个初始值为0的计数器，每次成功调用 acquire()/release()，计数器将+1/-1，为0时锁处于未锁定状态。

构造方法： 

RLock()

实例方法： 

acquire([timeout])/release(): 跟Lock差不多。

#!/usr/bin/env python
#example5.py
#use UTF-8
#Python 3.3.0
#功能: RLock 的使用
# encoding: UTF-8
import threading
import time
 
rlock = threading.RLock()
 
def func():
    # 第一次请求锁定
    print('%s acquire lock...' % threading.currentThread().getName())
    if rlock.acquire():
        print('%s get the lock.' % threading.currentThread().getName())
        time.sleep(2)
        
        # 第二次请求锁定
        print('%s acquire lock again...' % threading.currentThread().getName())
        if rlock.acquire():
            print('%s get the lock.' % threading.currentThread().getName())
            time.sleep(2)
        
        # 第一次释放锁
        print('%s release lock...' % threading.currentThread().getName())
        rlock.release()
        time.sleep(2)
        
        # 第二次释放锁
        print('%s release lock...' % threading.currentThread().getName())
        rlock.release()
 
t1 = threading.Thread(target=func)
t2 = threading.Thread(target=func)
t3 = threading.Thread(target=func)
t1.start()
t2.start()
t3.start()

输出
Thread-1 acquire lock...
Thread-2 acquire lock...
Thread-3 acquire lock...
Thread-1 get the lock.
Thread-1 acquire lock again...
Thread-1 get the lock.
Thread-1 release lock...
Thread-1 release lock...
Thread-2 get the lock.
Thread-2 acquire lock again...
Thread-2 get the lock.
Thread-2 release lock...
Thread-2 release lock...
Thread-3 get the lock.
Thread-3 acquire lock again...
Thread-3 get the lock.
Thread-3 release lock...
Thread-3 release lock...

不是很明白这个RLock的用途, 因为如果线程已经获得了这把锁, 已经锁住了, 在释放之前, 再获得一次有什么用? 从上面的输出结果来看感觉没什么用的.

5. Condition

        Condition（条件变量）通常与一个锁关联。需要在多个Contidion中共享一个锁时，可以传递一个Lock/RLock实例给构造方法，否则它将自己生成一个RLock实例。

可以认为，除了Lock带有的锁定池外，Condition还包含一个等待池，池中的线程处于状态图中的等待阻塞状态，直到另一个线程调用notify()/notifyAll()通知；得到通知后线程进入锁定池等待锁定。

构造方法： 

Condition([lock/rlock])

实例方法： 

acquire([timeout])/release():  调用关联的锁的相应方法。 

wait([timeout]):  调用这个方法将使线程进入Condition的等待池等待通知，并释放锁。

使用前线程必须已获得锁定，否则将抛出异常。 

notify():  调用这个方法将从等待池挑选一个线程并通知，收到通知的线程将自动调用acquire()尝试

获得锁定（进入锁定池）；其他线程仍然在等待池中。调用这个方法不会释放锁定。

使用前线程必须已获得锁定，否则将抛出异常。 

notifyAll():  调用这个方法将通知等待池中所有的线程，这些线程都将进入锁定池尝试获得锁定。

调用这个方法不会释放锁定。使用前线程必须已获得锁定，否则将抛出异常。

例子是很常见的生产者/消费者模式：

#!/usr/bin/env python
#example6.py
#use UTF-8
#Python 3.3.0
#功能: Condition 的使用
import threading
import time
 
# 商品
product = None
# 条件变量
con = threading.Condition()
 
# 生产者方法
def produce():
    global product
    
    if con.acquire():
        while True:
            if product is None:
                print('produce...')
                product = 'anything'
                
                # 通知消费者，商品已经生产
                con.notify()
            
            # 等待通知
            con.wait()
            time.sleep(2)
 
# 消费者方法
def consume():
    global product
    
    if con.acquire():
        while True:
            if product is not None:
                print('consume...')
                product = None
                
                # 通知生产者，商品已经没了
                con.notify()
            
            # 等待通知
            con.wait()
            time.sleep(2)
 
t1 = threading.Thread(target=produce)
t2 = threading.Thread(target=consume)
t2.start()
t1.start()

在两个线程相互握手的情况Condition比较适合使用, 核心理解notify和wait

6. Semaphore/BoundedSemaphore

        Semaphore（信号量）是计算机科学史上最古老的同步指令之一。Semaphore管理一个内置的计数器，每当调用acquire()时-1，调用release() 时+1。计数器不能小于0；当计数器为0时，acquire()将阻塞线程至同步锁定状态，直到其他线程调用release()。

基于这个特点，Semaphore经常用来同步一些有“访客上限”的对象，比如连接池。

BoundedSemaphore 与Semaphore的唯一区别在于前者将在调用release()时检查计数器的值是否超过了计数器的初始值，如果超过了将抛出一个异常。

构造方法： 

Semaphore(value=1): value是计数器的初始值。

实例方法： 

acquire([timeout]): 请求Semaphore。如果计数器为0，将阻塞线程至同步阻塞状态；否则将计数器-1并立即返回。 

release(): 释放Semaphore，将计数器+1，如果使用BoundedSemaphore，还将进行释放次数检查。release()方法不检查线程是否已获得 Semaphore。

#!/usr/bin/env python
#example5.py
#use UTF-8
#Python 3.3.0
#功能: Condition 的使用
import threading
import time
 
# 计数器初值为2
semaphore = threading.Semaphore(2)
 
def func():    
    # 请求Semaphore，成功后计数器-1；计数器为0时阻塞
    print('%s acquire semaphore...' % threading.currentThread().getName())
    if semaphore.acquire():        
        print('%s get semaphore' % threading.currentThread().getName())
        time.sleep(4)
        
        # 释放Semaphore，计数器+1
        print('%s release semaphore' % threading.currentThread().getName())
        semaphore.release()
 
t1 = threading.Thread(target=func)
t2 = threading.Thread(target=func)
t3 = threading.Thread(target=func)
t4 = threading.Thread(target=func)
t1.start()
t2.start()
t3.start()
t4.start()
 
time.sleep(2)
 
# 没有获得semaphore的主线程也可以调用release
# 若使用BoundedSemaphore，t4释放semaphore时将抛出异常
print('MainThread release semaphore without acquire')
semaphore.release()

7. Event

Event（事件）是最简单的线程通信机制之一：一个线程通知事件，其他线程等待事件。Event内置了一个初始为False的标志，当调用set()时设为True，调用clear()时重置为 False。wait()将阻塞线程至等待阻塞状态。

Event其实就是一个简化版的 Condition。Event没有锁，无法使线程进入同步阻塞状态。

构造方法： 

Event()

实例方法： 

isSet():  当内置标志为True时返回True。 

set():  将标志设为True，并通知所有处于等待阻塞状态的线程恢复运行状态。 

clear():  将标志设为False。 

wait([timeout]):  如果标志为True将立即返回，否则阻塞线程至等待阻塞状态，等待其他线程调用set()。

#!/usr/bin/env python
#example8.py
#use UTF-8
#Python 3.3.0
#功能: Event 的使用
import threading
import time

event = threading.Event()

def func():
    # 等待事件，进入等待阻塞状态
    print('%s wait for event...' % threading.currentThread().getName())
    event.wait()
    
    # 收到事件后进入运行状态
    print('%s recv event.' % threading.currentThread().getName())

t1 = threading.Thread(target=func)
t2 = threading.Thread(target=func)
t1.start()
t2.start()
 
time.sleep(2)
 
# 发送事件通知
print('MainThread set event.')
event.set()

其实我用得最多的也是这个

8. Timer

Timer（定时器）是Thread的派生类，用于在指定时间后调用一个方法。在C++中, 我就很喜欢使用线程来作为定时器

构造方法： 

Timer(interval, function, args=[], kwargs={}) 

interval: 指定的时间 

function: 要执行的方法 

args/kwargs: 方法的参数

实例方法： 

Timer从Thread派生，没有增加实例方法。

#!/usr/bin/env python
#example9.py
#use UTF-8
#Python 3.3.0
#功能: Timer 的使用
import threading
 
def func():
    print('hello timer!')
 
timer = threading.Timer(5, func) # 5秒后执行
timer.start()

9. local

        local是一个小写字母开头的类，用于管理 thread-local（线程局部的）数据。对于同一个local，线程无法访问其他线程设置的属性；线程设置的属性不会被其他线程设置的同名属性替换。

可以把local看成是一个“线程-属性字典”的字典，local封装了从自身使用线程作为 key检索对应的属性字典、再使用属性名作为key检索属性值的细节。

#!/usr/bin/env python
#example9.py
#use UTF-8
#Python 3.3.0
#功能: Timer 的使用
import threading
 
local = threading.local()
local.tname = 'main'
 
def func():
    local.tname = 'notmain'
    print(local.tname)
 
t1 = threading.Thread(target=func)
t1.start()
t1.join()
 
print(local.tname)

输出:
Notmain
Main