美文网首页
Python中两个高效的装饰器工具一定要用起来:debug神器p

Python中两个高效的装饰器工具一定要用起来:debug神器p

作者: 越大大雨天 | 来源:发表于2020-02-20 13:23 被阅读0次

    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试试吧,你一定会爱上的。

    相关文章

      网友评论

          本文标题:Python中两个高效的装饰器工具一定要用起来:debug神器p

          本文链接:https://www.haomeiwen.com/subject/rjfxqhtx.html