Skip to content

Instantly share code, notes, and snippets.

@vladignatyev
Last active October 29, 2023 16:36
Star You must be signed in to star a gist
Save vladignatyev/06860ec2040cb497f0f3 to your computer and use it in GitHub Desktop.
Python command line progress bar in less than 10 lines of code.
# 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)
@vladignatyev
Copy link
Author

vladignatyev commented Jul 21, 2021 via email

@eldemir
Copy link

eldemir commented Oct 16, 2021

Very nice!

@Yourun-proger
Copy link

@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)

@dpriskorn
Copy link

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

@Yourun-proger
Copy link

@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.

@dpriskorn
Copy link

👍

@vladignatyev
Copy link
Author

vladignatyev commented Oct 10, 2023

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment