← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Aaron Bentley
  • Date: 2005-09-18 19:21:48 UTC
  • mto: (1185.1.29)
  • mto: This revision was merged to the branch mainline in revision 1390.
  • Revision ID: aaron.bentley@utoronto.ca-20050918192148-3f9373ac85a83b02
Refactored and documented graph stuff

Show diffs side-by-side

added added

removed removed

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