23
23
import sys, os.path, types, re
26
from cElementTree import Element, ElementTree, SubElement
28
from elementtree.ElementTree import Element, ElementTree, SubElement
30
from xml import XMLMixin
31
from errors import bailout, BzrError, BzrCheckError
26
from bzrlib.errors import BzrError, BzrCheckError
28
34
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
29
35
from bzrlib.trace import mutter
30
from bzrlib.errors import NotVersionedError
33
class InventoryEntry(object):
37
class InventoryEntry(XMLMixin):
34
38
"""Description of a versioned file.
36
40
An InventoryEntry has the following fields, which are also
64
68
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
65
69
Traceback (most recent call last):
67
BzrError: inventory already contains entry with id {2323}
71
BzrError: ('inventory already contains entry with id {2323}', [])
68
72
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
69
73
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
70
74
>>> i.path2id('src/wibble')
94
98
# TODO: split InventoryEntry into subclasses for files,
95
99
# directories, etc etc.
97
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
98
'text_id', 'parent_id', 'children', ]
100
104
def __init__(self, file_id, name, kind, parent_id, text_id=None):
101
105
"""Create an InventoryEntry
212
211
from_element = classmethod(from_element)
214
def __eq__(self, other):
213
def __cmp__(self, other):
215
216
if not isinstance(other, InventoryEntry):
216
217
return NotImplemented
218
return (self.file_id == other.file_id) \
219
and (self.name == other.name) \
220
and (self.text_sha1 == other.text_sha1) \
221
and (self.text_size == other.text_size) \
222
and (self.text_id == other.text_id) \
223
and (self.parent_id == other.parent_id) \
224
and (self.kind == other.kind)
227
def __ne__(self, other):
228
return not (self == other)
231
raise ValueError('not hashable')
219
return cmp(self.file_id, other.file_id) \
220
or cmp(self.name, other.name) \
221
or cmp(self.text_sha1, other.text_sha1) \
222
or cmp(self.text_size, other.text_size) \
223
or cmp(self.text_id, other.text_id) \
224
or cmp(self.parent_id, other.parent_id) \
225
or cmp(self.kind, other.kind)
240
234
self.parent_id = None
243
def __eq__(self, other):
237
def __cmp__(self, other):
244
240
if not isinstance(other, RootEntry):
245
241
return NotImplemented
247
return (self.file_id == other.file_id) \
248
and (self.children == other.children)
252
class Inventory(object):
242
return cmp(self.file_id, other.file_id) \
243
or cmp(self.children, other.children)
247
class Inventory(XMLMixin):
253
248
"""Inventory of versioned files in a tree.
255
250
This describes which file_id is present at each point in the tree,
267
262
inserted, other than through the Inventory API.
269
264
>>> inv = Inventory()
265
>>> inv.write_xml(sys.stdout)
270
268
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
271
269
>>> inv['123-123'].name
283
281
>>> [x[0] for x in inv.iter_entries()]
285
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
286
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
284
>>> inv.write_xml(sys.stdout)
286
<entry file_id="123-123" kind="file" name="hello.c" />
288
def __init__(self, root_id=ROOT_ID):
289
291
"""Create or read an inventory.
291
293
If a working directory is specified, the inventory is read
295
297
The inventory is created with a default root directory, with
298
# We are letting Branch(init=True) create a unique inventory
299
# root id. Rather than generating a random one here.
301
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
302
self.root = RootEntry(root_id)
300
self.root = RootEntry(ROOT_ID)
303
301
self._byid = {self.root.file_id: self.root}
327
325
if ie.kind == 'directory':
328
326
for cn, cie in self.iter_entries(from_dir=ie.file_id):
329
327
yield os.path.join(name, cn), cie
333
"""Return list of (path, ie) for all entries except the root.
335
This may be faster than iter_entries.
331
def directories(self):
332
"""Return (path, entry) pairs for all directories.
338
def descend(dir_ie, dir_path):
339
kids = dir_ie.children.items()
341
for name, ie in kids:
342
child_path = os.path.join(dir_path, name)
343
accum.append((child_path, ie))
334
def descend(parent_ie):
335
parent_name = parent_ie.name
336
yield parent_name, parent_ie
338
# directory children in sorted order
340
for ie in parent_ie.children.itervalues():
344
341
if ie.kind == 'directory':
345
descend(ie, child_path)
347
descend(self.root, '')
351
def directories(self):
352
"""Return (path, entry) pairs for all directories, including the root.
355
def descend(parent_ie, parent_path):
356
accum.append((parent_path, parent_ie))
342
dn.append((ie.name, ie))
358
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
345
for name, child_ie in dn:
346
for sub_name, sub_ie in descend(child_ie):
347
yield appendpath(parent_name, sub_name), sub_ie
361
for name, child_ie in kids:
362
child_path = os.path.join(parent_path, name)
363
descend(child_ie, child_path)
364
descend(self.root, '')
349
for name, ie in descend(self.root):
409
394
To add a file to a branch ready to be committed, use Branch.add,
410
395
which calls this."""
411
396
if entry.file_id in self._byid:
412
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
414
if entry.parent_id == ROOT_ID or entry.parent_id is None:
415
entry.parent_id = self.root.file_id
397
bailout("inventory already contains entry with id {%s}" % entry.file_id)
418
400
parent = self._byid[entry.parent_id]
420
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
402
bailout("parent_id {%s} not in inventory" % entry.parent_id)
422
404
if parent.children.has_key(entry.name):
423
raise BzrError("%s is already versioned" %
405
bailout("%s is already versioned" %
424
406
appendpath(self.id2path(parent.file_id), entry.name))
426
408
self._byid[entry.file_id] = entry
431
413
"""Add entry from a path.
433
415
The immediate parent must already be versioned"""
434
from bzrlib.branch import gen_file_id
436
416
parts = bzrlib.osutils.splitpath(relpath)
437
417
if len(parts) == 0:
438
raise BzrError("cannot re-add root of inventory")
418
bailout("cannot re-add root of inventory")
440
420
if file_id == None:
441
file_id = gen_file_id(relpath)
443
parent_path = parts[:-1]
444
parent_id = self.path2id(parent_path)
445
if parent_id == None:
446
raise NotVersionedError(parent_path)
421
file_id = bzrlib.branch.gen_file_id(relpath)
423
parent_id = self.path2id(parts[:-1])
424
assert parent_id != None
448
425
ie = InventoryEntry(file_id, parts[-1],
449
426
kind=kind, parent_id=parent_id)
450
427
return self.add(ie)
476
453
del self[ie.parent_id].children[ie.name]
457
from bzrlib import frozenset
458
return frozenset(self._byid)
479
461
def to_element(self):
480
462
"""Convert to XML Element"""
481
from bzrlib.xml import Element
483
463
e = Element('inventory')
485
if self.root.file_id not in (None, ROOT_ID):
486
e.set('file_id', self.root.file_id)
487
465
for path, ie in self.iter_entries():
488
466
e.append(ie.to_element())
492
470
def from_element(cls, elt):
493
471
"""Construct from XML Element
495
473
>>> inv = Inventory()
496
474
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
497
475
>>> elt = inv.to_element()
502
# XXXX: doctest doesn't run this properly under python2.3
503
480
assert elt.tag == 'inventory'
504
root_id = elt.get('file_id') or ROOT_ID
507
ie = InventoryEntry.from_element(e)
508
if ie.parent_id == ROOT_ID:
509
ie.parent_id = root_id
483
o.add(InventoryEntry.from_element(e))
513
486
from_element = classmethod(from_element)
516
def __eq__(self, other):
489
def __cmp__(self, other):
517
490
"""Compare two sets by comparing their contents.
519
492
>>> i1 = Inventory()
530
506
if not isinstance(other, Inventory):
531
507
return NotImplemented
533
if len(self._byid) != len(other._byid):
534
# shortcut: obviously not the same
537
return self._byid == other._byid
540
def __ne__(self, other):
541
return not (self == other)
545
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])
549
519
def get_idpath(self, file_id):
569
539
"""Return as a list the path to file_id."""
571
541
# get all names, skipping root
572
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:]]
573
543
return os.sep.join(p)
620
590
This does not move the working file."""
621
591
if not is_valid_name(new_name):
622
raise BzrError("not an acceptable filename: %r" % new_name)
592
bailout("not an acceptable filename: %r" % new_name)
624
594
new_parent = self._byid[new_parent_id]
625
595
if new_name in new_parent.children:
626
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)))
628
598
new_parent_idpath = self.get_idpath(new_parent_id)
629
599
if file_id in new_parent_idpath:
630
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
600
bailout("cannot move directory %r into a subdirectory of itself, %r"
631
601
% (self.id2path(file_id), self.id2path(new_parent_id)))
633
603
file_ie = self._byid[file_id]
added
removed
bzrlib/inventory.py
