/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 bzrlib/cmdline.py

  • 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:
bzrlib/cmdline.py
1
 
# Copyright (C) 2010 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
"""Unicode-compatible command-line splitter for all platforms."""
18
 
 
19
 
import re
20
 
 
21
 
 
22
 
_whitespace_match = re.compile(u'\s', re.UNICODE).match
23
 
 
24
 
 
25
 
class _PushbackSequence(object):
26
 
    def __init__(self, orig):
27
 
        self._iter = iter(orig)
28
 
        self._pushback_buffer = []
29
 
 
30
 
    def next(self):
31
 
        if len(self._pushback_buffer) > 0:
32
 
            return self._pushback_buffer.pop()
33
 
        else:
34
 
            return self._iter.next()
35
 
 
36
 
    def pushback(self, char):
37
 
        self._pushback_buffer.append(char)
38
 
 
39
 
    def __iter__(self):
40
 
        return self
41
 
 
42
 
 
43
 
class _Whitespace(object):
44
 
    def process(self, next_char, context):
45
 
        if _whitespace_match(next_char):
46
 
            if len(context.token) > 0:
47
 
                return None
48
 
            else:
49
 
                return self
50
 
        elif next_char in context.allowed_quote_chars:
51
 
            context.quoted = True
52
 
            return _Quotes(next_char, self)
53
 
        elif next_char == u'\\':
54
 
            return _Backslash(self)
55
 
        else:
56
 
            context.token.append(next_char)
57
 
            return _Word()
58
 
 
59
 
 
60
 
class _Quotes(object):
61
 
    def __init__(self, quote_char, exit_state):
62
 
        self.quote_char = quote_char
63
 
        self.exit_state = exit_state
64
 
 
65
 
    def process(self, next_char, context):
66
 
        if next_char == u'\\':
67
 
            return _Backslash(self)
68
 
        elif next_char == self.quote_char:
69
 
            return self.exit_state
70
 
        else:
71
 
            context.token.append(next_char)
72
 
            return self
73
 
 
74
 
 
75
 
class _Backslash(object):
76
 
    # See http://msdn.microsoft.com/en-us/library/bb776391(VS.85).aspx
77
 
    def __init__(self, exit_state):
78
 
        self.exit_state = exit_state
79
 
        self.count = 1
80
 
 
81
 
    def process(self, next_char, context):
82
 
        if next_char == u'\\':
83
 
            self.count += 1
84
 
            return self
85
 
        elif next_char in context.allowed_quote_chars:
86
 
            # 2N backslashes followed by a quote are N backslashes
87
 
            context.token.append(u'\\' * (self.count/2))
88
 
            # 2N+1 backslashes follwed by a quote are N backslashes followed by
89
 
            # the quote which should not be processed as the start or end of
90
 
            # the quoted arg
91
 
            if self.count % 2 == 1:
92
 
                # odd number of \ escapes the quote
93
 
                context.token.append(next_char)
94
 
            else:
95
 
                # let exit_state handle next_char
96
 
                context.seq.pushback(next_char)
97
 
            self.count = 0
98
 
            return self.exit_state
99
 
        else:
100
 
            # N backslashes not followed by a quote are just N backslashes
101
 
            if self.count > 0:
102
 
                context.token.append(u'\\' * self.count)
103
 
                self.count = 0
104
 
            # let exit_state handle next_char
105
 
            context.seq.pushback(next_char)
106
 
            return self.exit_state
107
 
 
108
 
    def finish(self, context):
109
 
        if self.count > 0:
110
 
            context.token.append(u'\\' * self.count)
111
 
 
112
 
 
113
 
class _Word(object):
114
 
    def process(self, next_char, context):
115
 
        if _whitespace_match(next_char):
116
 
            return None
117
 
        elif next_char in context.allowed_quote_chars:
118
 
            return _Quotes(next_char, self)
119
 
        elif next_char == u'\\':
120
 
            return _Backslash(self)
121
 
        else:
122
 
            context.token.append(next_char)
123
 
            return self
124
 
 
125
 
 
126
 
class Splitter(object):
127
 
    def __init__(self, command_line, single_quotes_allowed):
128
 
        self.seq = _PushbackSequence(command_line)
129
 
        self.allowed_quote_chars = u'"'
130
 
        if single_quotes_allowed:
131
 
            self.allowed_quote_chars += u"'"
132
 
 
133
 
    def __iter__(self):
134
 
        return self
135
 
 
136
 
    def next(self):
137
 
        quoted, token = self._get_token()
138
 
        if token is None:
139
 
            raise StopIteration
140
 
        return quoted, token
141
 
 
142
 
    def _get_token(self):
143
 
        self.quoted = False
144
 
        self.token = []
145
 
        state = _Whitespace()
146
 
        for next_char in self.seq:
147
 
            state = state.process(next_char, self)
148
 
            if state is None:
149
 
                break
150
 
        if not state is None and not getattr(state, 'finish', None) is None:
151
 
            state.finish(self)
152
 
        result = u''.join(self.token)
153
 
        if not self.quoted and result == '':
154
 
            result = None
155
 
        return self.quoted, result
156
 
 
157
 
 
158
 
def split(unsplit, single_quotes_allowed=True):
159
 
    splitter = Splitter(unsplit, single_quotes_allowed=single_quotes_allowed)
160
 
    return [arg for quoted, arg in splitter]