Python少有人走过的坑

Python少有人走过的坑

毫无疑问,print函数是我们日常最常用的函数,无论是格式化输出还是打印中间变量进行调试,几乎没有print接不了的活儿。

但是上一次阿酱就差点被print给坑了。

坑从何来

最初是想要为自己的一个命令行小工具增加一个进度显示功能,于是用了threading模块来实现多线程,一个线程用于执行实际的逻辑,另一个线程用于打印当前进度。

01

根据我们多年使用命令行的经验,一般打印进度都是在行内打印,而Python的print则会默认在结尾打印一个换行符,这就十分不美了。

不过好在,print也提供了接口来改变打印的末尾字符,通过指定printend参数,即可改变print的打印结果。

所以我就哼哧哼哧地开干了,把打印进度的print("#")调用改为print("#", end="")

类似这样:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import time
import threading

def print_sharp():
    while True:
        time.sleep(0.5)
        print("#", end="")


t1 = threading.Thread(target=print_sharp)
t1.setDaemon(True)
t1.start()

time.sleep(5)

哪成想,这么一改却出了大问题:进度没法实时打印了。

02

也就是说,本来应该在程序执行期间,挨个打印出来的#号不再是听话的、可爱的#号了,而是在整个程序执行完成之后一次性输出到控制台中。

它长大了,也变丑了

03

那我要你有何用?

04

啥问题呢?

一开始阿酱以为是多线程出了问题,傻乎乎地到处找资料来“佐证”自己的各种猜测——事后想来实在太傻了,以至于现在说起还是会哈哈哈

05

这件事给我们的教训就是:千万不要自以为是,而应踏踏实实地解决问题,虚心对待每个细节

实际上,之所以我们看不到实时的输出,就是因为我们改变了print的结尾字符。

为了尽量减少I/O操作,Python存在一个这样的机制:尽量将输出字符缓存起来,当遇到字符串结束、换行符或强制刷新缓冲区时,才会一次性将缓冲区的内容输出到相应的流中。

——而我们改掉的地方,就是把print默认的换行符去掉了,所以原本每一个print都会触发一次缓冲区刷新,变成了现在一直触发不了缓冲区刷新,直到程序结束触发一次。

好嘛,知道了啥问题,我们又吭哧吭哧找资料,听说sys.stdout.flush可以强制触发标准输出缓冲区的刷新,于是在print后面,紧跟着又加上了sys.stdout.flush()

诶?还真好了?

06

这些可都是知识点,快记下来记下来,要考的

07

让我们查看print的官方文档,其原型为:

1
print(*objects, sep=' ', end='\n', file=sys.stdout, flush=False)

根据其下的描述,Python中print的输出是否进行缓冲,取决于两个参数:fileflush

file的类型有的需要缓冲,比如sys.stdout;而有的则不需要缓冲,比如sys.stderr

对于flush参数,当其值为False(默认)时,是否缓冲依赖file;而当其值为True时,则会强制刷新缓冲区。

我们把示例调用中的print调用修改一下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import sys
import time
import threading


def print_sharp():
    while True:
        time.sleep(0.5)
        print("#", end="", flush=True)


t1 = threading.Thread(target=print_sharp)
t1.setDaemon(True)
t1.start()

time.sleep(5)

08

同样可以实现进度的实时打印。

此外,还有一种方法,在调用程序时增加一个-u选项,也可以实现缓冲区的实时刷新:

1
$ python -u no_flush.py

09

当然这种方法就不太推荐了,毕竟不能对程序的使用者作任何预设。

总结

本文是阿酱的一次踩坑实录,记录了Python中一个很少有人会遇到的奇葩问题。

总的来说,要想成为一个真正的Python程序员,只是单纯掌握基本语法和一些奇技淫巧是远远不够的,还是需要对Python本身有一定的了解。

毕竟,剑客如果不熟悉自己的剑,又该如何行走江湖呢?

示例代码:https://github.com/JustDoPython/python-examples/tree/master/xuanyuanyulong/2020-09-28-problem-in-print

Python Geek Tech wechat
欢迎订阅 Python 技术,这里分享关于 Python 的一切。