Python中两个高效的装饰器工具一定要用起来:debug神器pysnooper、自动重试神器retrying

1.pysnooper

安装方式:pip install pysnooper
pypi地址:https://pypi.org/project/PySnooper/

不知你是否也经常用print()在各个变量下方进行打印排查某个造成异常的原因。排查起来心累最后还要挨着删除。
pysnooper在pypi上的第一行文字写的是:

PySnooper - Never use print for debugging again

是的,用了pysnooper后我是真的不需要再使用print来进行debug了。

使用方法

pysnooper的使用非常简单,日常使用只需要看看官方示例就可以了,平常用到的装饰器就是@snoop()一个,它可以按照装饰函数的运行逻辑顺序,规则的输出每一个变量和参数的值及当前代码行等信息,非常便于我们排查问题。
附上官方示例吧:

import pysnooper

@pysnooper.snoop()
def number_to_bits(number):
    if number:
        bits = []
        while number:
            number, remainder = divmod(number, 2)
            bits.insert(0, remainder)
        return bits
    else:
        return [0]

number_to_bits(6)

输出结果:

Source path:... /my_code/foo.py
Starting var:.. number = 6
15:29:11.327032 call         4 def number_to_bits(number):
15:29:11.327032 line         5     if number:
15:29:11.327032 line         6         bits = []
New var:....... bits = []
15:29:11.327032 line         7         while number:
15:29:11.327032 line         8             number, remainder = divmod(number, 2)
New var:....... remainder = 0
Modified var:.. number = 3
15:29:11.327032 line         9             bits.insert(0, remainder)
Modified var:.. bits = [0]
15:29:11.327032 line         7         while number:
15:29:11.327032 line         8             number, remainder = divmod(number, 2)
Modified var:.. number = 1
Modified var:.. remainder = 1
15:29:11.327032 line         9             bits.insert(0, remainder)
Modified var:.. bits = [1, 0]
15:29:11.327032 line         7         while number:
15:29:11.327032 line         8             number, remainder = divmod(number, 2)
Modified var:.. number = 0
15:29:11.327032 line         9             bits.insert(0, remainder)
Modified var:.. bits = [1, 1, 0]
15:29:11.327032 line         7         while number:
15:29:11.327032 line        10         return bits
15:29:11.327032 return      10         return bits
Return value:.. [1, 1, 0]

除了对函数使用该装饰品,也可以对特定的代码行就行解释;除了可以将解释结果输出到命令行,也可以输出到指定文件。
pysnooper的使用非常简单,如果你有需要,建议看一下上面的pypi文档地址就可轻松学会使用,这里不过多的重复搬运了。

2. retrying

安装方式:pip install retrying
pypi地址:https://pypi.org/project/retrying/

在使用retrying模块之前,我经常会自己手动写代码块来实现一些功能函数的重试操作,比如在数据库连接、查询等有网络IO的地方,经常会遇到timeout错误。

但是在代码内添加了这些重试逻辑后不仅难看而且都是重复工作。使用retrying模块可以直接简化我们的操作,我们需要做的只是导包、装饰即可,不用再自己去手动实现。

使用方法

同样,retrying模块的使用方法也是非常简单地,只需要参看pypi上的@retry()装饰器的使用说明就足够日常使用了。

  • 最简单的官方示例:
import random
from retrying import retry

@retry
def do_something_unreliable():
    if random.randint(0, 10) > 1:
        raise IOError("Broken sauce, everything is hosed!!!111one")
    else:
        return "Awesome sauce!"

print do_something_unreliable()

如果不传递参数,retry将会默认的无限重试直至没有异常捕获,当然这并不是一个好的建议,因为可能会出现过长的重试时间甚至死循环重试。

使用参数控制retry

只需要记住几个常用参数:
注意:retry内的时间值是以毫秒为单位的。

  • 最大重试次数限制
    当被装饰的任务重试次数超过设置值,将不再重试
    @retry(stop_max_attempt_number=7)
  • 最长任务时间
    当被装饰的任务运行总时间超过设置值,将不再重试
    @retry(stop_max_delay=10000)
  • 重试等待时间
    当重试失败后下一次重试将等待设置值时间
    @retry(wait_fixed=2000)
  • 重试随机等待时间
    当重试失败后下一次重试将设置最小值和最大值之间的随机值时间
    @retry(wait_random_min=1000, wait_random_max=2000)

除了这些,retry还可以对指定的异常进行重试、对指定的返回结果进行重试等,这里不再一一搬运,有需要的同学直接看pypi官方文档吧。

总结

没用过这两个装饰器的小伙伴快写个demo试试吧,你一定会爱上的。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,386评论 6 479
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,939评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,851评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,953评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,971评论 5 369
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,784评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,126评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,765评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,148评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,744评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,858评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,479评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,080评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,053评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,278评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,245评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,590评论 2 343

推荐阅读更多精彩内容