/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: 2020-04-05 19:11:34 UTC
  • mto: (7490.7.16 work)
  • mto: This revision was merged to the branch mainline in revision 7501.
  • Revision ID: jelmer@jelmer.uk-20200405191134-0aebh8ikiwygxma5
Populate the .gitignore file.

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