/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Robert Collins
  • Date: 2005-09-26 08:56:15 UTC
  • mto: (1092.3.4)
  • mto: This revision was merged to the branch mainline in revision 1390.
  • Revision ID: robertc@robertcollins.net-20050926085615-99b8fb35f41b541d
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/inventory.py
20
20
ROOT_ID = "TREE_ROOT"
21
21
 
22
22
 
23
 
import sys, os.path, types, re
 
23
import os.path
 
24
import re
 
25
import sys
 
26
import types
24
27
 
25
28
import bzrlib
26
29
from bzrlib.errors import BzrError, BzrCheckError
27
30
 
28
 
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
 
31
from bzrlib.osutils import quotefn, splitpath, joinpath, appendpath
29
32
from bzrlib.trace import mutter
30
33
from bzrlib.errors import NotVersionedError
31
 
        
 
34
 
32
35
 
33
36
class InventoryEntry(object):
34
37
    """Description of a versioned file.
55
58
    >>> i.path2id('')
56
59
    'TREE_ROOT'
57
60
    >>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
 
61
    InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
58
62
    >>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
 
63
    InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
59
64
    >>> for j in i.iter_entries():
60
65
    ...   print j
61
66
    ... 
66
71
    ...
67
72
    BzrError: inventory already contains entry with id {2323}
68
73
    >>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
 
74
    InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
69
75
    >>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
 
76
    InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
70
77
    >>> i.path2id('src/wibble')
71
78
    '2325'
72
79
    >>> '2325' in i
73
80
    True
74
81
    >>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
 
82
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
75
83
    >>> i['2326']
76
84
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
77
 
    >>> for j in i.iter_entries():
78
 
    ...     print j[0]
79
 
    ...     assert i.path2id(j[0])
 
85
    >>> for path, entry in i.iter_entries():
 
86
    ...     print path.replace('\\\\', '/')     # for win32 os.sep
 
87
    ...     assert i.path2id(path)
80
88
    ... 
81
89
    src
82
90
    src/bye.c
83
91
    src/hello.c
84
92
    src/wibble
85
93
    src/wibble/wibble.c
86
 
    >>> i.id2path('2326')
 
94
    >>> i.id2path('2326').replace('\\\\', '/')
87
95
    'src/wibble/wibble.c'
88
96
 
89
97
    TODO: Maybe also keep the full path of the entry, and the children?
95
103
    # directories, etc etc.
96
104
 
97
105
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
98
 
                 'text_id', 'parent_id', 'children', ]
 
106
                 'text_id', 'parent_id', 'children',
 
107
                 'text_version', 'entry_version', ]
 
108
 
99
109
 
100
110
    def __init__(self, file_id, name, kind, parent_id, text_id=None):
101
111
        """Create an InventoryEntry
112
122
        Traceback (most recent call last):
113
123
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
114
124
        """
 
125
        assert isinstance(name, basestring), name
115
126
        if '/' in name or '\\' in name:
116
127
            raise BzrCheckError('InventoryEntry name %r is invalid' % name)
117
128
        
 
129
        self.text_version = None
 
130
        self.entry_version = None
118
131
        self.text_sha1 = None
119
132
        self.text_size = None
120
 
    
121
133
        self.file_id = file_id
122
134
        self.name = name
123
135
        self.kind = kind
157
169
                   self.parent_id))
158
170
 
159
171
    
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
172
    def __eq__(self, other):
215
173
        if not isinstance(other, InventoryEntry):
216
174
            return NotImplemented
221
179
               and (self.text_size == other.text_size) \
222
180
               and (self.text_id == other.text_id) \
223
181
               and (self.parent_id == other.parent_id) \
224
 
               and (self.kind == other.kind)
 
182
               and (self.kind == other.kind) \
 
183
               and (self.text_version == other.text_version) \
 
184
               and (self.entry_version == other.entry_version)
225
185
 
226
186
 
227
187
    def __ne__(self, other):
268
228
 
269
229
    >>> inv = Inventory()
270
230
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
231
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
271
232
    >>> inv['123-123'].name
272
233
    'hello.c'
273
234
 
284
245
    ['hello.c']
285
246
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
286
247
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
248
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT-12345678-12345678')
287
249
    """
288
250
    def __init__(self, root_id=ROOT_ID):
289
251
        """Create or read an inventory.
295
257
        The inventory is created with a default root directory, with
296
258
        an id of None.
297
259
        """
298
 
        # We are letting Branch(init=True) create a unique inventory
 
260
        # We are letting Branch.initialize() create a unique inventory
299
261
        # root id. Rather than generating a random one here.
300
262
        #if root_id is None:
301
263
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
371
333
 
372
334
        >>> inv = Inventory()
373
335
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
336
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
374
337
        >>> '123' in inv
375
338
        True
376
339
        >>> '456' in inv
384
347
 
385
348
        >>> inv = Inventory()
386
349
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
 
350
        InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
387
351
        >>> inv['123123'].name
388
352
        'hello.c'
389
353
        """
407
371
        """Add entry to inventory.
408
372
 
409
373
        To add  a file to a branch ready to be committed, use Branch.add,
410
 
        which calls this."""
 
374
        which calls this.
 
375
 
 
376
        Returns the new entry object.
 
377
        """
411
378
        if entry.file_id in self._byid:
412
379
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
413
380
 
425
392
 
426
393
        self._byid[entry.file_id] = entry
427
394
        parent.children[entry.name] = entry
 
395
        return entry
428
396
 
429
397
 
430
398
    def add_path(self, relpath, kind, file_id=None):
431
399
        """Add entry from a path.
432
400
 
433
 
        The immediate parent must already be versioned"""
 
401
        The immediate parent must already be versioned.
 
402
 
 
403
        Returns the new entry object."""
434
404
        from bzrlib.branch import gen_file_id
435
405
        
436
406
        parts = bzrlib.osutils.splitpath(relpath)
455
425
 
456
426
        >>> inv = Inventory()
457
427
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
428
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
458
429
        >>> '123' in inv
459
430
        True
460
431
        >>> del inv['123']
476
447
        del self[ie.parent_id].children[ie.name]
477
448
 
478
449
 
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
450
    def __eq__(self, other):
517
451
        """Compare two sets by comparing their contents.
518
452
 
521
455
        >>> i1 == i2
522
456
        True
523
457
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
458
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
524
459
        >>> i1 == i2
525
460
        False
526
461
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
462
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
527
463
        >>> i1 == i2
528
464
        True
529
465
        """
545
481
        raise ValueError('not hashable')
546
482
 
547
483
 
548
 
 
549
484
    def get_idpath(self, file_id):
550
485
        """Return a list of file_ids for the path to an entry.
551
486
 
644
579
 
645
580
 
646
581
 
647
 
_NAME_RE = re.compile(r'^[^/\\]+$')
 
582
_NAME_RE = None
648
583
 
649
584
def is_valid_name(name):
 
585
    global _NAME_RE
 
586
    if _NAME_RE == None:
 
587
        _NAME_RE = re.compile(r'^[^/\\]+$')
 
588
        
650
589
    return bool(_NAME_RE.match(name))