相信很多人在寫一些簡單的python指令碼的時候都希望能夠在程式執行的過程中實現進度條的功能以便檢視程式執行的速度或者進度。

我之前一直想實現這樣一個東西，也檢視了許多部落格但是都找不到一個完美的解決方案（當然，使用progressBar這個庫是個選擇，但很多時候我們需要一些定製功能的時候就需要考慮自己實現，其實也挺簡單的，不想看廢話的可以直接跳到最後）

進度條最主要的問題就是所有字元全部在同一行，而且可以修改。

然而當執行print語句的時候，python會在列印完這個語句的同時在結尾加上’\n’，也就是換行，這就導致在控制檯下一旦被print之後就無法再修改了。所以我們現在的輸出就不能再使用print來完成了。

我們要使用的是來自sys庫的sys.stdout.write()函式，這個函式會在控制檯輸出這個字串的同時不加上任何結尾，這就意味著這個輸出還沒有完全結束。通過sys.stdout.flush()函式可以把輸出暫時列印在控制檯中（造成print的假象，我們姑且先叫這個假輸出）。那麼如果我們使用’r’這個轉義字元（回到行首），一切看起來是不是就合理很多了呢？

也就是說：列印字串的時候，沒有加上’\n’，同時讓游標回到行首，再把當前緩衝區顯示出來，也就好象是print了一樣，但是這時候游標還在原來的位置。

舉個例子：

import sys, time

for i in range(5):
    sys.stdout.write('{0}/5\r'.format(i + 1))
    sys.stdout.flush()
    time.sleep(1)

1

2

3

4

5

6

import sys, time

for i in range(5):

sys.stdout.write('{0}/5\r'.format(i + 1))

sys.stdout.flush()

time.sleep(1)

在終端下執行這段程式碼就會得到簡單的進度條效果。

接下來還需要解決兩個問題：

一：清空緩衝區

有些聰明的讀者可能發現，當新的字串比之前短的時候會出現問題，比如下面這段程式碼：

import sys, time

for i in range(5):
    sys.stdout.write(str(i) * (5 - i) + '\r')
    sys.stdout.flush()
    time.sleep(1)

1

2

3

4

5

6

import sys, time

for i in range(5):

sys.stdout.write(str(i) * (5 - i) + '\r')

sys.stdout.flush()

time.sleep(1)

執行後發現結果跟我們希望的不太一樣。

其實是因為已經被flush出去的字元並不會主動清空，所以只有新寫入的被修改了。針對這點我目前的解決方案是先輸出一波空格把之前的字串沖掉然後重新寫：

import sys, time

for i in range(5):
    sys.stdout.write(' ' * 10 + '\r')
    sys.stdout.flush()
    sys.stdout.write(str(i) * (5 - i) + '\r')
    sys.stdout.flush()
    time.sleep(1)

1

2

3

4

5

6

7

8

import sys, time

for i in range(5):

sys.stdout.write(' ' * 10 + '\r')

sys.stdout.flush()

sys.stdout.write(str(i) * (5 - i) + '\r')

sys.stdout.flush()

time.sleep(1)

二：固定底邊輸出

有時候我們希望在進度條載入的同時還有一些其他的輸出。

我們不妨在重新整理掉上一次輸出之後輸出所需輸出的字串，然後在假輸出進度條。

採用如下程式碼：

import sys, time

for i in range(5):
    sys.stdout.write(' ' * 10 + '\r')
    sys.stdout.flush()
    print i
    sys.stdout.write(str(i) * (5 - i) + '\r')
    sys.stdout.flush()
    time.sleep(1)

1

2

3

4

5

6

7

8

9

import sys, time

for i in range(5):

sys.stdout.write(' ' * 10 + '\r')

sys.stdout.flush()

print i

sys.stdout.write(str(i) * (5 - i) + '\r')

sys.stdout.flush()

time.sleep(1)

就可以完成所需任務了。

怎麼樣，其實原理還是挺簡單的吧？

這裡給出一個自己實現的類用來列印進度條：

# -*- coding:utf-8 -*-

# Copyright: Lustralisk
# Author: Cedric Liu
# Date: 2015-11-08

import sys, time

class ProgressBar:
    def __init__(self, count = 0, total = 0, width = 50):
        self.count = count
        self.total = total
        self.width = width
    def move(self):
        self.count += 1
    def log(self, s):
        sys.stdout.write(' ' * (self.width + 9) + '\r')
        sys.stdout.flush()
        print s
        progress = self.width * self.count / self.total
        sys.stdout.write('{0:3}/{1:3}: '.format(self.count, self.total))
        sys.stdout.write('#' * progress + '-' * (self.width - progress) + '\r')
        if progress == self.width:
            sys.stdout.write('\n')
        sys.stdout.flush()

bar = ProgressBar(total = 10)
for i in range(10):
    bar.move()
    bar.log('We have arrived at: ' + str(i + 1))
    time.sleep(1)

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

# -*- coding:utf-8 -*-

# Copyright: Lustralisk

# Author: Cedric Liu

# Date: 2015-11-08

import sys, time

class ProgressBar:

def __init__(self, count = 0, total = 0, width = 50):

self.count = count

self.total = total

self.width = width

def move(self):

self.count += 1

def log(self, s):

sys.stdout.write(' ' * (self.width + 9) + '\r')

sys.stdout.flush()

print s

progress = self.width * self.count / self.total

sys.stdout.write('{0:3}/{1:3}: '.format(self.count, self.total))

sys.stdout.write('#' * progress + '-' * (self.width - progress) + '\r')

if progress == self.width:

sys.stdout.write('\n')

sys.stdout.flush()

bar = ProgressBar(total = 10)

for i in range(10):

bar.move()

bar.log('We have arrived at: ' + str(i + 1))

time.sleep(1)

效果如下：

這樣就可以方便的在一些任務中檢視程式執行的進度了，比如爬蟲、機器學習等並不知道要花多少時間等工作也都可以有形象的時間把握了。

如果有什麼其他好的建議歡迎共同討論～

Python實現控制檯中的進度條

一：清空緩衝區

二：固定底邊輸出

相關文章