目錄

一、概述

1、定義

2、作用

二、主要應用場景

1、構造和析構

2、操作符重載

3、字符串和表示

4、容器管理

5、可調用對象

6、上下文管理

7、屬性訪問和描述符

8、迭代器和生成器

9、數值類型

10、復制和序列化

11、自定義元類行為

12、自定義類行為

13、類型檢查和轉換

14、自定義異常

三、學習方法

1、理解基礎

2、查閱文檔

3、編寫示例

4、實踐應用

5、閱讀他人代碼

6、參加社區討論

7、持續學習

8、練習與總結

9、注意兼容性

10、避免過度使用

四、魔法方法

14、__enter__方法

14-1、語法

14-2、參數

14-3、功能

14-4、返回值

14-5、說明

14-6、用法

15、__eq__方法

15-1、語法

15-2、參數

15-3、功能

15-4、返回值

15-5、說明

15-6、用法

16、__exit__方法

16-1、語法

16-2、參數

16-3、功能

16-4、返回值

16-5、說明

16-6、用法

五、推薦閱讀

1、Python筑基之旅

2、Python函數之旅

3、Python算法之旅

4、博客個人主頁

一、概述

1、定義

????????魔法方法(Magic Methods/Special Methods，也稱特殊方法或雙下劃線方法)是Python中一類具有特殊命名規則的方法，它們的名稱通常以雙下劃線(`__`)開頭和結尾。

????????魔法方法用于在特定情況下自動被Python解釋器調用，而不需要顯式地調用它們，它們提供了一種機制，讓你可以定義自定義類時具有與內置類型相似的行為。

2、作用

????????魔法方法允許開發者重載Python中的一些內置操作或函數的行為，從而為自定義的類添加特殊的功能。

二、主要應用場景

1、構造和析構

1-1、__init__(self, [args...])：在創建對象時初始化屬性。
1-2、__new__(cls, [args...])：在創建對象時控制實例的創建過程(通常與元類一起使用)。
1-3、__del__(self)：在對象被銷毀前執行清理操作，如關閉文件或釋放資源。

2、操作符重載

2-1、__add__(self, other)、__sub__(self, other)、__mul__(self, other)等：自定義對象之間的算術運算。
2-2、__eq__(self, other)、__ne__(self, other)、__lt__(self, other)等：定義對象之間的比較操作。

3、字符串和表示

3-1、__str__(self)：定義對象的字符串表示，常用于print()函數。
3-2、__repr__(self)：定義對象的官方字符串表示，用于repr()函數和交互式解釋器。

4、容器管理

4-1、__getitem__(self, key)、__setitem__(self, key, value)、__delitem__(self, key)：用于實現類似列表或字典的索引訪問、設置和刪除操作。
4-2、__len__(self)：返回對象的長度或元素個數。

5、可調用對象

5-1、__call__(self, [args...])：允許對象像函數一樣被調用。

6、上下文管理

6-1、__enter__(self)、__exit__(self, exc_type, exc_val, exc_tb)：用于實現上下文管理器，如with語句中的對象。

7、屬性訪問和描述符

7-1、__getattr__, __setattr__, __delattr__：這些方法允許對象在訪問或修改不存在的屬性時執行自定義操作。
7-2、描述符(Descriptors)是實現了__get__, __set__, 和__delete__方法的對象，它們可以控制對另一個對象屬性的訪問。

8、迭代器和生成器

8-1、__iter__和__next__：這些方法允許對象支持迭代操作，如使用for循環遍歷對象。
8-2、__aiter__, __anext__：這些是異步迭代器的魔法方法，用于支持異步迭代。

9、數值類型

9-1、__int__(self)、__float__(self)、__complex__(self)：定義對象到數值類型的轉換。
9-2、__index__(self)：定義對象用于切片時的整數轉換。

10、復制和序列化

10-1、__copy__和__deepcopy__：允許對象支持淺復制和深復制操作。
10-2、__getstate__和__setstate__：用于自定義對象的序列化和反序列化過程。

11、自定義元類行為

11-1、__metaclass__(Python 2)或元類本身(Python 3)：允許自定義類的創建過程，如動態創建類、修改類的定義等。

12、自定義類行為

12-1、__init__和__new__：用于初始化對象或控制對象的創建過程。
12-2、__init_subclass__：在子類被創建時調用，允許在子類中執行一些額外的操作。

13、類型檢查和轉換

13-1、__instancecheck__和__subclasscheck__：用于自定義isinstance()和issubclass()函數的行為。

14、自定義異常

14-1、你可以通過繼承內置的Exception類來創建自定義的異常類，并定義其特定的行為。

三、學習方法

????????要學好Python的魔法方法，你可以遵循以下方法及步驟：

1、理解基礎

????????首先確保你對Python的基本語法、數據類型、類和對象等概念有深入的理解，這些是理解魔法方法的基礎。

2、查閱文檔

????????仔細閱讀Python官方文檔中關于魔法方法的部分，文檔會詳細解釋每個魔法方法的作用、參數和返回值。你可以通過訪問Python的官方網站或使用help()函數在Python解釋器中查看文檔。

3、編寫示例

????????為每個魔法方法編寫簡單的示例代碼，以便更好地理解其用法和效果，通過實際編寫和運行代碼，你可以更直觀地感受到魔法方法如何改變對象的行為。

4、實踐應用

????????在實際項目中嘗試使用魔法方法。如，你可以創建一個自定義的集合類，使用__getitem__、__setitem__和__delitem__方法來實現索引操作。只有通過實踐應用，你才能更深入地理解魔法方法的用途和重要性。

5、閱讀他人代碼

????????閱讀開源項目或他人編寫的代碼，特別是那些使用了魔法方法的代碼，這可以幫助你學習如何在實際項目中使用魔法方法。通過分析他人代碼中的魔法方法使用方式，你可以學習到一些新的技巧和最佳實踐。

6、參加社區討論

????????參與Python社區的討論，與其他開發者交流關于魔法方法的使用經驗和技巧，在社區中提問或回答關于魔法方法的問題，這可以幫助你更深入地理解魔法方法并發現新的應用場景。

7、持續學習

????????Python語言和其生態系統不斷發展，新的魔法方法和功能可能會不斷被引入，保持對Python社區的關注，及時學習新的魔法方法和最佳實踐。

8、練習與總結

????????多做練習，通過編寫各種使用魔法方法的代碼來鞏固你的理解，定期總結你學到的知識和經驗，形成自己的知識體系。

9、注意兼容性

????????在使用魔法方法時，要注意不同Python版本之間的兼容性差異，確保你的代碼在不同版本的Python中都能正常工作。

10、避免過度使用

????????雖然魔法方法非常強大，但過度使用可能會導致代碼難以理解和維護，在編寫代碼時，要權衡使用魔法方法的利弊，避免濫用。

????????總之，學好Python的魔法方法需要不斷地學習、實踐和總結，只有通過不斷地練習和積累經驗，你才能更好地掌握這些強大的工具，并在實際項目中靈活運用它們。

四、魔法方法

14、__enter__方法

14-1、語法

__enter__(self)return self # 可以返回任何對象，或者簡單地返回self

14-2、參數

14-2-1、self(必須)：一個對實例對象本身的引用，在類的所有方法中都會自動傳遞。

14-3、功能

? ? ? ? 用于在進入一個由with語句控制的代碼塊時執行特定的操作。

14-4、返回值

????????在with語句塊開始執行時調用，并通常返回一個對象。

14-5、說明

? ? ? ? 在Python的官方文檔中，__enter__?方法是不接受任何參數的。但是，如果你真的看到了帶有參數的 __enter__ 方法，那可能是某個特定庫或框架的擴展用法，或者可能是對該方法的誤用。

14-6、用法

# 014、__enter__方法：
# 1、文件操作
# 定義一個名為 FileContextManager 的類，用于管理文件的上下文
class FileContextManager:# 初始化方法，接收一個文件名作為參數def __init__(self, filename):# 將傳入的文件名保存到實例變量 filename 中self.filename = filename# 定義 __enter__ 方法，用于 with 語句執行時進入上下文時調用def __enter__(self):# 使用實例變量 filename 打開文件，并設置文件模式為只讀 ('r')self.file = open(self.filename, 'r')# 返回打開的文件對象，以便在 with 語句的 as 子句中引用return self.file# 定義 __exit__ 方法，用于 with 語句執行完畢后退出上下文時調用def __exit__(self, exc_type, exc_val, exc_tb):# 關閉之前打開的文件對象self.file.close()# 使用 with 語句和 FileContextManager 類來管理文件操作
# 'test.txt' 是要打開的文件名，'file' 是打開文件后在 with 語句內部使用的引用名
with FileContextManager('test.txt') as file:# 讀取文件內容并打印，假設文件內容是 "Hello, World!"print(file.read())  # 輸出：Hello, World!# 2、數據庫連接
# 假設有一個數據庫連接庫（但在這里我們只是模擬它）
class DatabaseContext:# 定義一個上下文管理器的進入方法def __enter__(self):# 當使用 with 語句進入上下文時，該方法會被調用# 這里只是一個示例，實際中會使用數據庫連接庫來建立真實的數據庫連接print("Connecting to database...")# 假設我們有一個模擬的數據庫連接字符串self.connection = "Mock Database Connection"# 返回連接對象（或連接字符串），以便在 with 語句的 as 子句中引用return self.connection# 定義一個上下文管理器的退出方法def __exit__(self, exc_type, exc_val, exc_tb):# 當 with 語句塊結束時，無論是否發生異常，該方法都會被調用print("Closing database connection...")# 在這里，我們只是打印了一條消息，但在真實情況下，你會關閉數據庫連接
# 使用 with 語句和 DatabaseContext 類來管理數據庫連接的上下文
with DatabaseContext() as db:# 在這里使用數據庫連接（這里只是打印了一條消息）# 假設 db 是一個數據庫連接對象，但在本例中它只是一個字符串print("Using database:", db)# 當 with 語句塊結束時，__exit__ 方法會被自動調用，打印 "Closing database connection..."# 3、臨時目錄
# 導入tempfile模塊，用于創建臨時文件和目錄
import tempfile
# 導入shutil模塊，用于刪除目錄及其內容
import shutil
# 定義一個名為TempDirContext的上下文管理類
class TempDirContext:# 定義__enter__方法，當使用with語句進入上下文時調用def __enter__(self):# 使用tempfile.mkdtemp()方法創建一個臨時目錄self.temp_dir = tempfile.mkdtemp()# 打印創建的臨時目錄的路徑print(f"Created temp directory: {self.temp_dir}")# 返回臨時目錄的路徑，以便在with語句的as子句中引用return self.temp_dir# 定義__exit__方法，當with語句塊結束時調用def __exit__(self, exc_type, exc_val, exc_tb):# 打印將要刪除的臨時目錄的路徑print(f"Deleting temp directory: {self.temp_dir}")# 使用shutil.rmtree()方法刪除臨時目錄及其所有內容shutil.rmtree(self.temp_dir)
# 使用with語句和TempDirContext類來管理臨時目錄的上下文
with TempDirContext() as temp_dir:# 打印正在使用的臨時目錄的路徑print(f"Using temp directory: {temp_dir}")# 在這里可以使用temp_dir變量來引用臨時目錄，并執行相關操作# 例如：在臨時目錄中創建文件、寫入數據等# 注意：由于此代碼片段是一個注釋示例，所以沒有包含實際的文件操作# 4、鎖機制
# 導入threading模塊，用于多線程操作
import threading
# 定義一個名為ThreadLock的類，用于管理線程鎖
class ThreadLock:# 初始化方法，創建一個threading.Lock對象def __init__(self):self.lock = threading.Lock()# 定義__enter__方法，當使用with語句進入上下文時調用def __enter__(self):# 嘗試獲取鎖self.lock.acquire()# 打印鎖已被獲取的消息print("Acquired lock")# 返回鎖對象（雖然通常不需要返回，但這里為了示例還是返回了）return self.lock# 定義__exit__方法，當with語句塊結束時調用def __exit__(self, exc_type, exc_val, exc_tb):# 釋放鎖self.lock.release()# 打印鎖已被釋放的消息print("Released lock")
# 使用with語句和ThreadLock類來管理線程鎖
with ThreadLock() as lock:# 在這里進行線程安全的操作# 注意：因為with語句已經處理了鎖的獲取和釋放，所以這里的lock變量其實不需要使用# 除非你想在with塊內部檢查鎖的狀態或做其他與鎖相關的操作pass# 5、設置和恢復環境變量
# 定義一個名為EnvVarContext的上下文管理器類，用于臨時修改環境變量
class EnvVarContext:def __init__(self, var_name, new_value):# 初始化時接收環境變量名和新值self.var_name = var_name  # 存儲要修改的環境變量名self.new_value = new_value  # 存儲新的環境變量值self.old_value = None  # 用于存儲原始的環境變量值def __enter__(self):# 當使用with語句進入上下文時調用# 獲取環境變量原來的值self.old_value = os.environ.get(self.var_name)# 設置新的環境變量值os.environ[self.var_name] = self.new_value# 打印已設置新的環境變量值print(f"Set {self.var_name} to {self.new_value}")# 因為with語句的as子句沒有使用變量來接收返回值，所以這里不需要返回具體的值def __exit__(self, exc_type, exc_val, exc_tb):# 當with語句塊結束時調用# 恢復環境變量為原來的值if self.old_value is not None:# 如果原值存在，則恢復為原值os.environ[self.var_name] = self.old_valueelse:# 如果原值不存在，則從環境變量中刪除該變量del os.environ[self.var_name]# 打印環境變量已恢復為原始值或已刪除print(f"Restored {self.var_name} to its original value")
# 導入os模塊，以便操作環境變量
import os
# 使用with語句和EnvVarContext類來修改環境變量
with EnvVarContext('MY_VAR', 'new_value') as _:# 在with塊內部，MY_VAR的值已被臨時修改為'new_value'print(os.environ['MY_VAR'])  # 輸出: new_value
# 退出with塊后，MY_VAR被恢復為原來的值或刪除
# 之后的代碼可以確認MY_VAR的值是否已被恢復# 6、模擬上下文狀態管理
class MyContextManager:def __enter__(self):print("Entering the context")# 在這里，你可以設置任何進入上下文時需要的狀態或資源# 例如，打開一個文件、獲取一個鎖等self.resource = "some resource"  # 假設這是一個需要管理的資源return self  # 通常，__enter__ 應該返回一個對象，以便在 with 塊中使用def __exit__(self, exc_type, exc_value, traceback):print("Exiting the context")# 在這里，你可以執行任何清理工作，例如關閉文件、釋放鎖等# 你可以檢查 exc_type, exc_value, traceback 來確定是否發生了異常# 如果發生了異常并且你想重新拋出它，則不應該在這里進行任何操作# 如果你想忽略異常，你可以在這里返回 True# 如果你想在退出時總是執行一些清理代碼，無論是否發生異常，你可以將這里留空
# 使用 with 語句和上下文管理器
with MyContextManager() as manager:print("Inside the with block, accessing resource:", manager.resource)# 這里是代碼塊，當執行到這里時，__enter__ 已經被調用# 當這個代碼塊執行完畢（或者發生異常）時，__exit__ 將會被調用

15、__eq__方法

15-1、語法

__eq__(self, other, /)Return self==other

15-2、參數

15-2-1、self(必須)：表示調用該方法的對象本身。

15-2-2、other(必須)：表示與self進行相等性比較操作的對象。

15-2-3、/(可選)：這是從Python 3.8開始引入的參數注解語法，它表示這個方法不接受任何位置參數(positional-only parameters)之后的關鍵字參數(keyword arguments)。

15-3、功能

????????用于定義對象之間的相等性比較。

15-4、返回值

????????返回一個布爾值(True或False)，表示兩個對象是否相等。

15-5、說明

????????當你使用==運算符來比較兩個對象是否相等時，Python會嘗試調用這兩個對象的__eq__方法(如果它們定義了的話)。

15-6、用法

# 015、__eq__方法：
# 1、簡單的數值類
# 定義一個名為Number的類，用于封裝數值
class Number:# 類的初始化方法，當創建Number類的實例時調用def __init__(self, value):# 給實例對象添加一個屬性value，并賦值為傳入的參數valueself.value = value# 類的相等性比較方法，用于比較兩個Number對象是否相等def __eq__(self, other):# 檢查other是否是Number類的實例if isinstance(other, Number):# 如果是，則比較兩個Number對象的value屬性是否相等return self.value == other.value# 如果other不是Number類的實例，則直接返回Falsereturn False
# 當這個腳本作為主程序運行時，以下代碼會被執行
if __name__ == '__main__':# 創建兩個Number對象，它們的value屬性都是5num1 = Number(5)num2 = Number(5)# 創建一個Number對象，它的value屬性是10num3 = Number(10)# 使用==操作符比較num1和num2是否相等，并打印結果（注釋說明預期輸出為True）print(num1 == num2)  # 輸出: True# 使用==操作符比較num1和num3是否相等，并打印結果（注釋說明預期輸出為False）print(num1 == num3)  # 輸出: False# 2、點類(二維坐標)
# 定義一個名為Point的類，用于表示二維平面上的點
class Point:# 初始化方法，當創建Point類的實例時調用def __init__(self, x, y):# 設置點的x坐標self.x = x# 設置點的y坐標self.y = y# 相等性比較方法，用于比較兩個Point對象是否相等def __eq__(self, other):# 檢查other是否也是Point類的實例if isinstance(other, Point):# 如果是，則比較兩個點的x和y坐標是否都相等return self.x == other.x and self.y == other.y# 如果other不是Point類的實例，則返回Falsereturn False
# 當這個腳本作為主程序運行時，以下代碼會被執行
if __name__ == '__main__':# 創建一個Point對象p1，其x坐標為1，y坐標為2p1 = Point(1, 2)# 創建一個Point對象p2，其x坐標為1，y坐標為2（與p1相同）p2 = Point(1, 2)# 創建一個Point對象p3，其x坐標為2，y坐標為2（與p1不同）p3 = Point(2, 2)# 使用==操作符比較p1和p2是否相等，并打印結果（注釋說明預期輸出為True）print(p1 == p2)  # 輸出: True# 使用==操作符比較p1和p3是否相等，并打印結果（注釋說明預期輸出為False）print(p1 == p3)  # 輸出: False# 3、字符串封裝類
# 定義一個名為StringWrapper的類，用于封裝字符串  
class StringWrapper:# 初始化方法，當創建StringWrapper類的實例時調用  def __init__(self, text):# 給實例對象添加一個屬性text，并賦值為傳入的參數text  self.text = text# 相等性比較方法，用于比較兩個StringWrapper對象是否相等  def __eq__(self, other):# 檢查other是否也是StringWrapper類的實例  if isinstance(other, StringWrapper):# 如果是，則比較兩個StringWrapper對象的text屬性是否相等  return self.text == other.text# 如果other不是StringWrapper類的實例，則返回False  return False
# 當這個腳本作為主程序運行時，以下代碼會被執行  
if __name__ == '__main__':# 創建一個StringWrapper對象s1，封裝字符串"hello"  s1 = StringWrapper("hello")# 創建一個StringWrapper對象s2，封裝字符串"hello"（與s1相同）  s2 = StringWrapper("hello")# 創建一個StringWrapper對象s3，封裝字符串"world"（與s1不同）  s3 = StringWrapper("world")# 使用==操作符比較s1和s2是否相等，并打印結果（注釋說明預期輸出為True）  print(s1 == s2)  # 輸出: True  # 使用==操作符比較s1和s3是否相等，并打印結果（注釋說明預期輸出為False）  print(s1 == s3)  # 輸出: False# 4、用戶類(只比較用戶名)
# 定義一個名為 User 的類，表示用戶信息
class User:# 初始化方法，當創建 User 類的實例時會被調用def __init__(self, username, age):# 設置實例屬性 username，存儲用戶名self.username = username# 設置實例屬性 age，存儲年齡self.age = age# 重寫 __eq__ 方法，用于比較兩個 User 實例是否相等# 這里的相等定義為：如果兩個 User 實例的 username 屬性相等，則它們相等def __eq__(self, other):# 檢查 other 是否是 User 類的實例if isinstance(other, User):# 如果 other 是 User 類的實例，則比較兩者的 username 屬性return self.username == other.username# 如果 other 不是 User 類的實例，則返回 Falsereturn False
# 如果當前腳本作為主程序運行（而不是被導入為模塊）
if __name__ == '__main__':# 創建一個 User 實例，用戶名為 "Myelsa"，年齡為 18user1 = User("Myelsa", 18)# 創建一個 User 實例，用戶名為 "Myelsa"，年齡為 28user2 = User("Myelsa", 28)# 創建一個 User 實例，用戶名為 "Jimmy"，年齡為 15user3 = User("Jimmy", 15)# 使用 __eq__ 方法比較 user1 和 user2 是否相等，并打印結果# 因為它們的 username 相等，所以輸出為 Trueprint(user1 == user2)  # 輸出: True# 使用 __eq__ 方法比較 user1 和 user3 是否相等，并打印結果# 因為它們的 username 不相等，所以輸出為 Falseprint(user1 == user3)  # 輸出: False# 5、列表包裝類(考慮順序)
# 定義一個名為ListWrapper的類，用于包裝列表
class ListWrapper:# 類的初始化方法，用于設置items屬性def __init__(self, items):# items屬性存儲傳入的列表self.items = items# 類的相等性比較方法，用于判斷兩個ListWrapper對象是否相等def __eq__(self, other):# 檢查other是否是ListWrapper的實例if isinstance(other, ListWrapper):# 如果是，則比較兩個ListWrapper對象的items屬性是否相等# 這里使用了Python列表的相等性比較，即元素相同且順序也相同return self.items == other.items# 如果other不是ListWrapper的實例，則返回Falsereturn False
# 如果當前腳本作為主程序運行（而不是被導入）
if __name__ == '__main__':# 創建三個ListWrapper對象，分別包裝不同的列表lst1 = ListWrapper([1, 2, 3])  # 第一個ListWrapper對象，包裝了列表[1, 2, 3]lst2 = ListWrapper([2, 1, 3])  # 第二個ListWrapper對象，包裝了列表[2, 1, 3]，與lst1元素相同但順序不同lst3 = ListWrapper([1, 2, 3])  # 第三個ListWrapper對象，包裝了列表[1, 2, 3]，與lst1完全相同# 使用Python內置的相等性比較來比較lst1和lst2# 因為lst1和lst2的items屬性（即包裝的列表）元素相同但順序不同，所以不相等print(lst1 == lst2)  # 輸出：False# 使用Python內置的相等性比較來比較lst1和lst3# 因為lst1和lst3的items屬性（即包裝的列表）完全相同，所以相等print(lst1 == lst3)  # 輸出：True# 6、日期類(考慮年、月、日)
# 導入Python內置的date類，該類用于處理日期
from datetime import date
# 定義一個名為CustomDate的類，用于封裝日期功能
class CustomDate:# 類的初始化方法，用于創建CustomDate對象時設置日期def __init__(self, year, month, day):# 使用Python內置的date類來創建一個日期對象，并將其存儲在self.date屬性中self.date = date(year, month, day)# 類的相等性比較方法，用于判斷兩個CustomDate對象是否相等def __eq__(self, other):# 檢查other是否是CustomDate的實例if isinstance(other, CustomDate):# 如果是，則比較兩個CustomDate對象的date屬性是否相等# 這里使用了Python內置的date類的相等性比較return self.date == other.date# 如果other不是CustomDate的實例，則返回Falsereturn False
# 如果當前腳本作為主程序運行（而不是被導入）
if __name__ == '__main__':# 創建三個CustomDate對象，分別表示不同的日期date_1 = CustomDate(2024, 10, 24)  # 第一個CustomDate對象，表示2024年10月24日date_2 = CustomDate(2024, 10, 24)  # 第二個CustomDate對象，也表示2024年10月24日date_3 = CustomDate(2024, 10, 8)  # 第三個CustomDate對象，表示2024年10月8日# 使用Python內置的相等性比較來比較date_1和date_2# 因為date_1和date_2的date屬性相同（都是2024年10月24日），所以相等print(date_1 == date_2)  # 輸出：True# 使用Python內置的相等性比較來比較date_1和date_3# 因為date_1和date_3的date屬性不同（分別是2024年10月24日和2024年10月8日），所以不相等print(date_1 == date_3)  # 輸出：False

16、__exit__方法

16-1、語法

__exit__(self, exc_type, exc_value, exc_tb)return True  # 或者False或不返回任何值(即None)# 如果要忽略異常，則返回True

16-2、參數

16-2-1、self(必須)：一個對實例對象本身的引用，在類的所有方法中都會自動傳遞。

16-2-2、exc_type(可選)：異常類型，如果在with塊中引發了異常，則此參數是異常的類型；否則

為None。

16-2-3、exc_value(可選)：異常值，即with塊中引發的異常的實例；如果未引發異常則為None。

16-2-4、exc_tb(可選)：追蹤信息(traceback object)，它是一個指向引發異常位置的堆棧跟

蹤；如果未引發異常則為None。

16-3、功能

????????用于在退出一個由with語句控制的代碼塊時執行特定的操作。

16-4、返回值

16-4-1、返回True，那么它會抑制(忽略)異常，也就是說，即使with塊中的代碼引發了異常，這個異常也不會被傳播到with語句之外。

16-4-2、返回False或不返回任何值(即None)，那么with塊中引發的異常將會按照正常的異常處理機制來處理。

16-5、說明

????????無

16-6、用法

# 016、__exit__方法：
# 1、文件操作
# 定義一個名為 FileContextManager 的類，用于管理文件的上下文
class FileContextManager:# 初始化方法，接收一個文件名作為參數def __init__(self, filename):# 將傳入的文件名保存到實例變量 filename 中self.filename = filename# 定義 __enter__ 方法，用于 with 語句執行時進入上下文時調用def __enter__(self):# 使用實例變量 filename 打開文件，并設置文件模式為只讀 ('r')self.file = open(self.filename, 'r')# 返回打開的文件對象，以便在 with 語句的 as 子句中引用return self.file# 定義 __exit__ 方法，用于 with 語句執行完畢后退出上下文時調用def __exit__(self, exc_type, exc_val, exc_tb):# 關閉之前打開的文件對象self.file.close()# 使用 with 語句和 FileContextManager 類來管理文件操作
# 'test.txt' 是要打開的文件名，'file' 是打開文件后在 with 語句內部使用的引用名
with FileContextManager('test.txt') as file:# 讀取文件內容并打印，假設文件內容是 "Hello, World!"print(file.read())  # 輸出：Hello, World!# 2、數據庫連接
# 假設有一個數據庫連接庫（但在這里我們只是模擬它）
class DatabaseContext:# 定義一個上下文管理器的進入方法def __enter__(self):# 當使用 with 語句進入上下文時，該方法會被調用# 這里只是一個示例，實際中會使用數據庫連接庫來建立真實的數據庫連接print("Connecting to database...")# 假設我們有一個模擬的數據庫連接字符串self.connection = "Mock Database Connection"# 返回連接對象（或連接字符串），以便在 with 語句的 as 子句中引用return self.connection# 定義一個上下文管理器的退出方法def __exit__(self, exc_type, exc_val, exc_tb):# 當 with 語句塊結束時，無論是否發生異常，該方法都會被調用print("Closing database connection...")# 在這里，我們只是打印了一條消息，但在真實情況下，你會關閉數據庫連接
# 使用 with 語句和 DatabaseContext 類來管理數據庫連接的上下文
with DatabaseContext() as db:# 在這里使用數據庫連接（這里只是打印了一條消息）# 假設 db 是一個數據庫連接對象，但在本例中它只是一個字符串print("Using database:", db)# 當 with 語句塊結束時，__exit__ 方法會被自動調用，打印 "Closing database connection..."# 3、臨時目錄
# 導入tempfile模塊，用于創建臨時文件和目錄
import tempfile
# 導入shutil模塊，用于刪除目錄及其內容
import shutil
# 定義一個名為TempDirContext的上下文管理類
class TempDirContext:# 定義__enter__方法，當使用with語句進入上下文時調用def __enter__(self):# 使用tempfile.mkdtemp()方法創建一個臨時目錄self.temp_dir = tempfile.mkdtemp()# 打印創建的臨時目錄的路徑print(f"Created temp directory: {self.temp_dir}")# 返回臨時目錄的路徑，以便在with語句的as子句中引用return self.temp_dir# 定義__exit__方法，當with語句塊結束時調用def __exit__(self, exc_type, exc_val, exc_tb):# 打印將要刪除的臨時目錄的路徑print(f"Deleting temp directory: {self.temp_dir}")# 使用shutil.rmtree()方法刪除臨時目錄及其所有內容shutil.rmtree(self.temp_dir)
# 使用with語句和TempDirContext類來管理臨時目錄的上下文
with TempDirContext() as temp_dir:# 打印正在使用的臨時目錄的路徑print(f"Using temp directory: {temp_dir}")# 在這里可以使用temp_dir變量來引用臨時目錄，并執行相關操作# 例如：在臨時目錄中創建文件、寫入數據等# 注意：由于此代碼片段是一個注釋示例，所以沒有包含實際的文件操作# 4、鎖機制
# 導入threading模塊，用于多線程操作
import threading
# 定義一個名為ThreadLock的類，用于管理線程鎖
class ThreadLock:# 初始化方法，創建一個threading.Lock對象def __init__(self):self.lock = threading.Lock()# 定義__enter__方法，當使用with語句進入上下文時調用def __enter__(self):# 嘗試獲取鎖self.lock.acquire()# 打印鎖已被獲取的消息print("Acquired lock")# 返回鎖對象（雖然通常不需要返回，但這里為了示例還是返回了）return self.lock# 定義__exit__方法，當with語句塊結束時調用def __exit__(self, exc_type, exc_val, exc_tb):# 釋放鎖self.lock.release()# 打印鎖已被釋放的消息print("Released lock")
# 使用with語句和ThreadLock類來管理線程鎖
with ThreadLock() as lock:# 在這里進行線程安全的操作# 注意：因為with語句已經處理了鎖的獲取和釋放，所以這里的lock變量其實不需要使用# 除非你想在with塊內部檢查鎖的狀態或做其他與鎖相關的操作pass# 5、設置和恢復環境變量
# 定義一個名為EnvVarContext的上下文管理器類，用于臨時修改環境變量
class EnvVarContext:def __init__(self, var_name, new_value):# 初始化時接收環境變量名和新值self.var_name = var_name  # 存儲要修改的環境變量名self.new_value = new_value  # 存儲新的環境變量值self.old_value = None  # 用于存儲原始的環境變量值def __enter__(self):# 當使用with語句進入上下文時調用# 獲取環境變量原來的值self.old_value = os.environ.get(self.var_name)# 設置新的環境變量值os.environ[self.var_name] = self.new_value# 打印已設置新的環境變量值print(f"Set {self.var_name} to {self.new_value}")# 因為with語句的as子句沒有使用變量來接收返回值，所以這里不需要返回具體的值def __exit__(self, exc_type, exc_val, exc_tb):# 當with語句塊結束時調用# 恢復環境變量為原來的值if self.old_value is not None:# 如果原值存在，則恢復為原值os.environ[self.var_name] = self.old_valueelse:# 如果原值不存在，則從環境變量中刪除該變量del os.environ[self.var_name]# 打印環境變量已恢復為原始值或已刪除print(f"Restored {self.var_name} to its original value")
# 導入os模塊，以便操作環境變量
import os
# 使用with語句和EnvVarContext類來修改環境變量
with EnvVarContext('MY_VAR', 'new_value') as _:# 在with塊內部，MY_VAR的值已被臨時修改為'new_value'print(os.environ['MY_VAR'])  # 輸出: new_value
# 退出with塊后，MY_VAR被恢復為原來的值或刪除
# 之后的代碼可以確認MY_VAR的值是否已被恢復# 6、模擬上下文狀態管理
class MyContextManager:def __enter__(self):print("Entering the context")# 在這里，你可以設置任何進入上下文時需要的狀態或資源# 例如，打開一個文件、獲取一個鎖等self.resource = "some resource"  # 假設這是一個需要管理的資源return self  # 通常，__enter__ 應該返回一個對象，以便在 with 塊中使用def __exit__(self, exc_type, exc_value, traceback):print("Exiting the context")# 在這里，你可以執行任何清理工作，例如關閉文件、釋放鎖等# 你可以檢查 exc_type, exc_value, traceback 來確定是否發生了異常# 如果發生了異常并且你想重新拋出它，則不應該在這里進行任何操作# 如果你想忽略異常，你可以在這里返回 True# 如果你想在退出時總是執行一些清理代碼，無論是否發生異常，你可以將這里留空
# 使用 with 語句和上下文管理器
with MyContextManager() as manager:print("Inside the with block, accessing resource:", manager.resource)# 這里是代碼塊，當執行到這里時，__enter__ 已經被調用# 當這個代碼塊執行完畢（或者發生異常）時，__exit__ 將會被調用

五、推薦閱讀

1、Python筑基之旅

2、Python函數之旅

3、Python算法之旅

4、博客個人主頁