/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/xml4.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/xml4.py
 
1
# Copyright (C) 2005, 2006 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
from bzrlib.xml_serializer import ElementTree, SubElement, Element, Serializer
 
18
from bzrlib.inventory import ROOT_ID, Inventory, InventoryEntry
 
19
import bzrlib.inventory as inventory
 
20
from bzrlib.revision import Revision
 
21
from bzrlib.errors import BzrError
 
22
 
 
23
 
 
24
class _Serializer_v4(Serializer):
 
25
    """Version 0.0.4 serializer
 
26
 
 
27
    You should use the serializer_v4 singleton.
 
28
    
 
29
    v4 serialisation is no longer supported, only deserialisation.
 
30
    """
 
31
    
 
32
    __slots__ = []
 
33
    
 
34
    def _pack_entry(self, ie):
 
35
        """Convert InventoryEntry to XML element"""
 
36
        e = Element('entry')
 
37
        e.set('name', ie.name)
 
38
        e.set('file_id', ie.file_id)
 
39
        e.set('kind', ie.kind)
 
40
 
 
41
        if ie.text_size is not None:
 
42
            e.set('text_size', '%d' % ie.text_size)
 
43
 
 
44
        for f in ['text_id', 'text_sha1', 'symlink_target']:
 
45
            v = getattr(ie, f)
 
46
            if v is not None:
 
47
                e.set(f, v)
 
48
 
 
49
        # to be conservative, we don't externalize the root pointers
 
50
        # for now, leaving them as null in the xml form.  in a future
 
51
        # version it will be implied by nested elements.
 
52
        if ie.parent_id != ROOT_ID:
 
53
            assert isinstance(ie.parent_id, basestring)
 
54
            e.set('parent_id', ie.parent_id)
 
55
 
 
56
        e.tail = '\n'
 
57
 
 
58
        return e
 
59
 
 
60
 
 
61
    def _unpack_inventory(self, elt, revision_id=None):
 
62
        """Construct from XML Element
 
63
 
 
64
        :param revision_id: Ignored parameter used by xml5.
 
65
        """
 
66
        assert elt.tag == 'inventory'
 
67
        root_id = elt.get('file_id') or ROOT_ID
 
68
        inv = Inventory(root_id)
 
69
        for e in elt:
 
70
            ie = self._unpack_entry(e)
 
71
            if ie.parent_id == ROOT_ID:
 
72
                ie.parent_id = root_id
 
73
            inv.add(ie)
 
74
        return inv
 
75
 
 
76
 
 
77
    def _unpack_entry(self, elt):
 
78
        assert elt.tag == 'entry'
 
79
 
 
80
        ## original format inventories don't have a parent_id for
 
81
        ## nodes in the root directory, but it's cleaner to use one
 
82
        ## internally.
 
83
        parent_id = elt.get('parent_id')
 
84
        if parent_id is None:
 
85
            parent_id = ROOT_ID
 
86
 
 
87
        kind = elt.get('kind')
 
88
        if kind == 'directory':
 
89
            ie = inventory.InventoryDirectory(elt.get('file_id'),
 
90
                                              elt.get('name'),
 
91
                                              parent_id)
 
92
        elif kind == 'file':
 
93
            ie = inventory.InventoryFile(elt.get('file_id'),
 
94
                                         elt.get('name'),
 
95
                                         parent_id)
 
96
            ie.text_id = elt.get('text_id')
 
97
            ie.text_sha1 = elt.get('text_sha1')
 
98
            v = elt.get('text_size')
 
99
            ie.text_size = v and int(v)
 
100
        elif kind == 'symlink':
 
101
            ie = inventory.InventoryLink(elt.get('file_id'),
 
102
                                         elt.get('name'),
 
103
                                         parent_id)
 
104
            ie.symlink_target = elt.get('symlink_target')
 
105
        else:
 
106
            raise BzrError("unknown kind %r" % kind)
 
107
 
 
108
        ## mutter("read inventoryentry: %r", elt.attrib)
 
109
 
 
110
        return ie
 
111
 
 
112
 
 
113
    def _pack_revision(self, rev):
 
114
        """Revision object -> xml tree"""
 
115
        root = Element('revision',
 
116
                       committer = rev.committer,
 
117
                       timestamp = '%.9f' % rev.timestamp,
 
118
                       revision_id = rev.revision_id,
 
119
                       inventory_id = rev.inventory_id,
 
120
                       inventory_sha1 = rev.inventory_sha1,
 
121
                       )
 
122
        if rev.timezone:
 
123
            root.set('timezone', str(rev.timezone))
 
124
        root.text = '\n'
 
125
 
 
126
        msg = SubElement(root, 'message')
 
127
        msg.text = rev.message
 
128
        msg.tail = '\n'
 
129
 
 
130
        if rev.parents:
 
131
            pelts = SubElement(root, 'parents')
 
132
            pelts.tail = pelts.text = '\n'
 
133
            for i, parent_id in enumerate(rev.parents):
 
134
                p = SubElement(pelts, 'revision_ref')
 
135
                p.tail = '\n'
 
136
                assert parent_id
 
137
                p.set('revision_id', parent_id)
 
138
                if i < len(rev.parent_sha1s):
 
139
                    p.set('revision_sha1', rev.parent_sha1s[i])
 
140
        return root
 
141
 
 
142
    
 
143
    def _unpack_revision(self, elt):
 
144
        """XML Element -> Revision object"""
 
145
        
 
146
        # <changeset> is deprecated...
 
147
        if elt.tag not in ('revision', 'changeset'):
 
148
            raise BzrError("unexpected tag in revision file: %r" % elt)
 
149
 
 
150
        rev = Revision(committer = elt.get('committer'),
 
151
                       timestamp = float(elt.get('timestamp')),
 
152
                       revision_id = elt.get('revision_id'),
 
153
                       inventory_id = elt.get('inventory_id'),
 
154
                       inventory_sha1 = elt.get('inventory_sha1')
 
155
                       )
 
156
 
 
157
        precursor = elt.get('precursor')
 
158
        precursor_sha1 = elt.get('precursor_sha1')
 
159
 
 
160
        pelts = elt.find('parents')
 
161
 
 
162
        if pelts:
 
163
            for p in pelts:
 
164
                assert p.tag == 'revision_ref', \
 
165
                       "bad parent node tag %r" % p.tag
 
166
                rev.parent_ids.append(p.get('revision_id'))
 
167
                rev.parent_sha1s.append(p.get('revision_sha1'))
 
168
            if precursor:
 
169
                # must be consistent
 
170
                prec_parent = rev.parent_ids[0]
 
171
                assert prec_parent == precursor
 
172
        elif precursor:
 
173
            # revisions written prior to 0.0.5 have a single precursor
 
174
            # give as an attribute
 
175
            rev.parent_ids.append(precursor)
 
176
            rev.parent_sha1s.append(precursor_sha1)
 
177
 
 
178
        v = elt.get('timezone')
 
179
        rev.timezone = v and int(v)
 
180
 
 
181
        rev.message = elt.findtext('message') # text of <message>
 
182
        return rev
 
183
 
 
184
 
 
185
 
 
186
 
 
187
"""singleton instance"""
 
188
serializer_v4 = _Serializer_v4()
 
189