lttnganalyses/cli/progressbar.py

   1 #!/usr/bin/env python3
   2 #
   3 # The MIT License (MIT)
   4 #
   5 # Copyright (C) 2015 - Julien Desfossez <jdesfossez@efficios.com>
   6 #
   7 # Permission is hereby granted, free of charge, to any person obtaining a copy
   8 # of this software and associated documentation files (the "Software"), to deal
   9 # in the Software without restriction, including without limitation the rights
  10 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11 # copies of the Software, and to permit persons to whom the Software is
  12 # furnished to do so, subject to the following conditions:
  13 #
  14 # The above copyright notice and this permission notice shall be included in
  15 # all copies or substantial portions of the Software.
  16 #
  17 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23 # SOFTWARE.
  24
  25 import os
  26 import sys
  27
  28 try:
  29     from progressbar import ETA, Bar, Percentage, ProgressBar
  30     progressbar_available = True
  31 except ImportError:
  32     progressbar_available = False
  33
  34 # approximation for the progress bar
  35 BYTES_PER_EVENT = 30
  36
  37
  38 def getFolderSize(folder):
  39     total_size = os.path.getsize(folder)
  40     for item in os.listdir(folder):
  41         itempath = os.path.join(folder, item)
  42         if os.path.isfile(itempath):
  43             total_size += os.path.getsize(itempath)
  44         elif os.path.isdir(itempath):
  45             total_size += getFolderSize(itempath)
  46     return total_size
  47
  48
  49 def progressbar_setup(obj):
  50     if hasattr(obj, '_arg_no_progress') and obj._arg_no_progress:
  51         obj.pbar = None
  52         return
  53
  54     if progressbar_available:
  55         size = getFolderSize(obj._arg_path)
  56         widgets = ['Processing the trace: ', Percentage(), ' ',
  57                    Bar(marker='#', left='[', right=']'),
  58                    ' ', ETA(), ' ']  # see docs for other options
  59         obj.pbar = ProgressBar(widgets=widgets,
  60                                maxval=size/BYTES_PER_EVENT)
  61         obj.pbar.start()
  62     else:
  63         print('Warning: progressbar module not available, '
  64               'using --no-progress.', file=sys.stderr)
  65         obj._arg_no_progress = True
  66         obj.pbar = None
  67     obj.event_count = 0
  68
  69
  70 def progressbar_update(obj):
  71     if hasattr(obj, '_arg_no_progress') and \
  72             (obj._arg_no_progress or obj.pbar is None):
  73         return
  74     try:
  75         obj.pbar.update(obj.event_count)
  76     except ValueError:
  77         pass
  78     obj.event_count += 1
  79
  80
  81 def progressbar_finish(obj):
  82     if hasattr(obj, '_arg_no_progress') and obj._arg_no_progress:
  83         return
  84     obj.pbar.finish()