/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to patches/progress.diff

  • Committer: Robert Collins
  • Date: 2008-01-06 20:04:22 UTC
  • mto: (3221.11.1 StackableBranch)
  • mto: This revision was merged to the branch mainline in revision 3226.
  • Revision ID: robertc@robertcollins.net-20080106200422-x8yz6cxotlzltvwp
The bzrdir format registry now accepts an ``alias`` keyword to
register_metadir, used to indicate that a format name is an alias for
some other format and thus should not be reported when describing the
format. (Robert Collins)
-------------- This line and the fmllowing will be ignored --------------

modified:
  NEWS
  bzrlib/bzrdir.py
  bzrlib/info.py
  bzrlib/tests/test_bzrdir.py
  bzrlib/tests/test_info.py

=== modified file 'NEWS'
--- a/NEWS      2008-01-02 22:30:46 +0000
+++ b/NEWS      2008-01-06 20:04:15 +0000
@@ -135,6 +135,11 @@
     * Patience Diff now supports arbitrary python objects, as long as they
       support ``hash()``. (John Arbash Meinel)
 
+    * The bzrdir format registry now accepts an ``alias`` keyword to
+      register_metadir, used to indicate that a format name is an alias for
+      some other format and thus should not be reported when describing the
+      format. (Robert Collins)
+
   API BREAKS:
 
   TESTING:

=== modified file 'bzrlib/bzrdir.py'
--- a/bzrlib/bzrdir.py  2008-01-02 22:30:46 +0000
+++ b/bzrlib/bzrdir.py  2008-01-06 19:41:29 +0000
@@ -2447,12 +2447,22 @@
     e.g. BzrDirMeta1 with weave repository.  Also, it's more user-oriented.
     """
 
+    def __init__(self):
+        """Create a BzrDirFormatRegistry."""
+        self._aliases = set()
+        super(BzrDirFormatRegistry, self).__init__()
+
+    def aliases(self):
+        """Return a set of the format names which are aliases."""
+        return frozenset(self._aliases)
+
     def register_metadir(self, key,
              repository_format, help, native=True, deprecated=False,
              branch_format=None,
              tree_format=None,
              hidden=False,
-             experimental=False):
+             experimental=False,
+             alias=False):
         """Register a metadir subformat.
 
         These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
@@ -2491,10 +2501,10 @@
                 bd.repository_format = _load(repository_format)
             return bd
         self.register(key, helper, help, native, deprecated, hidden,
-            experimental)
+            experimental, alias)
 
     def register(self, key, factory, help, native=True, deprecated=False,
-                 hidden=False, experimental=False):
+                 hidden=False, experimental=False, alias=False):
         """Register a BzrDirFormat factory.
         
         The factory must be a callable that takes one parameter: the key.
@@ -2505,11 +2515,15 @@
         """
         registry.Registry.register(self, key, factory, help,
             BzrDirFormatInfo(native, deprecated, hidden, experimental))
+        if alias:
+            self._aliases.add(key)
 
     def register_lazy(self, key, module_name, member_name, help, native=True,
-                      deprecated=False, hidden=False, experimental=False):
+        deprecated=False, hidden=False, experimental=False, alias=False):
         registry.Registry.register_lazy(self, key, module_name, member_name,
             help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
+        if alias:
+            self._aliases.add(key)
 
     def set_default(self, key):
         """Set the 'default' key to be a clone of the supplied key.
@@ -2518,6 +2532,7 @@
         """
         registry.Registry.register(self, 'default', self.get(key),
             self.get_help(key), info=self.get_info(key))
+        self._aliases.add('default')
 
     def set_default_repository(self, key):
         """Set the FormatRegistry default and Repository default.
@@ -2670,6 +2685,7 @@
     tree_format='bzrlib.workingtree.WorkingTreeFormat4',
     hidden=False,
     )
+# The following two formats should always just be aliases.
 format_registry.register_metadir('development',
     'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
     help='Current development format. Can convert data to and from pack-0.92 '
@@ -2681,6 +2697,7 @@
     branch_format='bzrlib.branch.BzrBranchFormat6',
     tree_format='bzrlib.workingtree.WorkingTreeFormat4',
     experimental=True,
+    alias=True,
     )
 format_registry.register_metadir('development-subtree',
     'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
@@ -2693,7 +2710,9 @@
     branch_format='bzrlib.branch.BzrBranchFormat6',
     tree_format='bzrlib.workingtree.WorkingTreeFormat4',
     experimental=True,
+    alias=True,
     )
+# And the development formats which the will have aliased one of follow:
 format_registry.register_metadir('development0',
     'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
     help='Trivial rename of pack-0.92 to provide a development format. '

=== modified file 'bzrlib/info.py'
--- a/bzrlib/info.py    2007-11-06 09:00:25 +0000
+++ b/bzrlib/info.py    2008-01-06 20:01:30 +0000
@@ -440,7 +440,9 @@
         tree.bzrdir.root_transport.base):
         branch = None
         repository = None
-    for key in bzrdir.format_registry.keys():
+    non_aliases = set(bzrdir.format_registry.keys())
+    non_aliases.difference_update(bzrdir.format_registry.aliases())
+    for key in non_aliases:
         format = bzrdir.format_registry.make_bzrdir(key)
         if isinstance(format, bzrdir.BzrDirMetaFormat1):
             if (tree and format.workingtree_format !=
@@ -457,11 +459,12 @@
         candidates.append(key)
     if len(candidates) == 0:
         return 'unnamed'
-    new_candidates = [c for c in candidates if c != 'default']
-    if len(new_candidates) > 0:
-        candidates = new_candidates
+    candidates.sort()
     new_candidates = [c for c in candidates if not
         bzrdir.format_registry.get_info(c).hidden]
     if len(new_candidates) > 0:
+        # If there are any non-hidden formats that match, only return those to
+        # avoid listing hidden formats except when only a hidden format will
+        # do.
         candidates = new_candidates
     return ' or '.join(candidates)

=== modified file 'bzrlib/tests/test_bzrdir.py'
--- a/bzrlib/tests/test_bzrdir.py       2007-12-21 20:32:22 +0000
+++ b/bzrlib/tests/test_bzrdir.py       2008-01-06 19:45:00 +0000
@@ -170,6 +170,16 @@
         finally:
             bzrdir.format_registry.set_default_repository(old_default)
 
+    def test_aliases(self):
+        a_registry = bzrdir.BzrDirFormatRegistry()
+        a_registry.register('weave', bzrdir.BzrDirFormat6,
+            'Pre-0.8 format.  Slower and does not support checkouts or shared'
+            ' repositories', deprecated=True)
+        a_registry.register('weavealias', bzrdir.BzrDirFormat6,
+            'Pre-0.8 format.  Slower and does not support checkouts or shared'
+            ' repositories', deprecated=True, alias=True)
+        self.assertEqual(frozenset(['weavealias']), a_registry.aliases())
+    
 
 class SampleBranch(bzrlib.branch.Branch):
     """A dummy branch for guess what, dummy use."""

=== modified file 'bzrlib/tests/test_info.py'
--- a/bzrlib/tests/test_info.py 2007-11-26 13:55:51 +0000
+++ b/bzrlib/tests/test_info.py 2008-01-06 20:02:10 +0000
@@ -126,16 +126,22 @@
 
     def test_describe_tree_format(self):
         for key in bzrdir.format_registry.keys():
-            if key == 'default':
+            if key in bzrdir.format_registry.aliases():
                 continue
             self.assertTreeDescription(key)
 
     def test_describe_checkout_format(self):
         for key in bzrdir.format_registry.keys():
-            if key in ('default', 'weave', 'experimental'):
-                continue
-            if key.startswith('experimental-'):
-                # these are typically hidden or aliases for other formats
+            if key in bzrdir.format_registry.aliases():
+                # Aliases will not describe correctly in the UI because the
+                # real format is found.
+                continue
+            # legacy: weave does not support checkouts
+            if key == 'weave':
+                continue
+            if bzrdir.format_registry.get_info(key).experimental:
+                # We don't require that experimental formats support checkouts
+                # or describe correctly in the UI.
                 continue
             expected = None
             if key in ('dirstate', 'dirstate-tags', 'dirstate-with-subtree',
@@ -149,7 +155,7 @@
 
     def test_describe_branch_format(self):
         for key in bzrdir.format_registry.keys():
-            if key == 'default':
+            if key in bzrdir.format_registry.aliases():
                 continue
             expected = None
             if key in ('dirstate', 'knit'):
@@ -158,7 +164,7 @@
 
     def test_describe_repo_format(self):
         for key in bzrdir.format_registry.keys():
-            if key == 'default':
+            if key in bzrdir.format_registry.aliases():
                 continue
             expected = None
             if key in ('dirstate', 'knit', 'dirstate-tags'):

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
*** added file 'bzrlib/progress.py'
2
 
--- /dev/null 
3
 
+++ bzrlib/progress.py 
4
 
@@ -0,0 +1,138 @@
5
 
+# Copyright (C) 2005 Aaron Bentley
6
 
+# <aaron.bentley@utoronto.ca>
7
 
+#
8
 
+#    This program is free software; you can redistribute it and/or modify
9
 
+#    it under the terms of the GNU General Public License as published by
10
 
+#    the Free Software Foundation; either version 2 of the License, or
11
 
+#    (at your option) any later version.
12
 
+#
13
 
+#    This program is distributed in the hope that it will be useful,
14
 
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
15
 
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
 
+#    GNU General Public License for more details.
17
 
+#
18
 
+#    You should have received a copy of the GNU General Public License
19
 
+#    along with this program; if not, write to the Free Software
20
 
+#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21
 
+
22
 
+import sys
23
 
+import datetime
24
 
+
25
 
+class Progress(object):
26
 
+    def __init__(self, units, current, total=None):
27
 
+        self.units = units
28
 
+        self.current = current
29
 
+        self.total = total
30
 
+
31
 
+    def _get_percent(self):
32
 
+        if self.total is not None and self.current is not None:
33
 
+            return 100.0 * self.current / self.total
34
 
+
35
 
+    percent = property(_get_percent)
36
 
+
37
 
+    def __str__(self):
38
 
+        if self.total is not None:
39
 
+            return "%i of %i %s %.1f%%" % (self.current, self.total, self.units,
40
 
+                                         self.percent)
41
 
+        else:
42
 
+            return "%i %s" (self.current, self.units) 
43
 
+
44
 
+class ProgressBar(object):
45
 
+    def __init__(self):
46
 
+        self.start = None
47
 
+        object.__init__(self)
48
 
+
49
 
+    def __call__(self, progress):
50
 
+        if self.start is None:
51
 
+            self.start = datetime.datetime.now()
52
 
+        progress_bar(progress, start_time=self.start)
53
 
+        
54
 
+def divide_timedelta(delt, divisor):
55
 
+    """Divides a timedelta object"""
56
 
+    return datetime.timedelta(float(delt.days)/divisor, 
57
 
+                              float(delt.seconds)/divisor, 
58
 
+                              float(delt.microseconds)/divisor)
59
 
+
60
 
+def str_tdelta(delt):
61
 
+    if delt is None:
62
 
+        return "-:--:--"
63
 
+    return str(datetime.timedelta(delt.days, delt.seconds))
64
 
+
65
 
+def get_eta(start_time, progress, enough_samples=20):
66
 
+    if start_time is None or progress.current == 0:
67
 
+        return None
68
 
+    elif progress.current < enough_samples:
69
 
+        return None
70
 
+    elapsed = datetime.datetime.now() - start_time
71
 
+    total_duration = divide_timedelta((elapsed) * long(progress.total), 
72
 
+                                      progress.current)
73
 
+    if elapsed < total_duration:
74
 
+        eta = total_duration - elapsed
75
 
+    else:
76
 
+        eta = total_duration - total_duration
77
 
+    return eta
78
 
+
79
 
+def progress_bar(progress, start_time=None):
80
 
+    eta = get_eta(start_time, progress)
81
 
+    if start_time is not None:
82
 
+        eta_str = " "+str_tdelta(eta)
83
 
+    else:
84
 
+        eta_str = ""
85
 
+
86
 
+    fmt = " %i of %i %s (%.1f%%)"
87
 
+    f = fmt % (progress.total, progress.total, progress.units, 100.0)
88
 
+    max = len(f)
89
 
+    cols = 77 - max
90
 
+    if start_time is not None:
91
 
+        cols -= len(eta_str)
92
 
+    markers = int (float(cols) * progress.current / progress.total)
93
 
+    txt = fmt % (progress.current, progress.total, progress.units,
94
 
+                 progress.percent)
95
 
+    sys.stderr.write("\r[%s%s]%s%s" % ('='*markers, ' '*(cols-markers), txt, 
96
 
+                                       eta_str))
97
 
+
98
 
+def clear_progress_bar():
99
 
+    sys.stderr.write('\r%s\r' % (' '*79))
100
 
+
101
 
+def spinner_str(progress, show_text=False):
102
 
+    """
103
 
+    Produces the string for a textual "spinner" progress indicator
104
 
+    :param progress: an object represinting current progress
105
 
+    :param show_text: If true, show progress text as well
106
 
+    :return: The spinner string
107
 
+
108
 
+    >>> spinner_str(Progress("baloons", 0))
109
 
+    '|'
110
 
+    >>> spinner_str(Progress("baloons", 5))
111
 
+    '/'
112
 
+    >>> spinner_str(Progress("baloons", 6), show_text=True)
113
 
+    '- 6 baloons'
114
 
+    """
115
 
+    positions = ('|', '/', '-', '\\')
116
 
+    text = positions[progress.current % 4]
117
 
+    if show_text:
118
 
+        text+=" %i %s" % (progress.current, progress.units)
119
 
+    return text
120
 
+
121
 
+def spinner(progress, show_text=False, output=sys.stderr):
122
 
+    """
123
 
+    Update a spinner progress indicator on an output
124
 
+    :param progress: The progress to display
125
 
+    :param show_text: If true, show text as well as spinner
126
 
+    :param output: The output to write to
127
 
+
128
 
+    >>> spinner(Progress("baloons", 6), show_text=True, output=sys.stdout)
129
 
+    \r- 6 baloons
130
 
+    """
131
 
+    output.write('\r%s' % spinner_str(progress, show_text))
132
 
+
133
 
+def run_tests():
134
 
+    import doctest
135
 
+    result = doctest.testmod()
136
 
+    if result[1] > 0:
137
 
+        if result[0] == 0:
138
 
+            print "All tests passed"
139
 
+    else:
140
 
+        print "No tests to run"
141
 
+if __name__ == "__main__":
142
 
+    run_tests()
143