Python Progress Bar

Question

How do I use a progress bar when my script is doing some task that is likely to take time   For example  a function which takes some time to complete and returns True when done  How can I display a progress bar during the time the function is being executed   Note that I need this to be in real time  so I can t figure out what to do about it  Do I need a thread for this  I have no idea   Right now I am not printing anything while the function is being executed  however a progress bar would be nice  Also I am more interested in how this can be done from a code point of view

User · Answer

for a similar application  keeping track of the progress in a loop  I simply used the python-progressbar   Their example goes something like this   from progressbar import                   just a simple progress bar   widgets     Test     Percentage         Bar marker  0  left     right                       ETA         FileTransferSpeed     see docs for other options  pbar   ProgressBar widgets widgets  maxval 500  pbar start    for i in range 100 500 1 50         here do something long at each iteration     pbar update i   this adds a little symbol at each iteration pbar finish   print

User · Answer

I really like the python-progressbar  as it is very simple to use   For the most simple case  it is just   import progressbar import time  progress   progressbar ProgressBar   for i in progress range 80        time sleep 0 01    The appearance can be customized and it can display the estimated remaining time  For an example use the same code as above but with   progress   progressbar ProgressBar widgets  progressbar Bar                                                                  progressbar Percentage                                                     progressbar ETA

User · Answer

A simple solution here   void    -  fill       count   100 length increaseCount   0 for i in range length       print      fill i   void  length-i        str int increaseCount       end   r       increaseCount    count     time sleep 0 1  print      fill  i 1    void  length- i 1         str int increaseCount       end   n    Note   You can modify the fill and the  quot void quot  character if you want  The loading bar  picture

User · Answer

A very simple approach  def progbar count  int  - gt  None      for i in range count           print f quot   i       count-1-i        -  i 1   count  quot   end  quot  r quot           yield i     print   n    And the usage  from time import sleep  for i in progbar 10       sleep 0 2   whatever task you need to do

User · Answer

If your work can t be broken down into measurable chunks  you could call your function in a new thread and time how long it takes   import thread import time import sys  def work        time sleep  5    def locked call  func  lock        lock acquire       func       lock release    lock   thread allocate lock   thread start new thread  locked call    work  lock         This part is icky    while  not lock locked          time sleep  0 1    while  lock locked          sys stdout write            sys stdout flush       time sleep  1   print   nWork Done    You can obviously increase the timing precision as required

User · Answer

I used format   method to make a load bar  Here is my solution   import time  loadbarwidth   23  for i in range 1  loadbarwidth   1       time sleep 0 1        strbarwidth           -    r  format           i                   loadbarwidth - i     -                 0 2f   format   i     100 loadbarwidth                       print strbarwidth  end        print     Output                             - 100 00

User · Answer

I like Brian Khuu s answer for its simplicity and not needing external packages  I changed it a bit so I m adding my version here   import sys import time   def updt total  progress               Displays or updates a console progress bar       Original source  https   stackoverflow com a 15860757 1391441             barLength  status   20         progress   float progress    float total      if progress  gt   1           progress  status   1    r n      block   int round barLength   progress       text     r        0f       format                block    -     barLength - block   round progress   100  0           status      sys stdout write text      sys stdout flush     runs   300 for run num in range runs       time sleep  1      updt runs  run num   1    It takes the total number of runs  total  and the number of runs processed so far  progress  assuming total  gt   progress  The result looks like this         ---------------  27

User · Answer

This progress bar shows points of each 2 percent complete and numbers for each 10 percent complete   import sys  def ProgressBar  num  total  nextPercent  nextPoint       num   float  num      total   float  total  - 1     if not nextPoint          nextPoint   0 0     if not nextPercent          nextPoint    2 0         sys stdout write    0            nextPercent   10     elif num    total          sys stdout write   100   n           nextPercent    10     elif not nextPoint          nextPoint   0 0     elif num   total   100  gt   nextPercent          sys stdout write  str int  nextPercent                  nextPercent    10     elif num   total   100  gt   nextPoint          sys stdout write               nextPoint    2     return  nextPercent  nextPoint   nextPercent  nextPoint   0  0 total   1000  for num in range  total       nextPercent  nextPoint   ProgressBar  num  total  nextPercent  nextPoint    Results    gt  gt  gt    0     10      20      30      40      50      60      70      80      90      100    gt  gt  gt

User · Answer

Here s a short solution that builds the loading bar programmatically  you must decide how long you want it    import time  n   33    or however many loading slots you want to have load   0 01    artificial loading time  loading         n    for strings    is the repeat operator  for i in range n 1         this loop replaces each dot with a hash      print   r s Loading at  3d percent      loading  i 100 n   end         loading   loading  i          loading i 1       time sleep load

User · Answer

The code below is a quite general solution and also has a time elapsed and time remaining estimate  You can use any iterable with it  The progress bar has a fixed size of 25 characters but it can show updates in 1  steps using full  half  and quarter block characters  The output looks like this    18                                      0 00 01  0 00 06    Code with example   import sys  time from numpy import linspace  def ProgressBar iterObj     def SecToStr sec       m  s   divmod sec  60      h  m   divmod m  60      return u  d  02d  02d   h  m  s    L   len iterObj    steps    int x  y for x y in zip linspace 0  L  min 100 L   endpoint False                                      linspace 0  100  min 100 L   endpoint False      qSteps        u  u258E   u  u258C   u  u258A     quarter and half block chars   startT   time time     timeStr        0 00 00  - -- --     activity      -                     for nn item in enumerate iterObj       if nn in steps        done   u  u2588  int steps nn  4 0  qSteps int steps nn  4         todo        25-len done         barStr   u  4d     s s    steps nn   done  todo      if nn gt 0        endT   time time         timeStr       s   s    SecToStr endT-startT                                SecToStr  endT-startT   L float nn -1        sys stdout write   r  barStr activity nn 4  timeStr   sys stdout flush       yield item   barStr   u  4d     s    100  u  u2588  25    timeStr         s  0 00 00  n   SecToStr time time  -startT     sys stdout write   r  barStr timeStr   sys stdout flush      Example s      for c in ProgressBar list  Disassemble and reassemble this string       time sleep 0 2    s    c print s    Suggestions for improvements or other comments are appreciated  Cheers

User · Answer

If it is a big loop with a fixed amount of iterations that is taking a lot of time you can use this function I made  Each iteration of loop adds progress  Where count is the current iteration of the loop  total is the value you are looping to and size int  is how big you want the bar in increments of 10 i e   size 1  10 chars  size 2  20 chars    import sys def loadingBar count total size       percent   float count  float total  100     sys stdout write   r    str int count   rjust 3  0       str int total   rjust 3  0                int percent 10  size        10-int percent 10   size          example   for i in range 0 100        loadingBar i 100 2        do some code    output   i   50  gt  gt  050 100

User · Answer

use the os sys lib   i use it for many types of bars  example   from os sys progress import bar as Bar bar   Bar  progresing     max 20  for i in range 20        do somthing     bar next   bar finish     your output will be   procesing                                      2 10   read more in the discription of os sys

User · Answer

Use the progress library    pip install progress   Here is a custom subclass I wrote to format the ETA Elapsed times into a better readable format   import datetime from progress bar import IncrementalBar   class ProgressBar IncrementalBar               My custom progress bar that         - Show    count  elapsed  eta        - Time is shown in H M S format              message    Progress      suffix       percent  1f      index d   max d  --   elapsed min s  eta    eta min s        def formatTime self  seconds           return str datetime timedelta seconds seconds         property     def elapsed min self           return self formatTime self elapsed        property     def eta min self           return self formatTime self eta   if   name       main         counter   120     bar       ProgressBar  Processing   max counter       for i in range counter           bar next           time sleep 1       bar finish

User · Answer

This is a simple way to create a progressbar  import time sys toolbar width   50   setting up toolbar  -------------------------------------  sys stdout write    s      -   toolbar width   sys stdout flush     each hash represents 2   of the progress for i in range toolbar width       sys stdout write   r     return to start of line     sys stdout flush       sys stdout write      Overwrite over the existing text from the start      sys stdout write      i 1    number of   denotes the progress completed      sys stdout flush       time sleep 0 1

User · Answer

When running in jupyter notebooks use of normal tqdm doesn t work  as it writes output on multiple lines  Use this instead    import time from tqdm import tqdm notebook as tqdm  for i in tqdm range 100       time sleep 0 5

User · Answer

Massagran  It works well in my programs  Furthermore  we need to add a counter to indicate the loop times  This counter plays as the argument of the method update  For example  read all lines of a test file and treat them on something  Suppose that the function dosth   do not concern in the variable i   lines   open sys argv 1   readlines   i   0 widgets  Percentage    Bar    pbar   ProgressBar widgets widgets maxval len lines   start   pbar start   for line in lines  lt pre gt      dosth        i    1     pbar update i  lt  pre gt  pbar finish     The variable i controls the status of pbar via the method update

User · Answer

Try progress from https   pypi python org pypi progress   from progress bar import Bar  bar   Bar  Processing   max 20  for i in range 20         Do some work     bar next   bar finish     The result will be a bar like the following   Processing                                    42 100

User · Answer

You should link the progress bar to the task at hand  so that it measures the progress  D   For example  if you are FTPing a file  you can tell ftplib to grab a certain size buffer  let s say 128K  and then you add to your progress bar whatever percentage of the filesize 128k represents  If you are using the CLI  and your progress meter is 20 characters long  you would add one character when 1 20th of the file had transferred

User · Answer

Guess i m a little late but this should work for people working with the current versions of python 3  since this uses   f-strings   as introduced in Python 3 6 PEP 498   Code  from numpy import interp  class Progress      def   init   self  value  end  title  Downloading  buffer 20           self title   title          when calling in a for loop it doesn t include the last number         self end   end -1         self buffer   buffer         self value   value         self progress        def progress self           maped   int interp self value   0  self end    0  self buffer            print f  self title         maped   -   self buffer - maped    self value   self end     self value self end  100   2f     end   r     Example   some loop that does perfroms a task for x in range 21    set to 21 to include until 20     Progress x  21    Output  Downloading           ------------  8 20 40 00

User · Answer

I like this page   Starts with simple example and moves onto a multi-threaded version  Works out of the box  No 3rd party packages required   The code will look something like this   import time import sys  def do task        time sleep 1   def example 1 n       for i in range n           do task           print   b            sys stdout flush       print   Done    print  Starting    example 1 10    Or here is example to use threads in order to run the spinning loading bar while the program is running   import sys import time import threading  class progress bar loading threading Thread        def run self               global stop             global kill             print  Loading                     sys stdout flush               i   0             while stop    True                      if  i 4     0                           sys stdout write   b                        elif  i 4     1                           sys stdout write   b-                       elif  i 4     2                           sys stdout write   b                         elif  i 4     3                           sys stdout write   b                         sys stdout flush                       time sleep 0 2                      i  1              if kill    True                   print   b b b b ABORT                else                   print   b b done      kill   False       stop   False p   progress bar loading   p start    try       anything you want to run       time sleep 1      stop   True except KeyboardInterrupt or EOFError           kill   True          stop   True

User · Answer

Use this library  fish  GitHub    Usage    gt  gt  gt  import fish  gt  gt  gt  while churning          churn churn           fish animate     Have fun

User · Answer

I ve just made a simple progress class for my needs after searching here for a equivalent solution  I thought I might a well post it   from   future   import print function import sys import re   class ProgressBar object       DEFAULT    Progress    bar s   percent 3d        FULL      bar s   current d   total d    percent 3d      remaining d to go       def   init   self  total  width 40  fmt DEFAULT  symbol                       output sys stderr           assert len symbol     1          self total   total         self width   width         self symbol   symbol         self output   output         self fmt   re sub r   P lt name gt          d               r  g lt name gt  dd    len str total    fmt           self current   0      def   call   self           percent   self current   float self total          size   int self width   percent          remaining   self total - self current         bar         self symbol   size          self width - size                 args                  total   self total               bar   bar               current   self current               percent   percent   100               remaining   remaining                   print   r    self fmt   args  file self output  end          def done self           self current   self total         self           print     file self output      Example    from time import sleep  progress   ProgressBar 80  fmt ProgressBar FULL   for x in xrange progress total       progress current    1     progress       sleep 0 1  progress done     Will print the following                                              17 80   21   63 to go

User · Answer

I like Gabriel answer  but i changed it to be flexible  You can send bar-length to the function and get your progress bar with any length that you want  And you can t have a progress bar with zero or negative length  Also  you can use this function like Gabriel answer  Look at the Example  2    import sys import time  def ProgressBar Total  Progress  BarLength 20  ProgressIcon      BarIcon  -        try            You can t have a progress bar with zero or negative length          if BarLength  lt 1              BarLength   20           Use status variable for going to the next line after progress completion          Status                Calcuting progress between 0 and 1 for percentage          Progress   float Progress    float Total            Doing this conditions at final progressing          if Progress  gt   1               Progress   1             Status     r n       Going to the next line           Calculating how many places should be filled         Block   int round BarLength   Progress             Show this         Bar            0f       format ProgressIcon   Block   BarIcon    BarLength - Block   round Progress   100  0   Status          return Bar     except          return  ERROR   def ShowBar Bar       sys stdout write Bar      sys stdout flush    if   name         main         print  This is a simple progress bar  n          Example  1      print  Example  1       Runs   10     for i in range Runs   1           progressBar     rProgress      ProgressBar 10  i  Runs          ShowBar progressBar          time sleep 1         Example  2      print   nExample  2       Runs   10     for i in range Runs   1           progressBar     rProgress      ProgressBar 10  i  20                    ShowBar progressBar          time sleep 1       print   nDone       Example  2  Runs   10 for i in range Runs   1       ProgressBar 10  i      time sleep 1    Result      This is a simple progress bar       Example  1      Progress      -------  30        Example  2      Progress                         60        Done

User · Answer

You can also use enlighten  The main advantage is you can log at the same time without overwriting your progress bar   import time import enlighten  manager   enlighten Manager   pbar   manager counter total 100   for num in range 1  101       time sleep 0 05      print  Step  d complete    num      pbar update     It also handles multiple progress bars   import time import enlighten  manager   enlighten Manager   odds   manager counter total 50  evens   manager counter total 50   for num in range 1  101       time sleep 0 05      if num   2          odds update       else          evens update

User · Answer

This is my simple solution   import time  def progress  cur   max       p   round 100  cur  max      b   f Progress   p   -        int p 5       20-int p 5           print b  end   r      USAGE  for i in range 0 101       time sleep 0 1       progress i 100   print       5  end   r   print  Done

User · Answer

a little more generic answer of jelde015  credit to him of course   for updating the loading bar manually will be   import sys from math import     def loadingBar i  N  size       percent   float i    float N      sys stdout write   r                         str int i   rjust 3   0                                                   str int N   rjust 3   0                                                          ceil percent size                             floor  1-percent  size                                and calling it by   loadingBar 7  220  40    will result   007 220                                                just call it whenever you want with the current i value   set the size as the number of chars the bar should be

User · Answer

Try PyProg  PyProg is an open-source library for Python to create super customizable progress indicators  amp  bars   It is currently at version 1 0 2  it is hosted on Github and available on PyPI  Links down below   It is compatible with Python 3  amp  2 and it can also be used with Qt Console   It is really easy to use  The following code   import pyprog from time import sleep    Create Object prog   pyprog ProgressBar          34    Update Progress Bar prog update    for i in range 34         Do something     sleep 0 1        Set current status     prog set stat i   1        Update Progress Bar again     prog update      Make the Progress Bar final prog end     will produce   Initial State  Progress  0  --------------------------------------------------  When half done  Progress  50                           -------------------------  Final State  Progress  100                                                       I actually made PyProg because I needed a simple but super customizable progress bar library  You can easily install it with  pip install pyprog   PyProg Github  https   github com Bill13579 pyprog PyPI  https   pypi python org pypi pyprog

User · Answer

This answer doesn t rely on external packages  I also think that most people just want a ready-made piece of code  The code below can be adapted to fit your needs by customizing  bar progress symbol      bar size  text prefix etc  import sys  def progressbar it  prefix  quot  quot   size 60  file sys stdout       count   len it      def show j           x   int size j count          file write  quot  s  s s   i  i r quot     prefix   quot   quot  x   quot   quot   size-x   j  count           file flush               show 0      for i  item in enumerate it           yield item         show i 1      file write  quot  n quot       file flush    Usage  import time  for i in progressbar range 15    quot Computing   quot   40       time sleep 0 1    any calculation you need  Output  Computing                                             4 15   Doesn t require a second thread  Some solutions packages above require   Works with any iterable it means anything that len   can be used on  A list  a dict of anything for example   a    b    c       g    Works with generators only have to wrap it with a list    For example for i in progressbar list your generator    quot Computing   quot   40   Unless the work is done in the generator  In that case you need another solution  like tqdm     You can also change output by changing file to sys stderr for example

User · Answer

Here is a very simple version  in case you have a loop and just want to get an idea of progression of iterations  such as a dot for every  say  5000 iterations  my list   range 0 100000   counter   0 for x in my list       your code here      counter   counter   1     if counter   5000    0          print  quot   quot   end  quot  quot     end  quot  quot  avoids a newline  keeps dots together  print    this makes sure whatever you print next is in a new line  my list is not part of the scheme  Use your own iterable  whatever you are looping over  This version doesn t tell you ahead of time how many total iterations

User · Answer

With tqdm  conda install tqdm or pip install tqdm  you can add a progress meter to your loops in a second  from time import sleep from tqdm import tqdm for i in tqdm range 10        sleep 3    60                    6 10  00 18 lt 00 12   0 33 it s   Also  there is a notebook version  from tqdm notebook import tqdm for i in tqdm range 100        sleep 3   You can use tqdm auto instead of tqdm notebook to work in both a terminal and notebooks  tqdm contrib contains some helper functions to do things like enumerate  map  and zip  There are concurrent maps in tqdm contrib concurrent  You can even get progress sent to your phone after disconnecting from a jupyter notebook using tqdm contrib telegram or tqdm contrib discord

User · Answer

There are specific libraries  like this one here  but maybe something very simple would do   import time import sys  toolbar width   40    setup toolbar sys stdout write    s            toolbar width   sys stdout flush   sys stdout write   b     toolbar width 1     return to start of line  after      for i in xrange toolbar width       time sleep 0 1    do real work here       update the bar     sys stdout write  -       sys stdout flush    sys stdout write    n     this ends the progress bar   Note  progressbar2 is a fork of progressbar which hasn t been maintained in years

User · Answer

To use any progress-bar frameworks in a useful manner  to get an actual progress percent and an estimated ETA  you need to be able to declare how many steps it will have  So  your compute function in another thread  are you able to split it in a number of logical steps  Can you modify its code  You don t need to refactor or split it in any way  you could just put some strategic yields in some places or if it has a for loop  just one  That way  your function will look something like this  def compute        for i in range 1000           time sleep  1     process items         yield    insert this and you re done   Then just install  pip install alive-progress  And use it like  from alive progress import alive bar  with alive bar 1000  as bar      for i in compute            bar    To get a cool progress-bar                                                          321 1000  32   in 8s  40 1 s  eta  16s   Disclaimer  I m the author of alive-progress  but it should solve your problem nicely  Read the documentation at https   github com rsalmei alive-progress  here is an example of what it can do

User · Answer

The above suggestions are pretty good  but I think most people just want a ready made solution  with no dependencies on external packages  but is also reusable    I got the best points of all the above  and made it into a function  along with a test cases   To use it  just copy the lines under  def update progress progress   but not the test script  Don t forget to import sys  Call this whenever you need to display or update the progress bar   This works by directly sending the   r  symbol to console to move cursor back to the start   print  in python does not recongise the above symbol for this purpose  hence we need  sys   import time  sys    update progress     Displays or updates a console progress bar    Accepts a float between 0 and 1  Any int will be converted to a float     A value under 0 represents a  halt      A value at 1 or bigger represents 100  def update progress progress       barLength   10   Modify this to change the length of the progress bar     status          if isinstance progress  int           progress   float progress      if not isinstance progress  float           progress   0         status    error  progress var must be float r n      if progress  lt  0          progress   0         status    Halt    r n      if progress  gt   1          progress   1         status    Done    r n      block   int round barLength progress       text     rPercent    0    1    2   format      block    -   barLength-block   progress 100  status      sys stdout write text      sys stdout flush       update progress test script print  progress    hello   update progress  hello   time sleep 1   print  progress   3  update progress 3  time sleep 1   print  progress    23   update progress  23   time sleep 1   print    print  progress   -10  update progress -10  time sleep 2   print    print  progress   10  update progress 10  time sleep 2   print    print  progress   0- gt 1  for i in range 101       time sleep 0 1      update progress i 100 0   print    print  Test completed  time sleep 10    This is what the result of the test script shows  The last progress bar animates    progress    hello  Percent   ----------  0  error  progress var must be float progress   3 Percent               100  Done    progress    23  Percent   ----------  0  error  progress var must be float  progress   -10 Percent   ----------  0  Halt     progress   10 Percent               100  Done     progress   0- gt 1 Percent               100  Done    Test completed

User · Answer

It is quite straightforward in Python3      import time    import math      def show progress bar bar length  completed  total           bar length unit value    total   bar length          completed bar part   math ceil completed   bar length unit value          progress         completed bar part         remaining          bar length - completed bar part          percent done      2f      completed   total    100          print f   progress  remaining    percent done     end   r        bar length   30     total   100     for i in range 0  total   1           show progress bar bar length  i  total          time sleep 0 1       print   n

User · Answer

You can use tqdm   from tqdm import tqdm  with tqdm total 100  desc  Adding Users   bar format   l bar  bar    time left   remaining      as pbar      for i in range 100           time sleep 3          pbar update 1    In this example the progress bar is running for 5 minutes and it is shown like that   Adding Users    3                                                    time left  04 51                                                                                                             You can change it and customize it as you like

[python] Python Progress Bar

Examples related to python