/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/branchbuilder.py

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branchbuilder.py
16
16
 
17
17
"""Utility for create branches with particular contents."""
18
18
 
19
 
from __future__ import absolute_import
20
 
 
21
 
from . import (
22
 
    controldir,
 
19
from bzrlib import (
 
20
    bzrdir,
23
21
    commit,
24
22
    errors,
25
 
    revision,
26
 
    )
27
 
from .sixish import (
28
 
    viewitems,
 
23
    memorytree,
29
24
    )
30
25
 
31
26
 
41
36
 
42
37
    For instance:
43
38
 
44
 
    >>> from breezy.transport.memory import MemoryTransport
 
39
    >>> from bzrlib.transport.memory import MemoryTransport
45
40
    >>> builder = BranchBuilder(MemoryTransport("memory:///"))
46
41
    >>> builder.start_series()
47
 
    >>> builder.build_snapshot(None, [
48
 
    ...     ('add', ('', b'root-id', 'directory', '')),
49
 
    ...     ('add', ('filename', b'f-id', 'file', b'content\n'))],
50
 
    ...     revision_id=b'rev-id')
 
42
    >>> builder.build_snapshot('rev-id', None, [
 
43
    ...     ('add', ('', 'root-id', 'directory', '')),
 
44
    ...     ('add', ('filename', 'f-id', 'file', 'content\n'))])
51
45
    'rev-id'
52
 
    >>> builder.build_snapshot([b'rev-id'],
53
 
    ...     [('modify', ('filename', b'new-content\n'))],
54
 
    ...     revision_id=b'rev2-id')
 
46
    >>> builder.build_snapshot('rev2-id', ['rev-id'],
 
47
    ...     [('modify', ('f-id', 'new-content\n'))])
55
48
    'rev2-id'
56
49
    >>> builder.finish_series()
57
50
    >>> branch = builder.get_branch()
70
63
            If the path of the transport does not exist but its parent does
71
64
            it will be created.
72
65
        :param format: Either a BzrDirFormat, or the name of a format in the
73
 
            controldir format registry for the branch to be built.
 
66
            bzrdir format registry for the branch to be built.
74
67
        :param branch: An already constructed branch to use.  This param is
75
68
            mutually exclusive with the transport and format params.
76
69
        """
88
81
            if format is None:
89
82
                format = 'default'
90
83
            if isinstance(format, str):
91
 
                format = controldir.format_registry.make_controldir(format)
92
 
            self._branch = controldir.ControlDir.create_branch_convenience(
 
84
                format = bzrdir.format_registry.make_bzrdir(format)
 
85
            self._branch = bzrdir.BzrDir.create_branch_convenience(
93
86
                transport.base, format=format, force_new_tree=False)
94
87
        self._tree = None
95
88
 
96
 
    def build_commit(self, parent_ids=None, allow_leftmost_as_ghost=False,
97
 
                     **commit_kwargs):
 
89
    def build_commit(self, **commit_kwargs):
98
90
        """Build a commit on the branch.
99
91
 
100
92
        This makes a commit with no real file content for when you only want
103
95
        :param commit_kwargs: Arguments to pass through to commit, such as
104
96
             timestamp.
105
97
        """
106
 
        if parent_ids is not None:
107
 
            if len(parent_ids) == 0:
108
 
                base_id = revision.NULL_REVISION
109
 
            else:
110
 
                base_id = parent_ids[0]
111
 
            if base_id != self._branch.last_revision():
112
 
                self._move_branch_pointer(
113
 
                    base_id, allow_leftmost_as_ghost=allow_leftmost_as_ghost)
114
 
        tree = self._branch.create_memorytree()
115
 
        with tree.lock_write():
116
 
            if parent_ids is not None:
117
 
                tree.set_parent_ids(
118
 
                    parent_ids,
119
 
                    allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
98
        tree = memorytree.MemoryTree.create_on_branch(self._branch)
 
99
        tree.lock_write()
 
100
        try:
120
101
            tree.add('')
121
102
            return self._do_commit(tree, **commit_kwargs)
 
103
        finally:
 
104
            tree.unlock()
122
105
 
123
106
    def _do_commit(self, tree, message=None, message_callback=None, **kwargs):
124
107
        reporter = commit.NullCommitReporter()
125
108
        if message is None and message_callback is None:
126
109
            message = u'commit %d' % (self._branch.revno() + 1,)
127
110
        return tree.commit(message, message_callback=message_callback,
128
 
                           reporter=reporter, **kwargs)
 
111
            reporter=reporter,
 
112
            **kwargs)
129
113
 
130
114
    def _move_branch_pointer(self, new_revision_id,
131
 
                             allow_leftmost_as_ghost=False):
 
115
        allow_leftmost_as_ghost=False):
132
116
        """Point self._branch to a different revision id."""
133
 
        with self._branch.lock_write():
 
117
        self._branch.lock_write()
 
118
        try:
134
119
            # We don't seem to have a simple set_last_revision(), so we
135
120
            # implement it here.
136
121
            cur_revno, cur_revision_id = self._branch.last_revision_info()
137
122
            try:
138
123
                g = self._branch.repository.get_graph()
139
 
                new_revno = g.find_distance_to_null(
140
 
                    new_revision_id, [(cur_revision_id, cur_revno)])
 
124
                new_revno = g.find_distance_to_null(new_revision_id,
 
125
                    [(cur_revision_id, cur_revno)])
141
126
                self._branch.set_last_revision_info(new_revno, new_revision_id)
142
127
            except errors.GhostRevisionsHaveNoRevno:
143
128
                if not allow_leftmost_as_ghost:
144
129
                    raise
145
130
                new_revno = 1
 
131
        finally:
 
132
            self._branch.unlock()
146
133
        if self._tree is not None:
147
134
            # We are currently processing a series, but when switching branch
148
135
            # pointers, it is easiest to just create a new memory tree.
150
137
            # We are cheating a little bit here, and locking the new tree
151
138
            # before the old tree is unlocked. But that way the branch stays
152
139
            # locked throughout.
153
 
            new_tree = self._branch.create_memorytree()
 
140
            new_tree = memorytree.MemoryTree.create_on_branch(self._branch)
154
141
            new_tree.lock_write()
155
142
            self._tree.unlock()
156
143
            self._tree = new_tree
165
152
        if self._tree is not None:
166
153
            raise AssertionError('You cannot start a new series while a'
167
154
                                 ' series is already going.')
168
 
        self._tree = self._branch.create_memorytree()
 
155
        self._tree = memorytree.MemoryTree.create_on_branch(self._branch)
169
156
        self._tree.lock_write()
170
157
 
171
158
    def finish_series(self):
173
160
        self._tree.unlock()
174
161
        self._tree = None
175
162
 
176
 
    def build_snapshot(self, parent_ids, actions, message=None, timestamp=None,
177
 
                       allow_leftmost_as_ghost=False, committer=None,
178
 
                       timezone=None, message_callback=None, revision_id=None):
 
163
    def build_snapshot(self, revision_id, parent_ids, actions,
 
164
        message=None, timestamp=None, allow_leftmost_as_ghost=False,
 
165
        committer=None, timezone=None, message_callback=None):
179
166
        """Build a commit, shaped in a specific way.
180
167
 
181
 
        Most of the actions are self-explanatory.  'flush' is special action to
182
 
        break a series of actions into discrete steps so that complex changes
183
 
        (such as unversioning a file-id and re-adding it with a different kind)
184
 
        can be expressed in a way that will clearly work.
185
 
 
 
168
        :param revision_id: The handle for the new commit, can be None
186
169
        :param parent_ids: A list of parent_ids to use for the commit.
187
170
            It can be None, which indicates to use the last commit.
188
171
        :param actions: A list of actions to perform. Supported actions are:
189
 
            ('add', ('path', b'file-id', 'kind', b'content' or None))
190
 
            ('modify', ('path', b'new-content'))
191
 
            ('unversion', 'path')
 
172
            ('add', ('path', 'file-id', 'kind', 'content' or None))
 
173
            ('modify', ('file-id', 'new-content'))
 
174
            ('unversion', 'file-id')
192
175
            ('rename', ('orig-path', 'new-path'))
193
 
            ('flush', None)
194
176
        :param message: An optional commit message, if not supplied, a default
195
177
            commit message will be written.
196
178
        :param message_callback: A message callback to use for the commit, as
201
183
        :param committer: An optional username to use for commit
202
184
        :param allow_leftmost_as_ghost: True if the leftmost parent should be
203
185
            permitted to be a ghost.
204
 
        :param revision_id: The handle for the new commit, can be None
205
186
        :return: The revision_id of the new commit
206
187
        """
207
188
        if parent_ids is not None:
208
 
            if len(parent_ids) == 0:
209
 
                base_id = revision.NULL_REVISION
210
 
            else:
211
 
                base_id = parent_ids[0]
 
189
            base_id = parent_ids[0]
212
190
            if base_id != self._branch.last_revision():
213
 
                self._move_branch_pointer(
214
 
                    base_id, allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
191
                self._move_branch_pointer(base_id,
 
192
                    allow_leftmost_as_ghost=allow_leftmost_as_ghost)
215
193
 
216
194
        if self._tree is not None:
217
195
            tree = self._tree
218
196
        else:
219
 
            tree = self._branch.create_memorytree()
220
 
        with tree.lock_write():
 
197
            tree = memorytree.MemoryTree.create_on_branch(self._branch)
 
198
        tree.lock_write()
 
199
        try:
221
200
            if parent_ids is not None:
222
 
                tree.set_parent_ids(
223
 
                    parent_ids,
 
201
                tree.set_parent_ids(parent_ids,
224
202
                    allow_leftmost_as_ghost=allow_leftmost_as_ghost)
225
203
            # Unfortunately, MemoryTree.add(directory) just creates an
226
204
            # inventory entry. And the only public function to create a
227
205
            # directory is MemoryTree.mkdir() which creates the directory, but
228
206
            # also always adds it. So we have to use a multi-pass setup.
229
 
            pending = _PendingActions()
 
207
            to_add_directories = []
 
208
            to_add_files = []
 
209
            to_add_file_ids = []
 
210
            to_add_kinds = []
 
211
            new_contents = {}
 
212
            to_unversion_ids = []
 
213
            to_rename = []
230
214
            for action, info in actions:
231
215
                if action == 'add':
232
216
                    path, file_id, kind, content = info
233
217
                    if kind == 'directory':
234
 
                        pending.to_add_directories.append((path, file_id))
 
218
                        to_add_directories.append((path, file_id))
235
219
                    else:
236
 
                        pending.to_add_files.append(path)
237
 
                        pending.to_add_file_ids.append(file_id)
238
 
                        pending.to_add_kinds.append(kind)
 
220
                        to_add_files.append(path)
 
221
                        to_add_file_ids.append(file_id)
 
222
                        to_add_kinds.append(kind)
239
223
                        if content is not None:
240
 
                            pending.new_contents[path] = content
 
224
                            new_contents[file_id] = content
241
225
                elif action == 'modify':
242
 
                    path, content = info
243
 
                    pending.new_contents[path] = content
 
226
                    file_id, content = info
 
227
                    new_contents[file_id] = content
244
228
                elif action == 'unversion':
245
 
                    pending.to_unversion_paths.add(info)
 
229
                    to_unversion_ids.append(info)
246
230
                elif action == 'rename':
247
231
                    from_relpath, to_relpath = info
248
 
                    pending.to_rename.append((from_relpath, to_relpath))
249
 
                elif action == 'flush':
250
 
                    self._flush_pending(tree, pending)
251
 
                    pending = _PendingActions()
 
232
                    to_rename.append((from_relpath, to_relpath))
252
233
                else:
253
234
                    raise ValueError('Unknown build action: "%s"' % (action,))
254
 
            self._flush_pending(tree, pending)
255
 
            return self._do_commit(
256
 
                tree, message=message, rev_id=revision_id,
 
235
            if to_unversion_ids:
 
236
                tree.unversion(to_unversion_ids)
 
237
            for path, file_id in to_add_directories:
 
238
                if path == '':
 
239
                    # Special case, because the path already exists
 
240
                    tree.add([path], [file_id], ['directory'])
 
241
                else:
 
242
                    tree.mkdir(path, file_id)
 
243
            for from_relpath, to_relpath in to_rename:
 
244
                tree.rename_one(from_relpath, to_relpath)
 
245
            tree.add(to_add_files, to_add_file_ids, to_add_kinds)
 
246
            for file_id, content in new_contents.iteritems():
 
247
                tree.put_file_bytes_non_atomic(file_id, content)
 
248
            return self._do_commit(tree, message=message, rev_id=revision_id,
257
249
                timestamp=timestamp, timezone=timezone, committer=committer,
258
250
                message_callback=message_callback)
259
 
 
260
 
    def _flush_pending(self, tree, pending):
261
 
        """Flush the pending actions in 'pending', i.e. apply them to tree."""
262
 
        for path, file_id in pending.to_add_directories:
263
 
            if path == '':
264
 
                if tree.has_filename(path) \
265
 
                        and path in pending.to_unversion_paths:
266
 
                    # We're overwriting this path, no need to unversion
267
 
                    pending.to_unversion_paths.discard(path)
268
 
                # Special case, because the path already exists
269
 
                tree.add([path], [file_id], ['directory'])
270
 
            else:
271
 
                tree.mkdir(path, file_id)
272
 
        for from_relpath, to_relpath in pending.to_rename:
273
 
            tree.rename_one(from_relpath, to_relpath)
274
 
        if pending.to_unversion_paths:
275
 
            tree.unversion(pending.to_unversion_paths)
276
 
        tree.add(pending.to_add_files, pending.to_add_file_ids,
277
 
                 pending.to_add_kinds)
278
 
        for path, content in viewitems(pending.new_contents):
279
 
            tree.put_file_bytes_non_atomic(path, content)
 
251
        finally:
 
252
            tree.unlock()
280
253
 
281
254
    def get_branch(self):
282
255
        """Return the branch created by the builder."""
283
256
        return self._branch
284
 
 
285
 
 
286
 
class _PendingActions(object):
287
 
    """Pending actions for build_snapshot to take.
288
 
 
289
 
    This is just a simple class to hold a bunch of the intermediate state of
290
 
    build_snapshot in single object.
291
 
    """
292
 
 
293
 
    def __init__(self):
294
 
        self.to_add_directories = []
295
 
        self.to_add_files = []
296
 
        self.to_add_file_ids = []
297
 
        self.to_add_kinds = []
298
 
        self.new_contents = {}
299
 
        self.to_unversion_paths = set()
300
 
        self.to_rename = []