什麼時候可以考慮上下文管理器
當你的代碼邏輯需要用到如下關鍵字時,可以考慮使用上下文管理器讓你的代碼更加優雅:
try:
...
finally:
...
接下來介紹實現上下文管理器的三種方法。
方法1(上下文管理器協議)
總所周知,open()是默認支持上下文管理器的。所以打開一個txt文件,並向裏面寫入內容,再關閉這個文件的代碼可以這樣寫:
with open("1.txt", "w") as file:
file.write("this is a demo")
這是等同於:
file = None
try:
file = open("1.txt", "w")
file.write("this is a demo")
finally:
file.close()
要在Python中實現with語句的使用,就需要藉助上下文管理器協議。也就是需要實現__enter__和__exit__兩個魔法方法。
class OpenMyFile(object):
def __init__(self, path):
self.path = path
def __enter__(self):
print("opening the txt")
self.f = open(self.path, "w")
return self
def __exit__(self, *args, **kwargs):
print("closing the txt")
self.f.close()
def write(self, string):
print("writing...")
self.f.write(string)
with OpenMyFile("2.txt") as file:
file.write("this is a demo2")
# 輸出:
opening the txt
writing...
closing the txt
同時能夠看到本地生成了2.txt文件。需要注意的是,__enter__得return實例對象,不然會報異常:AttributeError: 'NoneType' object has no attribute 'write'
這是因爲Python中的函數默認返回None。
方法2(@contextmanager)
利用contextlib中的contextmanager裝飾器。
from contextlib import contextmanager
@contextmanager
def open_my_file(path):
print("opening the txt")
f = open("3.txt", "w")
yield f
print("closing the txt")
f.close()
with open_my_file("3.txt") as file:
file.write("this is demo3")
# 輸出:
opening the txt
closing the txt
在@contextmanager裝飾的函數中,需要用yield隔開兩個邏輯語句。這裏yield出來的對象會被as後面的變量接收。
方法3(contextlib.closing())
利用contextlib中的closing()方法。
from contextlib import closing
class OpenMyFile(object):
def __init__(self, path):
print("opening the txt")
self.f = open(path, "w")
def write(self, string):
self.f.write(string)
def close(self):
print("closing the txt")
self.f.close()
with closing(OpenMyFile("4.txt")) as file:
file.write("this is demo4")
# 輸出:
opening the txt
closing the txt
與方法1不同。經過closing()方法包裝過後,在with語句結束時,會強制調用對象的close()方法。所以使用方法3時,需要定義的方法不是__exit__()而是close()。