← 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-11 04:53:07 UTC
  • Revision ID: mbp@sourcefrog.net-20050711045307-2b38378d043dc25c
- Refactor weave calculation of inclusions

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():
99
92
    # TODO: split InventoryEntry into subclasses for files,
100
93
    # directories, etc etc.
101
94
 
102
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
103
 
                 'text_id', 'parent_id', 'children',
104
 
                 'text_version', 'entry_version', ]
105
 
 
106
 
 
 
95
    text_sha1 = None
 
96
    text_size = None
 
97
    
107
98
    def __init__(self, file_id, name, kind, parent_id, text_id=None):
108
99
        """Create an InventoryEntry
109
100
        
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
 
        self.text_sha1 = None
129
 
        self.text_size = None
130
116
        self.file_id = file_id
131
117
        self.name = name
132
118
        self.kind = kind
166
152
                   self.parent_id))
167
153
 
168
154
    
 
155
    def to_element(self):
 
156
        """Convert to XML element"""
 
157
        from bzrlib.xml import Element
 
158
        
 
159
        e = Element('entry')
 
160
 
 
161
        e.set('name', self.name)
 
162
        e.set('file_id', self.file_id)
 
163
        e.set('kind', self.kind)
 
164
 
 
165
        if self.text_size != None:
 
166
            e.set('text_size', '%d' % self.text_size)
 
167
            
 
168
        for f in ['text_id', 'text_sha1']:
 
169
            v = getattr(self, f)
 
170
            if v != None:
 
171
                e.set(f, v)
 
172
 
 
173
        # to be conservative, we don't externalize the root pointers
 
174
        # for now, leaving them as null in the xml form.  in a future
 
175
        # version it will be implied by nested elements.
 
176
        if self.parent_id != ROOT_ID:
 
177
            assert isinstance(self.parent_id, basestring)
 
178
            e.set('parent_id', self.parent_id)
 
179
 
 
180
        e.tail = '\n'
 
181
            
 
182
        return e
 
183
 
 
184
 
 
185
    def from_element(cls, elt):
 
186
        assert elt.tag == 'entry'
 
187
 
 
188
        ## original format inventories don't have a parent_id for
 
189
        ## nodes in the root directory, but it's cleaner to use one
 
190
        ## internally.
 
191
        parent_id = elt.get('parent_id')
 
192
        if parent_id == None:
 
193
            parent_id = ROOT_ID
 
194
 
 
195
        self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
 
196
        self.text_id = elt.get('text_id')
 
197
        self.text_sha1 = elt.get('text_sha1')
 
198
        
 
199
        ## mutter("read inventoryentry: %r" % (elt.attrib))
 
200
 
 
201
        v = elt.get('text_size')
 
202
        self.text_size = v and int(v)
 
203
 
 
204
        return self
 
205
            
 
206
 
 
207
    from_element = classmethod(from_element)
 
208
 
169
209
    def __eq__(self, other):
170
210
        if not isinstance(other, InventoryEntry):
171
211
            return NotImplemented
176
216
               and (self.text_size == other.text_size) \
177
217
               and (self.text_id == other.text_id) \
178
218
               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)
 
219
               and (self.kind == other.kind)
182
220
 
183
221
 
184
222
    def __ne__(self, other):
225
263
 
226
264
    >>> inv = Inventory()
227
265
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
228
 
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
229
266
    >>> inv['123-123'].name
230
267
    'hello.c'
231
268
 
240
277
 
241
278
    >>> [x[0] for x in inv.iter_entries()]
242
279
    ['hello.c']
243
 
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
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')
246
280
    """
247
 
    def __init__(self, root_id=ROOT_ID):
 
281
    def __init__(self):
248
282
        """Create or read an inventory.
249
283
 
250
284
        If a working directory is specified, the inventory is read
254
288
        The inventory is created with a default root directory, with
255
289
        an id of None.
256
290
        """
257
 
        # We are letting Branch(init=True) create a unique inventory
258
 
        # root id. Rather than generating a random one here.
259
 
        #if root_id is None:
260
 
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
261
 
        self.root = RootEntry(root_id)
 
291
        self.root = RootEntry(ROOT_ID)
262
292
        self._byid = {self.root.file_id: self.root}
263
293
 
264
294
 
330
360
 
331
361
        >>> inv = Inventory()
332
362
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
333
 
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
334
363
        >>> '123' in inv
335
364
        True
336
365
        >>> '456' in inv
344
373
 
345
374
        >>> inv = Inventory()
346
375
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
347
 
        InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
348
376
        >>> inv['123123'].name
349
377
        'hello.c'
350
378
        """
368
396
        """Add entry to inventory.
369
397
 
370
398
        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
 
        """
 
399
        which calls this."""
375
400
        if entry.file_id in self._byid:
376
401
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
377
402
 
378
 
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
379
 
            entry.parent_id = self.root.file_id
380
 
 
381
403
        try:
382
404
            parent = self._byid[entry.parent_id]
383
405
        except KeyError:
389
411
 
390
412
        self._byid[entry.file_id] = entry
391
413
        parent.children[entry.name] = entry
392
 
        return entry
393
414
 
394
415
 
395
416
    def add_path(self, relpath, kind, file_id=None):
396
417
        """Add entry from a path.
397
418
 
398
 
        The immediate parent must already be versioned.
399
 
 
400
 
        Returns the new entry object."""
401
 
        from bzrlib.branch import gen_file_id
 
419
        The immediate parent must already be versioned"""
 
420
        from bzrlib.errors import NotVersionedError
402
421
        
403
422
        parts = bzrlib.osutils.splitpath(relpath)
404
423
        if len(parts) == 0:
405
424
            raise BzrError("cannot re-add root of inventory")
406
425
 
407
426
        if file_id == None:
 
427
            from bzrlib.branch import gen_file_id
408
428
            file_id = gen_file_id(relpath)
409
429
 
410
430
        parent_path = parts[:-1]
422
442
 
423
443
        >>> inv = Inventory()
424
444
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
425
 
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
426
445
        >>> '123' in inv
427
446
        True
428
447
        >>> del inv['123']
444
463
        del self[ie.parent_id].children[ie.name]
445
464
 
446
465
 
 
466
    def to_element(self):
 
467
        """Convert to XML Element"""
 
468
        from bzrlib.xml import Element
 
469
        
 
470
        e = Element('inventory')
 
471
        e.text = '\n'
 
472
        for path, ie in self.iter_entries():
 
473
            e.append(ie.to_element())
 
474
        return e
 
475
    
 
476
 
 
477
    def from_element(cls, elt):
 
478
        """Construct from XML Element
 
479
        
 
480
        >>> inv = Inventory()
 
481
        >>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
 
482
        >>> elt = inv.to_element()
 
483
        >>> inv2 = Inventory.from_element(elt)
 
484
        >>> inv2 == inv
 
485
        True
 
486
        """
 
487
        # XXXX: doctest doesn't run this properly under python2.3
 
488
        assert elt.tag == 'inventory'
 
489
        o = cls()
 
490
        for e in elt:
 
491
            o.add(InventoryEntry.from_element(e))
 
492
        return o
 
493
        
 
494
    from_element = classmethod(from_element)
 
495
 
 
496
 
447
497
    def __eq__(self, other):
448
498
        """Compare two sets by comparing their contents.
449
499
 
452
502
        >>> i1 == i2
453
503
        True
454
504
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
455
 
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
456
505
        >>> i1 == i2
457
506
        False
458
507
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
459
 
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
460
508
        >>> i1 == i2
461
509
        True
462
510
        """
478
526
        raise ValueError('not hashable')
479
527
 
480
528
 
 
529
 
481
530
    def get_idpath(self, file_id):
482
531
        """Return a list of file_ids for the path to an entry.
483
532
 
501
550
        """Return as a list the path to file_id."""
502
551
 
503
552
        # get all names, skipping root
504
 
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
 
553
        p = [self[fid].name for fid in self.get_idpath(file_id)[1:]]
505
554
        return os.sep.join(p)
506
555
            
507
556
 
576
625
 
577
626
 
578
627
 
579
 
_NAME_RE = None
 
628
_NAME_RE = re.compile(r'^[^/\\]+$')
580
629
 
581
630
def is_valid_name(name):
582
 
    global _NAME_RE
583
 
    if _NAME_RE == None:
584
 
        _NAME_RE = re.compile(r'^[^/\\]+$')
585
 
        
586
631
    return bool(_NAME_RE.match(name))