« back to all changes in this revision
Viewing changes to bzrlib/inventory.py
- browse files at revision 1216
- compare with another revision
- download diff
- download tarball
- view history from revision 1216
- Committer: Martin Pool
- Date: 2005-09-12 09:50:44 UTC
- Revision ID: mbp@sourcefrog.net-20050912095044-6acfdb5611729987
- no tests in bzrlib.fetch anymore
- files added:
- bzrlib/meta_store.py
- files removed:
- NEWS.developers
- bzrlib/store
- bzrlib/transport
- files renamed:
- bzrlib/store/__init__.py => bzrlib/store.py
- bzrlib/store/weave.py => bzrlib/weavestore.py
- bzrlib/upgrade.py => tools/history2weaves.py
- bzrlib/selftest/test_weave.py => tools/testweave.py
- files modified:
- .bzrignore
added
removed
bzrlib/inventory.py
19
19
# But those depend on its position within a particular inventory, and
20
20
# it would be nice not to need to hold the backpointer here.
21
21
22
# TODO: Perhaps split InventoryEntry into subclasses for files,
23
# directories, etc etc.
24
25
22
26
# This should really be an id randomly assigned when the tree is
23
27
# created, but it's not for now.
24
28
ROOT_ID = "TREE_ROOT"
25
29
26
30
27
import os.path
28
import re
29
import sys
30
import tarfile
31
import types
31
import sys, os.path, types, re
32
32
33
33
import bzrlib
34
34
from bzrlib.errors import BzrError, BzrCheckError
35
35
36
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
37
appendpath, sha_strings)
36
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
38
37
from bzrlib.trace import mutter
39
38
from bzrlib.errors import NotVersionedError
40
39
41
40
42
41
class InventoryEntry(object):
43
42
"""Description of a versioned file.
50
49
name
51
50
(within the parent directory)
52
51
52
kind
53
'directory' or 'file'
54
53
55
parent_id
54
56
file_id of the parent directory, or ROOT_ID
55
57
56
revision
57
the revision_id in which this variation of this file was
58
introduced.
59
60
executable
61
Indicates that this file should be executable on systems
62
that support it.
58
entry_version
59
the revision_id in which the name or parent of this file was
60
last changed
63
61
64
62
text_sha1
65
63
sha-1 of the text of the file
67
65
text_size
68
66
size in bytes of the text of the file
69
67
68
text_version
69
the revision_id in which the text of this file was introduced
70
70
71
(reading a version 4 tree created a text_id field.)
71
72
72
73
>>> i = Inventory()
73
74
>>> i.path2id('')
74
75
'TREE_ROOT'
75
>>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
76
InventoryDirectory('123', 'src', parent_id='TREE_ROOT')
77
>>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
78
InventoryFile('2323', 'hello.c', parent_id='123')
76
>>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
77
InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
78
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
79
InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
79
80
>>> for j in i.iter_entries():
80
81
... print j
81
82
...
82
('src', InventoryDirectory('123', 'src', parent_id='TREE_ROOT'))
83
('src/hello.c', InventoryFile('2323', 'hello.c', parent_id='123'))
84
>>> i.add(InventoryFile('2323', 'bye.c', '123'))
83
('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
84
('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
85
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
85
86
Traceback (most recent call last):
86
87
...
87
88
BzrError: inventory already contains entry with id {2323}
88
>>> i.add(InventoryFile('2324', 'bye.c', '123'))
89
InventoryFile('2324', 'bye.c', parent_id='123')
90
>>> i.add(InventoryDirectory('2325', 'wibble', '123'))
91
InventoryDirectory('2325', 'wibble', parent_id='123')
89
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
90
InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
91
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
92
InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
92
93
>>> i.path2id('src/wibble')
93
94
'2325'
94
95
>>> '2325' in i
95
96
True
96
>>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
97
InventoryFile('2326', 'wibble.c', parent_id='2325')
97
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
98
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
98
99
>>> i['2326']
99
InventoryFile('2326', 'wibble.c', parent_id='2325')
100
>>> for path, entry in i.iter_entries():
101
... print path.replace('\\\\', '/') # for win32 os.sep
102
... assert i.path2id(path)
100
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
101
>>> for j in i.iter_entries():
102
... print j[0]
103
... assert i.path2id(j[0])
103
104
...
104
105
src
105
106
src/bye.c
106
107
src/hello.c
107
108
src/wibble
108
109
src/wibble/wibble.c
109
>>> i.id2path('2326').replace('\\\\', '/')
110
>>> i.id2path('2326')
110
111
'src/wibble/wibble.c'
111
112
"""
112
113
113
114
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
114
'text_id', 'parent_id', 'children', 'executable',
115
'revision']
116
117
def _add_text_to_weave(self, new_lines, parents, weave_store):
118
weave_store.add_text(self.file_id, self.revision, new_lines, parents)
119
120
def detect_changes(self, old_entry):
121
"""Return a (text_modified, meta_modified) from this to old_entry.
122
123
_read_tree_state must have been called on self and old_entry prior to
124
calling detect_changes.
125
"""
126
return False, False
127
128
def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
129
output_to, reverse=False):
130
"""Perform a diff from this to to_entry.
131
132
text_diff will be used for textual difference calculation.
133
This is a template method, override _diff in child classes.
134
"""
135
self._read_tree_state(tree.id2path(self.file_id), tree)
136
if to_entry:
137
# cannot diff from one kind to another - you must do a removal
138
# and an addif they do not match.
139
assert self.kind == to_entry.kind
140
to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
141
to_tree)
142
self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
143
output_to, reverse)
144
145
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
146
output_to, reverse=False):
147
"""Perform a diff between two entries of the same kind."""
148
149
def get_tar_item(self, root, dp, now, tree):
150
"""Get a tarfile item and a file stream for its content."""
151
item = tarfile.TarInfo(os.path.join(root, dp))
152
# TODO: would be cool to actually set it to the timestamp of the
153
# revision it was last changed
154
item.mtime = now
155
fileobj = self._put_in_tar(item, tree)
156
return item, fileobj
157
158
def has_text(self):
159
"""Return true if the object this entry represents has textual data.
160
161
Note that textual data includes binary content.
162
"""
163
return False
164
165
def __init__(self, file_id, name, parent_id, text_id=None):
115
'text_id', 'parent_id', 'children',
116
'text_version', 'entry_version', ]
117
118
119
def __init__(self, file_id, name, kind, parent_id, text_id=None):
166
120
"""Create an InventoryEntry
167
121
168
122
The filename must be a single component, relative to the
169
123
parent directory; it cannot be a whole path or relative name.
170
124
171
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
125
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
172
126
>>> e.name
173
127
'hello.c'
174
128
>>> e.file_id
175
129
'123'
176
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
130
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
177
131
Traceback (most recent call last):
178
132
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
179
133
"""
181
135
if '/' in name or '\\' in name:
182
136
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
183
137
184
self.executable = False
185
self.revision = None
138
self.text_version = None
139
self.entry_version = None
186
140
self.text_sha1 = None
187
141
self.text_size = None
188
142
self.file_id = file_id
189
143
self.name = name
144
self.kind = kind
190
145
self.text_id = text_id
191
146
self.parent_id = parent_id
192
self.symlink_target = None
193
194
def kind_character(self):
195
"""Return a short kind indicator useful for appending to names."""
196
raise BzrError('unknown kind %r' % self.kind)
197
198
known_kinds = ('file', 'directory', 'symlink', 'root_directory')
199
200
def _put_in_tar(self, item, tree):
201
"""populate item for stashing in a tar, and return the content stream.
202
203
If no content is available, return None.
204
"""
205
raise BzrError("don't know how to export {%s} of kind %r" %
206
(self.file_id, self.kind))
207
208
def put_on_disk(self, dest, dp, tree):
209
"""Create a representation of self on disk in the prefix dest.
210
211
This is a template method - implement _put_on_disk in subclasses.
212
"""
213
fullpath = appendpath(dest, dp)
214
self._put_on_disk(fullpath, tree)
215
mutter(" export {%s} kind %s to %s" % (self.file_id, self.kind, fullpath))
216
217
def _put_on_disk(self, fullpath, tree):
218
"""Put this entry onto disk at fullpath, from tree tree."""
219
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
147
if kind == 'directory':
148
self.children = {}
149
elif kind == 'file':
150
pass
151
else:
152
raise BzrError("unhandled entry kind %r" % kind)
153
154
220
155
221
156
def sorted_children(self):
222
157
l = self.children.items()
223
158
l.sort()
224
159
return l
225
160
226
@staticmethod
227
def versionable_kind(kind):
228
return kind in ('file', 'directory', 'symlink')
229
230
def check(self, checker, rev_id, inv, tree):
231
"""Check this inventory entry is intact.
232
233
This is a template method, override _check for kind specific
234
tests.
235
"""
236
if self.parent_id != None:
237
if not inv.has_id(self.parent_id):
238
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
239
% (self.parent_id, rev_id))
240
self._check(checker, rev_id, tree)
241
242
def _check(self, checker, rev_id, tree):
243
"""Check this inventory entry for kind specific errors."""
244
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
245
(self.kind, rev_id))
246
247
161
248
162
def copy(self):
249
"""Clone this inventory entry."""
250
raise NotImplementedError
163
other = InventoryEntry(self.file_id, self.name, self.kind,
164
self.parent_id)
165
other.text_id = self.text_id
166
other.text_sha1 = self.text_sha1
167
other.text_size = self.text_size
168
other.text_version = self.text_version
169
# note that children are *not* copied; they're pulled across when
170
# others are added
171
return other
251
172
252
def _get_snapshot_change(self, previous_entries):
253
if len(previous_entries) > 1:
254
return 'merged'
255
elif len(previous_entries) == 0:
256
return 'added'
257
else:
258
return 'modified/renamed/reparented'
259
173
260
174
def __repr__(self):
261
return ("%s(%r, %r, parent_id=%r)"
175
return ("%s(%r, %r, kind=%r, parent_id=%r)"
262
176
% (self.__class__.__name__,
263
177
self.file_id,
264
178
self.name,
179
self.kind,
265
180
self.parent_id))
266
181
267
def snapshot(self, revision, path, previous_entries, work_tree,
268
weave_store):
269
"""Make a snapshot of this entry which may or may not have changed.
270
271
This means that all its fields are populated, that it has its
272
text stored in the text store or weave.
273
"""
274
mutter('new parents of %s are %r', path, previous_entries)
275
self._read_tree_state(path, work_tree)
276
if len(previous_entries) == 1:
277
# cannot be unchanged unless there is only one parent file rev.
278
parent_ie = previous_entries.values()[0]
279
if self._unchanged(path, parent_ie, work_tree):
280
mutter("found unchanged entry")
281
self.revision = parent_ie.revision
282
return "unchanged"
283
return self.snapshot_revision(revision, previous_entries,
284
work_tree, weave_store)
285
286
def snapshot_revision(self, revision, previous_entries, work_tree,
287
weave_store):
288
"""Record this revision unconditionally."""
289
mutter('new revision for {%s}', self.file_id)
290
self.revision = revision
291
change = self._get_snapshot_change(previous_entries)
292
return change
293
294
def _snapshot_text(self, file_parents, work_tree, weave_store):
295
mutter('storing file {%s} in revision {%s}',
296
self.file_id, self.revision)
297
# special case to avoid diffing on renames or
298
# reparenting
299
if (len(file_parents) == 1
300
and self.text_sha1 == file_parents.values()[0].text_sha1
301
and self.text_size == file_parents.values()[0].text_size):
302
previous_ie = file_parents.values()[0]
303
weave_store.add_identical_text(
304
self.file_id, previous_ie.revision,
305
self.revision, file_parents)
306
else:
307
new_lines = work_tree.get_file(self.file_id).readlines()
308
self._add_text_to_weave(new_lines, file_parents, weave_store)
309
self.text_sha1 = sha_strings(new_lines)
310
self.text_size = sum(map(len, new_lines))
311
182
312
183
def __eq__(self, other):
313
184
if not isinstance(other, InventoryEntry):
314
185
return NotImplemented
315
186
316
return ((self.file_id == other.file_id)
317
and (self.name == other.name)
318
and (other.symlink_target == self.symlink_target)
319
and (self.text_sha1 == other.text_sha1)
320
and (self.text_size == other.text_size)
321
and (self.text_id == other.text_id)
322
and (self.parent_id == other.parent_id)
323
and (self.kind == other.kind)
324
and (self.revision == other.revision)
325
and (self.executable == other.executable)
326
)
187
return (self.file_id == other.file_id) \
188
and (self.name == other.name) \
189
and (self.text_sha1 == other.text_sha1) \
190
and (self.text_size == other.text_size) \
191
and (self.text_id == other.text_id) \
192
and (self.parent_id == other.parent_id) \
193
and (self.kind == other.kind) \
194
and (self.text_version == other.text_version) \
195
and (self.entry_version == other.entry_version)
196
327
197
328
198
def __ne__(self, other):
329
199
return not (self == other)
331
201
def __hash__(self):
332
202
raise ValueError('not hashable')
333
203
334
def _unchanged(self, path, previous_ie, work_tree):
335
"""Has this entry changed relative to previous_ie.
336
337
This method should be overriden in child classes.
338
"""
339
compatible = True
340
# different inv parent
341
if previous_ie.parent_id != self.parent_id:
342
compatible = False
343
# renamed
344
elif previous_ie.name != self.name:
345
compatible = False
346
return compatible
347
348
def _read_tree_state(self, path, work_tree):
349
"""Populate fields in the inventory entry from the given tree.
350
351
Note that this should be modified to be a noop on virtual trees
352
as all entries created there are prepopulated.
353
"""
354
204
355
205
356
206
class RootEntry(InventoryEntry):
357
358
def _check(self, checker, rev_id, tree):
359
"""See InventoryEntry._check"""
360
361
207
def __init__(self, file_id):
362
208
self.file_id = file_id
363
209
self.children = {}
373
219
and (self.children == other.children)
374
220
375
221
376
class InventoryDirectory(InventoryEntry):
377
"""A directory in an inventory."""
378
379
def _check(self, checker, rev_id, tree):
380
"""See InventoryEntry._check"""
381
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
382
raise BzrCheckError('directory {%s} has text in revision {%s}'
383
% (self.file_id, rev_id))
384
385
def copy(self):
386
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
387
other.revision = self.revision
388
# note that children are *not* copied; they're pulled across when
389
# others are added
390
return other
391
392
def __init__(self, file_id, name, parent_id):
393
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
394
self.children = {}
395
self.kind = 'directory'
396
397
def kind_character(self):
398
"""See InventoryEntry.kind_character."""
399
return '/'
400
401
def _put_in_tar(self, item, tree):
402
"""See InventoryEntry._put_in_tar."""
403
item.type = tarfile.DIRTYPE
404
fileobj = None
405
item.name += '/'
406
item.size = 0
407
item.mode = 0755
408
return fileobj
409
410
def _put_on_disk(self, fullpath, tree):
411
"""See InventoryEntry._put_on_disk."""
412
os.mkdir(fullpath)
413
414
415
class InventoryFile(InventoryEntry):
416
"""A file in an inventory."""
417
418
def _check(self, checker, rev_id, tree):
419
"""See InventoryEntry._check"""
420
revision = self.revision
421
t = (self.file_id, revision)
422
if t in checker.checked_texts:
423
prev_sha = checker.checked_texts[t]
424
if prev_sha != self.text_sha1:
425
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
426
(self.file_id, rev_id))
427
else:
428
checker.repeated_text_cnt += 1
429
return
430
mutter('check version {%s} of {%s}', rev_id, self.file_id)
431
file_lines = tree.get_file_lines(self.file_id)
432
checker.checked_text_cnt += 1
433
if self.text_size != sum(map(len, file_lines)):
434
raise BzrCheckError('text {%s} wrong size' % self.text_id)
435
if self.text_sha1 != sha_strings(file_lines):
436
raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
437
checker.checked_texts[t] = self.text_sha1
438
439
def copy(self):
440
other = InventoryFile(self.file_id, self.name, self.parent_id)
441
other.executable = self.executable
442
other.text_id = self.text_id
443
other.text_sha1 = self.text_sha1
444
other.text_size = self.text_size
445
other.revision = self.revision
446
return other
447
448
def detect_changes(self, old_entry):
449
"""See InventoryEntry.detect_changes."""
450
assert self.text_sha1 != None
451
assert old_entry.text_sha1 != None
452
text_modified = (self.text_sha1 != old_entry.text_sha1)
453
meta_modified = (self.executable != old_entry.executable)
454
return text_modified, meta_modified
455
456
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
457
output_to, reverse=False):
458
"""See InventoryEntry._diff."""
459
from_text = tree.get_file(self.file_id).readlines()
460
if to_entry:
461
to_text = to_tree.get_file(to_entry.file_id).readlines()
462
else:
463
to_text = []
464
if not reverse:
465
text_diff(from_label, from_text,
466
to_label, to_text, output_to)
467
else:
468
text_diff(to_label, to_text,
469
from_label, from_text, output_to)
470
471
def has_text(self):
472
"""See InventoryEntry.has_text."""
473
return True
474
475
def __init__(self, file_id, name, parent_id):
476
super(InventoryFile, self).__init__(file_id, name, parent_id)
477
self.kind = 'file'
478
479
def kind_character(self):
480
"""See InventoryEntry.kind_character."""
481
return ''
482
483
def _put_in_tar(self, item, tree):
484
"""See InventoryEntry._put_in_tar."""
485
item.type = tarfile.REGTYPE
486
fileobj = tree.get_file(self.file_id)
487
item.size = self.text_size
488
if tree.is_executable(self.file_id):
489
item.mode = 0755
490
else:
491
item.mode = 0644
492
return fileobj
493
494
def _put_on_disk(self, fullpath, tree):
495
"""See InventoryEntry._put_on_disk."""
496
pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
497
if tree.is_executable(self.file_id):
498
os.chmod(fullpath, 0755)
499
500
def _read_tree_state(self, path, work_tree):
501
"""See InventoryEntry._read_tree_state."""
502
self.text_sha1 = work_tree.get_file_sha1(self.file_id)
503
self.executable = work_tree.is_executable(self.file_id)
504
505
def snapshot_revision(self, revision, previous_entries, work_tree,
506
weave_store):
507
"""See InventoryEntry.snapshot_revision."""
508
change = super(InventoryFile, self).snapshot_revision(revision,
509
previous_entries, work_tree, weave_store)
510
self._snapshot_text(previous_entries, work_tree, weave_store)
511
return change
512
513
def _unchanged(self, path, previous_ie, work_tree):
514
"""See InventoryEntry._unchanged."""
515
compatible = super(InventoryFile, self)._unchanged(path, previous_ie,
516
work_tree)
517
if self.text_sha1 != previous_ie.text_sha1:
518
compatible = False
519
else:
520
# FIXME: 20050930 probe for the text size when getting sha1
521
# in _read_tree_state
522
self.text_size = previous_ie.text_size
523
return compatible
524
525
526
class InventoryLink(InventoryEntry):
527
"""A file in an inventory."""
528
529
__slots__ = ['symlink_target']
530
531
def _check(self, checker, rev_id, tree):
532
"""See InventoryEntry._check"""
533
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
534
raise BzrCheckError('symlink {%s} has text in revision {%s}'
535
% (self.file_id, rev_id))
536
if self.symlink_target == None:
537
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
538
% (self.file_id, rev_id))
539
540
def copy(self):
541
other = InventoryLink(self.file_id, self.name, self.parent_id)
542
other.symlink_target = self.symlink_target
543
other.revision = self.revision
544
return other
545
546
def detect_changes(self, old_entry):
547
"""See InventoryEntry.detect_changes."""
548
# FIXME: which _modified field should we use ? RBC 20051003
549
text_modified = (self.symlink_target != old_entry.symlink_target)
550
if text_modified:
551
mutter(" symlink target changed")
552
meta_modified = False
553
return text_modified, meta_modified
554
555
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
556
output_to, reverse=False):
557
"""See InventoryEntry._diff."""
558
from_text = self.symlink_target
559
if to_entry is not None:
560
to_text = to_entry.symlink_target
561
if reverse:
562
temp = from_text
563
from_text = to_text
564
to_text = temp
565
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
566
else:
567
if not reverse:
568
print >>output_to, '=== target was %r' % self.symlink_target
569
else:
570
print >>output_to, '=== target is %r' % self.symlink_target
571
572
def __init__(self, file_id, name, parent_id):
573
super(InventoryLink, self).__init__(file_id, name, parent_id)
574
self.kind = 'symlink'
575
576
def kind_character(self):
577
"""See InventoryEntry.kind_character."""
578
return ''
579
580
def _put_in_tar(self, item, tree):
581
"""See InventoryEntry._put_in_tar."""
582
iterm.type = tarfile.SYMTYPE
583
fileobj = None
584
item.size = 0
585
item.mode = 0755
586
item.linkname = self.symlink_target
587
return fileobj
588
589
def _put_on_disk(self, fullpath, tree):
590
"""See InventoryEntry._put_on_disk."""
591
try:
592
os.symlink(self.symlink_target, fullpath)
593
except OSError,e:
594
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
595
596
def _read_tree_state(self, path, work_tree):
597
"""See InventoryEntry._read_tree_state."""
598
self.symlink_target = work_tree.get_symlink_target(self.file_id)
599
600
def _unchanged(self, path, previous_ie, work_tree):
601
"""See InventoryEntry._unchanged."""
602
compatible = super(InventoryLink, self)._unchanged(path, previous_ie,
603
work_tree)
604
if self.symlink_target != previous_ie.symlink_target:
605
compatible = False
606
return compatible
607
608
222
609
223
class Inventory(object):
610
224
"""Inventory of versioned files in a tree.
624
238
inserted, other than through the Inventory API.
625
239
626
240
>>> inv = Inventory()
627
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
628
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
241
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
242
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
629
243
>>> inv['123-123'].name
630
244
'hello.c'
631
245
641
255
>>> [x[0] for x in inv.iter_entries()]
642
256
['hello.c']
643
257
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
644
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
645
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
258
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
259
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT-12345678-12345678')
646
260
"""
647
261
def __init__(self, root_id=ROOT_ID):
648
262
"""Create or read an inventory.
654
268
The inventory is created with a default root directory, with
655
269
an id of None.
656
270
"""
657
# We are letting Branch.initialize() create a unique inventory
271
# We are letting Branch(init=True) create a unique inventory
658
272
# root id. Rather than generating a random one here.
659
273
#if root_id is None:
660
274
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
740
354
"""True if this entry contains a file with given id.
741
355
742
356
>>> inv = Inventory()
743
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
744
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
357
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
358
InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
745
359
>>> '123' in inv
746
360
True
747
361
>>> '456' in inv
754
368
"""Return the entry for given file_id.
755
369
756
370
>>> inv = Inventory()
757
>>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
758
InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
371
>>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
372
InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
759
373
>>> inv['123123'].name
760
374
'hello.c'
761
375
"""
823
437
if parent_id == None:
824
438
raise NotVersionedError(parent_path)
825
439
826
if kind == 'directory':
827
ie = InventoryDirectory(file_id, parts[-1], parent_id)
828
elif kind == 'file':
829
ie = InventoryFile(file_id, parts[-1], parent_id)
830
elif kind == 'symlink':
831
ie = InventoryLink(file_id, parts[-1], parent_id)
832
else:
833
raise BzrError("unknown kind %r" % kind)
440
ie = InventoryEntry(file_id, parts[-1],
441
kind=kind, parent_id=parent_id)
834
442
return self.add(ie)
835
443
836
444
838
446
"""Remove entry by id.
839
447
840
448
>>> inv = Inventory()
841
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
842
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
449
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
450
InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
843
451
>>> '123' in inv
844
452
True
845
453
>>> del inv['123']
868
476
>>> i2 = Inventory()
869
477
>>> i1 == i2
870
478
True
871
>>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
872
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
479
>>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
480
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
873
481
>>> i1 == i2
874
482
False
875
>>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
876
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
483
>>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
484
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
877
485
>>> i1 == i2
878
486
True
879
487
"""
888
496
889
497
890
498
def __ne__(self, other):
891
return not self.__eq__(other)
499
return not (self == other)
892
500
893
501
894
502
def __hash__(self):
915
523
916
524
917
525
def id2path(self, file_id):
918
"""Return as a list the path to file_id.
919
920
>>> i = Inventory()
921
>>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
922
>>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
923
>>> print i.id2path('foo-id').replace(os.sep, '/')
924
src/foo.c
925
"""
526
"""Return as a list the path to file_id."""
527
926
528
# get all names, skipping root
927
529
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
928
530
return os.sep.join(p)
Loggerhead is a web-based interface for Breezy
Version: 2.0.1