使用f-strings调试(Python3.8)
/ / / 阅读数:6937前言
我日常开发大概有 98% 的情况下会使用 print 来调试 (别说 pdb 之类的,根本不实用),通过在合适的位置插入 print 语句打印出要跟踪的表达式或者变量的值来确认问题。f-string 让格式化这件事变得美观简单,但是依然对调试毫无帮助。
我举个例子:
s = 'A string' value = 123 |
如果你想看运行时 s 和 value 的值分别是多少 (PS: 这里演示的是常量,在实际代码执行中可能他们是表达式或者函数调用计算出来的,那时它们就是动态的了),可以在代码中加一行 print 打印一下它们:
s = 'A string' value = 123 print(s, value) # 新插入的行 |
这样就能通过日志或者终端知道 s 和 value 是什么了。不过,这样做的问题是,通过输出对应 s 和 value 是不明确的,你需要非常清晰的了解代码逻辑;如果代码中有多个 print,每个 print 都是 2 个参数,就麻烦了:
s = 'A string' value = 123 print(s, value) o = 'Other String' rv = 234 print(o, rv) # 另外一个print |
你还得用某种方法区分他们都是从哪行打印出来的:
s = 'A string' value = 123 print(s, value, 'S') o = 'Other String' rv = 234 print(o, rv, 'Other') |
这是我常用的方案,多加一个参数,通过第三项帮你确认分别是哪行打印出来的。
好的写法需要明确你要跟踪的变量和值的对应关系。可以这样写:
>>> print(f's={s!r}, value={value}') s='A string', value=123 >>> print(f'o={o!r}, rv={rv}') o='Other String', rv=234 |
大括号里面的除了有变量,后面还加个!r
,它是一个转换标志 (conversion flag),在过去的 format 格式化方法中也有。一共有三种转换标志,另外 2 个分别是!a
和!s
,我们感受一下:
>>> '{!a}'.format('哈哈') # 相当于 ascii('哈哈')
"'\\u54c8\\u54c8'"
>>> '{!s}'.format('哈哈') # 相当于 str('哈哈')
'哈哈'
>>> '{!r}'.format('哈哈') # 相当于 repr('哈哈')
"'哈哈'"
上面的例子中,{s!r}
就是对变量 s 执行str(s)
,不用 (不应该) 这样写:
>>> print(f's={s}') s=A string # 注意,没有引号,空格把值分开了,有多个值的话就不容易辨识 >>> print(f's="{s}"') # 不用`!r`需要手动加引号 s="A string" |
不管怎么说,这样其实已经算不错的了,虽然当要打印的变量比较多的时候 print 语句非常长...
Python 3.8 中 f-strings 的 '='
这个功能还是看 PyCON2019 的闪电演讲看到的,f-strings 的作者 Eric V. Smith 接受了 Larry Hastings 的意见实现了 f-string 的调试功能。本来是想另外一个转换标识!d
,效果大概是这样:
value = 10 s = 'a string!' print(f'{value!d}') print(f'next: {value+1!d}') print(f'{s!d}') print(f'{s!d:*^20}') print(f'*{value!d:^20}*') # 输出 value=10 next: value+1=11 s='a string!' '****s="A string"****' * value=10 * |
也就是说,f-strings 自动添加变量名 + =
,而且支持补齐空位还能做表达式求值,如上例,{value+1!d}
表示计算value+1
再打印出来。
不过后来作者和 Guido 讨论,改用了更灵活的=
。现在已经合并到 Python3.8,我们可以真实的试用了:
❯ ./python.exe Python 3.8.0a4+ (heads/master:2725cb01d7, May 22 2019, 10:29:22) ... >>> print(f'{s=}, {value=}') s='A string', value=123 >>> print(f'{o=}, {rv=}') o='Other String', rv=234 >>> print(f'{value / 3 + 15=}') value / 3 + 15=56.0 >>> print(f'{s=:*^20}') s=******A string****** >>> print(f'*{s=:^20}*') *s= A string * |
为啥我说用=
更灵活呢,再看几个混合转换标识的例子:
>>> x = '哈哈' >>> f'{x=}' "x='哈哈'" >>> f'{x=!s}' 'x=哈哈' >>> f'{x=!r}' "x='哈哈'" >>> f'{x=!a}' "x='\\u54c8\\u54c8'" >>> f'{x=!s:^20}' 'x= 哈哈 ' |
就是说,DEBUG 模式可以和转换标识一起用!
学到了吧?开始期待 Python3.8 了~
PS: 如果你看了 PyCON 的那个「Easier debugging with f-strings」的演讲 (延伸阅读链接 2),其中还是说用!d
,其实演讲后第二天就改成了=
了,要注意哈~
{s!r} 就是对变量 s 执行 str (s) 不是 {s!r} 就是对变量 s 执行 repr (s)?