« back to all changes in this revision
Viewing changes to bzrlib/inventory.py
- browse files at revision 20
- compare with another revision
- download diff
- download tarball
- view history from revision 20
- Committer: mbp at sourcefrog
- Date: 2005-03-11 06:24:40 UTC
- Revision ID: mbp@sourcefrog.net-20050311062440-fd4ec249b6b139ab
don't abort on trees that happen to contain symlinks
(they still can't be versioned though).
(they still can't be versioned though).
- files added:
- bzrlib/tests.py
- files removed:
- .bzrignore
- contrib
- contrib/bash
- contrib/zsh
- elementtree
- 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
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
24
26
25
27
try:
26
28
from cElementTree import Element, ElementTree, SubElement
27
29
except ImportError:
28
from elementtree.ElementTree import Element, ElementTree, SubElement
30
from elementtree import Element, ElementTree, SubElement
29
31
30
32
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
33
from errors import bailout
34
from osutils import uuid, quotefn, splitpath, joinpath, appendpath
35
from trace import mutter
36
36
37
37
class InventoryEntry(XMLMixin):
38
38
"""Description of a versioned file.
57
57
58
58
>>> i = Inventory()
59
59
>>> 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'))
60
>>> i.add(InventoryEntry('123', 'src', kind='directory'))
61
>>> i.add(InventoryEntry('2323', 'hello.c', parent_id='123'))
63
62
>>> for j in i.iter_entries():
64
63
... print j
65
64
...
66
('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
65
('src', InventoryEntry('123', 'src', kind='directory', parent_id=None))
67
66
('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
68
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
67
>>> i.add(InventoryEntry('2323', 'bye.c', parent_id='123'))
69
68
Traceback (most recent call last):
70
69
...
71
70
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'))
71
>>> i.add(InventoryEntry('2324', 'bye.c', parent_id='123'))
72
>>> i.add(InventoryEntry('2325', 'wibble', parent_id='123', kind='directory'))
74
73
>>> i.path2id('src/wibble')
75
74
'2325'
76
75
>>> '2325' in i
77
76
True
78
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
77
>>> i.add(InventoryEntry('2326', 'wibble.c', parent_id='2325'))
79
78
>>> i['2326']
80
79
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
81
80
>>> for j in i.iter_entries():
90
89
>>> i.id2path('2326')
91
90
'src/wibble/wibble.c'
92
91
93
TODO: Maybe also keep the full path of the entry, and the children?
92
:todo: Maybe also keep the full path of the entry, and the children?
94
93
But those depend on its position within a particular inventory, and
95
94
it would be nice not to need to hold the backpointer here.
96
95
"""
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):
96
def __init__(self, file_id, name, kind='file', text_id=None,
97
parent_id=None):
105
98
"""Create an InventoryEntry
106
99
107
100
The filename must be a single component, relative to the
108
101
parent directory; it cannot be a whole path or relative name.
109
102
110
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
103
>>> e = InventoryEntry('123', 'hello.c')
111
104
>>> e.name
112
105
'hello.c'
113
106
>>> e.file_id
114
107
'123'
115
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
108
>>> e = InventoryEntry('123', 'src/hello.c')
116
109
Traceback (most recent call last):
117
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
110
BzrError: ("InventoryEntry name is not a simple filename: 'src/hello.c'", [])
118
111
"""
119
if '/' in name or '\\' in name:
120
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
112
113
if len(splitpath(name)) != 1:
114
bailout('InventoryEntry name is not a simple filename: %r'
115
% name)
121
116
122
117
self.file_id = file_id
123
118
self.name = name
119
assert kind in ['file', 'directory']
124
120
self.kind = kind
125
121
self.text_id = text_id
126
122
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
123
self.text_sha1 = None
124
self.text_size = None
140
125
141
126
142
127
def copy(self):
143
128
other = InventoryEntry(self.file_id, self.name, self.kind,
144
self.parent_id, text_id=self.text_id)
129
self.text_id, self.parent_id)
145
130
other.text_sha1 = self.text_sha1
146
131
other.text_size = self.text_size
147
# note that children are *not* copied; they're pulled across when
148
# others are added
149
132
return other
150
133
151
134
166
149
e.set('file_id', self.file_id)
167
150
e.set('kind', self.kind)
168
151
169
if self.text_size != None:
152
if self.text_size is not None:
170
153
e.set('text_size', '%d' % self.text_size)
171
154
172
for f in ['text_id', 'text_sha1']:
155
for f in ['text_id', 'text_sha1', 'parent_id']:
173
156
v = getattr(self, f)
174
if v != None:
157
if v is not None:
175
158
e.set(f, v)
176
159
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
160
e.tail = '\n'
185
161
186
162
return e
188
164
189
165
def from_element(cls, elt):
190
166
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)
167
self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'))
200
168
self.text_id = elt.get('text_id')
201
169
self.text_sha1 = elt.get('text_sha1')
170
self.parent_id = elt.get('parent_id')
202
171
203
172
## mutter("read inventoryentry: %r" % (elt.attrib))
204
173
210
179
211
180
from_element = classmethod(from_element)
212
181
213
def __eq__(self, other):
182
def __cmp__(self, other):
183
if self is other:
184
return 0
214
185
if not isinstance(other, InventoryEntry):
215
186
return NotImplemented
216
187
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)
188
return cmp(self.file_id, other.file_id) \
189
or cmp(self.name, other.name) \
190
or cmp(self.text_sha1, other.text_sha1) \
191
or cmp(self.text_size, other.text_size) \
192
or cmp(self.text_id, other.text_id) \
193
or cmp(self.parent_id, other.parent_id) \
194
or cmp(self.kind, other.kind)
248
195
249
196
250
197
251
198
class Inventory(XMLMixin):
252
199
"""Inventory of versioned files in a tree.
253
200
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.
201
An Inventory acts like a set of InventoryEntry items. You can
202
also look files up by their file_id or name.
203
204
May be read from and written to a metadata file in a tree. To
205
manipulate the inventory (for example to add a file), it is read
206
in, modified, and then written back out.
257
207
258
208
The inventory represents a typical unix file tree, with
259
209
directories containing files and subdirectories. We never store
263
213
returned quickly.
264
214
265
215
InventoryEntry objects must not be modified after they are
266
inserted, other than through the Inventory API.
216
inserted.
267
217
268
218
>>> inv = Inventory()
269
219
>>> inv.write_xml(sys.stdout)
270
220
<inventory>
271
221
</inventory>
272
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
222
>>> inv.add(InventoryEntry('123-123', 'hello.c'))
273
223
>>> inv['123-123'].name
274
224
'hello.c'
225
>>> for file_id in inv: print file_id
226
...
227
123-123
275
228
276
229
May be treated as an iterator or set to look up file ids:
277
230
291
244
</inventory>
292
245
293
246
"""
247
248
## TODO: Clear up handling of files in subdirectories; we probably
249
## do want to be able to just look them up by name but this
250
## probably means gradually walking down the path, looking up as we go.
251
252
## TODO: Make sure only canonical filenames are stored.
253
254
## TODO: Do something sensible about the possible collisions on
255
## case-losing filesystems. Perhaps we should just always forbid
256
## such collisions.
257
258
## _tree should probably just be stored as
259
## InventoryEntry._children on each directory.
260
294
261
def __init__(self):
295
262
"""Create or read an inventory.
296
263
297
264
If a working directory is specified, the inventory is read
298
265
from there. If the file is specified, read from that. If not,
299
266
the inventory is created empty.
300
301
The inventory is created with a default root directory, with
302
an id of None.
303
267
"""
304
self.root = RootEntry(ROOT_ID)
305
self._byid = {self.root.file_id: self.root}
268
self._byid = dict()
269
270
# _tree is indexed by parent_id; at each level a map from name
271
# to ie. The None entry is the root.
272
self._tree = {None: {}}
306
273
307
274
308
275
def __iter__(self):
314
281
return len(self._byid)
315
282
316
283
317
def iter_entries(self, from_dir=None):
284
def iter_entries(self, parent_id=None):
318
285
"""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()
286
kids = self._tree[parent_id].items()
326
287
kids.sort()
327
288
for name, ie in kids:
328
289
yield name, ie
329
290
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
291
for cn, cie in self.iter_entries(parent_id=ie.file_id):
292
yield joinpath([name, cn]), cie
293
294
295
def directories(self, include_root=True):
296
"""Return (path, entry) pairs for all directories.
297
"""
298
if include_root:
299
yield '', None
300
for path, entry in self.iter_entries():
301
if entry.kind == 'directory':
302
yield path, entry
368
303
369
304
370
305
306
def children(self, parent_id):
307
"""Return entries that are direct children of parent_id."""
308
return self._tree[parent_id]
309
310
311
312
# TODO: return all paths and entries
313
314
371
315
def __contains__(self, file_id):
372
316
"""True if this entry contains a file with given id.
373
317
374
318
>>> inv = Inventory()
375
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
319
>>> inv.add(InventoryEntry('123', 'foo.c'))
376
320
>>> '123' in inv
377
321
True
378
322
>>> '456' in inv
385
329
"""Return the entry for given file_id.
386
330
387
331
>>> inv = Inventory()
388
>>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
332
>>> inv.add(InventoryEntry('123123', 'hello.c'))
389
333
>>> inv['123123'].name
390
334
'hello.c'
391
335
"""
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)
336
return self._byid[file_id]
406
337
407
338
408
339
def add(self, entry):
410
341
411
342
To add a file to a branch ready to be committed, use Branch.add,
412
343
which calls this."""
413
if entry.file_id in self._byid:
344
if entry.file_id in self:
414
345
bailout("inventory already contains entry with id {%s}" % entry.file_id)
415
346
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))
347
if entry.parent_id != None:
348
if entry.parent_id not in self:
349
bailout("parent_id %s of new entry not found in inventory"
350
% entry.parent_id)
351
352
if self._tree[entry.parent_id].has_key(entry.name):
353
bailout("%s is already versioned"
354
% appendpath(self.id2path(entry.parent_id), entry.name))
424
355
425
356
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)
357
self._tree[entry.parent_id][entry.name] = entry
358
359
if entry.kind == 'directory':
360
self._tree[entry.file_id] = {}
445
361
446
362
447
363
def __delitem__(self, file_id):
448
364
"""Remove entry by id.
449
365
450
366
>>> inv = Inventory()
451
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
367
>>> inv.add(InventoryEntry('123', 'foo.c'))
452
368
>>> '123' in inv
453
369
True
454
370
>>> del inv['123']
457
373
"""
458
374
ie = self[file_id]
459
375
460
assert self[ie.parent_id].children[ie.name] == ie
376
assert self._tree[ie.parent_id][ie.name] == ie
461
377
462
378
# TODO: Test deleting all children; maybe hoist to a separate
463
379
# deltree method?
464
380
if ie.kind == 'directory':
465
for cie in ie.children.values():
381
for cie in self._tree[file_id].values():
466
382
del self[cie.file_id]
467
del ie.children
383
del self._tree[file_id]
468
384
469
385
del self._byid[file_id]
470
del self[ie.parent_id].children[ie.name]
386
del self._tree[ie.parent_id][ie.name]
387
388
389
def id_set(self):
390
return Set(self._byid)
471
391
472
392
473
393
def to_element(self):
483
403
"""Construct from XML Element
484
404
485
405
>>> inv = Inventory()
486
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
406
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c'))
487
407
>>> elt = inv.to_element()
488
408
>>> inv2 = Inventory.from_element(elt)
489
409
>>> inv2 == inv
498
418
from_element = classmethod(from_element)
499
419
500
420
501
def __eq__(self, other):
421
def __cmp__(self, other):
502
422
"""Compare two sets by comparing their contents.
503
423
504
424
>>> i1 = Inventory()
505
425
>>> i2 = Inventory()
506
426
>>> i1 == i2
507
427
True
508
>>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
428
>>> i1.add(InventoryEntry('123', 'foo'))
509
429
>>> i1 == i2
510
430
False
511
>>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
431
>>> i2.add(InventoryEntry('123', 'foo'))
512
432
>>> i1 == i2
513
433
True
514
434
"""
435
if self is other:
436
return 0
437
515
438
if not isinstance(other, Inventory):
516
439
return NotImplemented
517
440
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
"""
441
if self.id_set() ^ other.id_set():
442
return 1
443
444
for file_id in self._byid:
445
c = cmp(self[file_id], other[file_id])
446
if c: return c
447
448
return 0
449
450
451
def id2path(self, file_id):
452
"""Return as a list the path to file_id."""
542
453
p = []
543
454
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)
455
ie = self[file_id]
456
p = [ie.name] + p
549
457
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)
458
return joinpath(p)
559
459
560
460
561
461
567
467
568
468
This returns the entry of the last component in the path,
569
469
which may be either a file or a directory.
570
571
Returns None iff the path is not found.
572
470
"""
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:
471
assert isinstance(name, types.StringTypes)
472
473
parent_id = None
474
for f in splitpath(name):
580
475
try:
581
cie = parent.children[f]
476
cie = self._tree[parent_id][f]
582
477
assert cie.name == f
583
assert cie.parent_id == parent.file_id
584
parent = cie
478
parent_id = cie.file_id
585
479
except KeyError:
586
480
# or raise an error?
587
481
return None
588
482
589
return parent.file_id
483
return parent_id
484
485
486
def get_child(self, parent_id, child_name):
487
return self._tree[parent_id].get(child_name)
590
488
591
489
592
490
def has_filename(self, names):
594
492
595
493
596
494
def has_id(self, file_id):
495
assert isinstance(file_id, str)
597
496
return self._byid.has_key(file_id)
598
497
599
498
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))
499
500
if __name__ == '__main__':
501
import doctest, inventory
502
doctest.testmod(inventory)
Loggerhead is a web-based interface for Breezy
Version: 2.0.1