/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/push.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/push.py
1
 
# Copyright (C) 2008, 2009, 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
 
"""UI helper for the push command."""
18
 
 
19
 
from bzrlib import (
20
 
    bzrdir,
21
 
    errors,
22
 
    revision as _mod_revision,
23
 
    transport,
24
 
    )
25
 
from bzrlib.trace import (
26
 
    note,
27
 
    warning,
28
 
    )
29
 
 
30
 
 
31
 
class PushResult(object):
32
 
    """Result of a push operation.
33
 
 
34
 
    :ivar branch_push_result: Result of a push between branches
35
 
    :ivar target_branch: The target branch
36
 
    :ivar stacked_on: URL of the branch on which the result is stacked
37
 
    :ivar workingtree_updated: Whether or not the target workingtree was updated.
38
 
    """
39
 
 
40
 
    def __init__(self):
41
 
        self.branch_push_result = None
42
 
        self.stacked_on = None
43
 
        self.workingtree_updated = None
44
 
        self.target_branch = None
45
 
 
46
 
    def report(self, to_file):
47
 
        """Write a human-readable description of the result."""
48
 
        if self.branch_push_result is None:
49
 
            if self.stacked_on is not None:
50
 
                note('Created new stacked branch referring to %s.' %
51
 
                    self.stacked_on)
52
 
            else:
53
 
                note('Created new branch.')
54
 
        else:
55
 
            self.branch_push_result.report(to_file)
56
 
 
57
 
 
58
 
def _show_push_branch(br_from, revision_id, location, to_file, verbose=False,
59
 
    overwrite=False, remember=False, stacked_on=None, create_prefix=False,
60
 
    use_existing_dir=False):
61
 
    """Push a branch to a location.
62
 
 
63
 
    :param br_from: the source branch
64
 
    :param revision_id: the revision-id to push up to
65
 
    :param location: the url of the destination
66
 
    :param to_file: the output stream
67
 
    :param verbose: if True, display more output than normal
68
 
    :param overwrite: if False, a current branch at the destination may not
69
 
        have diverged from the source, otherwise the push fails
70
 
    :param remember: if True, store the location as the push location for
71
 
        the source branch
72
 
    :param stacked_on: the url of the branch, if any, to stack on;
73
 
        if set, only the revisions not in that branch are pushed
74
 
    :param create_prefix: if True, create the necessary parent directories
75
 
        at the destination if they don't already exist
76
 
    :param use_existing_dir: if True, proceed even if the destination
77
 
        directory exists without a current .bzr directory in it
78
 
    """
79
 
    to_transport = transport.get_transport(location)
80
 
    try:
81
 
        dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
82
 
    except errors.NotBranchError:
83
 
        # Didn't find anything
84
 
        dir_to = None
85
 
 
86
 
    if dir_to is None:
87
 
        try:
88
 
            br_to = br_from.create_clone_on_transport(to_transport,
89
 
                revision_id=revision_id, stacked_on=stacked_on,
90
 
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
91
 
        except errors.FileExists, err:
92
 
            if err.path.endswith('/.bzr'):
93
 
                raise errors.BzrCommandError(
94
 
                    "Target directory %s already contains a .bzr directory, "
95
 
                    "but it is not valid." % (location,))
96
 
            if not use_existing_dir:
97
 
                raise errors.BzrCommandError("Target directory %s"
98
 
                     " already exists, but does not have a .bzr"
99
 
                     " directory. Supply --use-existing-dir to push"
100
 
                     " there anyway." % location)
101
 
            # This shouldn't occur, but if it does the FileExists error will be
102
 
            # more informative than an UnboundLocalError for br_to.
103
 
            raise
104
 
        except errors.NoSuchFile:
105
 
            if not create_prefix:
106
 
                raise errors.BzrCommandError("Parent directory of %s"
107
 
                    " does not exist."
108
 
                    "\nYou may supply --create-prefix to create all"
109
 
                    " leading parent directories."
110
 
                    % location)
111
 
            # This shouldn't occur (because create_prefix is true, so
112
 
            # create_clone_on_transport should be catching NoSuchFile and
113
 
            # creating the missing directories) but if it does the original
114
 
            # NoSuchFile error will be more informative than an
115
 
            # UnboundLocalError for br_to.
116
 
            raise
117
 
        except errors.TooManyRedirections:
118
 
            raise errors.BzrCommandError("Too many redirections trying "
119
 
                                         "to make %s." % location)
120
 
        push_result = PushResult()
121
 
        # TODO: Some more useful message about what was copied
122
 
        try:
123
 
            push_result.stacked_on = br_to.get_stacked_on_url()
124
 
        except (errors.UnstackableBranchFormat,
125
 
                errors.UnstackableRepositoryFormat,
126
 
                errors.NotStacked):
127
 
            push_result.stacked_on = None
128
 
        push_result.target_branch = br_to
129
 
        push_result.old_revid = _mod_revision.NULL_REVISION
130
 
        push_result.old_revno = 0
131
 
        if br_from.get_push_location() is None or remember:
132
 
            br_from.set_push_location(br_to.base)
133
 
    else:
134
 
        if stacked_on is not None:
135
 
            warning("Ignoring request for a stacked branch as repository "
136
 
                    "already exists at the destination location.")
137
 
        try:
138
 
            push_result = dir_to.push_branch(br_from, revision_id, overwrite, 
139
 
                remember, create_prefix)
140
 
        except errors.DivergedBranches:
141
 
            raise errors.BzrCommandError('These branches have diverged.'
142
 
                                    '  See "bzr help diverged-branches"'
143
 
                                    ' for more information.')
144
 
        except errors.NoRoundtrippingSupport, e:
145
 
            raise errors.BzrCommandError("It is not possible to losslessly "
146
 
                "push to %s. You may want to use dpush instead." % 
147
 
                    e.target_branch.mapping.vcs.abbreviation)
148
 
        except errors.NoRepositoryPresent:
149
 
            # we have a bzrdir but no branch or repository
150
 
            # XXX: Figure out what to do other than complain.
151
 
            raise errors.BzrCommandError("At %s you have a valid .bzr"
152
 
                " control directory, but not a branch or repository. This"
153
 
                " is an unsupported configuration. Please move the target"
154
 
                " directory out of the way and try again." % location)
155
 
        if push_result.workingtree_updated == False:
156
 
            warning("This transport does not update the working " 
157
 
                    "tree of: %s. See 'bzr help working-trees' for "
158
 
                    "more information." % push_result.target_branch.base)
159
 
    push_result.report(to_file)
160
 
    if verbose:
161
 
        br_to = push_result.target_branch
162
 
        br_to.lock_read()
163
 
        try:
164
 
            from bzrlib.log import show_branch_change
165
 
            show_branch_change(br_to, to_file, push_result.old_revno, 
166
 
                               push_result.old_revid)
167
 
        finally:
168
 
            br_to.unlock()
169
 
 
170