Skip to content

Instantly share code, notes, and snippets.

@joesolly
Forked from vladignatyev/progress.py
Last active February 1, 2022 10:03
Show Gist options
  • Save joesolly/666b16e2870346441588d9cbf42dcae1 to your computer and use it in GitHub Desktop.
Save joesolly/666b16e2870346441588d9cbf42dcae1 to your computer and use it in GitHub Desktop.
Python command line progress bar in 25 lines of code that allows you to wrap your for loop.
# 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(iterable, total=None, status_func=lambda: ''):
""" Usage
for item in progress(items, total=len(items), status_func=generate_status):
pass
"""
bar_len = 60
count = 0
if total is None:
total = len(iterable) # if this fails because it is an iterator or something, you must pass in total
def _print_progress_bar():
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_func()))
sys.stdout.flush() # As suggested by Rom Ruben (see: http://stackoverflow.com/questions/3173320/text-progress-bar-in-the-console/27871113#comment50529068_27871113)
try:
while 1:
item = next(iterable)
yield item
count += 1
_print_progress_bar()
except StopIteration:
_print_progress_bar()
sys.stdout.write('\n')
sys.stdout.flush()
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment