← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branchbuilder.py

(spiv) Add a 'flush' action to BranchBuilder.build_snapshot. (Andrew
 Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branchbuilder.py
166
166
        committer=None, timezone=None, message_callback=None):
167
167
        """Build a commit, shaped in a specific way.
168
168
 
 
169
        Most of the actions are self-explanatory.  'flush' is special action to
 
170
        break a series of actions into discrete steps so that complex changes
 
171
        (such as unversioning a file-id and re-adding it with a different kind)
 
172
        can be expressed in a way that will clearly work.
 
173
 
169
174
        :param revision_id: The handle for the new commit, can be None
170
175
        :param parent_ids: A list of parent_ids to use for the commit.
171
176
            It can be None, which indicates to use the last commit.
174
179
            ('modify', ('file-id', 'new-content'))
175
180
            ('unversion', 'file-id')
176
181
            ('rename', ('orig-path', 'new-path'))
 
182
            ('flush', None)
177
183
        :param message: An optional commit message, if not supplied, a default
178
184
            commit message will be written.
179
185
        :param message_callback: A message callback to use for the commit, as
208
214
            # inventory entry. And the only public function to create a
209
215
            # directory is MemoryTree.mkdir() which creates the directory, but
210
216
            # also always adds it. So we have to use a multi-pass setup.
211
 
            to_add_directories = []
212
 
            to_add_files = []
213
 
            to_add_file_ids = []
214
 
            to_add_kinds = []
215
 
            new_contents = {}
216
 
            to_unversion_ids = []
217
 
            to_rename = []
 
217
            pending = _PendingActions()
218
218
            for action, info in actions:
219
219
                if action == 'add':
220
220
                    path, file_id, kind, content = info
221
221
                    if kind == 'directory':
222
 
                        to_add_directories.append((path, file_id))
 
222
                        pending.to_add_directories.append((path, file_id))
223
223
                    else:
224
 
                        to_add_files.append(path)
225
 
                        to_add_file_ids.append(file_id)
226
 
                        to_add_kinds.append(kind)
 
224
                        pending.to_add_files.append(path)
 
225
                        pending.to_add_file_ids.append(file_id)
 
226
                        pending.to_add_kinds.append(kind)
227
227
                        if content is not None:
228
 
                            new_contents[file_id] = content
 
228
                            pending.new_contents[file_id] = content
229
229
                elif action == 'modify':
230
230
                    file_id, content = info
231
 
                    new_contents[file_id] = content
 
231
                    pending.new_contents[file_id] = content
232
232
                elif action == 'unversion':
233
 
                    to_unversion_ids.append(info)
 
233
                    pending.to_unversion_ids.add(info)
234
234
                elif action == 'rename':
235
235
                    from_relpath, to_relpath = info
236
 
                    to_rename.append((from_relpath, to_relpath))
 
236
                    pending.to_rename.append((from_relpath, to_relpath))
 
237
                elif action == 'flush':
 
238
                    self._flush_pending(tree, pending)
 
239
                    pending = _PendingActions()
237
240
                else:
238
241
                    raise ValueError('Unknown build action: "%s"' % (action,))
239
 
            if to_unversion_ids:
240
 
                tree.unversion(to_unversion_ids)
241
 
            for path, file_id in to_add_directories:
242
 
                if path == '':
243
 
                    # Special case, because the path already exists
244
 
                    tree.add([path], [file_id], ['directory'])
245
 
                else:
246
 
                    tree.mkdir(path, file_id)
247
 
            for from_relpath, to_relpath in to_rename:
248
 
                tree.rename_one(from_relpath, to_relpath)
249
 
            tree.add(to_add_files, to_add_file_ids, to_add_kinds)
250
 
            for file_id, content in new_contents.iteritems():
251
 
                tree.put_file_bytes_non_atomic(file_id, content)
 
242
            self._flush_pending(tree, pending)
252
243
            return self._do_commit(tree, message=message, rev_id=revision_id,
253
244
                timestamp=timestamp, timezone=timezone, committer=committer,
254
245
                message_callback=message_callback)
255
246
        finally:
256
247
            tree.unlock()
257
248
 
 
249
    def _flush_pending(self, tree, pending):
 
250
        """Flush the pending actions in 'pending', i.e. apply them to 'tree'."""
 
251
        for path, file_id in pending.to_add_directories:
 
252
            if path == '':
 
253
                old_id = tree.path2id(path)
 
254
                if old_id is not None and old_id in pending.to_unversion_ids:
 
255
                    # We're overwriting this path, no need to unversion
 
256
                    pending.to_unversion_ids.discard(old_id)
 
257
                # Special case, because the path already exists
 
258
                tree.add([path], [file_id], ['directory'])
 
259
            else:
 
260
                tree.mkdir(path, file_id)
 
261
        for from_relpath, to_relpath in pending.to_rename:
 
262
            tree.rename_one(from_relpath, to_relpath)
 
263
        if pending.to_unversion_ids:
 
264
            tree.unversion(pending.to_unversion_ids)
 
265
        tree.add(pending.to_add_files, pending.to_add_file_ids, pending.to_add_kinds)
 
266
        for file_id, content in pending.new_contents.iteritems():
 
267
            tree.put_file_bytes_non_atomic(file_id, content)
 
268
 
258
269
    def get_branch(self):
259
270
        """Return the branch created by the builder."""
260
271
        return self._branch
 
272
 
 
273
 
 
274
class _PendingActions(object):
 
275
    """Pending actions for build_snapshot to take.
 
276
 
 
277
    This is just a simple class to hold a bunch of the intermediate state of
 
278
    build_snapshot in single object.
 
279
    """
 
280
 
 
281
    def __init__(self):
 
282
        self.to_add_directories = []
 
283
        self.to_add_files = []
 
284
        self.to_add_file_ids = []
 
285
        self.to_add_kinds = []
 
286
        self.new_contents = {}
 
287
        self.to_unversion_ids = set()
 
288
        self.to_rename = []
 
289