一、说明

有一些任务，可能事先需要设置，事后做清理工作。 with方法就是python的非常酷的语句，安全可靠，方便。我们自己的类如何具备with的能力?必须拥有__enter__()方法，另一个__exit__()，因此，这里介绍这些能力。

对于这种场景，一个很好的例子是文件处理，你需要获取一个文件句柄，从文件中读取数据，然后关闭文件句柄。

二、python的with语句

2.1 有with语句和无的区别

一个很好的例子是文件处理，你需要获取一个文件句柄，从文件中读取数据，然后关闭文件句柄。如果不用with语句，代码如下：

file = open("/tmp/foo.txt")
data = file.read()
file.close()

这里有两个问题：

1）可能忘记关闭文件句柄；
2）文件读取数据发生异常，没有进行任何处理。

下面是处理异常的加强版本：

file = open("/tmp/foo.txt")
try:
    data = file.read()
finally:
    file.close()

虽然这段代码运行良好，但是太冗长了。这时候就是with一展身手的时候了。除了有更优雅的语法，with还可以很好的处理上下文环境产生的异常。下面是with版本的代码：

with open("/tmp /foo.txt") as file:
    data = file.read()

2.2 with如何工作？

这看起来充满魔法，但不仅仅是魔法，Python对with的处理还很聪明。基本思想是with所求值的对象必须有一个__enter__()方法，一个__exit__()方法。

紧跟with后面的语句被求值后，返回对象的__enter__()方法被调用，这个方法的返回值将被赋值给as后面的变量。当with后面的代码块全部被执行完之后，将调用前面返回对象的__exit__()方法。

下面例子可以具体说明with如何工作：

#!/usr/bin/env python
# with_example01.py

class Sample:
    def __enter__(self):
        print( "In __enter__()" )
        return "Foo"

    def __exit__(self, type, value, trace):
        print( "In __exit__()")


def get_sample():
    return Sample()


with get_sample() as sample:
    print ("sample:", sample)

输出如下

bash-3.2$ ./with_example01.py
In __enter__()
sample: Foo
In __exit__()

正如你看到的，

__enter__()方法被执行
__enter__()方法返回的值 - 这个例子中是"Foo"，赋值给变量'sample'
执行代码块，打印变量"sample"的值为 "Foo"
__exit__()方法被调用

with真正强大之处是它可以处理异常。可能你已经注意到Sample类的__exit__方法有三个参数val,type 和 trace。这些参数在异常处理中相当有用。我们来改一下代码，看看具体如何工作的。

#!/usr/bin/env python
# with_example02.py


class Sample:
    def __enter__(self):
        return self

    def __exit__(self, type, value, trace):
        print "type:", type
        print "value:", value
        print "trace:", trace

    def do_something(self):
        bar = 1/0
        return bar + 10

with Sample() as sample:
    sample.do_something()

这个例子中，with后面的get_sample()变成了Sample()。这没有任何关系，只要紧跟with后面的语句所返回的对象有 __enter__()和__exit__()方法即可。此例中，Sample()的__enter__()方法返回新创建的Sample对象，并赋值给变量sample。

代码执行后：

bash-3.2$ ./with_example02.py
type: <type 'exceptions.ZeroDivisionError'>
value: integer division or modulo by zero
trace: <traceback object at 0x1004a8128>
Traceback (most recent call last):
  File "./with_example02.py", line 19, in <module>
    sample.do_somet hing()
  File "./with_example02.py", line 15, in do_something
    bar = 1/0
ZeroDivisionError: integer division or modulo by zero

实际上，在with后面的代码块抛出任何异常时，__exit__()方法被执行。正如例子所示，异常抛出时，与之关联的type，value和stack trace传给__exit__()方法，因此抛出的ZeroDivisionError异常被打印出来了。开发库时，清理资源，关闭文件等等操作，都可以放在__exit__方法当中。

因此，Python的with语句是提供一个有效的机制，让代码更简练，同时在异常产生时，清理工作更简单。

三、上下文管理协议(enter,__exit)

3.1、上下文管理协议

即with语句，为了让一个对象兼容with语句，必须在这个对象的类中声明__enter__和__exit__方法

__enter__()会在with语句出现（实例化对象）时执行
__exit__()会在with语句的代码块实行完毕才会执行

class Open:
   def __init__(self,name):
          self.name = name
  
   def __enter__(self):                 #在实例化打开文件时即触发，在with时触发
         print('执行__enter__')
         return self                    #return的self会赋值给f，相当于通过Open类实例化处对象f

   def __exit__(self,exc_type,exc_val,exc_tb):    #在with中的代码块执行完毕才会触发
         print('执行__exit__')
 

with Open('a.txt') as f:                #会触发enter  '执行__enter__'，相当于--》f=Open('a.txt').__enter__()
  print(f)                              #<__main__.Open object at 0x01477270>
  print(f.name)                         #'a.txt'
print('*'*10)                           #先---'执行__exit__'
                                        #后---'*********'   


Output:
---------------------------------------------
执行__enter__
<__main__.Open object at 0x000000000210B208>
a.txt
执行__exit__
**********
---------------------------------------------

复制

3.2 exit

__exit__()中有三个参数分别代表异常类型，异常值和追溯信息，执行了__exit__则表示with语句执行完毕 1、若__exit__返回值不为True，则： a、若with语句中没有异常，则程序正常执行 b、若with语句中出现异常，则程序会执行到with中出错的语句并执行__exit__，然后程序终止，‘吐出’异常

class Open:
    def __init__(self,name):
        self.name = name
  
    def __enter__(self):                        
        print('执行__enter__')
        return self                    
  
    def __exit__(self,exc_type,exc_val,exc_tb):    
        print('执行__exit__')
        print(exc_type)                #<class 'AttributeError'>
        print(exc_val)                #'Open' object has no attribute 'age'
        print(exc_tb)                #<traceback object at 0x0178F738>
 
with Open('a.txt') as f:
     print(f)
     print(f.age)       
     #因为f对象没有age属性，则出现异常，程序执行到该句时将异常传递给__exit__的三个参数，并结束程序执行，报错
     print(f.name)        #该行语句后面的语句都不会执行，包括with语句的以外的语句也不会执行
print('*'*10) 


Output:
---------------------------------------------------------
执行__enter__
    print(f.age)
AttributeError: 'Open' object has no attribute 'age'
<__main__.Open object at 0x000000000257E4A8>
执行__exit__
<class 'AttributeError'>
'Open' object has no attribute 'age'
<traceback object at 0x0000000002583288>
---------------------------------------------------------

复制

2、若__exit__返回值为True，则： 　a、若with语句中没有异常，则程序正常执行　b、若with语句中出现异常，则程序会执行到with中出错的语句并执行__exit__，‘吞掉’异常。然后with语句中剩下的语句不会执行，但是会继续执行with语句以外的语句

class Open:
    def __init__(self,name):
        self.name = name
  
    def __enter__(self):                        
        print('执行__enter__')
        return self                    
  
    def __exit__(self,exc_type,exc_val,exc_tb):    
        print('执行__exit__')
        print(exc_type)                #<class 'AttributeError'>
        print(exc_val)                #'Open' object has no attribute 'age'
        print(exc_tb)                #<traceback object at 0x0178F738>
        return True
with Open('a.txt') as f:
     print(f)
     print(f.age)        #因为f对象没有age属性，则出现异常，程序执行到该句时将异常传递给__exit__的三个参数，并结束程序执行，'吞掉异常'不会报错
     print(f.name)       #该行语句后面的with中的语句都不会执行，但是with语句的以外的语句会继续执行
print('*'*10)            #'*********'

复制