23
23
import sys, os.path, types, re
27
from cElementTree import Element, ElementTree, SubElement
29
from elementtree.ElementTree import Element, ElementTree, SubElement
31
from xml import XMLMixin
32
from errors import bailout, BzrError, BzrCheckError
26
from bzrlib.errors import BzrError, BzrCheckError
28
35
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
29
36
from bzrlib.trace import mutter
31
class InventoryEntry(object):
38
class InventoryEntry(XMLMixin):
32
39
"""Description of a versioned file.
34
41
An InventoryEntry has the following fields, which are also
62
69
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
63
70
Traceback (most recent call last):
65
BzrError: inventory already contains entry with id {2323}
72
BzrError: ('inventory already contains entry with id {2323}', [])
66
73
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
67
74
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
68
75
>>> i.path2id('src/wibble')
92
99
# TODO: split InventoryEntry into subclasses for files,
93
100
# directories, etc etc.
95
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
96
'text_id', 'parent_id', 'children', ]
98
105
def __init__(self, file_id, name, kind, parent_id, text_id=None):
99
106
"""Create an InventoryEntry
210
212
from_element = classmethod(from_element)
212
def __eq__(self, other):
214
def __cmp__(self, other):
213
217
if not isinstance(other, InventoryEntry):
214
218
return NotImplemented
216
return (self.file_id == other.file_id) \
217
and (self.name == other.name) \
218
and (self.text_sha1 == other.text_sha1) \
219
and (self.text_size == other.text_size) \
220
and (self.text_id == other.text_id) \
221
and (self.parent_id == other.parent_id) \
222
and (self.kind == other.kind)
225
def __ne__(self, other):
226
return not (self == other)
229
raise ValueError('not hashable')
220
return cmp(self.file_id, other.file_id) \
221
or cmp(self.name, other.name) \
222
or cmp(self.text_sha1, other.text_sha1) \
223
or cmp(self.text_size, other.text_size) \
224
or cmp(self.text_id, other.text_id) \
225
or cmp(self.parent_id, other.parent_id) \
226
or cmp(self.kind, other.kind)
238
235
self.parent_id = None
241
def __eq__(self, other):
238
def __cmp__(self, other):
242
241
if not isinstance(other, RootEntry):
243
242
return NotImplemented
245
return (self.file_id == other.file_id) \
246
and (self.children == other.children)
250
class Inventory(object):
243
return cmp(self.file_id, other.file_id) \
244
or cmp(self.children, other.children)
248
class Inventory(XMLMixin):
251
249
"""Inventory of versioned files in a tree.
253
251
This describes which file_id is present at each point in the tree,
265
263
inserted, other than through the Inventory API.
267
265
>>> inv = Inventory()
266
>>> inv.write_xml(sys.stdout)
268
269
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
269
270
>>> inv['123-123'].name
281
282
>>> [x[0] for x in inv.iter_entries()]
283
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
284
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
285
>>> inv.write_xml(sys.stdout)
287
<entry file_id="123-123" kind="file" name="hello.c" />
286
def __init__(self, root_id=ROOT_ID):
287
292
"""Create or read an inventory.
289
294
If a working directory is specified, the inventory is read
293
298
The inventory is created with a default root directory, with
296
# We are letting Branch(init=True) create a unique inventory
297
# root id. Rather than generating a random one here.
299
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
300
self.root = RootEntry(root_id)
301
self.root = RootEntry(ROOT_ID)
301
302
self._byid = {self.root.file_id: self.root}
325
326
if ie.kind == 'directory':
326
327
for cn, cie in self.iter_entries(from_dir=ie.file_id):
327
328
yield os.path.join(name, cn), cie
331
"""Return list of (path, ie) for all entries except the root.
333
This may be faster than iter_entries.
332
def directories(self):
333
"""Return (path, entry) pairs for all directories.
336
def descend(dir_ie, dir_path):
337
kids = dir_ie.children.items()
339
for name, ie in kids:
340
child_path = os.path.join(dir_path, name)
341
accum.append((child_path, ie))
335
def descend(parent_ie):
336
parent_name = parent_ie.name
337
yield parent_name, parent_ie
339
# directory children in sorted order
341
for ie in parent_ie.children.itervalues():
342
342
if ie.kind == 'directory':
343
descend(ie, child_path)
345
descend(self.root, '')
349
def directories(self):
350
"""Return (path, entry) pairs for all directories, including the root.
353
def descend(parent_ie, parent_path):
354
accum.append((parent_path, parent_ie))
343
dn.append((ie.name, ie))
356
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
346
for name, child_ie in dn:
347
for sub_name, sub_ie in descend(child_ie):
348
yield appendpath(parent_name, sub_name), sub_ie
359
for name, child_ie in kids:
360
child_path = os.path.join(parent_path, name)
361
descend(child_ie, child_path)
362
descend(self.root, '')
350
for name, ie in descend(self.root):
407
395
To add a file to a branch ready to be committed, use Branch.add,
408
396
which calls this."""
409
397
if entry.file_id in self._byid:
410
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
412
if entry.parent_id == ROOT_ID or entry.parent_id is None:
413
entry.parent_id = self.root.file_id
398
bailout("inventory already contains entry with id {%s}" % entry.file_id)
416
401
parent = self._byid[entry.parent_id]
418
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
403
bailout("parent_id {%s} not in inventory" % entry.parent_id)
420
405
if parent.children.has_key(entry.name):
421
raise BzrError("%s is already versioned" %
406
bailout("%s is already versioned" %
422
407
appendpath(self.id2path(parent.file_id), entry.name))
424
409
self._byid[entry.file_id] = entry
429
414
"""Add entry from a path.
431
416
The immediate parent must already be versioned"""
432
from bzrlib.errors import NotVersionedError
434
417
parts = bzrlib.osutils.splitpath(relpath)
435
418
if len(parts) == 0:
436
raise BzrError("cannot re-add root of inventory")
419
bailout("cannot re-add root of inventory")
438
421
if file_id == None:
439
from bzrlib.branch import gen_file_id
440
file_id = gen_file_id(relpath)
442
parent_path = parts[:-1]
443
parent_id = self.path2id(parent_path)
444
if parent_id == None:
445
raise NotVersionedError(parent_path)
422
file_id = bzrlib.branch.gen_file_id(relpath)
424
parent_id = self.path2id(parts[:-1])
425
assert parent_id != None
447
426
ie = InventoryEntry(file_id, parts[-1],
448
427
kind=kind, parent_id=parent_id)
449
428
return self.add(ie)
475
454
del self[ie.parent_id].children[ie.name]
458
return Set(self._byid)
478
461
def to_element(self):
479
462
"""Convert to XML Element"""
480
from bzrlib.xml import Element
482
463
e = Element('inventory')
484
if self.root.file_id not in (None, ROOT_ID):
485
e.set('file_id', self.root.file_id)
486
465
for path, ie in self.iter_entries():
487
466
e.append(ie.to_element())
491
470
def from_element(cls, elt):
492
471
"""Construct from XML Element
494
473
>>> inv = Inventory()
495
474
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
496
475
>>> elt = inv.to_element()
501
# XXXX: doctest doesn't run this properly under python2.3
502
480
assert elt.tag == 'inventory'
503
root_id = elt.get('file_id') or ROOT_ID
506
ie = InventoryEntry.from_element(e)
507
if ie.parent_id == ROOT_ID:
508
ie.parent_id = root_id
483
o.add(InventoryEntry.from_element(e))
512
486
from_element = classmethod(from_element)
515
def __eq__(self, other):
489
def __cmp__(self, other):
516
490
"""Compare two sets by comparing their contents.
518
492
>>> i1 = Inventory()
529
506
if not isinstance(other, Inventory):
530
507
return NotImplemented
532
if len(self._byid) != len(other._byid):
533
# shortcut: obviously not the same
536
return self._byid == other._byid
539
def __ne__(self, other):
540
return not (self == other)
544
raise ValueError('not hashable')
509
if self.id_set() ^ other.id_set():
512
for file_id in self._byid:
513
c = cmp(self[file_id], other[file_id])
548
519
def get_idpath(self, file_id):
568
539
"""Return as a list the path to file_id."""
570
541
# get all names, skipping root
571
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
542
p = [self[fid].name for fid in self.get_idpath(file_id)[1:]]
572
543
return os.sep.join(p)
619
590
This does not move the working file."""
620
591
if not is_valid_name(new_name):
621
raise BzrError("not an acceptable filename: %r" % new_name)
592
bailout("not an acceptable filename: %r" % new_name)
623
594
new_parent = self._byid[new_parent_id]
624
595
if new_name in new_parent.children:
625
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
596
bailout("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
627
598
new_parent_idpath = self.get_idpath(new_parent_id)
628
599
if file_id in new_parent_idpath:
629
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
600
bailout("cannot move directory %r into a subdirectory of itself, %r"
630
601
% (self.id2path(file_id), self.id2path(new_parent_id)))
632
603
file_ie = self._byid[file_id]
added
removed
bzrlib/inventory.py
