← 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-05-26 02:13:57 UTC
  • Revision ID: mbp@sourcefrog.net-20050526021357-9a56decdca0c174f
- All top-level classes inherit from object
  (Python new-style classes)

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