雕虫小技 - 极度优雅的PYTHON进度条

很多时候执行时间较长的脚本的时候，需要在脚本里写入print()，在控制台打印任务日志。这种方法虽然写起来方便，但是实际并不好用，要么疯狂刷屏，要么半天打印一条，时间不好把控，为此我写了个进度条小工具，调用方便，可实现实时刷新进度百分比，动作条可视化进度百分比，估计剩余时间，打印日志，效果极度优雅！

基本效果如下：

执行中：

执行完：

代码如下：

import time


def _show_time(sec, mode=1, fill_zero=False):
    # 内部函数,将秒转换成文本
    t={
        'h': sec//3600,
        'm': (sec%3600)//60,
        's': sec%60,
        'uh': {1: ':', 2: 'h', 3: '小时'}.get(int(mode), ':'),
        'um': {1: ':', 2: 'm', 3: '分'}.get(int(mode), ':'),
        'us': {1: '', 2: 's', 3: '秒'}.get(int(mode), ''),
       }
    if fill_zero or int(mode)==1:
        # 用0补齐
        if t['h']>0 or int(mode)==1:
            return '{h:.0f}{uh}{m:0>2.0f}{um}{s:0>2.0f}{us}'.format(**t)
        else:
            if t['m']>0:
                return '{m:0>2.0f}{um}{s:0>2.0f}{us}'.format(**t)
            else:
                return '{s:0>2.0f}{us}'.format(**t)
    else:
        # 不用0补齐
        if t['h']>0:
            return '{h:.0f}{uh}{m:0>.0f}{um}{s:0>.0f}{us}'.format(**t)
        else:
            if t['m']>0:
                return '{m:0>.0f}{um}{s:0>.0f}{us}'.format(**t)
            else:
                return '{s:0>.0f}{us}'.format(**t)
     


class ProcessBar:
    def __init__(self, N, name='', len_bar=50, flush_freq=10000):
        '''
        # 初始化进度条
        :param N:           总步数
        :param name:        任务名称
        :param bar_len:     进度条长度
        :param flush_freq:  刷新频次
        '''
        self.N = N                              # 任务总长度
        self.mission_nm = name                  # 任务名称
        self.len_bar = len_bar                  # 进度条长度
        self.n = 0                              # 当前任务进度
        self.step_flush = max(N//flush_freq, 1) # 刷新次数步长
        self.start_time = time.time()           # 任务初始化时间
        self.trigger = True                     # 任务初始化开关
        self.s_bar_f = chr(9608)                # 动作条字符(已完成)
        self.s_bar_n = chr(9617)                # 动作条字符(未完成)

    def go(self, text=''):
        '''
        # 直接打印当前进度,百分比以及估计的剩余时间
        :param text:    # 需要在显示器打印的信息
        :return: None
        '''
        self._refresh()
        if text:
            print('\r' + text, flush=True)
        if self.n % self.step_flush==0:
            # 确定是否刷新进度条
            print('\r{0} {1:>2.0%} {2}'.format(self.s_bar, self.p,  _show_time(self.sec_rest, 1)), end='', flush=True)
        if self.trigger:
            self._close()

    def _refresh(self):
        # 进度条监视器,负责初始化、更新以及关闭进度条
        self.n += 1
        # 初始化进度条
        if self.trigger:
            print('任务{}开始...'.format('({})'.format(self.mission_nm) if self.mission_nm else ''))
            self.n = 1
            self.start_time = time.time()
            self.trigger = False
            self.s_bar = self.s_bar_n*50
        # 关闭进度条
        if self.n == self.N:
            self.trigger = True
            self.s_bar = self.s_bar_f * 50
        # 更新进度条
        n_fill = int(self.n / self.N * self.len_bar)
        self.s_bar = self.s_bar_f * n_fill + self.s_bar_n * (self.len_bar - n_fill)
        # 估计剩余时间
        self.p = self.n / self.N
        sec = int((time.time() - self.start_time) / self.p)
        self.sec_rest = int((1 - self.p) * sec)     # 估计剩余秒数

    def _close(self):
        sec = time.time() - self.start_time
        s_time = _show_time(sec, 3, False)
        print('\n任务{0}执行完毕,总共用时{1}...'.format('({})'.format(self.mission_nm) if self.mission_nm else '', s_time))

这个动作条的适用条件：必须能拆解成for/while循环，在循环的每一步中调用.go()方法即可。

详细样例如下：

pb = ProcessBar(1000, '模拟任务')
for i in range(1000):
    if pb.n%100 == 0:
        # 可以在任务执行过程中打印想要打印的信息，却不影响动作条
        pb.go('已经过去100条了...')
    else:
        pb.go()
    time.sleep(0.01)

执行以上代码，会得到下图效果：

执行完毕后效果如下：

很多时候会使用类似.apply(func)方法去实现循环，这时候ProcessBar实例传入闭包即可。