/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/revisiontree.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/revisiontree.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""RevisionTree - a Tree implementation backed by repository data for a revision."""
18
18
 
19
19
from cStringIO import StringIO
20
20
 
21
21
from bzrlib import (
22
 
    errors,
 
22
    osutils,
23
23
    revision,
24
 
    tree,
 
24
    symbol_versioning,
25
25
    )
26
 
 
27
 
 
28
 
class RevisionTree(tree.Tree):
 
26
from bzrlib.tree import Tree
 
27
 
 
28
 
 
29
class RevisionTree(Tree):
29
30
    """Tree viewing a previous revision.
30
31
 
31
32
    File text can be retrieved from the text store.
32
33
    """
33
 
 
 
34
    
34
35
    def __init__(self, branch, inv, revision_id):
35
 
        # for compatability the 'branch' parameter has not been renamed to
 
36
        # for compatability the 'branch' parameter has not been renamed to 
36
37
        # repository at this point. However, we should change RevisionTree's
37
 
        # construction to always be via Repository and not via direct
 
38
        # construction to always be via Repository and not via direct 
38
39
        # construction - this will mean that we can change the constructor
39
40
        # with much less chance of breaking client code.
40
41
        self._repository = branch
 
42
        self._weave_store = branch.weave_store
41
43
        self._inventory = inv
42
44
        self._revision_id = revision_id
43
 
        self._rules_searcher = None
44
45
 
45
46
    def supports_tree_reference(self):
46
 
        return getattr(self._repository._format, "supports_tree_reference",
47
 
            False)
 
47
        return True
48
48
 
49
49
    def get_parent_ids(self):
50
50
        """See Tree.get_parent_ids.
57
57
            parent_ids = self._repository.get_revision(
58
58
                self._revision_id).parent_ids
59
59
        return parent_ids
60
 
 
 
60
        
61
61
    def get_revision_id(self):
62
62
        """Return the revision id associated with this tree."""
63
63
        return self._revision_id
64
64
 
65
 
    def get_file_text(self, file_id, path=None):
66
 
        _, content = list(self.iter_files_bytes([(file_id, None)]))[0]
67
 
        return ''.join(content)
 
65
    @symbol_versioning.deprecated_method(symbol_versioning.zero_ninety)
 
66
    def get_weave(self, file_id):
 
67
        return self._get_weave(file_id)
 
68
 
 
69
    def _get_weave(self, file_id):
 
70
        return self._weave_store.get_weave(file_id,
 
71
                self._repository.get_transaction())
 
72
 
 
73
    def get_file_lines(self, file_id):
 
74
        ie = self._inventory[file_id]
 
75
        weave = self._get_weave(file_id)
 
76
        return weave.get_lines(ie.revision)
 
77
 
 
78
    def get_file_text(self, file_id):
 
79
        return ''.join(self.get_file_lines(file_id))
68
80
 
69
81
    def get_file(self, file_id, path=None):
70
82
        return StringIO(self.get_file_text(file_id))
71
83
 
72
84
    def iter_files_bytes(self, desired_files):
73
 
        """See Tree.iter_files_bytes.
 
85
        """See Tree.extract_files_bytes.
74
86
 
75
87
        This version is implemented on top of Repository.extract_files_bytes"""
76
88
        repo_desired_files = [(f, self.inventory[f].revision, i)
77
89
                              for f, i in desired_files]
78
 
        try:
79
 
            for result in self._repository.iter_files_bytes(repo_desired_files):
80
 
                yield result
81
 
        except errors.RevisionNotPresent, e:
82
 
            raise errors.NoSuchFile(e.revision_id)
 
90
        return self._repository.iter_files_bytes(repo_desired_files)
83
91
 
84
92
    def annotate_iter(self, file_id,
85
93
                      default_revision=revision.CURRENT_REVISION):
86
94
        """See Tree.annotate_iter"""
87
 
        text_key = (file_id, self.inventory[file_id].revision)
88
 
        annotator = self._repository.texts.get_annotator()
89
 
        annotations = annotator.annotate_flat(text_key)
90
 
        return [(key[-1], line) for key, line in annotations]
 
95
        w = self._get_weave(file_id)
 
96
        return w.annotate_iter(self.inventory[file_id].revision)
91
97
 
92
98
    def get_file_size(self, file_id):
93
 
        """See Tree.get_file_size"""
94
99
        return self._inventory[file_id].text_size
95
100
 
96
101
    def get_file_sha1(self, file_id, path=None, stat_value=None):
101
106
 
102
107
    def get_file_mtime(self, file_id, path=None):
103
108
        ie = self._inventory[file_id]
104
 
        try:
105
 
            revision = self._repository.get_revision(ie.revision)
106
 
        except errors.NoSuchRevision:
107
 
            raise errors.FileTimestampUnavailable(self.id2path(file_id))
 
109
        revision = self._repository.get_revision(ie.revision)
108
110
        return revision.timestamp
109
111
 
110
112
    def is_executable(self, file_id, path=None):
116
118
    def has_filename(self, filename):
117
119
        return bool(self.inventory.path2id(filename))
118
120
 
119
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
121
    def list_files(self, include_root=False):
120
122
        # The only files returned by this are those from the version
121
 
        inv = self.inventory
122
 
        if from_dir is None:
123
 
            from_dir_id = None
124
 
        else:
125
 
            from_dir_id = inv.path2id(from_dir)
126
 
            if from_dir_id is None:
127
 
                # Directory not versioned
128
 
                return
129
 
        entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
130
 
        if inv.root is not None and not include_root and from_dir is None:
 
123
        entries = self.inventory.iter_entries()
 
124
        # skip the root for compatability with the current apis.
 
125
        if self.inventory.root is not None and not include_root:
131
126
            # skip the root for compatability with the current apis.
132
127
            entries.next()
133
128
        for path, entry in entries:
135
130
 
136
131
    def get_symlink_target(self, file_id):
137
132
        ie = self._inventory[file_id]
138
 
        # Inventories store symlink targets in unicode
139
 
        return ie.symlink_target
 
133
        return ie.symlink_target;
140
134
 
141
135
    def get_reference_revision(self, file_id, path=None):
142
136
        return self.inventory[file_id].reference_revision
168
162
        return entry.kind, entry.executable, None
169
163
 
170
164
    def _file_size(self, entry, stat_value):
 
165
        assert entry.text_size is not None
171
166
        return entry.text_size
172
167
 
173
168
    def _get_ancestors(self, default_revision):
212
207
            for dir in reversed(dirblock):
213
208
                if dir[2] == _directory:
214
209
                    pending.append(dir)
215
 
 
216
 
    def _get_rules_searcher(self, default_searcher):
217
 
        """See Tree._get_rules_searcher."""
218
 
        if self._rules_searcher is None:
219
 
            self._rules_searcher = super(RevisionTree,
220
 
                self)._get_rules_searcher(default_searcher)
221
 
        return self._rules_searcher
222
 
 
223
 
 
224
 
class InterCHKRevisionTree(tree.InterTree):
225
 
    """Fast path optimiser for RevisionTrees with CHK inventories."""
226
 
 
227
 
    @staticmethod
228
 
    def is_compatible(source, target):
229
 
        if (isinstance(source, RevisionTree)
230
 
            and isinstance(target, RevisionTree)):
231
 
            try:
232
 
                # Only CHK inventories have id_to_entry attribute
233
 
                source.inventory.id_to_entry
234
 
                target.inventory.id_to_entry
235
 
                return True
236
 
            except AttributeError:
237
 
                pass
238
 
        return False
239
 
 
240
 
    def iter_changes(self, include_unchanged=False,
241
 
                     specific_files=None, pb=None, extra_trees=[],
242
 
                     require_versioned=True, want_unversioned=False):
243
 
        lookup_trees = [self.source]
244
 
        if extra_trees:
245
 
             lookup_trees.extend(extra_trees)
246
 
        # The ids of items we need to examine to insure delta consistency.
247
 
        precise_file_ids = set()
248
 
        discarded_changes = {}
249
 
        if specific_files == []:
250
 
            specific_file_ids = []
251
 
        else:
252
 
            specific_file_ids = self.target.paths2ids(specific_files,
253
 
                lookup_trees, require_versioned=require_versioned)
254
 
        # FIXME: It should be possible to delegate include_unchanged handling
255
 
        # to CHKInventory.iter_changes and do a better job there -- vila
256
 
        # 20090304
257
 
        changed_file_ids = set()
258
 
        for result in self.target.inventory.iter_changes(self.source.inventory):
259
 
            if specific_file_ids is not None:
260
 
                file_id = result[0]
261
 
                if file_id not in specific_file_ids:
262
 
                    # A change from the whole tree that we don't want to show yet.
263
 
                    # We may find that we need to show it for delta consistency, so
264
 
                    # stash it.
265
 
                    discarded_changes[result[0]] = result
266
 
                    continue
267
 
                new_parent_id = result[4][1]
268
 
                precise_file_ids.add(new_parent_id)
269
 
            yield result
270
 
            changed_file_ids.add(result[0])
271
 
        if specific_file_ids is not None:
272
 
            for result in self._handle_precise_ids(precise_file_ids,
273
 
                changed_file_ids, discarded_changes=discarded_changes):
274
 
                yield result
275
 
        if include_unchanged:
276
 
            # CHKMap avoid being O(tree), so we go to O(tree) only if
277
 
            # required to.
278
 
            # Now walk the whole inventory, excluding the already yielded
279
 
            # file ids
280
 
            changed_file_ids = set(changed_file_ids)
281
 
            for relpath, entry in self.target.inventory.iter_entries():
282
 
                if (specific_file_ids is not None
283
 
                    and not entry.file_id in specific_file_ids):
284
 
                    continue
285
 
                if not entry.file_id in changed_file_ids:
286
 
                    yield (entry.file_id,
287
 
                           (relpath, relpath), # Not renamed
288
 
                           False, # Not modified
289
 
                           (True, True), # Still  versioned
290
 
                           (entry.parent_id, entry.parent_id),
291
 
                           (entry.name, entry.name),
292
 
                           (entry.kind, entry.kind),
293
 
                           (entry.executable, entry.executable))
294
 
 
295
 
 
296
 
tree.InterTree.register_optimiser(InterCHKRevisionTree)