← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/push.py

  • Committer: Vincent Ladeuil
  • Date: 2010-04-23 08:51:52 UTC
  • mfrom: (5131.2.6 support_OO_flag)
  • mto: This revision was merged to the branch mainline in revision 5179.
  • Revision ID: v.ladeuil+lp@free.fr-20100423085152-uoewc1vnkwqhw0pj
Manually assign docstrings to command objects, so that they work with python -OO

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