/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 bzrlib/revisiontree.py

  • Committer: John Arbash Meinel
  • Date: 2006-09-13 02:09:37 UTC
  • mto: This revision was merged to the branch mainline in revision 2004.
  • Revision ID: john@arbash-meinel.com-20060913020937-2df2f49f9a28ec43
Update HACKING and docstrings

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/revisiontree.py
1
 
# Copyright (C) 2005, 2007 Canonical Ltd
 
1
# Copyright (C) 2005 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
18
18
 
19
19
from cStringIO import StringIO
20
20
 
21
 
from bzrlib import (
22
 
    osutils,
23
 
    revision,
24
 
    )
25
21
from bzrlib.tree import Tree
26
22
 
27
23
 
29
25
    """Tree viewing a previous revision.
30
26
 
31
27
    File text can be retrieved from the text store.
 
28
 
 
29
    TODO: Some kind of `__repr__` method, but a good one
 
30
           probably means knowing the branch and revision number,
 
31
           or at least passing a description to the constructor.
32
32
    """
33
33
    
34
34
    def __init__(self, branch, inv, revision_id):
40
40
        self._repository = branch
41
41
        self._weave_store = branch.weave_store
42
42
        self._inventory = inv
43
 
        self._revision_id = osutils.safe_revision_id(revision_id)
44
 
 
45
 
    def supports_tree_reference(self):
46
 
        return True
 
43
        assert inv.root is not None
 
44
        self._revision_id = revision_id
47
45
 
48
46
    def get_parent_ids(self):
49
47
        """See Tree.get_parent_ids.
50
48
 
51
49
        A RevisionTree's parents match the revision graph.
52
50
        """
53
 
        if self._revision_id in (None, revision.NULL_REVISION):
54
 
            parent_ids = []
55
 
        else:
56
 
            parent_ids = self._repository.get_revision(
57
 
                self._revision_id).parent_ids
 
51
        parent_ids = self._repository.get_revision(self._revision_id).parent_ids
58
52
        return parent_ids
59
53
        
60
54
    def get_revision_id(self):
62
56
        return self._revision_id
63
57
 
64
58
    def get_weave(self, file_id):
65
 
        file_id = osutils.safe_file_id(file_id)
66
59
        return self._weave_store.get_weave(file_id,
67
60
                self._repository.get_transaction())
68
61
 
69
62
    def get_file_lines(self, file_id):
70
 
        file_id = osutils.safe_file_id(file_id)
71
63
        ie = self._inventory[file_id]
72
64
        weave = self.get_weave(file_id)
73
65
        return weave.get_lines(ie.revision)
74
66
 
75
67
    def get_file_text(self, file_id):
76
 
        file_id = osutils.safe_file_id(file_id)
77
68
        return ''.join(self.get_file_lines(file_id))
78
69
 
79
70
    def get_file(self, file_id):
80
 
        file_id = osutils.safe_file_id(file_id)
81
71
        return StringIO(self.get_file_text(file_id))
82
72
 
83
 
    def annotate_iter(self, file_id):
84
 
        """See Tree.annotate_iter"""
85
 
        file_id = osutils.safe_file_id(file_id)
86
 
        w = self.get_weave(file_id)
87
 
        return w.annotate_iter(self.inventory[file_id].revision)
88
 
 
89
73
    def get_file_size(self, file_id):
90
 
        file_id = osutils.safe_file_id(file_id)
91
74
        return self._inventory[file_id].text_size
92
75
 
93
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
94
 
        file_id = osutils.safe_file_id(file_id)
 
76
    def get_file_sha1(self, file_id, path=None):
95
77
        ie = self._inventory[file_id]
96
78
        if ie.kind == "file":
97
79
            return ie.text_sha1
98
80
        return None
99
81
 
100
82
    def get_file_mtime(self, file_id, path=None):
101
 
        file_id = osutils.safe_file_id(file_id)
102
83
        ie = self._inventory[file_id]
103
84
        revision = self._repository.get_revision(ie.revision)
104
85
        return revision.timestamp
105
86
 
106
87
    def is_executable(self, file_id, path=None):
107
 
        file_id = osutils.safe_file_id(file_id)
108
88
        ie = self._inventory[file_id]
109
89
        if ie.kind != "file":
110
 
            return None
111
 
        return ie.executable
 
90
            return None 
 
91
        return self._inventory[file_id].executable
112
92
 
113
93
    def has_filename(self, filename):
114
94
        return bool(self.inventory.path2id(filename))
115
95
 
116
 
    def list_files(self, include_root=False):
 
96
    def list_files(self):
117
97
        # The only files returned by this are those from the version
118
98
        entries = self.inventory.iter_entries()
119
99
        # skip the root for compatability with the current apis.
120
 
        if self.inventory.root is not None and not include_root:
121
 
            # skip the root for compatability with the current apis.
122
 
            entries.next()
 
100
        entries.next()
123
101
        for path, entry in entries:
124
102
            yield path, 'V', entry.kind, entry.file_id, entry
125
103
 
126
104
    def get_symlink_target(self, file_id):
127
 
        file_id = osutils.safe_file_id(file_id)
128
105
        ie = self._inventory[file_id]
129
106
        return ie.symlink_target;
130
107
 
131
 
    def get_reference_revision(self, file_id, path=None):
132
 
        return self.inventory[file_id].reference_revision
133
 
 
134
 
    def get_root_id(self):
135
 
        if self.inventory.root:
136
 
            return self.inventory.root.file_id
137
 
 
138
108
    def kind(self, file_id):
139
 
        file_id = osutils.safe_file_id(file_id)
140
109
        return self._inventory[file_id].kind
141
110
 
142
 
    def _comparison_data(self, entry, path):
143
 
        if entry is None:
144
 
            return None, False, None
145
 
        return entry.kind, entry.executable, None
146
 
 
147
 
    def _file_size(self, entry, stat_value):
148
 
        assert entry.text_size is not None
149
 
        return entry.text_size
150
 
 
151
111
    def lock_read(self):
152
112
        self._repository.lock_read()
153
113
 
154
 
    def __repr__(self):
155
 
        return '<%s instance at %x, rev_id=%r>' % (
156
 
            self.__class__.__name__, id(self), self._revision_id)
157
 
 
158
114
    def unlock(self):
159
115
        self._repository.unlock()
160
116
 
161
 
    def walkdirs(self, prefix=""):
162
 
        _directory = 'directory'
163
 
        inv = self.inventory
164
 
        top_id = inv.path2id(prefix)
165
 
        if top_id is None:
166
 
            pending = []
167
 
        else:
168
 
            pending = [(prefix, '', _directory, None, top_id, None)]
169
 
        while pending:
170
 
            dirblock = []
171
 
            currentdir = pending.pop()
172
 
            # 0 - relpath, 1- basename, 2- kind, 3- stat, id, v-kind
173
 
            if currentdir[0]:
174
 
                relroot = currentdir[0] + '/'
175
 
            else:
176
 
                relroot = ""
177
 
            # FIXME: stash the node in pending
178
 
            entry = inv[currentdir[4]]
179
 
            for name, child in entry.sorted_children():
180
 
                toppath = relroot + name
181
 
                dirblock.append((toppath, name, child.kind, None,
182
 
                    child.file_id, child.kind
183
 
                    ))
184
 
            yield (currentdir[0], entry.file_id), dirblock
185
 
            # push the user specified dirs from dirblock
186
 
            for dir in reversed(dirblock):
187
 
                if dir[2] == _directory:
188
 
                    pending.append(dir)
 
117