python with語句上下文管理的兩種實現方法

在編程中會經常碰到這種情況：有一個特殊的語句塊，在執行這個語句塊之前需要先執行一些准備動作；當語句塊執行完成后，需要繼續執行一些收尾動作。例如，文件讀寫后需要關閉，數據庫讀寫完畢需要關閉連接，資源的加鎖和解鎖等情況。
對於這種情況python提供了上下文管理器（Context Manager）的概念，可以通過上下文管理器來定義/控制代碼塊執行前的准備動作，以及執行后的收尾動作。

一、為何使用上下文管理器

1、不使用上下文管理器的情況
通過try...finally語句執行異常處理和關閉句柄的動作。

logger = open("log.txt", "w")
try:
　　logger.write('Hello ')
　　logger.write('World')
finally:
　　logger.close()

print logger.closed

 

 

2、使用上下文管理器
默認文件Python的內置file類型是支持上下文管理協議的。
使用上下文管理器with使得依據精簡了很多。

with open("log.txt", "w") as logger:
　　logger.write('Hello ')
　　logger.write('World')

print logger.closed

 

 

二、實現上下文管理器實現上下文管理器有兩種方式實現。方法一：類實現__enter__和__exit__方法。方法二：contextlib模塊裝飾器和生成器實現。
下面我們通過兩種方法分別實現一個自定義的上下文管理器。
1、方法一：通過類實現__enter__和__exit__方法

class File(object):
    def __init__(self, file_name, method):
        self.file_obj = open(file_name, method)
    def __enter__(self):
        return self.file_obj
    def __exit__(self, type, value, traceback):
        self.file_obj.close()

with File('demo.txt', 'w') as opened_file:
    opened_file.write('Hola!')

 

實現__enter__和__exit__方法后，就能通過with語句進行上下文管理。

a、底層都發生了什么？

1、with語句先暫存了File類的__exit__方法，然后它調用File類的__enter__方法。
2、__enter__方法打開文件並返回給with語句，打開的文件句柄被傳遞給opened_file參數。
3、with語句調用之前暫存的__exit__方法，__exit__方法關閉了文件。

 

b、異常處理

關於異常處理，with語句會采取哪些步驟。
1. 它把異常的type,value和traceback傳遞給__exit__方法
2. 它讓__exit__方法來處理異常 
3. 如果__exit__返回的是True，那么這個異常就被忽略。
4. 如果__exit__返回的是True以外的任何東西，那么這個異常將被with語句拋出。

 

異常拋出

#異常拋出，_exit__返回的是True以外的任何東西，那么這個異常將被with語句拋出
class File(object):
    def __init__(self, file_name, method):
        self.file_obj = open(file_name, method)
    def __enter__(self):
        return self.file_obj
    def __exit__(self, type, value, traceback):
        self.file_obj.close()
        print "type:",type
        print "value:",value
        print "traceback:",traceback


with File('demo.txt', 'w') as opened_file:
    opened_file.undefined_function('Hola!')

#output================================================

# type: <type 'exceptions.AttributeError'>
# value: 'file' object has no attribute 'undefined_function'
# traceback: <traceback object at 0x000000000262D9C8>

#     opened_file.undefined_function('Hola!')
# AttributeError: 'file' object has no attribute 'undefined_function'

 

異常忽略：

#異常忽略，__exit__返回的是True，那么這個異常就被忽略。
class File(object):
    def __init__(self, file_name, method):
        self.file_obj = open(file_name, method)
    def __enter__(self):
        return self.file_obj
    def __exit__(self, exception_type, exception_value, traceback):
        print("Exception has been handled")
        self.file_obj.close()
        return True


with File('demo.txt', 'w') as opened_file:
    opened_file.undefined_function('Hola!')
    
# output==================================
# Exception has been handled

 

 

2、方法二：contextlib模塊裝飾器和生成器實現

這種方式實現更優雅，我個人更喜歡這種方式。

yield之前的代碼由__enter__方法執行，yield之后的代碼由__exit__方法執行。本質上還是__enter__和__exit__方法。

# coding:utf-8
import contextlib


@contextlib.contextmanager
def myopen(filename, mode):
    f = open(filename, mode)
    try:
        yield f.readlines()
    except Exception as e:
        print e

    finally:
        f.close()

if __name__ == '__main__':
    with myopen(r'c:\ip2.txt', 'r') as f:
        for line in f:
            print line

 

 3、with語句上多個下文關聯

直接通過一個with語句打開多個上下文，即可同時使用多個上下文變量，而不必需嵌套使用with語句。

class File(object):
    def __init__(self, file_name, method):
        self.file_obj = open(file_name, method)
    def __enter__(self):
        return self.file_obj
    def __exit__(self, exception_type, exception_value, traceback):
        self.file_obj.close()
        return True


with File('demo.txt', 'w') as f1,File('demo.txt','w') as f2:
    print f1,f2
    
# Output============================# <open file 'demo.txt', mode 'w' at 0x000000000263D150> <open file 'demo.txt', mode 'w' at 0x000000000263D1E0>