一个简单、易用的Python命令行(terminal)进度条库

eprogress 是一个简单、易用的基于Python3的命令行(terminal)进度条库,可以自由选择使用单行显示、多行显示进度条或转圈加载方式,也可以混合使用。

示例

  • 单行进度条


    progress_sample_line.gif
  • 多行进度条

progress_sample_multi_line.gif
  • 圆形加载
progress_sample_cicle.gif
  • 混合显示
progress_sample_multi_mix.gif

特性

  • 使用简单,实例化一个Progress对象,调用update方法即可刷新进度
  • 不依赖任何第三方库。
  • 可定制进度符号,title,显示宽度,个性化显示。
  • 多行、单行显示进度、圆形转圈加载随意搭配。
  • 多线程安全,可在多个线程中更新进度条。

使用方法

  1. 导入eprogress

    from eprogress import LineProgress, CircleProgress, MultiProgressManager
    
  2. 实例化进度条对象,更新进度

    # circle loading
       circle_progress = CircleProgress(title='circle loading')
       for i in range(1, 101):
             circle_progress.update(i)
             time.sleep(0.1)
    
    # line progress
            line_progress = LineProgress(title='line progress')
            for i in range(1, 101):
                line_progress.update(i)
                time.sleep(0.05)
    # multi line or circle loading progress
    progress_manager = MultiProgressManager()
    progress_manager.put(str(1001), LineProgress(total=100, title='1 thread'))
    progress_manager.put(str(1002), LineProgress(total=100, title='2 thread'))
    progress_manager.put(str(1003), LineProgress(total=100, title='3 thread'))
    progress_manager.put(str(1004), CircleProgress(title='4 thread'))
    
    ... ...
    
    progress_manager.update(key, progress)
    
    • 圆形加载条使用update(progress)实例方法进行刷新,只有当参数大于0时才会转动。

    • 线性进度条使包含4个可选参数:

      @param total : 进度总数
      @param symbol : 进度条符号
      @param width : 进度条展示的长度
      @param title : 进度条前面展示的文字
      

      创建实例后调用update(progress)实例方法更新进度。

    • 多行进度显示使用MultiProgressManager类,实例化该类,调用put(key,progressBar)方法统一管理多个进度条,内部使用一个dict来收集进度条,多行显示的顺序为put的顺序。更新某个进度条时使用progressMangager的update(key,progress)方法,该key为put进度条时使用的key。

    • 无论是使用多行进度条混合还是使用单行进度条,都不用考虑多线程更新的问题,内部已用Lock()加锁。

    • 详细样例请看源码:Sample源码

原理

  • 利用\r使光标回到本行的行首位置,不使用Python的print()函数,该函数会自动换行,当然你也可以指定print()函数的end参数让其不换行,如:

    print('Complete',end='')
    

    我这里使用sys.stdout.write()来输出字符:

    sys.stdout.write('Complete')
    
  • 使用ANSI终端指令码\033[K清除光标后面的字符。

  • 使用\033[F使用光标回到上一行,这里要注意,光标回到上一行后下面的一行会被清除。

  • 使用threading.Lock()加锁,在多线程更新进度时确保安全。

  • 抽象类ProgressBar下面有两个子类,分别为LineProgress和 CircleProgress,可单独使用这两个子类来显示单行的进度条。

  • 多行显示进度条时使用MultiProgressManager类来管理,把ProgressBar实现类put到MultiProgressManager类里面,用dict来管理,MultiProgressManager提供统一的update(key,progress)实例方法来指定更新哪一行的进度条。

  • 详细请看源码:Sample源码

注意事项

  • 请在Python3环境下使用。
  • 请不要IDE的运行方式使用,需在终端(terminal)下使用。

源码

作者:竹尘居士
博客:http://zhuchen.vip/2017/07/25/python/python-eprogress.html
源码地址:https://github.com/homgwu/eprogress

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容