Tenacity——Exception Retry 從此無比簡單

Python 裝飾器裝飾類中的方法這篇文章,使用了裝飾器來捕獲代碼異常。這種方式可以讓代碼變得更加簡潔和Pythonic。

在寫代碼的過程中,處理異常并重試是一個非常常見的需求。但是如何把捕獲異常并重試寫得簡潔高效,這就是一個技術活了。

以爬蟲開發為例,由于網頁返回的源代碼有各種不同的情況,因此捕獲異常并重試是很常見的要求。下面這幾段代碼是我多年以前,在剛開始學習爬蟲的時候,由于捕獲異常并重試導致代碼混亂化過程。

代碼一開始的邏輯非常簡單,獲取網頁后臺API返回的JSON字符串,轉化成字典,提取出里面data的數據,然后傳遞給save()函數:

def extract(url):
    info_json = requests.get(url).content.decode()
    info_dict = json.loads(info_json)
    data = info_dict['data']
    save(data)

代碼運行一段時間,發現有時候JSON會隨機出現解析錯誤。于是添加捕獲異常并重試的功能:

def extract(url):
    info_json = requests.get(url).text
    try:
        info_dict = json.loads(info_json)
    except Exception:
        print('網頁返回的不是有效的JSON格式字符串,重試!')
        extract(url)
        return
    data = info_dict['data']
    save(data)

后來又發現,有部份的URL會導致遞歸深度超過最大值。這是因為有一些URL返回的是數據始終是錯誤的,而有些URL,重試幾次又能返回正常的JSON數據,于是限制只重試3次:

def extract(url):
    info_json = requests.get(url).text
    try:
        info_dict = json.loads(info_json)
    except Exception:
        print('網頁返回的不是有效的JSON格式字符串,重試!')
        for i in range(3):
            if extract(url):
                break

    data = info_dict['data']
    save(data)
    return True

后來又發現,不能立刻重試,重試要有時間間隔,并且時間間隔逐次增大......

從上面的例子中可以看到,對于異常的捕獲和處理,一不小心就讓整個代碼變得很難看很難維護。為了解決這個問題,就需要通過裝飾器來完成處理異常并重試的功能。

Python 有一個第三方庫,叫做Tenacity,它實現了一種優雅的重試功能。

以上面爬蟲最初的無限重試版本為例,如果想實現遇到異常就重試。只需要添加兩行代碼,爬蟲的主體函數完全不需要做修改:

from tenacity import retry

@retry
def extract(url):
    info_json = requests.get(url).content.decode()
    info_dict = json.loads(info_json)
    data = info_dict['data']
    save(data)

現在要限制重試次數為3次,代碼總行數不需要新增一行就能實現:

from tenacity import retry

@retry(stop=stop_after_attempt(3))
def extract(url):
    info_json = requests.get(url).content.decode()
    info_dict = json.loads(info_json)
    data = info_dict['data']
    save(data)

現在想每5秒鐘重試一次,代碼行數也不需要增加:

from tenacity import retry

@retry(wait=wait_fixed(5))
def extract(url):
    info_json = requests.get(url).content.decode()
    info_dict = json.loads(info_json)
    data = info_dict['data']
    save(data)

甚至重試的時間間隔想指數級遞增,代碼行數也不需要增加:

from tenacity import retry

@retry(wait=wait_exponential(multiplier=1, max=10)) # 重試時間間隔滿足:2^n * multiplier, n為重試次數,但最多間隔10秒
def extract(url):
    info_json = requests.get(url).content.decode()
    info_dict = json.loads(info_json)
    data = info_dict['data']
    save(data)

重試不僅可以限制次數和間隔時間,還可以針對特定的異常進行重試。在爬蟲主體中,其實有三個地方可能出現異常:

  • requests獲取網頁出錯
  • 解析JSON出錯
  • info_dict字典里面沒有data這個key

如果只需要在JSON解析錯誤時重試,由于異常類型為json.decoder.JSONDecodeError,所以就可以通過參數來進行限制:

from tenacity import retry
from json.decoder import JSONDecodeError

@retry(retry=retry_if_exception_type(JSONDecodeError))
def extract(url):
    info_json = requests.get(url).content.decode()
    info_dict = json.loads(info_json)
    data = info_dict['data']
    save(data)

當然,這些特性都可以進行組合,例如只對JSONDecodeError 進行重試,每次間隔5秒,重試三次,那就寫成:

from tenacity import retry
from json.decoder import JSONDecodeError

@retry(retry=retry_if_exception_type(JSONDecodeError), wait=wait_fixed(5), stop=stop_after_attempt(3))
def extract(url):
    info_json = requests.get(url).content.decode()
    info_dict = json.loads(info_json)
    data = info_dict['data']
    save(data)

自始至終,爬蟲主體的代碼完全不需要做任何修改。

Tenacity是我見過的,最 Pythonic ,最優雅的第三方庫。

** 本文首發地址:https://kingname.info/2017/06/18/easy-retry/** 轉載請注明出處。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,119評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,382評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,038評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,853評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,616評論 6 408
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,112評論 1 323
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,192評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,355評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,869評論 1 334
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,727評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,928評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,467評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,165評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,570評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,813評論 1 282
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,585評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,892評論 2 372

推薦閱讀更多精彩內容

  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,781評論 18 139
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,618評論 25 708
  • 只要不怕麻煩,做想做的事,其實沒那么難。
    執念馥郁閱讀 153評論 0 0
  • 文/寒霜 【原創】 江南春·桃花 青淺淺,粉嫣嫣。 枝飛嬌媚鮮,朝落彩霞丹。 ...
    劉寒霜閱讀 438評論 36 28
  • 聽一首簡單的歌, 寫一句簡單的話, 望一輪皎潔的明月, 夜深了,心情安靜了。 想一段似水的記憶, 夢一場自導的話劇...
    Cinko閱讀 231評論 0 17