Python 之 threading

Python线程简介： 

　　Threading 用于提供线程相关的操作，线程是应用程序中工作的最小单位。

threading 模块提供的类

 　　Thread, Lock, Rlock, Condition, Semaphore, Event, Timer, local

threading 模块提供的常用方法

 　　threading.currentThread()：  返回当前的线程变量

　　 threading.enumerate(): 返回一个包含正在运行的线程的list。 正在运行指线程启动后，结束钱，不包括启动前盒终止后的线程

　　 threading.activeCount():   返回正在运行的线程数量。

threading 模块提供的常量

 　　threading.TIMEOUT_MAX 设置threading 全局超时时间

Thread 类

　　有两种实用方法，直接传入要运行的方法或者从Thread继承并覆盖run()方法

 #-*- coding:utf-8 -*-
  import threading
  import time
  #方法一： 将要执行的方法左右参数传给Thread的构造方法
  def action(arg):
      time.sleep(1)
      print("the arg is %s"%arg)
  t_list= []
  for i in range(20):   
     t = threading.Thread(target=action,args=("hello",))   #target 填写要执行的方法名称 args 给要执行的方法传入参数。
     t_list.append(i)
     t.start()
 for i in t_list:
     t.join()
#方法二: 从Thread 继承，并重写run()
class Mythread(threading.Thread):
    def __init__(self,agr):
        super(Mythread,self).__init__()  #注意：一定要显示的调用父类的初始化函数
        self.agr = agr
    def run(self):                       # 方法名称一定要定义为run Thread才会调用这个方法
        time.sleep(1)
        print("the arg is %s" %self.agr)
for i in range(20):
    t = Mythread("test")
    t.start()

构造方法

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

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

　　target：要执行的方法；

　　name：线程名；

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

实例方法

　　isAlive():  返回线程是否再运行。

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

　　 start(): 线程准备就绪，等待CPU调度。启动线程

　　 s/setDaemon(bool): 获取/设置后台线程（默认前台线程（False )).

　　　　如果是后台线程，主线程执行过程中，后台线程也在进程，主线程执行完毕后，后台线程不论成功与否，均停止　

　　　　如果是前台线程，主线程执行过程中，前台线程也在进行，主线程执行完毕后，等待前台线程也执行完成后，程序停止

　　 join： 将线程变成了串行，逐个执行每个线程，执行完毕后继续往下执行。

使用例子（未设置setDaemon） 守护进程

 验证了setDaemon(False)前台线程，主线程执行过程中，前台线程也在进行，主线程执行完毕后，等待前台线程也执行完成后，程序停止

#-*- coding:utf-8 -*-
import threading
import time
def action(arg):
    time.sleep(1)
    print("sub thread start! the thread name is %s" %threading.current_thread().getName())
    print("the arg is %s"%arg)
    time.sleep(1)
for i in range(4):
    t = threading.Thread(target=action,args=(i,))
    t.start()

print("main thread done")
#执行结果
main thread done
sub thread start! the thread name is Thread-3
the arg is 2
sub thread start! the thread name is Thread-2
the arg is 1
sub thread start! the thread name is Thread-1
the arg is 0
sub thread start! the thread name is Thread-4
the arg is 3
进程已结束,退出代码0

使用例子二（setDeamon =True)

#-*- coding:utf-8 -*-
  import threading
  import time
  def action(arg):
      time.sleep(1)
      print("sub thread start! the thread name is %s" %threading.current_thread().getName())
      print("the arg is %s"%arg)
      time.sleep(1)
  for i in range(4):
     t = threading.Thread(target=action,args=(i,))
     t.setDaemon(True)
     t.start()
 
 print("main thread done")
 #执行结果
 main thread done
 
 进程已结束,退出代码0

使用join 例子

#-*- coding:utf-8 -*-
import threading
import time
def action(arg):
    time.sleep(1)
    print("sub thread start! the thread name is %s" %threading.current_thread().getName())
    print("the arg is %s"%arg)
    time.sleep(1)
t_list = []
for i in range(4):
    t = threading.Thread(target=action,args=(i,))
    t.start()
    t_list.append(t)
for i in t_list:
    i.join()
print("main thread done")
#执行结果
sub thread start! the thread name is Thread-1
the arg is 0
sub thread start! the thread name is Thread-3
the arg is 2
sub thread start! the thread name is Thread-2
the arg is 1
sub thread start! the thread name is Thread-4
the arg is 3
main thread done

进程已结束,退出代码0

 验证了join()阻塞当前上下文环境的线程，直到调用此方法的线程终止或到达指定的timeout，即使设置了setDaemon(Ture) 主线程依然要等待子线程结束

JOIN 使用不妥当的示例

#-*- coding:utf-8 -*-
import threading
import time
def action(arg):
    time.sleep(1)
    print("sub thread start! the thread name is %s" %threading.current_thread().getName())
    print("the arg is %s"%arg)
    time.sleep(1)
for i in range(4):
    t = threading.Thread(target=action,args=(i,))
    t.start()
    t.join()
print("main thread done")
#执行结果
vsub thread start! the thread name is Thread-1
the arg is 0
sub thread start! the thread name is Thread-2
the arg is 1
sub thread start! the thread name is Thread-3
the arg is 2
sub thread start! the thread name is Thread-4
the arg is 3
main thread done

进程已结束,退出代码0

Lock

　　Lock（指令锁）是可用的最低级的同步指令。Lock处于锁定状态时，不被特定的线程拥有。Lock包含两种状态——锁定和非锁定，以及两个基本的方法。

　　可以认为Lock有一个锁定池，当线程请求锁定时，将线程至于池中，直到获得锁定后出池。池中的线程处于状态图中的同步阻塞状态。

构造方法： 
　　Lock()

实例方法： 
　　acquire([timeout]): 使线程进入同步阻塞状态，尝试获得锁定。 
　　release(): 释放锁。使用前线程必须已获得锁定，否则将抛出异常

# encoding: UTF-8
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()

Rlock

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

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

构造方法： 
　　RLock()

实例方法： 
　　acquire([timeout])/release(): 跟Lock差不多。

#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()

Condition

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

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

构造方法： 
　　ondition([lock/rlock])

实例方法： 
　　acquire([timeout])/release(): 调用关联的锁的相应方法。 
　　wait([timeout]): 调用这个方法将使线程进入Condition的等待池等待通知，并释放锁。使用前线程必须已获得锁定，否则将抛出异常。 
　　notify(): 调用这个方法将从等待池挑选一个线程并通知，收到通知的线程将自动调用acquire()尝试获得锁定（进入锁定池）；其他线程仍然在等待池中。调用这个方法不会释放锁定。使用前线程必须已获得锁定，否则将抛出异常。 
　　notifyAll(): 调用这个方法将通知等待池中所有的线程，这些线程都将进入锁定池尝试获得锁定。调用这个方法不会释放锁定。使用前线程必须已获得锁定，否则将抛出异常。

示例  生产者/消费者

# encoding: UTF-8
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()

Semaphore /BoundeSemaphore

　　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。

# encoding: UTF-8
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()

Event

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

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

构造方法： 
　　Event()

实例方法： 
　　isSet(): 当内置标志为True时返回True。 
　　set(): 将标志设为True，并通知所有处于等待阻塞状态的线程恢复运行状态。 
　　lear(): 将标志设为False。 
　　wait([timeout]): 如果标志为True将立即返回，否则阻塞线程至等待阻塞状态，等待其他线程调用set()。

# encoding: UTF-8
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()

local

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

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

# encoding: UTF-8
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

熟练掌握Thread、Lock、Condition就可以应对绝大多数需要使用线程的场合，某些情况下local也是非常有用的东西。本文的最后使用这几个类展示线程基础中提到的场景：

# encoding: UTF-8
import threading
 
alist = None
condition = threading.Condition()
 
def doSet():
    if condition.acquire():
        while alist is None:
            condition.wait()
        for i in range(len(alist))[::-1]:
            alist[i] = 1
        condition.release()
 
def doPrint():
    if condition.acquire():
        while alist is None:
            condition.wait()
        for i in alist:
            print i,
        print
        condition.release()
 
def doCreate():
    global alist
    if condition.acquire():
        if alist is None:
            alist = [0 for i in range(10)]
            condition.notifyAll()
        condition.release()
 
tset = threading.Thread(target=doSet,name='tset')
tprint = threading.Thread(target=doPrint,name='tprint')
tcreate = threading.Thread(target=doCreate,name='tcreate')
tset.start()
tprint.start()
tcreate.start()

Timer

　　Timer（定时器）是Thread的派生类，用于在指定时间后调用一个方法。

造方法： 
　　Timer(interval, function, args=[], kwargs={}) 
　　interval: 指定的时间 
　　function: 要执行的方法 
　　args/kwargs: 方法的参数

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

# encoding: UTF-8
import threading
 
def func():
    print 'hello timer!'
 
timer = threading.Timer(5, func)
timer.start()