/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

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
23
    memorytree,
26
 
    revision,
27
 
    )
28
 
from .sixish import (
29
 
    viewitems,
30
24
    )
31
25
 
32
26
 
42
36
 
43
37
    For instance:
44
38
 
45
 
    >>> from breezy.transport.memory import MemoryTransport
 
39
    >>> from bzrlib.transport.memory import MemoryTransport
46
40
    >>> builder = BranchBuilder(MemoryTransport("memory:///"))
47
41
    >>> builder.start_series()
48
42
    >>> builder.build_snapshot('rev-id', None, [
69
63
            If the path of the transport does not exist but its parent does
70
64
            it will be created.
71
65
        :param format: Either a BzrDirFormat, or the name of a format in the
72
 
            controldir format registry for the branch to be built.
 
66
            bzrdir format registry for the branch to be built.
73
67
        :param branch: An already constructed branch to use.  This param is
74
68
            mutually exclusive with the transport and format params.
75
69
        """
87
81
            if format is None:
88
82
                format = 'default'
89
83
            if isinstance(format, str):
90
 
                format = controldir.format_registry.make_controldir(format)
91
 
            self._branch = controldir.ControlDir.create_branch_convenience(
 
84
                format = bzrdir.format_registry.make_bzrdir(format)
 
85
            self._branch = bzrdir.BzrDir.create_branch_convenience(
92
86
                transport.base, format=format, force_new_tree=False)
93
87
        self._tree = None
94
88
 
95
 
    def build_commit(self, parent_ids=None, allow_leftmost_as_ghost=False,
96
 
                     **commit_kwargs):
 
89
    def build_commit(self, **commit_kwargs):
97
90
        """Build a commit on the branch.
98
91
 
99
92
        This makes a commit with no real file content for when you only want
102
95
        :param commit_kwargs: Arguments to pass through to commit, such as
103
96
             timestamp.
104
97
        """
105
 
        if parent_ids is not None:
106
 
            if len(parent_ids) == 0:
107
 
                base_id = revision.NULL_REVISION
108
 
            else:
109
 
                base_id = parent_ids[0]
110
 
            if base_id != self._branch.last_revision():
111
 
                self._move_branch_pointer(base_id,
112
 
                    allow_leftmost_as_ghost=allow_leftmost_as_ghost)
113
98
        tree = memorytree.MemoryTree.create_on_branch(self._branch)
114
99
        tree.lock_write()
115
100
        try:
116
 
            if parent_ids is not None:
117
 
                tree.set_parent_ids(parent_ids,
118
 
                    allow_leftmost_as_ghost=allow_leftmost_as_ghost)
119
101
            tree.add('')
120
102
            return self._do_commit(tree, **commit_kwargs)
121
103
        finally:
183
165
        committer=None, timezone=None, message_callback=None):
184
166
        """Build a commit, shaped in a specific way.
185
167
 
186
 
        Most of the actions are self-explanatory.  'flush' is special action to
187
 
        break a series of actions into discrete steps so that complex changes
188
 
        (such as unversioning a file-id and re-adding it with a different kind)
189
 
        can be expressed in a way that will clearly work.
190
 
 
191
168
        :param revision_id: The handle for the new commit, can be None
192
169
        :param parent_ids: A list of parent_ids to use for the commit.
193
170
            It can be None, which indicates to use the last commit.
196
173
            ('modify', ('file-id', 'new-content'))
197
174
            ('unversion', 'file-id')
198
175
            ('rename', ('orig-path', 'new-path'))
199
 
            ('flush', None)
200
176
        :param message: An optional commit message, if not supplied, a default
201
177
            commit message will be written.
202
178
        :param message_callback: A message callback to use for the commit, as
210
186
        :return: The revision_id of the new commit
211
187
        """
212
188
        if parent_ids is not None:
213
 
            if len(parent_ids) == 0:
214
 
                base_id = revision.NULL_REVISION
215
 
            else:
216
 
                base_id = parent_ids[0]
 
189
            base_id = parent_ids[0]
217
190
            if base_id != self._branch.last_revision():
218
191
                self._move_branch_pointer(base_id,
219
192
                    allow_leftmost_as_ghost=allow_leftmost_as_ghost)
231
204
            # inventory entry. And the only public function to create a
232
205
            # directory is MemoryTree.mkdir() which creates the directory, but
233
206
            # also always adds it. So we have to use a multi-pass setup.
234
 
            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 = []
235
214
            for action, info in actions:
236
215
                if action == 'add':
237
216
                    path, file_id, kind, content = info
238
217
                    if kind == 'directory':
239
 
                        pending.to_add_directories.append((path, file_id))
 
218
                        to_add_directories.append((path, file_id))
240
219
                    else:
241
 
                        pending.to_add_files.append(path)
242
 
                        pending.to_add_file_ids.append(file_id)
243
 
                        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)
244
223
                        if content is not None:
245
 
                            pending.new_contents[file_id] = content
 
224
                            new_contents[file_id] = content
246
225
                elif action == 'modify':
247
226
                    file_id, content = info
248
 
                    pending.new_contents[file_id] = content
 
227
                    new_contents[file_id] = content
249
228
                elif action == 'unversion':
250
 
                    pending.to_unversion_ids.add(info)
 
229
                    to_unversion_ids.append(info)
251
230
                elif action == 'rename':
252
231
                    from_relpath, to_relpath = info
253
 
                    pending.to_rename.append((from_relpath, to_relpath))
254
 
                elif action == 'flush':
255
 
                    self._flush_pending(tree, pending)
256
 
                    pending = _PendingActions()
 
232
                    to_rename.append((from_relpath, to_relpath))
257
233
                else:
258
234
                    raise ValueError('Unknown build action: "%s"' % (action,))
259
 
            self._flush_pending(tree, pending)
 
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)
260
248
            return self._do_commit(tree, message=message, rev_id=revision_id,
261
249
                timestamp=timestamp, timezone=timezone, committer=committer,
262
250
                message_callback=message_callback)
263
251
        finally:
264
252
            tree.unlock()
265
253
 
266
 
    def _flush_pending(self, tree, pending):
267
 
        """Flush the pending actions in 'pending', i.e. apply them to 'tree'."""
268
 
        for path, file_id in pending.to_add_directories:
269
 
            if path == '':
270
 
                old_id = tree.path2id(path)
271
 
                if old_id is not None and old_id in pending.to_unversion_ids:
272
 
                    # We're overwriting this path, no need to unversion
273
 
                    pending.to_unversion_ids.discard(old_id)
274
 
                # Special case, because the path already exists
275
 
                tree.add([path], [file_id], ['directory'])
276
 
            else:
277
 
                tree.mkdir(path, file_id)
278
 
        for from_relpath, to_relpath in pending.to_rename:
279
 
            tree.rename_one(from_relpath, to_relpath)
280
 
        if pending.to_unversion_ids:
281
 
            tree.unversion(pending.to_unversion_ids)
282
 
        tree.add(pending.to_add_files, pending.to_add_file_ids, pending.to_add_kinds)
283
 
        for file_id, content in viewitems(pending.new_contents):
284
 
            tree.put_file_bytes_non_atomic(file_id, content)
285
 
 
286
254
    def get_branch(self):
287
255
        """Return the branch created by the builder."""
288
256
        return self._branch
289
 
 
290
 
 
291
 
class _PendingActions(object):
292
 
    """Pending actions for build_snapshot to take.
293
 
 
294
 
    This is just a simple class to hold a bunch of the intermediate state of
295
 
    build_snapshot in single object.
296
 
    """
297
 
 
298
 
    def __init__(self):
299
 
        self.to_add_directories = []
300
 
        self.to_add_files = []
301
 
        self.to_add_file_ids = []
302
 
        self.to_add_kinds = []
303
 
        self.new_contents = {}
304
 
        self.to_unversion_ids = set()
305
 
        self.to_rename = []
306