/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/treebuilder.py

  • Committer: Robert Collins
  • Date: 2005-12-24 02:20:45 UTC
  • mto: (1185.50.57 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1550.
  • Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/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 . import errors
24
 
 
25
 
 
26
 
class AlreadyBuilding(errors.BzrError):
27
 
 
28
 
    _fmt = "The tree builder is already building a tree."
29
 
 
30
 
 
31
 
class NotBuilding(errors.BzrError):
32
 
 
33
 
    _fmt = "Not currently building a tree."
34
 
 
35
 
 
36
 
class TreeBuilder(object):
37
 
    """A TreeBuilder allows the creation of specific content in one tree at a
38
 
    time.
39
 
    """
40
 
 
41
 
    def __init__(self):
42
 
        """Construct a TreeBuilder."""
43
 
        self._tree = None
44
 
        self._root_done = False
45
 
 
46
 
    def build(self, recipe):
47
 
        """Build recipe into the current tree.
48
 
 
49
 
        :param recipe: A sequence of paths. For each path, the corresponding
50
 
            path in the current tree is created and added. If the path ends in
51
 
            '/' then a directory is added, otherwise a regular file is added.
52
 
        """
53
 
        self._ensure_building()
54
 
        if not self._root_done:
55
 
            self._tree.add('', b'root-id', 'directory')
56
 
            self._root_done = True
57
 
        for name in recipe:
58
 
            if name.endswith('/'):
59
 
                self._tree.mkdir(name[:-1])
60
 
            else:
61
 
                end = b'\n'
62
 
                content = b"contents of %s%s" % (name.encode('utf-8'), end)
63
 
                self._tree.add(name, None, 'file')
64
 
                self._tree.put_file_bytes_non_atomic(name, content)
65
 
 
66
 
    def _ensure_building(self):
67
 
        """Raise NotBuilding if there is no current tree being built."""
68
 
        if self._tree is None:
69
 
            raise NotBuilding
70
 
 
71
 
    def finish_tree(self):
72
 
        """Finish building the current tree."""
73
 
        self._ensure_building()
74
 
        tree = self._tree
75
 
        self._tree = None
76
 
        tree.unlock()
77
 
 
78
 
    def start_tree(self, tree):
79
 
        """Start building on tree.
80
 
 
81
 
        :param tree: A tree to start building on. It must provide the
82
 
            MutableTree interface.
83
 
        """
84
 
        if self._tree is not None:
85
 
            raise AlreadyBuilding
86
 
        self._tree = tree
87
 
        self._tree.lock_tree_write()