← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/treebuilder.py

  • Committer: Vincent Ladeuil
  • Date: 2013-08-09 15:09:23 UTC
  • mto: This revision was merged to the branch mainline in revision 6587.
  • Revision ID: v.ladeuil+lp@free.fr-20130809150923-y71dusyorep0hbkt
Fix various typos in docstrings. Rename 'buffer' to 'buf' since it's now a python builtin function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/treebuilder.py
 
1
# Copyright (C) 2006, 2008, 2009, 2010 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""TreeBuilder helper class.
 
18
 
 
19
TreeBuilders are used to build trees of various shapes or properties. This
 
20
can be extremely useful in testing for instance.
 
21
"""
 
22
 
 
23
from __future__ import absolute_import
 
24
 
 
25
from bzrlib import errors
 
26
 
 
27
 
 
28
class TreeBuilder(object):
 
29
    """A TreeBuilder allows the creation of specific content in one tree at a
 
30
    time.
 
31
    """
 
32
 
 
33
    def __init__(self):
 
34
        """Construct a TreeBuilder."""
 
35
        self._tree = None
 
36
        self._root_done = False
 
37
 
 
38
    def build(self, recipe):
 
39
        """Build recipe into the current tree.
 
40
 
 
41
        :param recipe: A sequence of paths. For each path, the corresponding
 
42
            path in the current tree is created and added. If the path ends in
 
43
            '/' then a directory is added, otherwise a regular file is added.
 
44
        """
 
45
        self._ensure_building()
 
46
        if not self._root_done:
 
47
            self._tree.add('', 'root-id', 'directory')
 
48
            self._root_done = True
 
49
        for name in recipe:
 
50
            if name[-1] == '/':
 
51
                self._tree.mkdir(name[:-1])
 
52
            else:
 
53
                end = '\n'
 
54
                content = "contents of %s%s" % (name.encode('utf-8'), end)
 
55
                self._tree.add(name, None, 'file')
 
56
                file_id = self._tree.path2id(name)
 
57
                self._tree.put_file_bytes_non_atomic(file_id, content)
 
58
 
 
59
    def _ensure_building(self):
 
60
        """Raise NotBuilding if there is no current tree being built."""
 
61
        if self._tree is None:
 
62
            raise errors.NotBuilding
 
63
 
 
64
    def finish_tree(self):
 
65
        """Finish building the current tree."""
 
66
        self._ensure_building()
 
67
        tree = self._tree
 
68
        self._tree = None
 
69
        tree.unlock()
 
70
 
 
71
    def start_tree(self, tree):
 
72
        """Start building on tree.
 
73
 
 
74
        :param tree: A tree to start building on. It must provide the
 
75
            MutableTree interface.
 
76
        """
 
77
        if self._tree is not None:
 
78
            raise errors.AlreadyBuilding
 
79
        self._tree = tree
 
80
        self._tree.lock_tree_write()