~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Aaron Bentley
  • Date: 2005-09-29 21:07:17 UTC
  • mfrom: (1393.1.6)
  • mto: (1185.25.1)
  • mto: This revision was merged to the branch mainline in revision 1419.
  • Revision ID: abentley@panoramicfeedback.com-20050929210717-cd73981590f17017
Merged the weave changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
 
18
# TODO: Maybe also keep the full path of the entry, and the children?
 
19
# But those depend on its position within a particular inventory, and
 
20
# it would be nice not to need to hold the backpointer here.
 
21
 
 
22
# TODO: Perhaps split InventoryEntry into subclasses for files,
 
23
# directories, etc etc.
 
24
 
 
25
 
18
26
# This should really be an id randomly assigned when the tree is
19
27
# created, but it's not for now.
20
28
ROOT_ID = "TREE_ROOT"
21
29
 
22
30
 
23
 
import sys, os.path, types, re
 
31
import os.path
 
32
import re
 
33
import sys
 
34
import types
24
35
 
25
36
import bzrlib
26
37
from bzrlib.errors import BzrError, BzrCheckError
27
38
 
28
 
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
 
39
from bzrlib.osutils import quotefn, splitpath, joinpath, appendpath
29
40
from bzrlib.trace import mutter
30
41
from bzrlib.errors import NotVersionedError
31
 
        
 
42
 
32
43
 
33
44
class InventoryEntry(object):
34
45
    """Description of a versioned file.
36
47
    An InventoryEntry has the following fields, which are also
37
48
    present in the XML inventory-entry element:
38
49
 
39
 
    * *file_id*
40
 
    * *name*: (only the basename within the directory, must not
41
 
      contain slashes)
42
 
    * *kind*: "directory" or "file"
43
 
    * *directory_id*: (if absent/null means the branch root directory)
44
 
    * *text_sha1*: only for files
45
 
    * *text_size*: in bytes, only for files 
46
 
    * *text_id*: identifier for the text version, only for files
47
 
 
48
 
    InventoryEntries can also exist inside a WorkingTree
49
 
    inventory, in which case they are not yet bound to a
50
 
    particular revision of the file.  In that case the text_sha1,
51
 
    text_size and text_id are absent.
52
 
 
 
50
    file_id
 
51
 
 
52
    name
 
53
        (within the parent directory)
 
54
 
 
55
    kind
 
56
        'directory' or 'file'
 
57
 
 
58
    parent_id
 
59
        file_id of the parent directory, or ROOT_ID
 
60
 
 
61
    name_version
 
62
        the revision_id in which the name or parent of this file was
 
63
        last changed
 
64
 
 
65
    text_sha1
 
66
        sha-1 of the text of the file
 
67
        
 
68
    text_size
 
69
        size in bytes of the text of the file
 
70
        
 
71
    text_version
 
72
        the revision_id in which the text of this file was introduced
 
73
 
 
74
    (reading a version 4 tree created a text_id field.)
53
75
 
54
76
    >>> i = Inventory()
55
77
    >>> i.path2id('')
79
101
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
80
102
    >>> i['2326']
81
103
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
82
 
    >>> for j in i.iter_entries():
83
 
    ...     print j[0]
84
 
    ...     assert i.path2id(j[0])
 
104
    >>> for path, entry in i.iter_entries():
 
105
    ...     print path.replace('\\\\', '/')     # for win32 os.sep
 
106
    ...     assert i.path2id(path)
85
107
    ... 
86
108
    src
87
109
    src/bye.c
88
110
    src/hello.c
89
111
    src/wibble
90
112
    src/wibble/wibble.c
91
 
    >>> i.id2path('2326')
 
113
    >>> i.id2path('2326').replace('\\\\', '/')
92
114
    'src/wibble/wibble.c'
93
 
 
94
 
    TODO: Maybe also keep the full path of the entry, and the children?
95
 
           But those depend on its position within a particular inventory, and
96
 
           it would be nice not to need to hold the backpointer here.
97
115
    """
98
 
 
99
 
    # TODO: split InventoryEntry into subclasses for files,
100
 
    # directories, etc etc.
101
 
 
 
116
    
102
117
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
103
118
                 'text_id', 'parent_id', 'children',
104
 
                 'text_version', 'entry_version', ]
 
119
                 'text_version', 'name_version', ]
105
120
 
106
121
 
107
122
    def __init__(self, file_id, name, kind, parent_id, text_id=None):
124
139
            raise BzrCheckError('InventoryEntry name %r is invalid' % name)
125
140
        
126
141
        self.text_version = None
127
 
        self.entry_version = None
 
142
        self.name_version = None
128
143
        self.text_sha1 = None
129
144
        self.text_size = None
130
145
        self.file_id = file_id
149
164
 
150
165
    def copy(self):
151
166
        other = InventoryEntry(self.file_id, self.name, self.kind,
152
 
                               self.parent_id, text_id=self.text_id)
 
167
                               self.parent_id)
 
168
        other.text_id = self.text_id
153
169
        other.text_sha1 = self.text_sha1
154
170
        other.text_size = self.text_size
 
171
        other.text_version = self.text_version
 
172
        other.name_version = self.name_version
155
173
        # note that children are *not* copied; they're pulled across when
156
174
        # others are added
157
175
        return other
178
196
               and (self.parent_id == other.parent_id) \
179
197
               and (self.kind == other.kind) \
180
198
               and (self.text_version == other.text_version) \
181
 
               and (self.entry_version == other.entry_version)
 
199
               and (self.name_version == other.name_version)
182
200
 
183
201
 
184
202
    def __ne__(self, other):
262
280
        self._byid = {self.root.file_id: self.root}
263
281
 
264
282
 
 
283
    def copy(self):
 
284
        other = Inventory(self.root.file_id)
 
285
        # copy recursively so we know directories will be added before
 
286
        # their children.  There are more efficient ways than this...
 
287
        for path, entry in self.iter_entries():
 
288
            if entry == self.root:
 
289
                continue
 
290
            other.add(entry.copy())
 
291
        return other
 
292
 
 
293
 
265
294
    def __iter__(self):
266
295
        return iter(self._byid)
267
296
 
471
500
 
472
501
 
473
502
    def __ne__(self, other):
474
 
        return not (self == other)
 
503
        return not self.__eq__(other)
475
504
 
476
505
 
477
506
    def __hash__(self):