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