前言

這是 “Python 工匠”系列的第 6 篇文章。（點擊原文鏈接，可查看系列其他文章）

如果你用 Python 編程，那么你就無法避開異常，因為異常在這門語言里無處不在。打個比方，當你在腳本執(zhí)行時按 ctrl+c 退出，解釋器就會產生一個 KeyboardInterrupt 異常。而 KeyError、 ValueError、 TypeError 等更是日常編程里隨處可見的老朋友。

異常處理工作由“捕獲”和“拋出”兩部分組成?！安东@”指的是使用 try...except 包裹特定語句，妥當?shù)耐瓿慑e誤流程處理。而恰當?shù)氖褂?raise 主動“拋出”異常，更是優(yōu)雅代碼里必不可少的組成部分。

在這篇文章里，我會分享與異常處理相關的 3 個好習慣。繼續(xù)閱讀前，我希望你已經了解了下面這些知識點：

• 異常的基本語法與用法（建議閱讀官方文檔 “Errors and Exceptions”）

• 為什么要使用異常代替錯誤返回（建議閱讀《讓函數(shù)返回結果的技巧》）

• 為什么在寫 Python 時鼓勵使用異常 （建議閱讀 “Write Cleaner Python: Use Exceptions”）

三個好習慣

1. 只做最精確的異常捕獲

假如你不夠了解異常機制，就難免會對它有一種天然恐懼感。你可能會覺得：異常是一種不好的東西，好的程序就應該捕獲所有的異常，讓一切都平平穩(wěn)穩(wěn)的運行。而抱著這種想法寫出的代碼，里面通常會出現(xiàn)大段含糊的異常捕獲邏輯。

讓我們用一段可執(zhí)行腳本作為樣例：

腳本里的 save_website_title 函數(shù)做了好幾件事情。它首先通過網絡獲取網頁內容，然后利用正則匹配出標題，最后將標題寫在本地文件里。而這里有兩個步驟很容易出錯：網絡請求 與 本地文件操作。所以在代碼里，我們用一個大大的 try...except 語句塊，將這幾個步驟都包裹了起來。安全第一。

那么，這段看上去簡潔易懂的代碼，里面藏著什么問題呢？

如果你旁邊剛好有一臺安裝了 Python 的電腦，那么你可以試著跑一遍上面的腳本。你會發(fā)現(xiàn)，上面的代碼是不能成功執(zhí)行的。而且你還會發(fā)現(xiàn)，無論你如何修改網址和目標文件的值，程序仍然會報錯 “save failed: unable to...”。為什么呢？

問題就藏在這個碩大無比的 try...except 語句塊里。假如你把眼睛貼近屏幕，非常仔細的檢查這段代碼。你會發(fā)現(xiàn)在編寫函數(shù)時，我犯了一個小錯誤，我把獲取正則匹配串的方法錯打成了 obj.grop(1)，少了一個 'u'（ obj.group(1)）。

但正是因為那個過于龐大、含糊的異常捕獲，這個由打錯方法名導致的原本該被拋出的 AttibuteError 卻被吞噬了。從而給我們的 debug 過程增加了不必要的麻煩。

異常捕獲的目的，不是去捕獲盡可能多的異常。假如我們從一開始就堅持：只做最精準的異常捕獲。那么這樣的問題就根本不會發(fā)生，精準捕獲包括：

• 永遠只捕獲那些可能會拋出異常的語句塊

• 盡量只捕獲精確的異常類型，而不是模糊的 Exception

依照這個原則，我們的樣例應該被改成這樣：

2. 別讓異常破壞抽象一致性

大約四五年前，當時的我正在開發(fā)某移動應用的后端 API 項目。如果你也有過開發(fā)后端 API 的經驗，那么你一定知道，這樣的系統(tǒng)都需要制定一套“API 錯誤碼規(guī)范”，來為客戶端處理調用錯誤時提供方便。

一個錯誤碼返回大概長這個樣子：

在制定好錯誤碼規(guī)范后，接下來的任務就是如何實現(xiàn)它。當時的項目使用了 Django 框架，而 Django 的錯誤頁面正是使用了異常機制實現(xiàn)的。打個比方，如果你想讓一個請求返回 404 狀態(tài)碼，那么只要在該請求處理過程中執(zhí)行 raiseHttp404 即可。

所以，我們很自然的從 Django 獲得了靈感。首先，我們在項目內定義了錯誤碼異常類：APIErrorCode。然后依據“錯誤碼規(guī)范”，寫了很多繼承該類的錯誤碼。當需要返回錯誤信息給用戶時，只需要做一次 raise 就能搞定。

毫無意外，所有人都很喜歡用這種方式來返回錯誤碼。因為它用起來非常方便，無論調用棧多深，只要你想給用戶返回錯誤碼，調用 raiseerror_codes.ANY_THING 就好。

隨著時間推移，項目也變得越來越龐大，拋出 APIErrorCode 的地方也越來越多。有一天，我正準備復用一個底層圖片處理函數(shù)時，突然碰到了一個問題。

我看到了一段讓我非常糾結的代碼：

process_image 函數(shù)會嘗試解析一個文件對象，如果該對象不能被作為圖片正常打開，就拋出 error_codes.INVALID_IMAGE_UPLOADED（APIErrorCode子類） 異常，從而給調用方返回錯誤代碼 JSON。

讓我給你從頭理理這段代碼。最初編寫 process_image 時，我雖然把它放在了 util.image 模塊里，但當時調這個函數(shù)的地方就只有 “處理用戶上傳圖片的 POST 請求” 而已。為了偷懶，我讓函數(shù)直接拋出 APIErrorCode 異常來完成了錯誤處理工作。

再來說當時的問題。那時我需要寫一個在后臺運行的批處理圖片腳本，而它剛好可以復用 process_image 函數(shù)所實現(xiàn)的功能。但這時不對勁的事情出現(xiàn)了，如果我想復用該函數(shù)，那么：

• 我必須去捕獲一個名為 INVALID_IMAGE_UPLOADED 的異常

• 哪怕我的圖片根本就不是來自于用戶上傳

• 我必須引入 APIErrorCode 異常類作為依賴來捕獲異常

• 哪怕我的腳本和 Django API 根本沒有任何關系

這就是異常類抽象層級不一致導致的結果。APIErrorCode 異常類的意義，在于表達一種能夠直接被終端用戶（人）識別并消費的“錯誤代碼”。它在整個項目里，屬于最高層的抽象之一。但是出于方便，我們卻在底層模塊里引入并拋出了它。這打破了 image.processor 模塊的抽象一致性，影響了它的可復用性和可維護性。

這類情況屬于“模塊拋出了高于所屬抽象層級的異常”。避免這類錯誤需要注意以下幾點：

• 讓模塊只拋出與當前抽象層級一致的異常

• 比如 image.processer 模塊應該拋出自己封裝的 ImageOpenError 異常

• 在必要的地方進行異常包裝與轉換

• 比如，應該在貼近高層抽象（視圖 View 函數(shù)）的地方，將圖像處理模塊的 ImageOpenError 低級異常包裝轉換為 APIErrorCode 高級異常

修改后的代碼：

除了應該避免拋出高于當前抽象級別的異常外，我們同樣應該避免泄露低于當前抽象級別的異常。

如果你用過 requests 模塊，你可能已經發(fā)現(xiàn)它請求頁面出錯時所拋出的異常，并不是它在底層所使用的 urllib3 模塊的原始異常，而是通過 requests.exceptions 包裝過一次的異常。

這樣做同樣是為了保證異常類的抽象一致性。因為 urllib3 模塊是 requests 模塊依賴的底層實現(xiàn)細節(jié)，而這個細節(jié)有可能在未來版本發(fā)生變動。所以必須對它拋出的異常進行恰當?shù)陌b，避免未來的底層變更對 requests 用戶端錯誤處理邏輯產生影響。

3. 異常處理不應該喧賓奪主

在前面我們提到異常捕獲要精準、抽象級別要一致。但在現(xiàn)實世界中，如果你嚴格遵循這些流程，那么很有可能會碰上另外一個問題：異常處理邏輯太多，以至于擾亂了代碼核心邏輯。具體表現(xiàn)就是，代碼里充斥著大量的 try、 except、 raise 語句，讓核心邏輯變得難以辨識。

讓我們看一段例子：

這是一個處理用戶上傳頭像的視圖函數(shù)。這個函數(shù)內做了三件事情，并且針對每件事都做了異常捕獲。如果做某件事時發(fā)生了異常，就返回對用戶友好的錯誤到前端。

這樣的處理流程縱然合理，但是顯然代碼里的異常處理邏輯有點“喧賓奪主”了。一眼看過去全是代碼縮進，很難提煉出代碼的核心邏輯。

早在 2.5 版本時，Python 語言就已經提供了對付這類場景的工具：“上下文管理器（context manager）”。上下文管理器是一種配合 with 語句使用的特殊 Python 對象，通過它，可以讓異常處理工作變得更方便。

那么，如何利用上下文管理器來改善我們的異常處理流程呢？讓我們直接看代碼吧。

在上面的代碼里，我們定義了一個名為 raise_api_error 的上下文管理器，它在進入上下文時什么也不做。但是在退出上下文時，會判斷當前上下文中是否拋出了類型為 self.captures 的異常，如果有，就用 APIErrorCode 異常類替代它。

使用該上下文管理器后，整個函數(shù)可以變得更清晰簡潔：

Hint：建議閱讀 PEP 343 -- The "with" Statement | Python.org，了解與上下文管理器有關的更多知識。 模塊 contextlib 也提供了非常多與編寫上下文管理器相關的工具函數(shù)與樣例。

總結

在這篇文章中，我分享了與異常處理相關的三個建議。最后再總結一下要點： - 只捕獲可能會拋出異常的語句，避免含糊的捕獲邏輯 - 保持模塊異常類的抽象一致性，必要時對底層異常類進行包裝 - 使用“上下文管理器”可以簡化重復的異常處理邏輯

看完文章的你，有沒有什么想吐槽的？請留言或者在 項目 Github Issues 告訴我吧。

附錄

• 題圖來源: Photo by Bernard Hermant on Unsplash

• 更多系列文章地址：https://github.com/piglei/one-python-craftsman

系列其他文章： - Python 工匠：讓函數(shù)返回結果的技巧

藍鯨智云

本文由騰訊藍鯨智云編輯發(fā)布，騰訊藍鯨智云（簡稱藍鯨）軟件體系是一套基于PaaS的技術解決方案，致力于打造行業(yè)領先的一站式自動化運維平臺。目前已經推出社區(qū)版、企業(yè)版，歡迎體驗。

• 官網：https://bk.tencent.com/

• 下載鏈接：https://bk.tencent.com/download/

• 社區(qū)：https://bk.tencent.com/s-mart/community/question