« back to all changes in this revision
Viewing changes to bzrlib/inventory.py
- browse files at revision 6
- compare with another revision
- download diff
- download tarball
- view history from revision 6
- Committer: mbp at sourcefrog
- Date: 2005-03-09 04:51:05 UTC
- Revision ID: mbp@sourcefrog.net-20050309045105-d02cd410a115da2c
import all docs from arch
- files added:
- bzrlib/tests.py
- files removed:
- .bzrignore
- contrib
- contrib/bash
- contrib/zsh
- elementtree
- notes
- patches
- urlgrabber
- files renamed:
- bzrlib/commands.py => bzr.py
- files modified:
- README
added
removed
bzrlib/inventory.py
1
# (C) 2005 Canonical Ltd
1
#! /usr/bin/env python
2
# -*- coding: UTF-8 -*-
2
3
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
14
15
# along with this program; if not, write to the Free Software
15
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
17
17
18
# This should really be an id randomly assigned when the tree is
19
# created, but it's not for now.
20
ROOT_ID = "TREE_ROOT"
21
22
23
import sys, os.path, types, re
24
25
try:
26
from cElementTree import Element, ElementTree, SubElement
27
except ImportError:
28
from elementtree.ElementTree import Element, ElementTree, SubElement
18
"""Inventories map files to their name in a revision."""
19
20
21
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
22
__author__ = "Martin Pool <mbp@canonical.com>"
23
24
import sys, os.path, types
25
from sets import Set
29
26
30
27
from xml import XMLMixin
31
from errors import bailout, BzrError, BzrCheckError
32
33
import bzrlib
34
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
35
from bzrlib.trace import mutter
28
from ElementTree import ElementTree, Element
29
from errors import bailout
30
from osutils import uuid, quotefn, splitpath, joinpath, appendpath
31
from trace import mutter
36
32
37
33
class InventoryEntry(XMLMixin):
38
34
"""Description of a versioned file.
57
53
58
54
>>> i = Inventory()
59
55
>>> i.path2id('')
60
'TREE_ROOT'
61
>>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
62
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
56
>>> i.add(InventoryEntry('123', 'src', kind='directory'))
57
>>> i.add(InventoryEntry('2323', 'hello.c', parent_id='123'))
63
58
>>> for j in i.iter_entries():
64
59
... print j
65
60
...
66
('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
61
('src', InventoryEntry('123', 'src', kind='directory', parent_id=None))
67
62
('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
68
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
63
>>> i.add(InventoryEntry('2323', 'bye.c', parent_id='123'))
69
64
Traceback (most recent call last):
70
65
...
71
66
BzrError: ('inventory already contains entry with id {2323}', [])
72
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
73
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
67
>>> i.add(InventoryEntry('2324', 'bye.c', parent_id='123'))
68
>>> i.add(InventoryEntry('2325', 'wibble', parent_id='123', kind='directory'))
74
69
>>> i.path2id('src/wibble')
75
70
'2325'
76
71
>>> '2325' in i
77
72
True
78
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
73
>>> i.add(InventoryEntry('2326', 'wibble.c', parent_id='2325'))
79
74
>>> i['2326']
80
75
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
81
76
>>> for j in i.iter_entries():
90
85
>>> i.id2path('2326')
91
86
'src/wibble/wibble.c'
92
87
93
TODO: Maybe also keep the full path of the entry, and the children?
88
:todo: Maybe also keep the full path of the entry, and the children?
94
89
But those depend on its position within a particular inventory, and
95
90
it would be nice not to need to hold the backpointer here.
96
91
"""
97
98
# TODO: split InventoryEntry into subclasses for files,
99
# directories, etc etc.
100
101
text_sha1 = None
102
text_size = None
103
104
def __init__(self, file_id, name, kind, parent_id, text_id=None):
92
def __init__(self, file_id, name, kind='file', text_id=None,
93
parent_id=None):
105
94
"""Create an InventoryEntry
106
95
107
96
The filename must be a single component, relative to the
108
97
parent directory; it cannot be a whole path or relative name.
109
98
110
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
99
>>> e = InventoryEntry('123', 'hello.c')
111
100
>>> e.name
112
101
'hello.c'
113
102
>>> e.file_id
114
103
'123'
115
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
104
>>> e = InventoryEntry('123', 'src/hello.c')
116
105
Traceback (most recent call last):
117
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
106
BzrError: ("InventoryEntry name is not a simple filename: 'src/hello.c'", [])
118
107
"""
119
if '/' in name or '\\' in name:
120
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
108
109
if len(splitpath(name)) != 1:
110
bailout('InventoryEntry name is not a simple filename: %r'
111
% name)
121
112
122
113
self.file_id = file_id
123
114
self.name = name
115
assert kind in ['file', 'directory']
124
116
self.kind = kind
125
117
self.text_id = text_id
126
118
self.parent_id = parent_id
127
if kind == 'directory':
128
self.children = {}
129
elif kind == 'file':
130
pass
131
else:
132
raise BzrError("unhandled entry kind %r" % kind)
133
134
135
136
def sorted_children(self):
137
l = self.children.items()
138
l.sort()
139
return l
119
self.text_sha1 = None
120
self.text_size = None
140
121
141
122
142
123
def copy(self):
143
124
other = InventoryEntry(self.file_id, self.name, self.kind,
144
self.parent_id, text_id=self.text_id)
125
self.text_id, self.parent_id)
145
126
other.text_sha1 = self.text_sha1
146
127
other.text_size = self.text_size
147
# note that children are *not* copied; they're pulled across when
148
# others are added
149
128
return other
150
129
151
130
166
145
e.set('file_id', self.file_id)
167
146
e.set('kind', self.kind)
168
147
169
if self.text_size != None:
148
if self.text_size is not None:
170
149
e.set('text_size', '%d' % self.text_size)
171
150
172
for f in ['text_id', 'text_sha1']:
151
for f in ['text_id', 'text_sha1', 'parent_id']:
173
152
v = getattr(self, f)
174
if v != None:
153
if v is not None:
175
154
e.set(f, v)
176
155
177
# to be conservative, we don't externalize the root pointers
178
# for now, leaving them as null in the xml form. in a future
179
# version it will be implied by nested elements.
180
if self.parent_id != ROOT_ID:
181
assert isinstance(self.parent_id, basestring)
182
e.set('parent_id', self.parent_id)
183
184
156
e.tail = '\n'
185
157
186
158
return e
188
160
189
161
def from_element(cls, elt):
190
162
assert elt.tag == 'entry'
191
192
## original format inventories don't have a parent_id for
193
## nodes in the root directory, but it's cleaner to use one
194
## internally.
195
parent_id = elt.get('parent_id')
196
if parent_id == None:
197
parent_id = ROOT_ID
198
199
self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
163
self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'))
200
164
self.text_id = elt.get('text_id')
201
165
self.text_sha1 = elt.get('text_sha1')
166
self.parent_id = elt.get('parent_id')
202
167
203
168
## mutter("read inventoryentry: %r" % (elt.attrib))
204
169
210
175
211
176
from_element = classmethod(from_element)
212
177
213
def __eq__(self, other):
178
def __cmp__(self, other):
179
if self is other:
180
return 0
214
181
if not isinstance(other, InventoryEntry):
215
182
return NotImplemented
216
183
217
return (self.file_id == other.file_id) \
218
and (self.name == other.name) \
219
and (self.text_sha1 == other.text_sha1) \
220
and (self.text_size == other.text_size) \
221
and (self.text_id == other.text_id) \
222
and (self.parent_id == other.parent_id) \
223
and (self.kind == other.kind)
224
225
226
def __ne__(self, other):
227
return not (self == other)
228
229
def __hash__(self):
230
raise ValueError('not hashable')
231
232
233
234
class RootEntry(InventoryEntry):
235
def __init__(self, file_id):
236
self.file_id = file_id
237
self.children = {}
238
self.kind = 'root_directory'
239
self.parent_id = None
240
self.name = ''
241
242
def __eq__(self, other):
243
if not isinstance(other, RootEntry):
244
return NotImplemented
245
246
return (self.file_id == other.file_id) \
247
and (self.children == other.children)
184
return cmp(self.file_id, other.file_id) \
185
or cmp(self.name, other.name) \
186
or cmp(self.text_sha1, other.text_sha1) \
187
or cmp(self.text_size, other.text_size) \
188
or cmp(self.text_id, other.text_id) \
189
or cmp(self.parent_id, other.parent_id) \
190
or cmp(self.kind, other.kind)
248
191
249
192
250
193
251
194
class Inventory(XMLMixin):
252
195
"""Inventory of versioned files in a tree.
253
196
254
This describes which file_id is present at each point in the tree,
255
and possibly the SHA-1 or other information about the file.
256
Entries can be looked up either by path or by file_id.
197
An Inventory acts like a set of InventoryEntry items. You can
198
also look files up by their file_id or name.
199
200
May be read from and written to a metadata file in a tree. To
201
manipulate the inventory (for example to add a file), it is read
202
in, modified, and then written back out.
257
203
258
204
The inventory represents a typical unix file tree, with
259
205
directories containing files and subdirectories. We never store
263
209
returned quickly.
264
210
265
211
InventoryEntry objects must not be modified after they are
266
inserted, other than through the Inventory API.
212
inserted.
267
213
268
214
>>> inv = Inventory()
269
215
>>> inv.write_xml(sys.stdout)
270
216
<inventory>
271
217
</inventory>
272
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
218
>>> inv.add(InventoryEntry('123-123', 'hello.c'))
273
219
>>> inv['123-123'].name
274
220
'hello.c'
221
>>> for file_id in inv: print file_id
222
...
223
123-123
275
224
276
225
May be treated as an iterator or set to look up file ids:
277
226
291
240
</inventory>
292
241
293
242
"""
243
244
## TODO: Clear up handling of files in subdirectories; we probably
245
## do want to be able to just look them up by name but this
246
## probably means gradually walking down the path, looking up as we go.
247
248
## TODO: Make sure only canonical filenames are stored.
249
250
## TODO: Do something sensible about the possible collisions on
251
## case-losing filesystems. Perhaps we should just always forbid
252
## such collisions.
253
254
## _tree should probably just be stored as
255
## InventoryEntry._children on each directory.
256
294
257
def __init__(self):
295
258
"""Create or read an inventory.
296
259
297
260
If a working directory is specified, the inventory is read
298
261
from there. If the file is specified, read from that. If not,
299
262
the inventory is created empty.
300
301
The inventory is created with a default root directory, with
302
an id of None.
303
263
"""
304
self.root = RootEntry(ROOT_ID)
305
self._byid = {self.root.file_id: self.root}
264
self._byid = dict()
265
266
# _tree is indexed by parent_id; at each level a map from name
267
# to ie. The None entry is the root.
268
self._tree = {None: {}}
306
269
307
270
308
271
def __iter__(self):
314
277
return len(self._byid)
315
278
316
279
317
def iter_entries(self, from_dir=None):
280
def iter_entries(self, parent_id=None):
318
281
"""Return (path, entry) pairs, in order by name."""
319
if from_dir == None:
320
assert self.root
321
from_dir = self.root
322
elif isinstance(from_dir, basestring):
323
from_dir = self._byid[from_dir]
324
325
kids = from_dir.children.items()
282
kids = self._tree[parent_id].items()
326
283
kids.sort()
327
284
for name, ie in kids:
328
285
yield name, ie
329
286
if ie.kind == 'directory':
330
for cn, cie in self.iter_entries(from_dir=ie.file_id):
331
yield os.path.join(name, cn), cie
332
333
334
def entries(self):
335
"""Return list of (path, ie) for all entries except the root.
336
337
This may be faster than iter_entries.
338
"""
339
accum = []
340
def descend(dir_ie, dir_path):
341
kids = dir_ie.children.items()
342
kids.sort()
343
for name, ie in kids:
344
child_path = os.path.join(dir_path, name)
345
accum.append((child_path, ie))
346
if ie.kind == 'directory':
347
descend(ie, child_path)
348
349
descend(self.root, '')
350
return accum
351
352
353
def directories(self):
354
"""Return (path, entry) pairs for all directories, including the root.
355
"""
356
accum = []
357
def descend(parent_ie, parent_path):
358
accum.append((parent_path, parent_ie))
359
360
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
361
kids.sort()
362
363
for name, child_ie in kids:
364
child_path = os.path.join(parent_path, name)
365
descend(child_ie, child_path)
366
descend(self.root, '')
367
return accum
287
for cn, cie in self.iter_entries(parent_id=ie.file_id):
288
yield joinpath([name, cn]), cie
289
290
291
def directories(self, include_root=True):
292
"""Return (path, entry) pairs for all directories.
293
"""
294
if include_root:
295
yield '', None
296
for path, entry in self.iter_entries():
297
if entry.kind == 'directory':
298
yield path, entry
368
299
369
300
370
301
302
def children(self, parent_id):
303
"""Return entries that are direct children of parent_id."""
304
return self._tree[parent_id]
305
306
307
308
# TODO: return all paths and entries
309
310
371
311
def __contains__(self, file_id):
372
312
"""True if this entry contains a file with given id.
373
313
374
314
>>> inv = Inventory()
375
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
315
>>> inv.add(InventoryEntry('123', 'foo.c'))
376
316
>>> '123' in inv
377
317
True
378
318
>>> '456' in inv
385
325
"""Return the entry for given file_id.
386
326
387
327
>>> inv = Inventory()
388
>>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
328
>>> inv.add(InventoryEntry('123123', 'hello.c'))
389
329
>>> inv['123123'].name
390
330
'hello.c'
391
331
"""
392
try:
393
return self._byid[file_id]
394
except KeyError:
395
if file_id == None:
396
raise BzrError("can't look up file_id None")
397
else:
398
raise BzrError("file_id {%s} not in inventory" % file_id)
399
400
401
def get_file_kind(self, file_id):
402
return self._byid[file_id].kind
403
404
def get_child(self, parent_id, filename):
405
return self[parent_id].children.get(filename)
332
return self._byid[file_id]
406
333
407
334
408
335
def add(self, entry):
410
337
411
338
To add a file to a branch ready to be committed, use Branch.add,
412
339
which calls this."""
413
if entry.file_id in self._byid:
340
if entry.file_id in self:
414
341
bailout("inventory already contains entry with id {%s}" % entry.file_id)
415
342
416
try:
417
parent = self._byid[entry.parent_id]
418
except KeyError:
419
bailout("parent_id {%s} not in inventory" % entry.parent_id)
420
421
if parent.children.has_key(entry.name):
422
bailout("%s is already versioned" %
423
appendpath(self.id2path(parent.file_id), entry.name))
343
if entry.parent_id != None:
344
if entry.parent_id not in self:
345
bailout("parent_id %s of new entry not found in inventory"
346
% entry.parent_id)
347
348
if self._tree[entry.parent_id].has_key(entry.name):
349
bailout("%s is already versioned"
350
% appendpath(self.id2path(entry.parent_id), entry.name))
424
351
425
352
self._byid[entry.file_id] = entry
426
parent.children[entry.name] = entry
427
428
429
def add_path(self, relpath, kind, file_id=None):
430
"""Add entry from a path.
431
432
The immediate parent must already be versioned"""
433
parts = bzrlib.osutils.splitpath(relpath)
434
if len(parts) == 0:
435
bailout("cannot re-add root of inventory")
436
437
if file_id == None:
438
file_id = bzrlib.branch.gen_file_id(relpath)
439
440
parent_id = self.path2id(parts[:-1])
441
assert parent_id != None
442
ie = InventoryEntry(file_id, parts[-1],
443
kind=kind, parent_id=parent_id)
444
return self.add(ie)
353
self._tree[entry.parent_id][entry.name] = entry
354
355
if entry.kind == 'directory':
356
self._tree[entry.file_id] = {}
445
357
446
358
447
359
def __delitem__(self, file_id):
448
360
"""Remove entry by id.
449
361
450
362
>>> inv = Inventory()
451
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
363
>>> inv.add(InventoryEntry('123', 'foo.c'))
452
364
>>> '123' in inv
453
365
True
454
366
>>> del inv['123']
457
369
"""
458
370
ie = self[file_id]
459
371
460
assert self[ie.parent_id].children[ie.name] == ie
372
assert self._tree[ie.parent_id][ie.name] == ie
461
373
462
374
# TODO: Test deleting all children; maybe hoist to a separate
463
375
# deltree method?
464
376
if ie.kind == 'directory':
465
for cie in ie.children.values():
377
for cie in self._tree[file_id].values():
466
378
del self[cie.file_id]
467
del ie.children
379
del self._tree[file_id]
468
380
469
381
del self._byid[file_id]
470
del self[ie.parent_id].children[ie.name]
382
del self._tree[ie.parent_id][ie.name]
383
384
385
def id_set(self):
386
return Set(self._byid)
471
387
472
388
473
389
def to_element(self):
483
399
"""Construct from XML Element
484
400
485
401
>>> inv = Inventory()
486
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
402
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c'))
487
403
>>> elt = inv.to_element()
488
404
>>> inv2 = Inventory.from_element(elt)
489
405
>>> inv2 == inv
498
414
from_element = classmethod(from_element)
499
415
500
416
501
def __eq__(self, other):
417
def __cmp__(self, other):
502
418
"""Compare two sets by comparing their contents.
503
419
504
420
>>> i1 = Inventory()
505
421
>>> i2 = Inventory()
506
422
>>> i1 == i2
507
423
True
508
>>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
424
>>> i1.add(InventoryEntry('123', 'foo'))
509
425
>>> i1 == i2
510
426
False
511
>>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
427
>>> i2.add(InventoryEntry('123', 'foo'))
512
428
>>> i1 == i2
513
429
True
514
430
"""
431
if self is other:
432
return 0
433
515
434
if not isinstance(other, Inventory):
516
435
return NotImplemented
517
436
518
if len(self._byid) != len(other._byid):
519
# shortcut: obviously not the same
520
return False
521
522
return self._byid == other._byid
523
524
525
def __ne__(self, other):
526
return not (self == other)
527
528
529
def __hash__(self):
530
raise ValueError('not hashable')
531
532
533
534
def get_idpath(self, file_id):
535
"""Return a list of file_ids for the path to an entry.
536
537
The list contains one element for each directory followed by
538
the id of the file itself. So the length of the returned list
539
is equal to the depth of the file in the tree, counting the
540
root directory as depth 1.
541
"""
437
if self.id_set() ^ other.id_set():
438
return 1
439
440
for file_id in self._byid:
441
c = cmp(self[file_id], other[file_id])
442
if c: return c
443
444
return 0
445
446
447
def id2path(self, file_id):
448
"""Return as a list the path to file_id."""
542
449
p = []
543
450
while file_id != None:
544
try:
545
ie = self._byid[file_id]
546
except KeyError:
547
bailout("file_id {%s} not found in inventory" % file_id)
548
p.insert(0, ie.file_id)
451
ie = self[file_id]
452
p = [ie.name] + p
549
453
file_id = ie.parent_id
550
return p
551
552
553
def id2path(self, file_id):
554
"""Return as a list the path to file_id."""
555
556
# get all names, skipping root
557
p = [self[fid].name for fid in self.get_idpath(file_id)[1:]]
558
return os.sep.join(p)
454
return joinpath(p)
559
455
560
456
561
457
567
463
568
464
This returns the entry of the last component in the path,
569
465
which may be either a file or a directory.
570
571
Returns None iff the path is not found.
572
466
"""
573
if isinstance(name, types.StringTypes):
574
name = splitpath(name)
575
576
mutter("lookup path %r" % name)
577
578
parent = self.root
579
for f in name:
467
assert isinstance(name, types.StringTypes)
468
469
parent_id = None
470
for f in splitpath(name):
580
471
try:
581
cie = parent.children[f]
472
cie = self._tree[parent_id][f]
582
473
assert cie.name == f
583
assert cie.parent_id == parent.file_id
584
parent = cie
474
parent_id = cie.file_id
585
475
except KeyError:
586
476
# or raise an error?
587
477
return None
588
478
589
return parent.file_id
479
return parent_id
480
481
482
def get_child(self, parent_id, child_name):
483
return self._tree[parent_id].get(child_name)
590
484
591
485
592
486
def has_filename(self, names):
594
488
595
489
596
490
def has_id(self, file_id):
491
assert isinstance(file_id, str)
597
492
return self._byid.has_key(file_id)
598
493
599
494
600
def rename(self, file_id, new_parent_id, new_name):
601
"""Move a file within the inventory.
602
603
This can change either the name, or the parent, or both.
604
605
This does not move the working file."""
606
if not is_valid_name(new_name):
607
bailout("not an acceptable filename: %r" % new_name)
608
609
new_parent = self._byid[new_parent_id]
610
if new_name in new_parent.children:
611
bailout("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
612
613
new_parent_idpath = self.get_idpath(new_parent_id)
614
if file_id in new_parent_idpath:
615
bailout("cannot move directory %r into a subdirectory of itself, %r"
616
% (self.id2path(file_id), self.id2path(new_parent_id)))
617
618
file_ie = self._byid[file_id]
619
old_parent = self._byid[file_ie.parent_id]
620
621
# TODO: Don't leave things messed up if this fails
622
623
del old_parent.children[file_ie.name]
624
new_parent.children[new_name] = file_ie
625
626
file_ie.name = new_name
627
file_ie.parent_id = new_parent_id
628
629
630
631
632
_NAME_RE = re.compile(r'^[^/\\]+$')
633
634
def is_valid_name(name):
635
return bool(_NAME_RE.match(name))
495
496
if __name__ == '__main__':
497
import doctest, inventory
498
doctest.testmod(inventory)
Loggerhead is a web-based interface for Breezy
Version: 2.0.1