Python程式設計：輕鬆搞清楚上下文管理器（Context Manager）

前言

本文聚焦在Python的脈絡管理的解說與應用。還是透過程式碼實例的方式，對照理解和學習，以達到「多快好省」的理解、掌握和應用。閒話少敘，開始－

1.何為上下文管理器

上下文管理器是一個對象，它定義了在執行with語句時要建立的運行時上下文。上下文管理器是為程式碼區塊所執行的上下文環境自動處理進入和退出所需的執行時間。上下文管理器通常使用with語句調用，但也可以透過直接調用它們的方法來使用。

上下文管理器的典型用途包括保存和恢復各種全域狀態，鎖定和解鎖資源，關閉打開的文件，等等。

在章節中，我們將學習如何使用Python中的上下文管理器以及如何自訂上下文管理器。

1.With語句

with語句用於上下文管理器定義的方法包裝區塊的執行。這允許封裝常見的try…except…finally使用模式以方便重複使用。與傳統的try…except…finally區塊相比，with語句提供了更短且可重複使用的程式碼。

在Python標準函式庫中，許多類別都支援with語句。一個非常常見的範例是內建的open()函數，它提供了使用with語句處理檔案物件的模式。

下面是with語句的一般語法:

with expression as target:
# 使用target
# 来处理事情

我們看一個使用open()函數的範例。在目前專案的files資料夾中有一個文字檔案。檔案名稱為color_names.txt，其中包含一些顏色名稱（可自行提供一些文字內容）。我們希望透過使用open()函數和with語句來開啟並列印該檔案中的內容。程式碼範例如下：

import os
fileDirPath = os.getcwd()+os.sep+"ctxManager"+os.sep #自定义文件路径
# 指定文件路径和名称
path = fileDirPath+'files/color_names.txt'

# with 语句
with open(path, mode='r') as file:
# 读取文件内容
print(file.read())

執行程式輸出結果如下

red
orange
yellow
green
blue
white
black

在上面清單中，看到是with語句的一個常見用例。我們使用open()函數開啟給定的路徑（path）上的文件，且open()函數以唯讀模式返回文件物件。然後程式碼中使用這個檔案物件讀取並透過程式碼:print(file.read())將其內容列印輸出。

上面範例是上下文管理器的典型用法。為了更好地理解和應用上下文管理器，我們還得繼續往下看。

3. 上下文管理器協定

上下文管理器協定（Context Manager Protocol），說白了就是上下文管理器的處理機制，或說預定的規約標準。這部分內容也可查看這裡：Python核心協議。為了閱讀的獨立性，這裡也再說一說。

Python的with語句支援由上下文管理器定義的執行時期上下文的概念。這是透過一對方法實現的，它們允許使用者定義的類別定義運行時上下文，該上下文在語句體執行之前進入，並在語句結束時退出。

前所提到的這些方法稱為上下文管理器協定。來具體看一下這兩個方法:

1）__enter__(self)

該方法由with語句調用，以進入與當前物件相關的運行時上下文。 with語句將此方法的回傳值綁定到語句的as子句中指定的目標(如果有的話)。

上例中傳回的上下文管理器的是檔案物件。在背後，檔案物件從__enter__()傳回其本身，以允許open()被用作with語句中的上下文表達式。

2)__exit__(self, exc_type, exc_value, traceback):

當執行離開with程式碼區塊時呼叫此方法。它退出與此物件相關的運行時上下文。參數描述了導致退出上下文的異常訊息。如果沒有異常而退出上下文，那麼所有三個參數都將為None。

如果提供了異常，並且希望該方法抑制該異常(即，阻止它被傳播)，那麼它應該傳回一個True值。否則，異常將在退出此方法時正常處理。 __exit__()方法傳回一個布林值，可以是True或False。

使用上下文管理器協定中的方法執行with語句的過程如下:

with EXPRESSION as TARGET:
SUITE

• #計算上下文表達式（EXPRESSION）以獲得上下文管理器。
• 載入上下文管理員的__enter__()以供隨後使用。
• 載入上下文管理員的__exit__()以供隨後使用。
•  呼叫上下文管理器的__enter__()方法。
•  如果在with語句中包含了一個TARGET，則會將__enter__()的回傳值賦給它。
• 執行套件(with語句作用域中的程式碼區塊)。
• 呼叫上下文管理器的__exit__()方法。如果例外狀況導致套件退出，則其類型、值和回溯將作為參數傳遞給__exit__()。否則，將提供三個None參數。

如果套件因例外以外的任何原因退出，則會忽略__exit__()的回傳值，並在所執行退出類型的正常位置繼續執行後續程式碼（若有）。

4. 類別形式上下文管理器

現在我們了解了上下文管理器協定背後的基本思想，讓我們在一個類別中實現它。這個類別將是我們的上下文管理器，並稍後在with語句中使用它。

定义的上下文管理器类参考示例清单如下：

# 自定义上下文管理器类
class CustomContextManager:
# 初始化方法init -> 定义一些变量
def __init__(self, path, mode):
self.path = path
self.mode = mode
self.file = None

# __enter__ method -> open the file
def __enter__(self):
self.file = open(self.path, self.mode)
return self.file

# exit method to close the file

def __exit__(self, exc_type, exc_value,exc_traceback):
self.file.close()

我们的CustomContextManager类实现了成为上下文管理器的必要方法:__enter__和__exit__。

在__init__方法中，它定义了三个实例变量来存储路径、模式和文件对象。

在__enter__方法中，它使用内置的open()函数打开指定路径中的文件。由于open()函数返回file对象，我们将其赋值给self.file属性。

在__exit__方法中，我们将文件关闭:self.file.close()。

__exit__方法接受三个参数，它们是上下文管理器协议所需要的。

现在我们可以在with语句中使用自定义上下文管理器。

使用自定义的类上下文管理器的示例（和我们前面的示例雷同）:

# 应用示例
import os
fileDirPath = os.getcwd()+os.sep+"ctxManager"+os.sep
# 在with语句中使用自定义上下文管理器
file_path = fileDirPath + 'files/color_names.txt'

with CustomContextManager(path=file_path, mode='r') as file:
#输出文件file内容
print(file.read())

运行输出结果这里不再赘述。简单解释一下代码。

上面清单中，在with语句中使用CustomContexManager类，通过它来读取文件内容并打印出来。下面是这个自定义上下文管理器幕后的故事:

1）在with行，调用类CustomContextManager的方_enter__法

2） __enter__方法打开文件并返回它。

3）我们将打开的文件简单地命名为file。

4）在with语句块中，读取文件内容并将其打印出来。

5）with语句自动调用__exit__方法。

6）__exit__方法关闭文件。

我们再来定义另一个上下文管理器类。这次我们想打印指定文件夹中的文件列表。

参考实现的代码清单如下：

class ContentList:
'''Prints the content of a directory'''

def __init__(self, directory):
self.directory = directory

def __enter__(self):
return os.listdir(self.directory)

def __exit__(self, exc_type, exc_val, exc_tb):
if exc_type is not None:
print("Error getting directory list.")
return True

# 输出项目目录下的内容
project_directory = '.'
with ContentList(project_directory) as directory_list:
print(directory_list)

在代码清单中，我们定义了一个新的上下文管理器。这个类的名字是ContentList。为什么它是一个上下文管理器?因为它实现了上下文管理器协议(__enter__和__exit__方法)。

我们将目录路径作为类构造函数__init__方法中的参数。

在__enter__方法中，只需调用os模块中的listdir()方法，就可以获得该目录中的内容列表:os.listdir(self.directory)。然后返回这个列表。请注意，在这个上下文管理器中我们的__enter__方法返回一个列表。

在__exit__方法中，我们检查是否存在任何错误。如果我们的上下文管理器中有错误，exc_type、exc_val、exc_tb参数值将不会为None。因此，我们检查exc_type是否为None以打印错误文本。

在with语句中使用该上下文管理器。由于它返回一个列表对象，我们只需将返回值赋值给directory_list变量。在with语句的主体中，我们打印这个列表。运行程序后在输出中，可以看到项目目录中的内容列表。记住,"."表示当前目录，在我们的例子中是项目根目录（由于项目环境不同，输出内容可能也不一样）。

6. 函数形式上下文管理器

前文中,我们学习了如何使用类语法定义上下文管理器。但是有点繁琐和冗长。因为需要明确地实现__enter__和exit__方法,还需要处理可能的异常。所以希望Python中能有在创建上下文管理器更好的方法:基于函数的上下文管理器。

其实函数上下文管理器是使用生成器和contextlib.contextmanager装饰器的特殊函数。 contextlib.contextmanager装饰器负责实现上下文管理器协议。

下面就来定义一个函数型上下文管理器。

from contextlib import contextmanager

# 定义上下文管理器函数
@contextmanager
def function_based_context_manager():
print("进入上下文: __enter__")
yield "这是个基于上下文管理器的函数"
print("离开上下文: __exit__")

# with语句中使用上下文管理器函数
with function_based_context_manager() as yield_text:
print(yield_text)

运行程序输出结果类似如下：

进入上下文: __enter__
这是个基于上下文管理器的函数
离开上下文: __exit__

在上面代码中，我们定义了一个作为上下文管理器的自定义函数。contextmanager装饰器将常规函数转换为全堆栈上下文管理器（自动实现上下文管理器的协议）。如果你为函数提供了@contextmanager装饰器，就不需要担心实现__enter__和__exit__函数。

代码中的yield语句在基于类的上下文管理器中的__enter__方法中充当返回语句。由于我们使用了yield语句，故此，这个基于函数的上下文管理器也是生成器函数。

再来定义一个新的上下文管理器。这一次，它将以写的模式打开一个文件并添加一些文本。示例如下:

代码清单

在清单中，我们定义了一个基于函数的上下文管理器。在try块中，它尝试打开指定路径中的文件，并指定了文件的默认编码集。如果它成功地打开它，那么它将生成(返回)file_object。在finally块中，我们检查是否有一个file_object要关闭。如果file_object不是None，则关闭file_object。

在with語句中，我們用檔案名稱funBasedContextManagers.txt呼叫上下文管理器。上下文管理器以寫入模式開啟該文件並返回文件對象，我們將其簡單命名為file。接著在這個文件中寫入一些文字。記住，如果這樣的文件不存在，'w'模式將建立一個空文件。

執行上面程序，若檔案不存在，則產生對應名稱的檔案並保持寫入的內容。若文件存在，則這種寫入文件是每次情況來源文件再寫入內容的，這一點操作請注意。

像是這種處理「收尾」工作的，使用上下文管理器特別方便，尤其涉及到資料庫操作方面，例如可以自己包裝一個來完成自動的關閉連接等。

本文小結

本期我們介紹了上下文管理器的相關程式內容，諸如何為上下文管理器、上下文管理器協定、自訂的類別形式上下文管理器以及函數型上下文管理器等。相關內容大都配合可實戰的程式碼進行了演示和解說。要提升程式設計技能，多動手敲程式碼是不可或缺的要求。

以上是Python程式設計：輕鬆搞清楚上下文管理器（Context Manager）的詳細內容。更多資訊請關注PHP中文網其他相關文章！