Python command line progress bar in less than 10 lines of code.

progress.py

# The MIT License (MIT)
# Copyright (c) 2016 Vladimir Ignatev
#
# Permission is hereby granted, free of charge, to any person obtaining 
# a copy of this software and associated documentation files (the "Software"), 
# to deal in the Software without restriction, including without limitation 
# the rights to use, copy, modify, merge, publish, distribute, sublicense, 
# and/or sell copies of the Software, and to permit persons to whom the Software 
# is furnished to do so, subject to the following conditions:
# 
# The above copyright notice and this permission notice shall be included 
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR 
# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
# FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
# OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 
# OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
import sys


def progress(count, total, status=''):
    bar_len = 60
    filled_len = int(round(bar_len * count / float(total)))

    percents = round(100.0 * count / float(total), 1)
    bar = '=' * filled_len + '-' * (bar_len - filled_len)

    sys.stdout.write('[%s] %s%s ...%s\r' % (bar, percents, '%', status))
    sys.stdout.flush()  # As suggested by Rom Ruben (see: http://stackoverflow.com/questions/3173320/text-progress-bar-in-the-console/27871113#comment50529068_27871113)

Can't this to work in a jupyter notebook.

If your status has variable length, you might want to insert the character for “erase to end of line” just before the first write, line 30: sys.stdout.write("\033[K")

very good! I take it. thanks

Hello,
I can check that if the long job tries to print something, the progress bar breaks and starts to print in a new line. Is it possible to fix it???

@gkiryaziev, @xsponse in the while loop that @vladignatyev used for demonstration, change the comparison operator to <= from < and it will show 100%

Thanks for the progress bar. Will be using it on my own projects from now on!

excellent

If you put the percentage at the end of the line in windows you get visual feedback in the task bar.

echo -ne '\r [---] 10%'
sleep 1
echo -ne '\r [---] 20%'
sleep 1
echo -ne '\r [---] 30%'
sleep 1

awesome, works like a charm

I made a small improvement because I couldn't get it working, it wasn't printing anything cause of the \r character:

def progres(count, total, status='', bar_len=60):
    filled_len = int(round(bar_len * count / float(total)))

    percents = round(100.0 * count / float(total), 1)
    bar = '=' * filled_len + '-' * (bar_len - filled_len)

    fmt = '[%s] %s%s ...%s' % (bar, percents, '%', status)
    print('\b' * len(fmt), end='')  # clears the line
    sys.stdout.write(fmt)
    sys.stdout.flush()

@MarcDirven thank you, for your contribution! Could you please tell more about your setup? What OS and terminal you use to reproduce the problem?

By the way, 28th of December, 2020 will be the celebration of 5-years progress.py snippet. :D

Genius, I love it!

@vladignatyev Great snippet of code!! I will use this many times over.
As far as getting the progress bar to reach and display 100% -- I found that it works if you either start the counter value at 1, or increment the counter in the loop before calling the progress function (rather than incrementing after the function)

simple and nice, thank you @vladignatyev for this snippet..

Just download a module, this is BASIC

@MarcDirven thank you, for your contribution! Could you please tell more about your setup? What OS and terminal you use to reproduce the problem?

Hi sorry for the late reply, I didn't quite see my notifications. I was using PyCharm at the time and I believe it was Python 3.7. I was using Windows and was just using the terminal that comes with PyCharm.

Hey there, thanks for the awesome quick and simple progress bar :)

Made a quick improvement updating it to use the new style python string formatter as well as added a little colour effect for a more visual cue of the current progress. (https://gist.github.com/Minotorious/b5da8ee00301b9e9fcf3d71b92bd5973)

The equivalent new line in your code would be:
sys.stdout.write('[{0}] {1}% {2}\r'.format(bar, percents, status))

Hey @vladignatyev !

Thanks for that very simple progress bar.
I've had some real fun adding some nonsense-rainbow color waves to the progress bar. Just uncomment the code in the lower region for a quick demo.

https://github.com/andrewissac/pyProgressbar/blob/main/progressbar.py

Cheers and stay healthy! :)

Very nice!

I created a fork that allows you to wrap your iterator for item in progress(items, total=len(items), status_func=generate_status):
https://gist.github.com/joesolly/666b16e2870346441588d9cbf42dcae1

Thank you @joesolly! ср, 21 июл. 2021 г. в 19:41, Joseph Solomon ***@***.***>:

…

***@***.**** commented on this gist. ------------------------------ I created a fork that allows you to wrap your iterator for item in progress(items, total=len(items), status_func=generate_status): https://gist.github.com/joesolly/666b16e2870346441588d9cbf42dcae1 — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <https://gist.github.com/06860ec2040cb497f0f3#gistcomment-3823004>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAD5PFCRX7RYIXB32MDXM3DTY32E7ANCNFSM4IKRWZQQ> .

Very nice!

@vladignatyev, thank you! Very useful and minimalistic code snippet. I was inspired by it and made a "progress spinner":

import sys

def progress_spinner(status, cur_pos):
    pos = ["|", "/", "-", "\\"]
    sys.stdout.write("%s: %s, [%s%s]\r" % (status, pos[cur_pos%4], cur_pos, '%'))
    sys.stdout.flush()

It can be used like this:

import time 

for i in range(101):
    progress_spinner('Build project', i)
    time.sleep(0.5)

I have used console.status() from Rich instead of this one.

@dpriskorn, cool "spinner", thanks! I posted "my" spinner with the same motivation as the author of the original gist: to provide an understandable simple short solution that can be implemented into the project without unnecessary dependencies.

👍

In case you need a really sophisticated and beautiful progress bar in a terminal, consider importing the rich library: https://github.com/Textualize/rich

See it in action: https://github.com/Textualize/rich/blob/master/imgs/progress.gif

Also, I used rich for a handy CLI tool that I've made in spare time. Demo and code is here: https://github.com/vladignatyev/bulktag

take it, thanks