1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
35
# TODO: Give the workingtree sole responsibility for the working inventory;
36
# remove the variable and references to it from the branch. This may require
37
# updating the commit code so as to update the inventory within the working
38
# copy, and making sure there's only one WorkingTree for any directory on disk.
39
# At the moment they may alias the inventory and have old copies of it in
40
# memory. (Now done? -- mbp 20060309)
42
from binascii import hexlify
44
from copy import deepcopy
45
from cStringIO import StringIO
53
from bzrlib.atomicfile import AtomicFile
54
from bzrlib.branch import (Branch,
56
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
57
import bzrlib.bzrdir as bzrdir
58
from bzrlib.decorators import needs_read_lock, needs_write_lock
59
import bzrlib.errors as errors
60
from bzrlib.errors import (BzrCheckError,
64
WeaveRevisionNotPresent,
68
MergeModifiedFormatError,
71
from bzrlib.inventory import InventoryEntry, Inventory
72
from bzrlib.lockable_files import LockableFiles, TransportLock
73
from bzrlib.lockdir import LockDir
74
from bzrlib.merge import merge_inner, transform_tree
75
from bzrlib.osutils import (
92
from bzrlib.progress import DummyProgress, ProgressPhase
93
from bzrlib.revision import NULL_REVISION
94
from bzrlib.rio import RioReader, rio_file, Stanza
95
from bzrlib.symbol_versioning import *
96
from bzrlib.textui import show_status
98
from bzrlib.transform import build_tree
99
from bzrlib.trace import mutter, note
100
from bzrlib.transport import get_transport
101
from bzrlib.transport.local import LocalTransport
102
import bzrlib.urlutils as urlutils
107
# the regex here does the following:
108
# 1) remove any weird characters; we don't escape them but rather
110
# 2) match leading '.'s to make it not hidden
111
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
112
_gen_id_suffix = None
116
def _next_id_suffix():
117
"""Create a new file id suffix that is reasonably unique.
119
On the first call we combine the current time with 64 bits of randomness
120
to give a highly probably globally unique number. Then each call in the same
121
process adds 1 to a serial number we append to that unique value.
123
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
124
# than having to move the id randomness out of the inner loop like this.
125
# XXX TODO: for the global randomness this uses we should add the thread-id
126
# before the serial #.
127
global _gen_id_suffix, _gen_id_serial
128
if _gen_id_suffix is None:
129
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
131
return _gen_id_suffix + str(_gen_id_serial)
134
def gen_file_id(name):
135
"""Return new file id for the basename 'name'.
137
The uniqueness is supplied from _next_id_suffix.
139
# XXX TODO: squash the filename to lowercase.
140
# XXX TODO: truncate the filename to something like 20 or 30 chars.
141
# XXX TODO: consider what to do with ids that look like illegal filepaths
142
# on platforms we support.
143
return _gen_file_id_re.sub('', name) + _next_id_suffix()
147
"""Return a new tree-root file id."""
148
return gen_file_id('TREE_ROOT')
151
class TreeEntry(object):
152
"""An entry that implements the minium interface used by commands.
154
This needs further inspection, it may be better to have
155
InventoryEntries without ids - though that seems wrong. For now,
156
this is a parallel hierarchy to InventoryEntry, and needs to become
157
one of several things: decorates to that hierarchy, children of, or
159
Another note is that these objects are currently only used when there is
160
no InventoryEntry available - i.e. for unversioned objects.
161
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
164
def __eq__(self, other):
165
# yes, this us ugly, TODO: best practice __eq__ style.
166
return (isinstance(other, TreeEntry)
167
and other.__class__ == self.__class__)
169
def kind_character(self):
173
class TreeDirectory(TreeEntry):
174
"""See TreeEntry. This is a directory in a working tree."""
176
def __eq__(self, other):
177
return (isinstance(other, TreeDirectory)
178
and other.__class__ == self.__class__)
180
def kind_character(self):
184
class TreeFile(TreeEntry):
185
"""See TreeEntry. This is a regular file in a working tree."""
187
def __eq__(self, other):
188
return (isinstance(other, TreeFile)
189
and other.__class__ == self.__class__)
191
def kind_character(self):
195
class TreeLink(TreeEntry):
196
"""See TreeEntry. This is a symlink in a working tree."""
198
def __eq__(self, other):
199
return (isinstance(other, TreeLink)
200
and other.__class__ == self.__class__)
202
def kind_character(self):
206
class WorkingTree(bzrlib.tree.Tree):
207
"""Working copy tree.
209
The inventory is held in the `Branch` working-inventory, and the
210
files are in a directory on disk.
212
It is possible for a `WorkingTree` to have a filename which is
213
not listed in the Inventory and vice versa.
216
def __init__(self, basedir='.',
217
branch=DEPRECATED_PARAMETER,
223
"""Construct a WorkingTree for basedir.
225
If the branch is not supplied, it is opened automatically.
226
If the branch is supplied, it must be the branch for this basedir.
227
(branch.base is not cross checked, because for remote branches that
228
would be meaningless).
230
self._format = _format
231
self.bzrdir = _bzrdir
233
# not created via open etc.
234
warn("WorkingTree() is deprecated as of bzr version 0.8. "
235
"Please use bzrdir.open_workingtree or WorkingTree.open().",
238
wt = WorkingTree.open(basedir)
239
self._branch = wt.branch
240
self.basedir = wt.basedir
241
self._control_files = wt._control_files
242
self._hashcache = wt._hashcache
243
self._set_inventory(wt._inventory)
244
self._format = wt._format
245
self.bzrdir = wt.bzrdir
246
from bzrlib.hashcache import HashCache
247
from bzrlib.trace import note, mutter
248
assert isinstance(basedir, basestring), \
249
"base directory %r is not a string" % basedir
250
basedir = safe_unicode(basedir)
251
mutter("opening working tree %r", basedir)
252
if deprecated_passed(branch):
254
warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
255
" Please use bzrdir.open_workingtree() or"
256
" WorkingTree.open().",
260
self._branch = branch
262
self._branch = self.bzrdir.open_branch()
263
assert isinstance(self.branch, Branch), \
264
"branch %r is not a Branch" % self.branch
265
self.basedir = realpath(basedir)
266
# if branch is at our basedir and is a format 6 or less
267
if isinstance(self._format, WorkingTreeFormat2):
268
# share control object
269
self._control_files = self.branch.control_files
271
# only ready for format 3
272
assert isinstance(self._format, WorkingTreeFormat3)
273
assert isinstance(_control_files, LockableFiles), \
274
"_control_files must be a LockableFiles, not %r" \
276
self._control_files = _control_files
277
# update the whole cache up front and write to disk if anything changed;
278
# in the future we might want to do this more selectively
279
# two possible ways offer themselves : in self._unlock, write the cache
280
# if needed, or, when the cache sees a change, append it to the hash
281
# cache file, and have the parser take the most recent entry for a
283
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
284
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
286
# is this scan needed ? it makes things kinda slow.
293
if _inventory is None:
294
self._set_inventory(self.read_working_inventory())
296
self._set_inventory(_inventory)
299
fget=lambda self: self._branch,
300
doc="""The branch this WorkingTree is connected to.
302
This cannot be set - it is reflective of the actual disk structure
303
the working tree has been constructed from.
306
def break_lock(self):
307
"""Break a lock if one is present from another instance.
309
Uses the ui factory to ask for confirmation if the lock may be from
312
This will probe the repository for its lock as well.
314
self._control_files.break_lock()
315
self.branch.break_lock()
317
def _set_inventory(self, inv):
318
self._inventory = inv
319
self.path2id = self._inventory.path2id
321
def is_control_filename(self, filename):
322
"""True if filename is the name of a control file in this tree.
324
:param filename: A filename within the tree. This is a relative path
325
from the root of this tree.
327
This is true IF and ONLY IF the filename is part of the meta data
328
that bzr controls in this tree. I.E. a random .bzr directory placed
329
on disk will not be a control file for this tree.
331
return self.bzrdir.is_control_filename(filename)
334
def open(path=None, _unsupported=False):
335
"""Open an existing working tree at path.
339
path = os.path.getcwdu()
340
control = bzrdir.BzrDir.open(path, _unsupported)
341
return control.open_workingtree(_unsupported)
344
def open_containing(path=None):
345
"""Open an existing working tree which has its root about path.
347
This probes for a working tree at path and searches upwards from there.
349
Basically we keep looking up until we find the control directory or
350
run into /. If there isn't one, raises NotBranchError.
351
TODO: give this a new exception.
352
If there is one, it is returned, along with the unused portion of path.
354
:return: The WorkingTree that contains 'path', and the rest of path
358
control, relpath = bzrdir.BzrDir.open_containing(path)
360
return control.open_workingtree(), relpath
363
def open_downlevel(path=None):
364
"""Open an unsupported working tree.
366
Only intended for advanced situations like upgrading part of a bzrdir.
368
return WorkingTree.open(path, _unsupported=True)
371
"""Iterate through file_ids for this tree.
373
file_ids are in a WorkingTree if they are in the working inventory
374
and the working file exists.
376
inv = self._inventory
377
for path, ie in inv.iter_entries():
378
if bzrlib.osutils.lexists(self.abspath(path)):
382
return "<%s of %s>" % (self.__class__.__name__,
383
getattr(self, 'basedir', None))
385
def abspath(self, filename):
386
return pathjoin(self.basedir, filename)
388
def basis_tree(self):
389
"""Return RevisionTree for the current last revision."""
390
revision_id = self.last_revision()
391
if revision_id is not None:
393
xml = self.read_basis_inventory()
394
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
397
if inv is not None and inv.revision_id == revision_id:
398
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
400
# FIXME? RBC 20060403 should we cache the inventory here ?
401
return self.branch.repository.revision_tree(revision_id)
404
@deprecated_method(zero_eight)
405
def create(branch, directory):
406
"""Create a workingtree for branch at directory.
408
If existing_directory already exists it must have a .bzr directory.
409
If it does not exist, it will be created.
411
This returns a new WorkingTree object for the new checkout.
413
TODO FIXME RBC 20060124 when we have checkout formats in place this
414
should accept an optional revisionid to checkout [and reject this if
415
checking out into the same dir as a pre-checkout-aware branch format.]
417
XXX: When BzrDir is present, these should be created through that
420
warn('delete WorkingTree.create', stacklevel=3)
421
transport = get_transport(directory)
422
if branch.bzrdir.root_transport.base == transport.base:
424
return branch.bzrdir.create_workingtree()
425
# different directory,
426
# create a branch reference
427
# and now a working tree.
428
raise NotImplementedError
431
@deprecated_method(zero_eight)
432
def create_standalone(directory):
433
"""Create a checkout and a branch and a repo at directory.
435
Directory must exist and be empty.
437
please use BzrDir.create_standalone_workingtree
439
return bzrdir.BzrDir.create_standalone_workingtree(directory)
441
def relpath(self, path):
442
"""Return the local path portion from a given path.
444
The path may be absolute or relative. If its a relative path it is
445
interpreted relative to the python current working directory.
447
return relpath(self.basedir, path)
449
def has_filename(self, filename):
450
return bzrlib.osutils.lexists(self.abspath(filename))
452
def get_file(self, file_id):
453
return self.get_file_byname(self.id2path(file_id))
455
def get_file_byname(self, filename):
456
return file(self.abspath(filename), 'rb')
458
def get_root_id(self):
459
"""Return the id of this trees root"""
460
inv = self.read_working_inventory()
461
return inv.root.file_id
463
def _get_store_filename(self, file_id):
464
## XXX: badly named; this is not in the store at all
465
return self.abspath(self.id2path(file_id))
468
def clone(self, to_bzrdir, revision_id=None, basis=None):
469
"""Duplicate this working tree into to_bzr, including all state.
471
Specifically modified files are kept as modified, but
472
ignored and unknown files are discarded.
474
If you want to make a new line of development, see bzrdir.sprout()
477
If not None, the cloned tree will have its last revision set to
478
revision, and and difference between the source trees last revision
479
and this one merged in.
482
If not None, a closer copy of a tree which may have some files in
483
common, and which file content should be preferentially copied from.
485
# assumes the target bzr dir format is compatible.
486
result = self._format.initialize(to_bzrdir)
487
self.copy_content_into(result, revision_id)
491
def copy_content_into(self, tree, revision_id=None):
492
"""Copy the current content and user files of this tree into tree."""
493
if revision_id is None:
494
transform_tree(tree, self)
496
# TODO now merge from tree.last_revision to revision
497
transform_tree(tree, self)
498
tree.set_last_revision(revision_id)
501
def commit(self, message=None, revprops=None, *args, **kwargs):
502
# avoid circular imports
503
from bzrlib.commit import Commit
506
if not 'branch-nick' in revprops:
507
revprops['branch-nick'] = self.branch.nick
508
# args for wt.commit start at message from the Commit.commit method,
509
# but with branch a kwarg now, passing in args as is results in the
510
#message being used for the branch
511
args = (DEPRECATED_PARAMETER, message, ) + args
512
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
513
self._set_inventory(self.read_working_inventory())
515
def id2abspath(self, file_id):
516
return self.abspath(self.id2path(file_id))
518
def has_id(self, file_id):
519
# files that have been deleted are excluded
520
inv = self._inventory
521
if not inv.has_id(file_id):
523
path = inv.id2path(file_id)
524
return bzrlib.osutils.lexists(self.abspath(path))
526
def has_or_had_id(self, file_id):
527
if file_id == self.inventory.root.file_id:
529
return self.inventory.has_id(file_id)
531
__contains__ = has_id
533
def get_file_size(self, file_id):
534
return os.path.getsize(self.id2abspath(file_id))
537
def get_file_sha1(self, file_id, path=None):
539
path = self._inventory.id2path(file_id)
540
return self._hashcache.get_sha1(path)
542
if not supports_executable():
543
def is_executable(self, file_id, path=None):
544
return self._inventory[file_id].executable
546
def is_executable(self, file_id, path=None):
548
path = self._inventory.id2path(file_id)
549
mode = os.lstat(self.abspath(path)).st_mode
550
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
553
def add(self, files, ids=None):
554
"""Make files versioned.
556
Note that the command line normally calls smart_add instead,
557
which can automatically recurse.
559
This adds the files to the inventory, so that they will be
560
recorded by the next commit.
563
List of paths to add, relative to the base of the tree.
566
If set, use these instead of automatically generated ids.
567
Must be the same length as the list of files, but may
568
contain None for ids that are to be autogenerated.
570
TODO: Perhaps have an option to add the ids even if the files do
573
TODO: Perhaps callback with the ids and paths as they're added.
575
# TODO: Re-adding a file that is removed in the working copy
576
# should probably put it back with the previous ID.
577
if isinstance(files, basestring):
578
assert(ids is None or isinstance(ids, basestring))
584
ids = [None] * len(files)
586
assert(len(ids) == len(files))
588
inv = self.read_working_inventory()
589
for f,file_id in zip(files, ids):
590
if self.is_control_filename(f):
591
raise BzrError("cannot add control file %s" % quotefn(f))
596
raise BzrError("cannot add top-level %r" % f)
598
fullpath = normpath(self.abspath(f))
601
kind = file_kind(fullpath)
603
if e.errno == errno.ENOENT:
604
raise NoSuchFile(fullpath)
605
# maybe something better?
606
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
608
if not InventoryEntry.versionable_kind(kind):
609
raise BzrError('cannot add: not a versionable file ('
610
'i.e. regular file, symlink or directory): %s' % quotefn(f))
613
inv.add_path(f, kind=kind)
615
inv.add_path(f, kind=kind, file_id=file_id)
617
self._write_inventory(inv)
620
def add_pending_merge(self, *revision_ids):
621
# TODO: Perhaps should check at this point that the
622
# history of the revision is actually present?
623
p = self.pending_merges()
625
for rev_id in revision_ids:
631
self.set_pending_merges(p)
634
def pending_merges(self):
635
"""Return a list of pending merges.
637
These are revisions that have been merged into the working
638
directory but not yet committed.
641
merges_file = self._control_files.get_utf8('pending-merges')
643
if e.errno != errno.ENOENT:
647
for l in merges_file.readlines():
648
p.append(l.rstrip('\n'))
652
def set_pending_merges(self, rev_list):
653
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
656
def set_merge_modified(self, modified_hashes):
658
for file_id, hash in modified_hashes.iteritems():
659
yield Stanza(file_id=file_id, hash=hash)
660
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
663
def _put_rio(self, filename, stanzas, header):
664
my_file = rio_file(stanzas, header)
665
self._control_files.put(filename, my_file)
668
def merge_modified(self):
670
hashfile = self._control_files.get('merge-hashes')
675
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
676
raise MergeModifiedFormatError()
677
except StopIteration:
678
raise MergeModifiedFormatError()
679
for s in RioReader(hashfile):
680
file_id = s.get("file_id")
681
if file_id not in self.inventory:
684
if hash == self.get_file_sha1(file_id):
685
merge_hashes[file_id] = hash
688
def get_symlink_target(self, file_id):
689
return os.readlink(self.id2abspath(file_id))
691
def file_class(self, filename):
692
if self.path2id(filename):
694
elif self.is_ignored(filename):
699
def list_files(self):
700
"""Recursively list all files as (path, class, kind, id, entry).
702
Lists, but does not descend into unversioned directories.
704
This does not include files that have been deleted in this
707
Skips the control directory.
709
inv = self._inventory
710
# Convert these into local objects to save lookup times
711
pathjoin = bzrlib.osutils.pathjoin
712
file_kind = bzrlib.osutils.file_kind
714
# transport.base ends in a slash, we want the piece
715
# between the last two slashes
716
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
718
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
720
# directory file_id, relative path, absolute path, reverse sorted children
721
children = os.listdir(self.basedir)
723
# jam 20060527 The kernel sized tree seems equivalent whether we
724
# use a deque and popleft to keep them sorted, or if we use a plain
725
# list and just reverse() them.
726
children = collections.deque(children)
727
stack = [(inv.root.file_id, u'', self.basedir, children)]
729
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
732
f = children.popleft()
733
## TODO: If we find a subdirectory with its own .bzr
734
## directory, then that is a separate tree and we
735
## should exclude it.
737
# the bzrdir for this tree
738
if transport_base_dir == f:
741
# we know that from_dir_relpath and from_dir_abspath never end in a slash
742
# and 'f' doesn't begin with one, we can do a string op, rather
743
# than the checks of pathjoin(), all relative paths will have an extra slash
745
fp = from_dir_relpath + '/' + f
748
fap = from_dir_abspath + '/' + f
750
f_ie = inv.get_child(from_dir_id, f)
753
elif self.is_ignored(fp[1:]):
762
raise BzrCheckError("file %r entered as kind %r id %r, "
764
% (fap, f_ie.kind, f_ie.file_id, fk))
766
# make a last minute entry
768
yield fp[1:], c, fk, f_ie.file_id, f_ie
771
yield fp[1:], c, fk, None, fk_entries[fk]()
773
yield fp[1:], c, fk, None, TreeEntry()
776
if fk != 'directory':
779
# But do this child first
780
new_children = os.listdir(fap)
782
new_children = collections.deque(new_children)
783
stack.append((f_ie.file_id, fp, fap, new_children))
784
# Break out of inner loop, so that we start outer loop with child
787
# if we finished all children, pop it off the stack
792
def move(self, from_paths, to_name):
795
to_name must exist in the inventory.
797
If to_name exists and is a directory, the files are moved into
798
it, keeping their old names.
800
Note that to_name is only the last component of the new name;
801
this doesn't change the directory.
803
This returns a list of (from_path, to_path) pairs for each
807
## TODO: Option to move IDs only
808
assert not isinstance(from_paths, basestring)
810
to_abs = self.abspath(to_name)
811
if not isdir(to_abs):
812
raise BzrError("destination %r is not a directory" % to_abs)
813
if not self.has_filename(to_name):
814
raise BzrError("destination %r not in working directory" % to_abs)
815
to_dir_id = inv.path2id(to_name)
816
if to_dir_id == None and to_name != '':
817
raise BzrError("destination %r is not a versioned directory" % to_name)
818
to_dir_ie = inv[to_dir_id]
819
if to_dir_ie.kind not in ('directory', 'root_directory'):
820
raise BzrError("destination %r is not a directory" % to_abs)
822
to_idpath = inv.get_idpath(to_dir_id)
825
if not self.has_filename(f):
826
raise BzrError("%r does not exist in working tree" % f)
827
f_id = inv.path2id(f)
829
raise BzrError("%r is not versioned" % f)
830
name_tail = splitpath(f)[-1]
831
dest_path = pathjoin(to_name, name_tail)
832
if self.has_filename(dest_path):
833
raise BzrError("destination %r already exists" % dest_path)
834
if f_id in to_idpath:
835
raise BzrError("can't move %r to a subdirectory of itself" % f)
837
# OK, so there's a race here, it's possible that someone will
838
# create a file in this interval and then the rename might be
839
# left half-done. But we should have caught most problems.
840
orig_inv = deepcopy(self.inventory)
843
name_tail = splitpath(f)[-1]
844
dest_path = pathjoin(to_name, name_tail)
845
result.append((f, dest_path))
846
inv.rename(inv.path2id(f), to_dir_id, name_tail)
848
rename(self.abspath(f), self.abspath(dest_path))
850
raise BzrError("failed to rename %r to %r: %s" %
851
(f, dest_path, e[1]),
852
["rename rolled back"])
854
# restore the inventory on error
855
self._set_inventory(orig_inv)
857
self._write_inventory(inv)
861
def rename_one(self, from_rel, to_rel):
864
This can change the directory or the filename or both.
867
if not self.has_filename(from_rel):
868
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
869
if self.has_filename(to_rel):
870
raise BzrError("can't rename: new working file %r already exists" % to_rel)
872
file_id = inv.path2id(from_rel)
874
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
877
from_parent = entry.parent_id
878
from_name = entry.name
880
if inv.path2id(to_rel):
881
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
883
to_dir, to_tail = os.path.split(to_rel)
884
to_dir_id = inv.path2id(to_dir)
885
if to_dir_id == None and to_dir != '':
886
raise BzrError("can't determine destination directory id for %r" % to_dir)
888
mutter("rename_one:")
889
mutter(" file_id {%s}" % file_id)
890
mutter(" from_rel %r" % from_rel)
891
mutter(" to_rel %r" % to_rel)
892
mutter(" to_dir %r" % to_dir)
893
mutter(" to_dir_id {%s}" % to_dir_id)
895
inv.rename(file_id, to_dir_id, to_tail)
897
from_abs = self.abspath(from_rel)
898
to_abs = self.abspath(to_rel)
900
rename(from_abs, to_abs)
902
inv.rename(file_id, from_parent, from_name)
903
raise BzrError("failed to rename %r to %r: %s"
904
% (from_abs, to_abs, e[1]),
905
["rename rolled back"])
906
self._write_inventory(inv)
910
"""Return all unknown files.
912
These are files in the working directory that are not versioned or
913
control files or ignored.
915
>>> from bzrlib.bzrdir import ScratchDir
916
>>> d = ScratchDir(files=['foo', 'foo~'])
917
>>> b = d.open_branch()
918
>>> tree = d.open_workingtree()
919
>>> map(str, tree.unknowns())
922
>>> list(b.unknowns())
924
>>> tree.remove('foo')
925
>>> list(b.unknowns())
928
for subp in self.extras():
929
if not self.is_ignored(subp):
932
@deprecated_method(zero_eight)
933
def iter_conflicts(self):
934
"""List all files in the tree that have text or content conflicts.
935
DEPRECATED. Use conflicts instead."""
936
return self._iter_conflicts()
938
def _iter_conflicts(self):
940
for info in self.list_files():
942
stem = get_conflicted_stem(path)
945
if stem not in conflicted:
950
def pull(self, source, overwrite=False, stop_revision=None):
951
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
954
pp = ProgressPhase("Pull phase", 2, top_pb)
956
old_revision_history = self.branch.revision_history()
957
basis_tree = self.basis_tree()
958
count = self.branch.pull(source, overwrite, stop_revision)
959
new_revision_history = self.branch.revision_history()
960
if new_revision_history != old_revision_history:
962
if len(old_revision_history):
963
other_revision = old_revision_history[-1]
965
other_revision = None
966
repository = self.branch.repository
967
pb = bzrlib.ui.ui_factory.nested_progress_bar()
969
merge_inner(self.branch,
970
self.branch.basis_tree(),
976
self.set_last_revision(self.branch.last_revision())
983
"""Yield all unknown files in this WorkingTree.
985
If there are any unknown directories then only the directory is
986
returned, not all its children. But if there are unknown files
987
under a versioned subdirectory, they are returned.
989
Currently returned depth-first, sorted by name within directories.
991
## TODO: Work from given directory downwards
992
for path, dir_entry in self.inventory.directories():
993
mutter("search for unknowns in %r", path)
994
dirabs = self.abspath(path)
995
if not isdir(dirabs):
996
# e.g. directory deleted
1000
for subf in os.listdir(dirabs):
1002
and (subf not in dir_entry.children)):
1007
subp = pathjoin(path, subf)
1010
def _translate_ignore_rule(self, rule):
1011
"""Translate a single ignore rule to a regex.
1013
There are two types of ignore rules. Those that do not contain a / are
1014
matched against the tail of the filename (that is, they do not care
1015
what directory the file is in.) Rules which do contain a slash must
1016
match the entire path. As a special case, './' at the start of the
1017
string counts as a slash in the string but is removed before matching
1018
(e.g. ./foo.c, ./src/foo.c)
1020
:return: The translated regex.
1022
if rule[:2] in ('./', '.\\'):
1024
result = fnmatch.translate(rule[2:])
1025
elif '/' in rule or '\\' in rule:
1027
result = fnmatch.translate(rule)
1029
# default rule style.
1030
result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1031
assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1032
return "(" + result + ")"
1034
def _combine_ignore_rules(self, rules):
1035
"""Combine a list of ignore rules into a single regex object.
1037
Each individual rule is combined with | to form a big regex, which then
1038
has $ added to it to form something like ()|()|()$. The group index for
1039
each subregex's outermost group is placed in a dictionary mapping back
1040
to the rule. This allows quick identification of the matching rule that
1042
:return: a list of the compiled regex and the matching-group index
1043
dictionaries. We return a list because python complains if you try to
1044
combine more than 100 regexes.
1049
translated_rules = []
1051
translated_rule = self._translate_ignore_rule(rule)
1052
compiled_rule = re.compile(translated_rule)
1053
groups[next_group] = rule
1054
next_group += compiled_rule.groups
1055
translated_rules.append(translated_rule)
1056
if next_group == 99:
1057
result.append((re.compile("|".join(translated_rules)), groups))
1060
translated_rules = []
1061
if len(translated_rules):
1062
result.append((re.compile("|".join(translated_rules)), groups))
1065
def ignored_files(self):
1066
"""Yield list of PATH, IGNORE_PATTERN"""
1067
for subp in self.extras():
1068
pat = self.is_ignored(subp)
1072
def get_ignore_list(self):
1073
"""Return list of ignore patterns.
1075
Cached in the Tree object after the first call.
1077
if hasattr(self, '_ignorelist'):
1078
return self._ignorelist
1080
l = bzrlib.DEFAULT_IGNORE[:]
1081
if self.has_filename(bzrlib.IGNORE_FILENAME):
1082
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1083
l.extend([line.rstrip("\n\r").decode('utf-8')
1084
for line in f.readlines()])
1085
self._ignorelist = l
1086
self._ignore_regex = self._combine_ignore_rules(l)
1089
def _get_ignore_rules_as_regex(self):
1090
"""Return a regex of the ignore rules and a mapping dict.
1092
:return: (ignore rules compiled regex, dictionary mapping rule group
1093
indices to original rule.)
1095
if getattr(self, '_ignorelist', None) is None:
1096
self.get_ignore_list()
1097
return self._ignore_regex
1099
def is_ignored(self, filename):
1100
r"""Check whether the filename matches an ignore pattern.
1102
Patterns containing '/' or '\' need to match the whole path;
1103
others match against only the last component.
1105
If the file is ignored, returns the pattern which caused it to
1106
be ignored, otherwise None. So this can simply be used as a
1107
boolean if desired."""
1109
# TODO: Use '**' to match directories, and other extended
1110
# globbing stuff from cvs/rsync.
1112
# XXX: fnmatch is actually not quite what we want: it's only
1113
# approximately the same as real Unix fnmatch, and doesn't
1114
# treat dotfiles correctly and allows * to match /.
1115
# Eventually it should be replaced with something more
1118
rules = self._get_ignore_rules_as_regex()
1119
for regex, mapping in rules:
1120
match = regex.match(filename)
1121
if match is not None:
1122
# one or more of the groups in mapping will have a non-None group
1124
groups = match.groups()
1125
rules = [mapping[group] for group in
1126
mapping if groups[group] is not None]
1130
def kind(self, file_id):
1131
return file_kind(self.id2abspath(file_id))
1134
def last_revision(self):
1135
"""Return the last revision id of this working tree.
1137
In early branch formats this was == the branch last_revision,
1138
but that cannot be relied upon - for working tree operations,
1139
always use tree.last_revision().
1141
return self.branch.last_revision()
1143
def is_locked(self):
1144
return self._control_files.is_locked()
1146
def lock_read(self):
1147
"""See Branch.lock_read, and WorkingTree.unlock."""
1148
self.branch.lock_read()
1150
return self._control_files.lock_read()
1152
self.branch.unlock()
1155
def lock_write(self):
1156
"""See Branch.lock_write, and WorkingTree.unlock."""
1157
self.branch.lock_write()
1159
return self._control_files.lock_write()
1161
self.branch.unlock()
1164
def get_physical_lock_status(self):
1165
return self._control_files.get_physical_lock_status()
1167
def _basis_inventory_name(self):
1168
return 'basis-inventory'
1171
def set_last_revision(self, new_revision):
1172
"""Change the last revision in the working tree."""
1173
if self._change_last_revision(new_revision):
1174
self._cache_basis_inventory(new_revision)
1176
def _change_last_revision(self, new_revision):
1177
"""Template method part of set_last_revision to perform the change.
1179
This is used to allow WorkingTree3 instances to not affect branch
1180
when their last revision is set.
1182
if new_revision is None:
1183
self.branch.set_revision_history([])
1185
# current format is locked in with the branch
1186
revision_history = self.branch.revision_history()
1188
position = revision_history.index(new_revision)
1190
raise errors.NoSuchRevision(self.branch, new_revision)
1191
self.branch.set_revision_history(revision_history[:position + 1])
1194
def _cache_basis_inventory(self, new_revision):
1195
"""Cache new_revision as the basis inventory."""
1197
# this double handles the inventory - unpack and repack -
1198
# but is easier to understand. We can/should put a conditional
1199
# in here based on whether the inventory is in the latest format
1200
# - perhaps we should repack all inventories on a repository
1202
inv = self.branch.repository.get_inventory(new_revision)
1203
inv.revision_id = new_revision
1204
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1206
path = self._basis_inventory_name()
1207
self._control_files.put_utf8(path, xml)
1208
except WeaveRevisionNotPresent:
1211
def read_basis_inventory(self):
1212
"""Read the cached basis inventory."""
1213
path = self._basis_inventory_name()
1214
return self._control_files.get_utf8(path).read()
1217
def read_working_inventory(self):
1218
"""Read the working inventory."""
1219
# ElementTree does its own conversion from UTF-8, so open in
1221
result = bzrlib.xml5.serializer_v5.read_inventory(
1222
self._control_files.get('inventory'))
1223
self._set_inventory(result)
1227
def remove(self, files, verbose=False):
1228
"""Remove nominated files from the working inventory..
1230
This does not remove their text. This does not run on XXX on what? RBC
1232
TODO: Refuse to remove modified files unless --force is given?
1234
TODO: Do something useful with directories.
1236
TODO: Should this remove the text or not? Tough call; not
1237
removing may be useful and the user can just use use rm, and
1238
is the opposite of add. Removing it is consistent with most
1239
other tools. Maybe an option.
1241
## TODO: Normalize names
1242
## TODO: Remove nested loops; better scalability
1243
if isinstance(files, basestring):
1246
inv = self.inventory
1248
# do this before any modifications
1250
fid = inv.path2id(f)
1252
# TODO: Perhaps make this just a warning, and continue?
1253
# This tends to happen when
1254
raise NotVersionedError(path=f)
1255
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1257
# having remove it, it must be either ignored or unknown
1258
if self.is_ignored(f):
1262
show_status(new_status, inv[fid].kind, quotefn(f))
1265
self._write_inventory(inv)
1268
def revert(self, filenames, old_tree=None, backups=True,
1269
pb=DummyProgress()):
1270
from transform import revert
1271
from conflicts import resolve
1272
if old_tree is None:
1273
old_tree = self.basis_tree()
1274
conflicts = revert(self, old_tree, filenames, backups, pb)
1275
if not len(filenames):
1276
self.set_pending_merges([])
1279
resolve(self, filenames, ignore_misses=True)
1282
# XXX: This method should be deprecated in favour of taking in a proper
1283
# new Inventory object.
1285
def set_inventory(self, new_inventory_list):
1286
from bzrlib.inventory import (Inventory,
1291
inv = Inventory(self.get_root_id())
1292
for path, file_id, parent, kind in new_inventory_list:
1293
name = os.path.basename(path)
1296
# fixme, there should be a factory function inv,add_??
1297
if kind == 'directory':
1298
inv.add(InventoryDirectory(file_id, name, parent))
1299
elif kind == 'file':
1300
inv.add(InventoryFile(file_id, name, parent))
1301
elif kind == 'symlink':
1302
inv.add(InventoryLink(file_id, name, parent))
1304
raise BzrError("unknown kind %r" % kind)
1305
self._write_inventory(inv)
1308
def set_root_id(self, file_id):
1309
"""Set the root id for this tree."""
1310
inv = self.read_working_inventory()
1311
orig_root_id = inv.root.file_id
1312
del inv._byid[inv.root.file_id]
1313
inv.root.file_id = file_id
1314
inv._byid[inv.root.file_id] = inv.root
1317
if entry.parent_id == orig_root_id:
1318
entry.parent_id = inv.root.file_id
1319
self._write_inventory(inv)
1322
"""See Branch.unlock.
1324
WorkingTree locking just uses the Branch locking facilities.
1325
This is current because all working trees have an embedded branch
1326
within them. IF in the future, we were to make branch data shareable
1327
between multiple working trees, i.e. via shared storage, then we
1328
would probably want to lock both the local tree, and the branch.
1330
# FIXME: We want to write out the hashcache only when the last lock on
1331
# this working copy is released. Peeking at the lock count is a bit
1332
# of a nasty hack; probably it's better to have a transaction object,
1333
# which can do some finalization when it's either successfully or
1334
# unsuccessfully completed. (Denys's original patch did that.)
1335
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1336
# wrongly. Hookinh into unllock on the control files object is fine though.
1338
# TODO: split this per format so there is no ugly if block
1339
if self._hashcache.needs_write and (
1340
# dedicated lock files
1341
self._control_files._lock_count==1 or
1343
(self._control_files is self.branch.control_files and
1344
self._control_files._lock_count==3)):
1345
self._hashcache.write()
1346
# reverse order of locking.
1348
return self._control_files.unlock()
1350
self.branch.unlock()
1354
"""Update a working tree along its branch.
1356
This will update the branch if its bound too, which means we have multiple trees involved:
1357
The new basis tree of the master.
1358
The old basis tree of the branch.
1359
The old basis tree of the working tree.
1360
The current working tree state.
1361
pathologically all three may be different, and non ancestors of each other.
1362
Conceptually we want to:
1363
Preserve the wt.basis->wt.state changes
1364
Transform the wt.basis to the new master basis.
1365
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1366
Restore the wt.basis->wt.state changes.
1368
There isn't a single operation at the moment to do that, so we:
1369
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1370
Do a 'normal' merge of the old branch basis if it is relevant.
1372
old_tip = self.branch.update()
1373
if old_tip is not None:
1374
self.add_pending_merge(old_tip)
1375
self.branch.lock_read()
1378
if self.last_revision() != self.branch.last_revision():
1379
# merge tree state up to new branch tip.
1380
basis = self.basis_tree()
1381
to_tree = self.branch.basis_tree()
1382
result += merge_inner(self.branch,
1386
self.set_last_revision(self.branch.last_revision())
1387
if old_tip and old_tip != self.last_revision():
1388
# our last revision was not the prior branch last reivison
1389
# and we have converted that last revision to a pending merge.
1390
# base is somewhere between the branch tip now
1391
# and the now pending merge
1392
from bzrlib.revision import common_ancestor
1394
base_rev_id = common_ancestor(self.branch.last_revision(),
1396
self.branch.repository)
1397
except errors.NoCommonAncestor:
1399
base_tree = self.branch.repository.revision_tree(base_rev_id)
1400
other_tree = self.branch.repository.revision_tree(old_tip)
1401
result += merge_inner(self.branch,
1407
self.branch.unlock()
1410
def _write_inventory(self, inv):
1411
"""Write inventory as the current inventory."""
1413
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1415
self._control_files.put('inventory', sio)
1416
self._set_inventory(inv)
1417
mutter('wrote working inventory')
1419
def set_conflicts(self, arg):
1420
raise UnsupportedOperation(self.set_conflicts, self)
1423
def conflicts(self):
1424
conflicts = ConflictList()
1425
for conflicted in self._iter_conflicts():
1428
if file_kind(self.abspath(conflicted)) != "file":
1431
if e.errno == errno.ENOENT:
1436
for suffix in ('.THIS', '.OTHER'):
1438
kind = file_kind(self.abspath(conflicted+suffix))
1440
if e.errno == errno.ENOENT:
1448
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1449
conflicts.append(Conflict.factory(ctype, path=conflicted,
1450
file_id=self.path2id(conflicted)))
1454
class WorkingTree3(WorkingTree):
1455
"""This is the Format 3 working tree.
1457
This differs from the base WorkingTree by:
1458
- having its own file lock
1459
- having its own last-revision property.
1461
This is new in bzr 0.8
1465
def last_revision(self):
1466
"""See WorkingTree.last_revision."""
1468
return self._control_files.get_utf8('last-revision').read()
1472
def _change_last_revision(self, revision_id):
1473
"""See WorkingTree._change_last_revision."""
1474
if revision_id is None or revision_id == NULL_REVISION:
1476
self._control_files._transport.delete('last-revision')
1477
except errors.NoSuchFile:
1482
self.branch.revision_history().index(revision_id)
1484
raise errors.NoSuchRevision(self.branch, revision_id)
1485
self._control_files.put_utf8('last-revision', revision_id)
1489
def set_conflicts(self, conflicts):
1490
self._put_rio('conflicts', conflicts.to_stanzas(),
1494
def conflicts(self):
1496
confile = self._control_files.get('conflicts')
1498
return ConflictList()
1500
if confile.next() != CONFLICT_HEADER_1 + '\n':
1501
raise ConflictFormatError()
1502
except StopIteration:
1503
raise ConflictFormatError()
1504
return ConflictList.from_stanzas(RioReader(confile))
1507
def get_conflicted_stem(path):
1508
for suffix in CONFLICT_SUFFIXES:
1509
if path.endswith(suffix):
1510
return path[:-len(suffix)]
1512
@deprecated_function(zero_eight)
1513
def is_control_file(filename):
1514
"""See WorkingTree.is_control_filename(filename)."""
1515
## FIXME: better check
1516
filename = normpath(filename)
1517
while filename != '':
1518
head, tail = os.path.split(filename)
1519
## mutter('check %r for control file' % ((head, tail),))
1522
if filename == head:
1528
class WorkingTreeFormat(object):
1529
"""An encapsulation of the initialization and open routines for a format.
1531
Formats provide three things:
1532
* An initialization routine,
1536
Formats are placed in an dict by their format string for reference
1537
during workingtree opening. Its not required that these be instances, they
1538
can be classes themselves with class methods - it simply depends on
1539
whether state is needed for a given format or not.
1541
Once a format is deprecated, just deprecate the initialize and open
1542
methods on the format class. Do not deprecate the object, as the
1543
object will be created every time regardless.
1546
_default_format = None
1547
"""The default format used for new trees."""
1550
"""The known formats."""
1553
def find_format(klass, a_bzrdir):
1554
"""Return the format for the working tree object in a_bzrdir."""
1556
transport = a_bzrdir.get_workingtree_transport(None)
1557
format_string = transport.get("format").read()
1558
return klass._formats[format_string]
1560
raise errors.NoWorkingTree(base=transport.base)
1562
raise errors.UnknownFormatError(format_string)
1565
def get_default_format(klass):
1566
"""Return the current default format."""
1567
return klass._default_format
1569
def get_format_string(self):
1570
"""Return the ASCII format string that identifies this format."""
1571
raise NotImplementedError(self.get_format_string)
1573
def get_format_description(self):
1574
"""Return the short description for this format."""
1575
raise NotImplementedError(self.get_format_description)
1577
def is_supported(self):
1578
"""Is this format supported?
1580
Supported formats can be initialized and opened.
1581
Unsupported formats may not support initialization or committing or
1582
some other features depending on the reason for not being supported.
1587
def register_format(klass, format):
1588
klass._formats[format.get_format_string()] = format
1591
def set_default_format(klass, format):
1592
klass._default_format = format
1595
def unregister_format(klass, format):
1596
assert klass._formats[format.get_format_string()] is format
1597
del klass._formats[format.get_format_string()]
1601
class WorkingTreeFormat2(WorkingTreeFormat):
1602
"""The second working tree format.
1604
This format modified the hash cache from the format 1 hash cache.
1607
def get_format_description(self):
1608
"""See WorkingTreeFormat.get_format_description()."""
1609
return "Working tree format 2"
1611
def stub_initialize_remote(self, control_files):
1612
"""As a special workaround create critical control files for a remote working tree
1614
This ensures that it can later be updated and dealt with locally,
1615
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1616
no working tree. (See bug #43064).
1620
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1622
control_files.put('inventory', sio)
1624
control_files.put_utf8('pending-merges', '')
1627
def initialize(self, a_bzrdir, revision_id=None):
1628
"""See WorkingTreeFormat.initialize()."""
1629
if not isinstance(a_bzrdir.transport, LocalTransport):
1630
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1631
branch = a_bzrdir.open_branch()
1632
if revision_id is not None:
1635
revision_history = branch.revision_history()
1637
position = revision_history.index(revision_id)
1639
raise errors.NoSuchRevision(branch, revision_id)
1640
branch.set_revision_history(revision_history[:position + 1])
1643
revision = branch.last_revision()
1645
wt = WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1651
wt._write_inventory(inv)
1652
wt.set_root_id(inv.root.file_id)
1653
wt.set_last_revision(revision)
1654
wt.set_pending_merges([])
1655
build_tree(wt.basis_tree(), wt)
1659
super(WorkingTreeFormat2, self).__init__()
1660
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1662
def open(self, a_bzrdir, _found=False):
1663
"""Return the WorkingTree object for a_bzrdir
1665
_found is a private parameter, do not use it. It is used to indicate
1666
if format probing has already been done.
1669
# we are being called directly and must probe.
1670
raise NotImplementedError
1671
if not isinstance(a_bzrdir.transport, LocalTransport):
1672
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1673
return WorkingTree(a_bzrdir.root_transport.local_abspath('.'),
1679
class WorkingTreeFormat3(WorkingTreeFormat):
1680
"""The second working tree format updated to record a format marker.
1683
- exists within a metadir controlling .bzr
1684
- includes an explicit version marker for the workingtree control
1685
files, separate from the BzrDir format
1686
- modifies the hash cache format
1688
- uses a LockDir to guard access to the repository
1691
def get_format_string(self):
1692
"""See WorkingTreeFormat.get_format_string()."""
1693
return "Bazaar-NG Working Tree format 3"
1695
def get_format_description(self):
1696
"""See WorkingTreeFormat.get_format_description()."""
1697
return "Working tree format 3"
1699
_lock_file_name = 'lock'
1700
_lock_class = LockDir
1702
def _open_control_files(self, a_bzrdir):
1703
transport = a_bzrdir.get_workingtree_transport(None)
1704
return LockableFiles(transport, self._lock_file_name,
1707
def initialize(self, a_bzrdir, revision_id=None):
1708
"""See WorkingTreeFormat.initialize().
1710
revision_id allows creating a working tree at a differnet
1711
revision than the branch is at.
1713
if not isinstance(a_bzrdir.transport, LocalTransport):
1714
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1715
transport = a_bzrdir.get_workingtree_transport(self)
1716
control_files = self._open_control_files(a_bzrdir)
1717
control_files.create_lock()
1718
control_files.lock_write()
1719
control_files.put_utf8('format', self.get_format_string())
1720
branch = a_bzrdir.open_branch()
1721
if revision_id is None:
1722
revision_id = branch.last_revision()
1724
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1730
_control_files=control_files)
1733
wt._write_inventory(inv)
1734
wt.set_root_id(inv.root.file_id)
1735
wt.set_last_revision(revision_id)
1736
wt.set_pending_merges([])
1737
build_tree(wt.basis_tree(), wt)
1740
control_files.unlock()
1744
super(WorkingTreeFormat3, self).__init__()
1745
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1747
def open(self, a_bzrdir, _found=False):
1748
"""Return the WorkingTree object for a_bzrdir
1750
_found is a private parameter, do not use it. It is used to indicate
1751
if format probing has already been done.
1754
# we are being called directly and must probe.
1755
raise NotImplementedError
1756
if not isinstance(a_bzrdir.transport, LocalTransport):
1757
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1758
control_files = self._open_control_files(a_bzrdir)
1759
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1763
_control_files=control_files)
1766
return self.get_format_string()
1769
# formats which have no format string are not discoverable
1770
# and not independently creatable, so are not registered.
1771
__default_format = WorkingTreeFormat3()
1772
WorkingTreeFormat.register_format(__default_format)
1773
WorkingTreeFormat.set_default_format(__default_format)
1774
_legacy_formats = [WorkingTreeFormat2(),
1778
class WorkingTreeTestProviderAdapter(object):
1779
"""A tool to generate a suite testing multiple workingtree formats at once.
1781
This is done by copying the test once for each transport and injecting
1782
the transport_server, transport_readonly_server, and workingtree_format
1783
classes into each copy. Each copy is also given a new id() to make it
1787
def __init__(self, transport_server, transport_readonly_server, formats):
1788
self._transport_server = transport_server
1789
self._transport_readonly_server = transport_readonly_server
1790
self._formats = formats
1792
def adapt(self, test):
1793
from bzrlib.tests import TestSuite
1794
result = TestSuite()
1795
for workingtree_format, bzrdir_format in self._formats:
1796
new_test = deepcopy(test)
1797
new_test.transport_server = self._transport_server
1798
new_test.transport_readonly_server = self._transport_readonly_server
1799
new_test.bzrdir_format = bzrdir_format
1800
new_test.workingtree_format = workingtree_format
1801
def make_new_test_id():
1802
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1803
return lambda: new_id
1804
new_test.id = make_new_test_id()
1805
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
