151 lines
5.8 KiB
Python
151 lines
5.8 KiB
Python
# Copyright (c) 2012-2013, Eucalyptus Systems, Inc.
|
|
#
|
|
# Permission to use, copy, modify, and/or distribute this software for
|
|
# any purpose with or without fee is hereby granted, provided that the
|
|
# above copyright notice and this permission notice appear in all copies.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
|
|
# OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
|
|
import math
|
|
from requestbuilder import Arg, MutuallyExclusiveArgList
|
|
import sys
|
|
|
|
try:
|
|
import progressbar
|
|
except ImportError:
|
|
pass
|
|
|
|
|
|
class TabifyingCommand(object):
|
|
'''
|
|
A command mixin that provides the tabify() function along with its
|
|
associated --show-empty-fields command line arg.
|
|
'''
|
|
|
|
ARGS = [Arg('--show-empty-fields', action='store_true', route_to=None,
|
|
help='show empty values as "(nil)"')]
|
|
|
|
def tabify(self, fields, include=None):
|
|
'''
|
|
Join a list of strings with tabs. Nonzero items that Python considers
|
|
false are printed as-is if they appear in the include list, replaced
|
|
with '(nil)' if the user specifies --show-empty-fields at the command
|
|
line, and omitted otherwise.
|
|
'''
|
|
def allowable(item):
|
|
return bool(item) or item is 0 or item in (include or [])
|
|
|
|
if self.args['show_empty_fields']:
|
|
fstr = '(nil)'
|
|
else:
|
|
fstr = ''
|
|
return '\t'.join([str(f) if allowable(f) else fstr for f in fields])
|
|
|
|
|
|
if 'progressbar' in sys.modules:
|
|
_PROGRESS_BAR_COMMAND_ARGS = [
|
|
MutuallyExclusiveArgList(
|
|
Arg('--progress', dest='show_progress', action='store_true',
|
|
default=sys.stdout.isatty(), route_to=None,
|
|
help='show progress (the default when run interactively)'),
|
|
Arg('--no-progress', dest='show_progress', action='store_false',
|
|
default=sys.stdout.isatty(), route_to=None, help='''do not
|
|
show progress (the default when run non-interactively)'''))]
|
|
else:
|
|
_PROGRESS_BAR_COMMAND_ARGS = []
|
|
|
|
|
|
class FileTransferProgressBarMixin(object):
|
|
'''
|
|
A command mixin that provides download/upload progress bar support,
|
|
along with options to enable or disable them. If progress bars are
|
|
disabled at the command line get_progressbar will return None. If the
|
|
progressbar module is unavailable get_progressbar will return None *and*
|
|
no progress-related options will be added.
|
|
'''
|
|
|
|
ARGS = _PROGRESS_BAR_COMMAND_ARGS
|
|
|
|
def get_progressbar(self, label=None, maxval=None):
|
|
if 'progressbar' in sys.modules and self.args.get('show_progress',
|
|
False):
|
|
widgets = []
|
|
if label is not None:
|
|
widgets += [label, ' ']
|
|
if maxval is not None:
|
|
widgets += [progressbar.Percentage(), ' ',
|
|
progressbar.Bar(marker='='), ' ',
|
|
_FileSize(), ' ',
|
|
progressbar.FileTransferSpeed(), ' ']
|
|
if 'AdaptiveETA' in dir(progressbar):
|
|
widgets.append(progressbar.AdaptiveETA())
|
|
else:
|
|
widgets.append(progressbar.ETA())
|
|
return progressbar.ProgressBar(widgets=widgets,
|
|
maxval=(maxval or sys.maxint),
|
|
poll=0.05)
|
|
else:
|
|
widgets += [_IndeterminateBouncingBar(marker='='), ' ',
|
|
_FileSize(), ' ',
|
|
progressbar.FileTransferSpeed(), ' ',
|
|
progressbar.Timer(format='Time: %s')]
|
|
return _IndeterminateProgressBar(widgets=widgets,
|
|
maxval=(maxval or sys.maxint),
|
|
poll=0.05)
|
|
else:
|
|
return _EveryMethodObject()
|
|
|
|
|
|
# Used as a placeholder for ProgressBar when progressbar isn't there
|
|
class _EveryMethodObject(object):
|
|
def do_nothing(self, *args, **kwargs):
|
|
pass
|
|
|
|
def __getattribute__(self, name):
|
|
return object.__getattribute__(self, 'do_nothing')
|
|
|
|
|
|
if 'progressbar' in sys.modules:
|
|
class _IndeterminateProgressBar(progressbar.ProgressBar):
|
|
def finish(self):
|
|
self.maxval = self.currval
|
|
progressbar.ProgressBar.finish(self)
|
|
|
|
|
|
class _IndeterminateBouncingBar(progressbar.BouncingBar):
|
|
'''
|
|
A BouncingBar that moves exactly one space each time it updates,
|
|
rather than one space per unit. This is mainly used for downloads with
|
|
unknown lengths.
|
|
'''
|
|
def __init__(self, *args, **kwargs):
|
|
progressbar.BouncingBar.__init__(self, *args, **kwargs)
|
|
self.__update_count = 0
|
|
|
|
def update(self, pbar, width):
|
|
orig_currval = pbar.currval
|
|
pbar.currval = self.__update_count
|
|
retval = progressbar.BouncingBar.update(self, pbar, width)
|
|
pbar.currval = orig_currval
|
|
self.__update_count += 1
|
|
return retval
|
|
|
|
|
|
class _FileSize(progressbar.Widget):
|
|
PREFIXES = ' kMGTPEZY'
|
|
|
|
def update(self, pbar):
|
|
if pbar.currval == 0:
|
|
power = 0
|
|
scaledval = 0
|
|
else:
|
|
power = int(math.log(pbar.currval, 1024))
|
|
scaledval = pbar.currval / 1024.0 ** power
|
|
return '{0:6.2f} {1}B'.format(scaledval, self.PREFIXES[power])
|