← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Martin Pool
  • Date: 2005-06-06 11:53:29 UTC
  • Revision ID: mbp@sourcefrog.net-20050606115329-1596352add25bffd
- merge aaron's updated merge/pull code

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/inventory.py
22
22
 
23
23
import sys, os.path, types, re
24
24
 
 
25
try:
 
26
    from cElementTree import Element, ElementTree, SubElement
 
27
except ImportError:
 
28
    from elementtree.ElementTree import Element, ElementTree, SubElement
 
29
 
 
30
from xml import XMLMixin
 
31
from errors import bailout, BzrError, BzrCheckError
 
32
 
25
33
import bzrlib
26
 
from bzrlib.errors import BzrError, BzrCheckError
27
 
 
28
34
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
29
35
from bzrlib.trace import mutter
30
36
 
31
 
class InventoryEntry(object):
 
37
class InventoryEntry(XMLMixin):
32
38
    """Description of a versioned file.
33
39
 
34
40
    An InventoryEntry has the following fields, which are also
62
68
    >>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
63
69
    Traceback (most recent call last):
64
70
    ...
65
 
    BzrError: inventory already contains entry with id {2323}
 
71
    BzrError: ('inventory already contains entry with id {2323}', [])
66
72
    >>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
67
73
    >>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
68
74
    >>> i.path2id('src/wibble')
92
98
    # TODO: split InventoryEntry into subclasses for files,
93
99
    # directories, etc etc.
94
100
 
95
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
96
 
                 'text_id', 'parent_id', 'children', ]
97
 
 
 
101
    text_sha1 = None
 
102
    text_size = None
 
103
    
98
104
    def __init__(self, file_id, name, kind, parent_id, text_id=None):
99
105
        """Create an InventoryEntry
100
106
        
113
119
        if '/' in name or '\\' in name:
114
120
            raise BzrCheckError('InventoryEntry name %r is invalid' % name)
115
121
        
116
 
        self.text_sha1 = None
117
 
        self.text_size = None
118
 
    
119
122
        self.file_id = file_id
120
123
        self.name = name
121
124
        self.kind = kind
157
160
    
158
161
    def to_element(self):
159
162
        """Convert to XML element"""
160
 
        from bzrlib.xml import Element
161
 
        
162
163
        e = Element('entry')
163
164
 
164
165
        e.set('name', self.name)
247
248
 
248
249
 
249
250
 
250
 
class Inventory(object):
 
251
class Inventory(XMLMixin):
251
252
    """Inventory of versioned files in a tree.
252
253
 
253
254
    This describes which file_id is present at each point in the tree,
265
266
    inserted, other than through the Inventory API.
266
267
 
267
268
    >>> inv = Inventory()
 
269
    >>> inv.write_xml(sys.stdout)
 
270
    <inventory>
 
271
    </inventory>
268
272
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
269
273
    >>> inv['123-123'].name
270
274
    'hello.c'
280
284
 
281
285
    >>> [x[0] for x in inv.iter_entries()]
282
286
    ['hello.c']
283
 
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
284
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
287
    
 
288
    >>> inv.write_xml(sys.stdout)
 
289
    <inventory>
 
290
    <entry file_id="123-123" kind="file" name="hello.c" />
 
291
    </inventory>
 
292
 
285
293
    """
286
 
    def __init__(self, root_id=ROOT_ID):
 
294
    def __init__(self):
287
295
        """Create or read an inventory.
288
296
 
289
297
        If a working directory is specified, the inventory is read
293
301
        The inventory is created with a default root directory, with
294
302
        an id of None.
295
303
        """
296
 
        # We are letting Branch(init=True) create a unique inventory
297
 
        # root id. Rather than generating a random one here.
298
 
        #if root_id is None:
299
 
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
300
 
        self.root = RootEntry(root_id)
 
304
        self.root = RootEntry(ROOT_ID)
301
305
        self._byid = {self.root.file_id: self.root}
302
306
 
303
307
 
407
411
        To add  a file to a branch ready to be committed, use Branch.add,
408
412
        which calls this."""
409
413
        if entry.file_id in self._byid:
410
 
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
411
 
 
412
 
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
413
 
            entry.parent_id = self.root.file_id
 
414
            bailout("inventory already contains entry with id {%s}" % entry.file_id)
414
415
 
415
416
        try:
416
417
            parent = self._byid[entry.parent_id]
417
418
        except KeyError:
418
 
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
 
419
            bailout("parent_id {%s} not in inventory" % entry.parent_id)
419
420
 
420
421
        if parent.children.has_key(entry.name):
421
 
            raise BzrError("%s is already versioned" %
 
422
            bailout("%s is already versioned" %
422
423
                    appendpath(self.id2path(parent.file_id), entry.name))
423
424
 
424
425
        self._byid[entry.file_id] = entry
429
430
        """Add entry from a path.
430
431
 
431
432
        The immediate parent must already be versioned"""
432
 
        from bzrlib.errors import NotVersionedError
433
 
        
434
433
        parts = bzrlib.osutils.splitpath(relpath)
435
434
        if len(parts) == 0:
436
 
            raise BzrError("cannot re-add root of inventory")
 
435
            bailout("cannot re-add root of inventory")
437
436
 
438
437
        if file_id == None:
439
 
            from bzrlib.branch import gen_file_id
440
 
            file_id = gen_file_id(relpath)
441
 
 
442
 
        parent_path = parts[:-1]
443
 
        parent_id = self.path2id(parent_path)
444
 
        if parent_id == None:
445
 
            raise NotVersionedError(parent_path)
446
 
 
 
438
            file_id = bzrlib.branch.gen_file_id(relpath)
 
439
 
 
440
        parent_id = self.path2id(parts[:-1])
 
441
        assert parent_id != None
447
442
        ie = InventoryEntry(file_id, parts[-1],
448
443
                            kind=kind, parent_id=parent_id)
449
444
        return self.add(ie)
477
472
 
478
473
    def to_element(self):
479
474
        """Convert to XML Element"""
480
 
        from bzrlib.xml import Element
481
 
        
482
475
        e = Element('inventory')
483
476
        e.text = '\n'
484
 
        if self.root.file_id not in (None, ROOT_ID):
485
 
            e.set('file_id', self.root.file_id)
486
477
        for path, ie in self.iter_entries():
487
478
            e.append(ie.to_element())
488
479
        return e
490
481
 
491
482
    def from_element(cls, elt):
492
483
        """Construct from XML Element
493
 
        
 
484
 
494
485
        >>> inv = Inventory()
495
486
        >>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
496
487
        >>> elt = inv.to_element()
498
489
        >>> inv2 == inv
499
490
        True
500
491
        """
501
 
        # XXXX: doctest doesn't run this properly under python2.3
502
492
        assert elt.tag == 'inventory'
503
 
        root_id = elt.get('file_id') or ROOT_ID
504
 
        o = cls(root_id)
 
493
        o = cls()
505
494
        for e in elt:
506
 
            ie = InventoryEntry.from_element(e)
507
 
            if ie.parent_id == ROOT_ID:
508
 
                ie.parent_id = root_id
509
 
            o.add(ie)
 
495
            o.add(InventoryEntry.from_element(e))
510
496
        return o
511
497
        
512
498
    from_element = classmethod(from_element)
558
544
            try:
559
545
                ie = self._byid[file_id]
560
546
            except KeyError:
561
 
                raise BzrError("file_id {%s} not found in inventory" % file_id)
 
547
                bailout("file_id {%s} not found in inventory" % file_id)
562
548
            p.insert(0, ie.file_id)
563
549
            file_id = ie.parent_id
564
550
        return p
568
554
        """Return as a list the path to file_id."""
569
555
 
570
556
        # get all names, skipping root
571
 
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
 
557
        p = [self[fid].name for fid in self.get_idpath(file_id)[1:]]
572
558
        return os.sep.join(p)
573
559
            
574
560
 
618
604
 
619
605
        This does not move the working file."""
620
606
        if not is_valid_name(new_name):
621
 
            raise BzrError("not an acceptable filename: %r" % new_name)
 
607
            bailout("not an acceptable filename: %r" % new_name)
622
608
 
623
609
        new_parent = self._byid[new_parent_id]
624
610
        if new_name in new_parent.children:
625
 
            raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
 
611
            bailout("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
626
612
 
627
613
        new_parent_idpath = self.get_idpath(new_parent_id)
628
614
        if file_id in new_parent_idpath:
629
 
            raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
 
615
            bailout("cannot move directory %r into a subdirectory of itself, %r"
630
616
                    % (self.id2path(file_id), self.id2path(new_parent_id)))
631
617
 
632
618
        file_ie = self._byid[file_id]