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

  • Committer: Jelmer Vernooij
  • Date: 2018-02-18 19:18:40 UTC
  • mto: This revision was merged to the branch mainline in revision 6928.
  • Revision ID: jelmer@jelmer.uk-20180218191840-2wezg20u9ffbfmed
Fix more bees, use with rather than try/finally for some files.

Show diffs side-by-side

added added

removed removed

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