← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/treebuilder.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-21 22:29:49 UTC
  • Revision ID: mbp@sourcefrog.net-20050321222949-232c2093a6eadd80
fixup doctest for new module structure

Show diffs side-by-side

added added

removed removed

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