1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
# Copyright (C) 2006, 2008, 2009, 2010 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""TreeBuilder helper class.
TreeBuilders are used to build trees of various shapes or properties. This
can be extremely useful in testing for instance.
"""
from __future__ import absolute_import
from bzrlib import errors
class TreeBuilder(object):
"""A TreeBuilder allows the creation of specific content in one tree at a
time.
"""
def __init__(self):
"""Construct a TreeBuilder."""
self._tree = None
self._root_done = False
def build(self, recipe):
"""Build recipe into the current tree.
:param recipe: A sequence of paths. For each path, the corresponding
path in the current tree is created and added. If the path ends in
'/' then a directory is added, otherwise a regular file is added.
"""
self._ensure_building()
if not self._root_done:
self._tree.add('', 'root-id', 'directory')
self._root_done = True
for name in recipe:
if name[-1] == '/':
self._tree.mkdir(name[:-1])
else:
end = '\n'
content = "contents of %s%s" % (name.encode('utf-8'), end)
self._tree.add(name, None, 'file')
file_id = self._tree.path2id(name)
self._tree.put_file_bytes_non_atomic(file_id, content)
def _ensure_building(self):
"""Raise NotBuilding if there is no current tree being built."""
if self._tree is None:
raise errors.NotBuilding
def finish_tree(self):
"""Finish building the current tree."""
self._ensure_building()
tree = self._tree
self._tree = None
tree.unlock()
def start_tree(self, tree):
"""Start building on tree.
:param tree: A tree to start building on. It must provide the
MutableTree interface.
"""
if self._tree is not None:
raise errors.AlreadyBuilding
self._tree = tree
self._tree.lock_tree_write()
|