← 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-07-22 19:44:09 UTC
  • Revision ID: mbp@sourcefrog.net-20050722194409-9f99ffe3d62cf8c0
- tidy up imports to use full module names

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/inventory.py
27
27
 
28
28
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
29
29
from bzrlib.trace import mutter
30
 
from bzrlib.errors import NotVersionedError
31
 
        
32
30
 
33
31
class InventoryEntry(object):
34
32
    """Description of a versioned file.
55
53
    >>> i.path2id('')
56
54
    'TREE_ROOT'
57
55
    >>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
58
 
    InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
59
56
    >>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
60
 
    InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
61
57
    >>> for j in i.iter_entries():
62
58
    ...   print j
63
59
    ... 
68
64
    ...
69
65
    BzrError: inventory already contains entry with id {2323}
70
66
    >>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
71
 
    InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
72
67
    >>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
73
 
    InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
74
68
    >>> i.path2id('src/wibble')
75
69
    '2325'
76
70
    >>> '2325' in i
77
71
    True
78
72
    >>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
79
 
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
80
73
    >>> i['2326']
81
74
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
82
75
    >>> for j in i.iter_entries():
100
93
    # directories, etc etc.
101
94
 
102
95
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
103
 
                 'text_id', 'parent_id', 'children',
104
 
                 'text_version', 'entry_version', ]
105
 
 
 
96
                 'text_id', 'parent_id', 'children', ]
106
97
 
107
98
    def __init__(self, file_id, name, kind, parent_id, text_id=None):
108
99
        """Create an InventoryEntry
119
110
        Traceback (most recent call last):
120
111
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
121
112
        """
122
 
        assert isinstance(name, basestring), name
123
113
        if '/' in name or '\\' in name:
124
114
            raise BzrCheckError('InventoryEntry name %r is invalid' % name)
125
115
        
126
 
        self.text_version = None
127
 
        self.entry_version = None
128
116
        self.text_sha1 = None
129
117
        self.text_size = None
 
118
    
130
119
        self.file_id = file_id
131
120
        self.name = name
132
121
        self.kind = kind
166
155
                   self.parent_id))
167
156
 
168
157
    
 
158
    def to_element(self):
 
159
        """Convert to XML element"""
 
160
        from bzrlib.xml import Element
 
161
        
 
162
        e = Element('entry')
 
163
 
 
164
        e.set('name', self.name)
 
165
        e.set('file_id', self.file_id)
 
166
        e.set('kind', self.kind)
 
167
 
 
168
        if self.text_size != None:
 
169
            e.set('text_size', '%d' % self.text_size)
 
170
            
 
171
        for f in ['text_id', 'text_sha1']:
 
172
            v = getattr(self, f)
 
173
            if v != None:
 
174
                e.set(f, v)
 
175
 
 
176
        # to be conservative, we don't externalize the root pointers
 
177
        # for now, leaving them as null in the xml form.  in a future
 
178
        # version it will be implied by nested elements.
 
179
        if self.parent_id != ROOT_ID:
 
180
            assert isinstance(self.parent_id, basestring)
 
181
            e.set('parent_id', self.parent_id)
 
182
 
 
183
        e.tail = '\n'
 
184
            
 
185
        return e
 
186
 
 
187
 
 
188
    def from_element(cls, elt):
 
189
        assert elt.tag == 'entry'
 
190
 
 
191
        ## original format inventories don't have a parent_id for
 
192
        ## nodes in the root directory, but it's cleaner to use one
 
193
        ## internally.
 
194
        parent_id = elt.get('parent_id')
 
195
        if parent_id == None:
 
196
            parent_id = ROOT_ID
 
197
 
 
198
        self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
 
199
        self.text_id = elt.get('text_id')
 
200
        self.text_sha1 = elt.get('text_sha1')
 
201
        
 
202
        ## mutter("read inventoryentry: %r" % (elt.attrib))
 
203
 
 
204
        v = elt.get('text_size')
 
205
        self.text_size = v and int(v)
 
206
 
 
207
        return self
 
208
            
 
209
 
 
210
    from_element = classmethod(from_element)
 
211
 
169
212
    def __eq__(self, other):
170
213
        if not isinstance(other, InventoryEntry):
171
214
            return NotImplemented
176
219
               and (self.text_size == other.text_size) \
177
220
               and (self.text_id == other.text_id) \
178
221
               and (self.parent_id == other.parent_id) \
179
 
               and (self.kind == other.kind) \
180
 
               and (self.text_version == other.text_version) \
181
 
               and (self.entry_version == other.entry_version)
 
222
               and (self.kind == other.kind)
182
223
 
183
224
 
184
225
    def __ne__(self, other):
225
266
 
226
267
    >>> inv = Inventory()
227
268
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
228
 
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
229
269
    >>> inv['123-123'].name
230
270
    'hello.c'
231
271
 
242
282
    ['hello.c']
243
283
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
244
284
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
245
 
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT-12345678-12345678')
246
285
    """
247
286
    def __init__(self, root_id=ROOT_ID):
248
287
        """Create or read an inventory.
330
369
 
331
370
        >>> inv = Inventory()
332
371
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
333
 
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
334
372
        >>> '123' in inv
335
373
        True
336
374
        >>> '456' in inv
344
382
 
345
383
        >>> inv = Inventory()
346
384
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
347
 
        InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
348
385
        >>> inv['123123'].name
349
386
        'hello.c'
350
387
        """
368
405
        """Add entry to inventory.
369
406
 
370
407
        To add  a file to a branch ready to be committed, use Branch.add,
371
 
        which calls this.
372
 
 
373
 
        Returns the new entry object.
374
 
        """
 
408
        which calls this."""
375
409
        if entry.file_id in self._byid:
376
410
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
377
411
 
389
423
 
390
424
        self._byid[entry.file_id] = entry
391
425
        parent.children[entry.name] = entry
392
 
        return entry
393
426
 
394
427
 
395
428
    def add_path(self, relpath, kind, file_id=None):
396
429
        """Add entry from a path.
397
430
 
398
 
        The immediate parent must already be versioned.
399
 
 
400
 
        Returns the new entry object."""
401
 
        from bzrlib.branch import gen_file_id
 
431
        The immediate parent must already be versioned"""
 
432
        from bzrlib.errors import NotVersionedError
402
433
        
403
434
        parts = bzrlib.osutils.splitpath(relpath)
404
435
        if len(parts) == 0:
405
436
            raise BzrError("cannot re-add root of inventory")
406
437
 
407
438
        if file_id == None:
 
439
            from bzrlib.branch import gen_file_id
408
440
            file_id = gen_file_id(relpath)
409
441
 
410
442
        parent_path = parts[:-1]
422
454
 
423
455
        >>> inv = Inventory()
424
456
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
425
 
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
426
457
        >>> '123' in inv
427
458
        True
428
459
        >>> del inv['123']
444
475
        del self[ie.parent_id].children[ie.name]
445
476
 
446
477
 
 
478
    def to_element(self):
 
479
        """Convert to XML Element"""
 
480
        from bzrlib.xml import Element
 
481
        
 
482
        e = Element('inventory')
 
483
        e.text = '\n'
 
484
        if self.root.file_id not in (None, ROOT_ID):
 
485
            e.set('file_id', self.root.file_id)
 
486
        for path, ie in self.iter_entries():
 
487
            e.append(ie.to_element())
 
488
        return e
 
489
    
 
490
 
 
491
    def from_element(cls, elt):
 
492
        """Construct from XML Element
 
493
        
 
494
        >>> inv = Inventory()
 
495
        >>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
 
496
        >>> elt = inv.to_element()
 
497
        >>> inv2 = Inventory.from_element(elt)
 
498
        >>> inv2 == inv
 
499
        True
 
500
        """
 
501
        # XXXX: doctest doesn't run this properly under python2.3
 
502
        assert elt.tag == 'inventory'
 
503
        root_id = elt.get('file_id') or ROOT_ID
 
504
        o = cls(root_id)
 
505
        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)
 
510
        return o
 
511
        
 
512
    from_element = classmethod(from_element)
 
513
 
 
514
 
447
515
    def __eq__(self, other):
448
516
        """Compare two sets by comparing their contents.
449
517
 
452
520
        >>> i1 == i2
453
521
        True
454
522
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
455
 
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
456
523
        >>> i1 == i2
457
524
        False
458
525
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
459
 
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
460
526
        >>> i1 == i2
461
527
        True
462
528
        """
478
544
        raise ValueError('not hashable')
479
545
 
480
546
 
 
547
 
481
548
    def get_idpath(self, file_id):
482
549
        """Return a list of file_ids for the path to an entry.
483
550
 
576
643
 
577
644
 
578
645
 
579
 
_NAME_RE = None
 
646
_NAME_RE = re.compile(r'^[^/\\]+$')
580
647
 
581
648
def is_valid_name(name):
582
 
    global _NAME_RE
583
 
    if _NAME_RE == None:
584
 
        _NAME_RE = re.compile(r'^[^/\\]+$')
585
 
        
586
649
    return bool(_NAME_RE.match(name))