← Back to branch summary

~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to progress.py

  • Committer: Aaron Bentley
  • Date: 2005-05-15 22:31:18 UTC
  • Revision ID: abentley@bruiser-20050515223118-216927c08abfb1b6
Made bzr revision ids predictable

Show diffs side-by-side

added added

removed removed

Lines of Context:
progress.py
1
1
# Copyright (C) 2005 Aaron Bentley
2
 
# <aaron@aaronbentley.com>
 
2
# <aaron.bentley@utoronto.ca>
3
3
#
4
4
#    This program is free software; you can redistribute it and/or modify
5
5
#    it under the terms of the GNU General Public License as published by
16
16
#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
17
 
18
18
import sys
19
 
import datetime
20
 
from bzrlib.progress import ProgressBar
21
19
 
22
20
class Progress(object):
23
21
    def __init__(self, units, current, total=None):
24
22
        self.units = units
25
23
        self.current = current
26
24
        self.total = total
27
 
 
28
 
    def _get_percent(self):
29
 
        if self.total is None:
30
 
            return None
31
 
        return 100.0 * self.current / self.total
32
 
 
33
 
    percent = property(_get_percent)
 
25
        self.percent = None
 
26
        if self.total is not None:
 
27
            self.percent = 100.0 * current / total
34
28
 
35
29
    def __str__(self):
36
30
        if self.total is not None:
37
31
            return "%i of %i %s %.1f%%" % (self.current, self.total, self.units,
38
32
                                         self.percent)
39
33
        else:
40
 
            return "%i %s" (self.current, self.units)
41
 
 
42
 
def show_progress(pi, prog):
43
 
    pi.update(prog.units, prog.current, prog.total)
 
34
            return "%i %s" (self.current, self.units) 
 
35
 
 
36
 
 
37
def progress_bar(progress):
 
38
    fmt = " %i of %i %s (%.1f%%)"
 
39
    f = fmt % (progress.total, progress.total, progress.units, 100.0)
 
40
    max = len(f)
 
41
    cols = 77 - max
 
42
    markers = int (float(cols) * progress.current / progress.total)
 
43
    txt = fmt % (progress.current, progress.total, progress.units,
 
44
                 progress.percent)
 
45
    sys.stderr.write("\r[%s%s]%s" % ('='*markers, ' '*(cols-markers), txt))
44
46
 
45
47
def clear_progress_bar():
46
48
    sys.stderr.write('\r%s\r' % (' '*79))
 
49
 
 
50
def spinner_str(progress, show_text=False):
 
51
    """
 
52
    Produces the string for a textual "spinner" progress indicator
 
53
    :param progress: an object represinting current progress
 
54
    :param show_text: If true, show progress text as well
 
55
    :return: The spinner string
 
56
 
 
57
    >>> spinner_str(Progress("baloons", 0))
 
58
    '|'
 
59
    >>> spinner_str(Progress("baloons", 5))
 
60
    '/'
 
61
    >>> spinner_str(Progress("baloons", 6), show_text=True)
 
62
    '- 6 baloons'
 
63
    """
 
64
    positions = ('|', '/', '-', '\\')
 
65
    text = positions[progress.current % 4]
 
66
    if show_text:
 
67
        text+=" %i %s" % (progress.current, progress.units)
 
68
    return text
 
69
 
 
70
def spinner(progress, show_text=False, output=sys.stderr):
 
71
    """
 
72
    Update a spinner progress indicator on an output
 
73
    :param progress: The progress to display
 
74
    :param show_text: If true, show text as well as spinner
 
75
    :param output: The output to write to
 
76
 
 
77
    >>> spinner(Progress("baloons", 6), show_text=True, output=sys.stdout)
 
78
    \r- 6 baloons
 
79
    """
 
80
    output.write('\r%s' % spinner_str(progress, show_text))
 
81
 
 
82
def run_tests():
 
83
    import doctest
 
84
    result = doctest.testmod()
 
85
    if result[1] > 0:
 
86
        if result[0] == 0:
 
87
            print "All tests passed"
 
88
    else:
 
89
        print "No tests to run"
 
90
if __name__ == "__main__":
 
91
    run_tests()