1
# Copyright (C) 2005-2011 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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.
23
At the moment every WorkingTree has its own branch. Remote
24
WorkingTrees aren't supported.
26
To get a WorkingTree, call controldir.open_workingtree() or
27
WorkingTree.open(dir).
30
from __future__ import absolute_import
39
from .lazy_import import lazy_import
40
lazy_import(globals(), """
41
from bisect import bisect_left
48
conflicts as _mod_conflicts,
51
filters as _mod_filters,
54
revision as _mod_revision,
65
from .i18n import gettext
66
from . import mutabletree
70
from .trace import mutter, note
73
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
76
class SettingFileIdUnsupported(errors.BzrError):
78
_fmt = "This format does not support setting file ids."
81
class ShelvingUnsupported(errors.BzrError):
83
_fmt = "This format does not support shelving changes."
86
class TreeEntry(object):
87
"""An entry that implements the minimum interface used by commands.
89
This needs further inspection, it may be better to have
90
InventoryEntries without ids - though that seems wrong. For now,
91
this is a parallel hierarchy to InventoryEntry, and needs to become
92
one of several things: decorates to that hierarchy, children of, or
94
Another note is that these objects are currently only used when there is
95
no InventoryEntry available - i.e. for unversioned objects.
96
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
99
def __eq__(self, other):
100
# yes, this us ugly, TODO: best practice __eq__ style.
101
return (isinstance(other, TreeEntry)
102
and other.__class__ == self.__class__)
104
def kind_character(self):
108
class TreeDirectory(TreeEntry):
109
"""See TreeEntry. This is a directory in a working tree."""
111
def __eq__(self, other):
112
return (isinstance(other, TreeDirectory)
113
and other.__class__ == self.__class__)
115
def kind_character(self):
119
class TreeFile(TreeEntry):
120
"""See TreeEntry. This is a regular file in a working tree."""
122
def __eq__(self, other):
123
return (isinstance(other, TreeFile)
124
and other.__class__ == self.__class__)
126
def kind_character(self):
130
class TreeLink(TreeEntry):
131
"""See TreeEntry. This is a symlink in a working tree."""
133
def __eq__(self, other):
134
return (isinstance(other, TreeLink)
135
and other.__class__ == self.__class__)
137
def kind_character(self):
141
class WorkingTree(mutabletree.MutableTree,
142
controldir.ControlComponent):
143
"""Working copy tree.
145
:ivar basedir: The root of the tree on disk. This is a unicode path object
146
(as opposed to a URL).
149
# override this to set the strategy for storing views
150
def _make_views(self):
151
return views.DisabledViews(self)
153
def __init__(self, basedir='.',
159
"""Construct a WorkingTree instance. This is not a public API.
161
:param branch: A branch to override probing for the branch.
163
self._format = _format
164
self.controldir = _controldir
166
raise errors.BzrError("Please use controldir.open_workingtree or "
167
"WorkingTree.open() to obtain a WorkingTree.")
168
basedir = osutils.safe_unicode(basedir)
169
mutter("opening working tree %r", basedir)
170
if branch is not None:
171
self._branch = branch
173
self._branch = self.controldir.open_branch()
174
self.basedir = osutils.realpath(basedir)
175
self._transport = _transport
176
self._rules_searcher = None
177
self.views = self._make_views()
180
def user_transport(self):
181
return self.controldir.user_transport
184
def control_transport(self):
185
return self._transport
187
def is_control_filename(self, filename):
188
"""True if filename is the name of a control file in this tree.
190
:param filename: A filename within the tree. This is a relative path
191
from the root of this tree.
193
This is true IF and ONLY IF the filename is part of the meta data
194
that bzr controls in this tree. I.E. a random .bzr directory placed
195
on disk will not be a control file for this tree.
197
return self.controldir.is_control_filename(filename)
200
fget=lambda self: self._branch,
201
doc="""The branch this WorkingTree is connected to.
203
This cannot be set - it is reflective of the actual disk structure
204
the working tree has been constructed from.
207
def has_versioned_directories(self):
208
"""See `Tree.has_versioned_directories`."""
209
return self._format.supports_versioned_directories
211
def _supports_executable(self):
212
if sys.platform == 'win32':
214
# FIXME: Ideally this should check the file system
217
def break_lock(self):
218
"""Break a lock if one is present from another instance.
220
Uses the ui factory to ask for confirmation if the lock may be from
223
This will probe the repository for its lock as well.
225
raise NotImplementedError(self.break_lock)
227
def requires_rich_root(self):
228
return self._format.requires_rich_root
230
def supports_tree_reference(self):
233
def supports_content_filtering(self):
234
return self._format.supports_content_filtering()
236
def supports_views(self):
237
return self.views.supports_views()
239
def supports_setting_file_ids(self):
240
return self._format.supports_setting_file_ids
242
def get_config_stack(self):
243
"""Retrieve the config stack for this tree.
245
:return: A ``breezy.config.Stack``
247
# For the moment, just provide the branch config stack.
248
return self.branch.get_config_stack()
251
def open(path=None, _unsupported=False):
252
"""Open an existing working tree at path.
256
path = osutils.getcwd()
257
control = controldir.ControlDir.open(path, _unsupported=_unsupported)
258
return control.open_workingtree(unsupported=_unsupported)
261
def open_containing(path=None):
262
"""Open an existing working tree which has its root about path.
264
This probes for a working tree at path and searches upwards from there.
266
Basically we keep looking up until we find the control directory or
267
run into /. If there isn't one, raises NotBranchError.
268
TODO: give this a new exception.
269
If there is one, it is returned, along with the unused portion of path.
271
:return: The WorkingTree that contains 'path', and the rest of path
274
path = osutils.getcwd()
275
control, relpath = controldir.ControlDir.open_containing(path)
276
return control.open_workingtree(), relpath
279
def open_containing_paths(file_list, default_directory=None,
280
canonicalize=True, apply_view=True):
281
"""Open the WorkingTree that contains a set of paths.
283
Fail if the paths given are not all in a single tree.
285
This is used for the many command-line interfaces that take a list of
286
any number of files and that require they all be in the same tree.
288
if default_directory is None:
289
default_directory = u'.'
290
# recommended replacement for builtins.internal_tree_files
291
if file_list is None or len(file_list) == 0:
292
tree = WorkingTree.open_containing(default_directory)[0]
293
# XXX: doesn't really belong here, and seems to have the strange
294
# side effect of making it return a bunch of files, not the whole
295
# tree -- mbp 20100716
296
if tree.supports_views() and apply_view:
297
view_files = tree.views.lookup_view()
299
file_list = view_files
300
view_str = views.view_display_str(view_files)
301
note(gettext("Ignoring files outside view. View is %s") % view_str)
302
return tree, file_list
303
if default_directory == u'.':
306
seed = default_directory
307
file_list = [osutils.pathjoin(default_directory, f)
309
tree = WorkingTree.open_containing(seed)[0]
310
return tree, tree.safe_relpath_files(file_list, canonicalize,
311
apply_view=apply_view)
313
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
314
"""Convert file_list into a list of relpaths in tree.
316
:param self: A tree to operate on.
317
:param file_list: A list of user provided paths or None.
318
:param apply_view: if True and a view is set, apply it or check that
319
specified files are within it
320
:return: A list of relative paths.
321
:raises errors.PathNotChild: When a provided path is in a different self
324
if file_list is None:
326
if self.supports_views() and apply_view:
327
view_files = self.views.lookup_view()
331
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
332
# doesn't - fix that up here before we enter the loop.
334
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
337
for filename in file_list:
338
relpath = fixer(osutils.dereference_path(filename))
339
if view_files and not osutils.is_inside_any(view_files, relpath):
340
raise views.FileOutsideView(filename, view_files)
341
new_list.append(relpath)
345
def open_downlevel(path=None):
346
"""Open an unsupported working tree.
348
Only intended for advanced situations like upgrading part of a controldir.
350
return WorkingTree.open(path, _unsupported=True)
353
def find_trees(location):
354
def list_current(transport):
355
return [d for d in transport.list_dir('')
356
if not controldir.is_control_filename(d)]
357
def evaluate(controldir):
359
tree = controldir.open_workingtree()
360
except errors.NoWorkingTree:
364
t = transport.get_transport(location)
365
iterator = controldir.ControlDir.find_controldirs(t, evaluate=evaluate,
366
list_current=list_current)
367
return [tr for tr in iterator if tr is not None]
370
return "<%s of %s>" % (self.__class__.__name__,
371
getattr(self, 'basedir', None))
373
def abspath(self, filename):
374
return osutils.pathjoin(self.basedir, filename)
376
def basis_tree(self):
377
"""Return RevisionTree for the current last revision.
379
If the left most parent is a ghost then the returned tree will be an
380
empty tree - one obtained by calling
381
repository.revision_tree(NULL_REVISION).
384
revision_id = self.get_parent_ids()[0]
386
# no parents, return an empty revision tree.
387
# in the future this should return the tree for
388
# 'empty:' - the implicit root empty tree.
389
return self.branch.repository.revision_tree(
390
_mod_revision.NULL_REVISION)
392
return self.revision_tree(revision_id)
393
except errors.NoSuchRevision:
395
# No cached copy available, retrieve from the repository.
396
# FIXME? RBC 20060403 should we cache the inventory locally
399
return self.branch.repository.revision_tree(revision_id)
400
except (errors.RevisionNotPresent, errors.NoSuchRevision):
401
# the basis tree *may* be a ghost or a low level error may have
402
# occurred. If the revision is present, its a problem, if its not
404
if self.branch.repository.has_revision(revision_id):
406
# the basis tree is a ghost so return an empty tree.
407
return self.branch.repository.revision_tree(
408
_mod_revision.NULL_REVISION)
410
def relpath(self, path):
411
"""Return the local path portion from a given path.
413
The path may be absolute or relative. If its a relative path it is
414
interpreted relative to the python current working directory.
416
return osutils.relpath(self.basedir, path)
418
def has_filename(self, filename):
419
return osutils.lexists(self.abspath(filename))
421
def get_file(self, file_id, path=None, filtered=True):
422
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
424
def get_file_with_stat(self, file_id, path=None, filtered=True,
425
_fstat=osutils.fstat):
426
"""See Tree.get_file_with_stat."""
428
path = self.id2path(file_id)
429
file_obj = self.get_file_byname(path, filtered=False)
430
stat_value = _fstat(file_obj.fileno())
431
if filtered and self.supports_content_filtering():
432
filters = self._content_filter_stack(path)
433
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
434
return (file_obj, stat_value)
436
def get_file_text(self, file_id, path=None, filtered=True):
437
my_file = self.get_file(file_id, path=path, filtered=filtered)
439
return my_file.read()
443
def get_file_byname(self, filename, filtered=True):
444
path = self.abspath(filename)
446
if filtered and self.supports_content_filtering():
447
filters = self._content_filter_stack(filename)
448
return _mod_filters.filtered_input_file(f, filters)
452
def get_file_lines(self, file_id, path=None, filtered=True):
453
"""See Tree.get_file_lines()"""
454
file = self.get_file(file_id, path, filtered=filtered)
456
return file.readlines()
460
def get_parent_ids(self):
461
"""See Tree.get_parent_ids.
463
This implementation reads the pending merges list and last_revision
464
value and uses that to decide what the parents list should be.
466
last_rev = _mod_revision.ensure_null(self._last_revision())
467
if _mod_revision.NULL_REVISION == last_rev:
472
merges_bytes = self._transport.get_bytes('pending-merges')
473
except errors.NoSuchFile:
476
for l in osutils.split_lines(merges_bytes):
477
revision_id = l.rstrip('\n')
478
parents.append(revision_id)
481
def get_root_id(self):
482
"""Return the id of this trees root"""
483
raise NotImplementedError(self.get_root_id)
485
def clone(self, to_controldir, revision_id=None):
486
"""Duplicate this working tree into to_bzr, including all state.
488
Specifically modified files are kept as modified, but
489
ignored and unknown files are discarded.
491
If you want to make a new line of development, see ControlDir.sprout()
494
If not None, the cloned tree will have its last revision set to
495
revision, and difference between the source trees last revision
496
and this one merged in.
498
with self.lock_read():
499
# assumes the target bzr dir format is compatible.
500
result = to_controldir.create_workingtree()
501
self.copy_content_into(result, revision_id)
504
def copy_content_into(self, tree, revision_id=None):
505
"""Copy the current content and user files of this tree into tree."""
506
with self.lock_read():
507
tree.set_root_id(self.get_root_id())
508
if revision_id is None:
509
merge.transform_tree(tree, self)
511
# TODO now merge from tree.last_revision to revision (to
512
# preserve user local changes)
514
other_tree = self.revision_tree(revision_id)
515
except errors.NoSuchRevision:
516
other_tree = self.branch.repository.revision_tree(
519
merge.transform_tree(tree, other_tree)
520
if revision_id == _mod_revision.NULL_REVISION:
523
new_parents = [revision_id]
524
tree.set_parent_ids(new_parents)
526
def id2abspath(self, file_id):
527
return self.abspath(self.id2path(file_id))
529
def get_file_size(self, file_id):
530
"""See Tree.get_file_size"""
531
# XXX: this returns the on-disk size; it should probably return the
534
return os.path.getsize(self.id2abspath(file_id))
536
if e.errno != errno.ENOENT:
541
def _gather_kinds(self, files, kinds):
542
"""See MutableTree._gather_kinds."""
543
with self.lock_tree_write():
544
for pos, f in enumerate(files):
545
if kinds[pos] is None:
546
fullpath = osutils.normpath(self.abspath(f))
548
kinds[pos] = osutils.file_kind(fullpath)
550
if e.errno == errno.ENOENT:
551
raise errors.NoSuchFile(fullpath)
553
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
554
"""Add revision_id as a parent.
556
This is equivalent to retrieving the current list of parent ids
557
and setting the list to its value plus revision_id.
559
:param revision_id: The revision id to add to the parent list. It may
560
be a ghost revision as long as its not the first parent to be
561
added, or the allow_leftmost_as_ghost parameter is set True.
562
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
564
with self.lock_write():
565
parents = self.get_parent_ids() + [revision_id]
566
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
567
or allow_leftmost_as_ghost)
569
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
570
"""Add revision_id, tree tuple as a parent.
572
This is equivalent to retrieving the current list of parent trees
573
and setting the list to its value plus parent_tuple. See also
574
add_parent_tree_id - if you only have a parent id available it will be
575
simpler to use that api. If you have the parent already available, using
576
this api is preferred.
578
:param parent_tuple: The (revision id, tree) to add to the parent list.
579
If the revision_id is a ghost, pass None for the tree.
580
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
582
with self.lock_tree_write():
583
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
584
if len(parent_ids) > 1:
585
# the leftmost may have already been a ghost, preserve that if it
587
allow_leftmost_as_ghost = True
588
self.set_parent_ids(parent_ids,
589
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
591
def add_pending_merge(self, *revision_ids):
592
with self.lock_tree_write():
593
# TODO: Perhaps should check at this point that the
594
# history of the revision is actually present?
595
parents = self.get_parent_ids()
597
for rev_id in revision_ids:
598
if rev_id in parents:
600
parents.append(rev_id)
603
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
605
def path_content_summary(self, path, _lstat=os.lstat,
606
_mapper=osutils.file_kind_from_stat_mode):
607
"""See Tree.path_content_summary."""
608
abspath = self.abspath(path)
610
stat_result = _lstat(abspath)
612
if getattr(e, 'errno', None) == errno.ENOENT:
614
return ('missing', None, None, None)
615
# propagate other errors
617
kind = _mapper(stat_result.st_mode)
619
return self._file_content_summary(path, stat_result)
620
elif kind == 'directory':
621
# perhaps it looks like a plain directory, but it's really a
623
if self._directory_is_tree_reference(path):
624
kind = 'tree-reference'
625
return kind, None, None, None
626
elif kind == 'symlink':
627
target = osutils.readlink(abspath)
628
return ('symlink', None, None, target)
630
return (kind, None, None, None)
632
def _file_content_summary(self, path, stat_result):
633
size = stat_result.st_size
634
executable = self._is_executable_from_path_and_stat(path, stat_result)
635
# try for a stat cache lookup
636
return ('file', size, executable, self._sha_from_stat(
639
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
640
"""Common ghost checking functionality from set_parent_*.
642
This checks that the left hand-parent exists if there are any
645
if len(revision_ids) > 0:
646
leftmost_id = revision_ids[0]
647
if (not allow_leftmost_as_ghost and not
648
self.branch.repository.has_revision(leftmost_id)):
649
raise errors.GhostRevisionUnusableHere(leftmost_id)
651
def _set_merges_from_parent_ids(self, parent_ids):
652
merges = parent_ids[1:]
653
self._transport.put_bytes('pending-merges', '\n'.join(merges),
654
mode=self.controldir._get_file_mode())
656
def _filter_parent_ids_by_ancestry(self, revision_ids):
657
"""Check that all merged revisions are proper 'heads'.
659
This will always return the first revision_id, and any merged revisions
662
if len(revision_ids) == 0:
664
graph = self.branch.repository.get_graph()
665
heads = graph.heads(revision_ids)
666
new_revision_ids = revision_ids[:1]
667
for revision_id in revision_ids[1:]:
668
if revision_id in heads and revision_id not in new_revision_ids:
669
new_revision_ids.append(revision_id)
670
if new_revision_ids != revision_ids:
671
mutter('requested to set revision_ids = %s,'
672
' but filtered to %s', revision_ids, new_revision_ids)
673
return new_revision_ids
675
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
676
"""Set the parent ids to revision_ids.
678
See also set_parent_trees. This api will try to retrieve the tree data
679
for each element of revision_ids from the trees repository. If you have
680
tree data already available, it is more efficient to use
681
set_parent_trees rather than set_parent_ids. set_parent_ids is however
682
an easier API to use.
684
:param revision_ids: The revision_ids to set as the parent ids of this
685
working tree. Any of these may be ghosts.
687
with self.lock_tree_write():
688
self._check_parents_for_ghosts(revision_ids,
689
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
690
for revision_id in revision_ids:
691
_mod_revision.check_not_reserved_id(revision_id)
693
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
695
if len(revision_ids) > 0:
696
self.set_last_revision(revision_ids[0])
698
self.set_last_revision(_mod_revision.NULL_REVISION)
700
self._set_merges_from_parent_ids(revision_ids)
702
def set_pending_merges(self, rev_list):
703
with self.lock_tree_write():
704
parents = self.get_parent_ids()
705
leftmost = parents[:1]
706
new_parents = leftmost + rev_list
707
self.set_parent_ids(new_parents)
709
def set_merge_modified(self, modified_hashes):
710
"""Set the merge modified hashes."""
711
raise NotImplementedError(self.set_merge_modified)
713
def _sha_from_stat(self, path, stat_result):
714
"""Get a sha digest from the tree's stat cache.
716
The default implementation assumes no stat cache is present.
718
:param path: The path.
719
:param stat_result: The stat result being looked up.
723
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
724
merge_type=None, force=False):
725
"""Merge from a branch into this working tree.
727
:param branch: The branch to merge from.
728
:param to_revision: If non-None, the merge will merge to to_revision,
729
but not beyond it. to_revision does not need to be in the history
730
of the branch when it is supplied. If None, to_revision defaults to
731
branch.last_revision().
733
from .merge import Merger, Merge3Merger
734
with self.lock_write():
735
merger = Merger(self.branch, this_tree=self)
736
# check that there are no local alterations
737
if not force and self.has_changes():
738
raise errors.UncommittedChanges(self)
739
if to_revision is None:
740
to_revision = _mod_revision.ensure_null(branch.last_revision())
741
merger.other_rev_id = to_revision
742
if _mod_revision.is_null(merger.other_rev_id):
743
raise errors.NoCommits(branch)
744
self.branch.fetch(branch, last_revision=merger.other_rev_id)
745
merger.other_basis = merger.other_rev_id
746
merger.other_tree = self.branch.repository.revision_tree(
748
merger.other_branch = branch
749
if from_revision is None:
752
merger.set_base_revision(from_revision, branch)
753
if merger.base_rev_id == merger.other_rev_id:
754
raise errors.PointlessMerge
755
merger.backup_files = False
756
if merge_type is None:
757
merger.merge_type = Merge3Merger
759
merger.merge_type = merge_type
760
merger.set_interesting_files(None)
761
merger.show_base = False
762
merger.reprocess = False
763
conflicts = merger.do_merge()
767
def merge_modified(self):
768
"""Return a dictionary of files modified by a merge.
770
The list is initialized by WorkingTree.set_merge_modified, which is
771
typically called after we make some automatic updates to the tree
774
This returns a map of file_id->sha1, containing only files which are
775
still in the working inventory and have that text hash.
777
raise NotImplementedError(self.merge_modified)
779
def mkdir(self, path, file_id=None):
780
"""See MutableTree.mkdir()."""
782
if self.supports_setting_file_ids():
783
file_id = generate_ids.gen_file_id(os.path.basename(path))
785
if not self.supports_setting_file_ids():
786
raise SettingFileIdUnsupported()
787
with self.lock_write():
788
os.mkdir(self.abspath(path))
789
self.add(path, file_id, 'directory')
792
def get_symlink_target(self, file_id, path=None):
794
abspath = self.abspath(path)
796
abspath = self.id2abspath(file_id)
797
target = osutils.readlink(abspath)
800
def subsume(self, other_tree):
801
raise NotImplementedError(self.subsume)
803
def _setup_directory_is_tree_reference(self):
804
if self._branch.repository._format.supports_tree_reference:
805
self._directory_is_tree_reference = \
806
self._directory_may_be_tree_reference
808
self._directory_is_tree_reference = \
809
self._directory_is_never_tree_reference
811
def _directory_is_never_tree_reference(self, relpath):
814
def _directory_may_be_tree_reference(self, relpath):
815
# as a special case, if a directory contains control files then
816
# it's a tree reference, except that the root of the tree is not
817
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
818
# TODO: We could ask all the control formats whether they
819
# recognize this directory, but at the moment there's no cheap api
820
# to do that. Since we probably can only nest bzr checkouts and
821
# they always use this name it's ok for now. -- mbp 20060306
823
# FIXME: There is an unhandled case here of a subdirectory
824
# containing .bzr but not a branch; that will probably blow up
825
# when you try to commit it. It might happen if there is a
826
# checkout in a subdirectory. This can be avoided by not adding
829
def extract(self, file_id, format=None):
830
"""Extract a subtree from this tree.
832
A new branch will be created, relative to the path for this tree.
834
raise NotImplementedError(self.extract)
837
"""Write the in memory meta data to disk."""
838
raise NotImplementedError(self.flush)
840
def _kind(self, relpath):
841
return osutils.file_kind(self.abspath(relpath))
843
def list_files(self, include_root=False, from_dir=None, recursive=True):
844
"""List all files as (path, class, kind, id, entry).
846
Lists, but does not descend into unversioned directories.
847
This does not include files that have been deleted in this
848
tree. Skips the control directory.
850
:param include_root: if True, return an entry for the root
851
:param from_dir: start from this directory or None for the root
852
:param recursive: whether to recurse into subdirectories or not
854
raise NotImplementedError(self.list_files)
856
def move(self, from_paths, to_dir=None, after=False):
859
to_dir must be known to the working tree.
861
If to_dir exists and is a directory, the files are moved into
862
it, keeping their old names.
864
Note that to_dir is only the last component of the new name;
865
this doesn't change the directory.
867
For each entry in from_paths the move mode will be determined
870
The first mode moves the file in the filesystem and updates the
871
working tree metadata. The second mode only updates the working tree
872
metadata without touching the file on the filesystem.
874
move uses the second mode if 'after == True' and the target is not
875
versioned but present in the working tree.
877
move uses the second mode if 'after == False' and the source is
878
versioned but no longer in the working tree, and the target is not
879
versioned but present in the working tree.
881
move uses the first mode if 'after == False' and the source is
882
versioned and present in the working tree, and the target is not
883
versioned and not present in the working tree.
885
Everything else results in an error.
887
This returns a list of (from_path, to_path) pairs for each
890
raise NotImplementedError(self.move)
892
def rename_one(self, from_rel, to_rel, after=False):
895
This can change the directory or the filename or both.
897
rename_one has several 'modes' to work. First, it can rename a physical
898
file and change the file_id. That is the normal mode. Second, it can
899
only change the file_id without touching any physical file.
901
rename_one uses the second mode if 'after == True' and 'to_rel' is
902
either not versioned or newly added, and present in the working tree.
904
rename_one uses the second mode if 'after == False' and 'from_rel' is
905
versioned but no longer in the working tree, and 'to_rel' is not
906
versioned but present in the working tree.
908
rename_one uses the first mode if 'after == False' and 'from_rel' is
909
versioned and present in the working tree, and 'to_rel' is not
910
versioned and not present in the working tree.
912
Everything else results in an error.
914
raise NotImplementedError(self.rename_one)
917
"""Return all unknown files.
919
These are files in the working directory that are not versioned or
920
control files or ignored.
922
with self.lock_read():
923
# force the extras method to be fully executed before returning, to
924
# prevent race conditions with the lock
926
[subp for subp in self.extras() if not self.is_ignored(subp)])
928
def unversion(self, file_ids):
929
"""Remove the file ids in file_ids from the current versioned set.
931
When a file_id is unversioned, all of its children are automatically
934
:param file_ids: The file ids to stop versioning.
935
:raises: NoSuchId if any fileid is not currently versioned.
937
raise NotImplementedError(self.unversion)
939
def pull(self, source, overwrite=False, stop_revision=None,
940
change_reporter=None, possible_transports=None, local=False,
942
with self.lock_write(), source.lock_read():
943
old_revision_info = self.branch.last_revision_info()
944
basis_tree = self.basis_tree()
945
count = self.branch.pull(source, overwrite, stop_revision,
946
possible_transports=possible_transports,
948
new_revision_info = self.branch.last_revision_info()
949
if new_revision_info != old_revision_info:
950
repository = self.branch.repository
951
if repository._format.fast_deltas:
952
parent_ids = self.get_parent_ids()
954
basis_id = parent_ids[0]
955
basis_tree = repository.revision_tree(basis_id)
956
with basis_tree.lock_read():
957
new_basis_tree = self.branch.basis_tree()
963
change_reporter=change_reporter,
965
basis_root_id = basis_tree.get_root_id()
966
new_root_id = new_basis_tree.get_root_id()
967
if new_root_id is not None and basis_root_id != new_root_id:
968
self.set_root_id(new_root_id)
969
# TODO - dedup parents list with things merged by pull ?
970
# reuse the revisiontree we merged against to set the new
973
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
975
(self.branch.last_revision(), new_basis_tree))
976
# we have to pull the merge trees out again, because
977
# merge_inner has set the ids. - this corner is not yet
978
# layered well enough to prevent double handling.
979
# XXX TODO: Fix the double handling: telling the tree about
980
# the already known parent data is wasteful.
981
merges = self.get_parent_ids()[1:]
982
parent_trees.extend([
983
(parent, repository.revision_tree(parent)) for
985
self.set_parent_trees(parent_trees)
988
def put_file_bytes_non_atomic(self, file_id, bytes):
989
"""See MutableTree.put_file_bytes_non_atomic."""
990
with self.lock_write():
991
stream = file(self.id2abspath(file_id), 'wb')
998
"""Yield all unversioned files in this WorkingTree.
1000
If there are any unversioned directories then only the directory is
1001
returned, not all its children. But if there are unversioned files
1002
under a versioned subdirectory, they are returned.
1004
Currently returned depth-first, sorted by name within directories.
1005
This is the same order used by 'osutils.walkdirs'.
1007
raise NotImplementedError(self.extras)
1009
def ignored_files(self):
1010
"""Yield list of PATH, IGNORE_PATTERN"""
1011
for subp in self.extras():
1012
pat = self.is_ignored(subp)
1016
def is_ignored(self, filename):
1017
r"""Check whether the filename matches an ignore pattern.
1019
raise NotImplementedError(self.is_ignored)
1021
def kind(self, file_id):
1022
return osutils.file_kind(self.id2abspath(file_id))
1024
def stored_kind(self, file_id):
1025
"""See Tree.stored_kind"""
1026
raise NotImplementedError(self.stored_kind)
1028
def _comparison_data(self, entry, path):
1029
abspath = self.abspath(path)
1031
stat_value = os.lstat(abspath)
1032
except OSError as e:
1033
if getattr(e, 'errno', None) == errno.ENOENT:
1040
mode = stat_value.st_mode
1041
kind = osutils.file_kind_from_stat_mode(mode)
1042
if not self._supports_executable():
1043
executable = entry is not None and entry.executable
1045
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1046
return kind, executable, stat_value
1048
def _file_size(self, entry, stat_value):
1049
return stat_value.st_size
1051
def last_revision(self):
1052
"""Return the last revision of the branch for this tree.
1054
This format tree does not support a separate marker for last-revision
1055
compared to the branch.
1057
See MutableTree.last_revision
1059
return self._last_revision()
1061
def _last_revision(self):
1062
"""helper for get_parent_ids."""
1063
with self.lock_read():
1064
return _mod_revision.ensure_null(self.branch.last_revision())
1066
def is_locked(self):
1067
"""Check if this tree is locked."""
1068
raise NotImplementedError(self.is_locked)
1070
def lock_read(self):
1071
"""Lock the tree for reading.
1073
This also locks the branch, and can be unlocked via self.unlock().
1075
:return: A breezy.lock.LogicalLockResult.
1077
raise NotImplementedError(self.lock_read)
1079
def lock_tree_write(self):
1080
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1082
:return: A breezy.lock.LogicalLockResult.
1084
raise NotImplementedError(self.lock_tree_write)
1086
def lock_write(self):
1087
"""See MutableTree.lock_write, and WorkingTree.unlock.
1089
:return: A breezy.lock.LogicalLockResult.
1091
raise NotImplementedError(self.lock_write)
1093
def get_physical_lock_status(self):
1094
raise NotImplementedError(self.get_physical_lock_status)
1096
def set_last_revision(self, new_revision):
1097
"""Change the last revision in the working tree."""
1098
raise NotImplementedError(self.set_last_revision)
1100
def _change_last_revision(self, new_revision):
1101
"""Template method part of set_last_revision to perform the change.
1103
This is used to allow WorkingTree3 instances to not affect branch
1104
when their last revision is set.
1106
if _mod_revision.is_null(new_revision):
1107
self.branch.set_last_revision_info(0, new_revision)
1109
_mod_revision.check_not_reserved_id(new_revision)
1111
self.branch.generate_revision_history(new_revision)
1112
except errors.NoSuchRevision:
1113
# not present in the repo - dont try to set it deeper than the tip
1114
self.branch._set_revision_history([new_revision])
1117
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1119
"""Remove nominated files from the working tree metadata.
1121
:files: File paths relative to the basedir.
1122
:keep_files: If true, the files will also be kept.
1123
:force: Delete files and directories, even if they are changed and
1124
even if the directories are not empty.
1126
raise NotImplementedError(self.remove)
1128
def revert(self, filenames=None, old_tree=None, backups=True,
1129
pb=None, report_changes=False):
1130
from .conflicts import resolve
1131
with self.lock_tree_write():
1132
if old_tree is None:
1133
basis_tree = self.basis_tree()
1134
basis_tree.lock_read()
1135
old_tree = basis_tree
1139
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1141
if filenames is None and len(self.get_parent_ids()) > 1:
1143
last_revision = self.last_revision()
1144
if last_revision != _mod_revision.NULL_REVISION:
1145
if basis_tree is None:
1146
basis_tree = self.basis_tree()
1147
basis_tree.lock_read()
1148
parent_trees.append((last_revision, basis_tree))
1149
self.set_parent_trees(parent_trees)
1152
resolve(self, filenames, ignore_misses=True, recursive=True)
1154
if basis_tree is not None:
1158
def store_uncommitted(self):
1159
"""Store uncommitted changes from the tree in the branch."""
1160
raise NotImplementedError(self.store_uncommitted)
1162
def restore_uncommitted(self):
1163
"""Restore uncommitted changes from the branch into the tree."""
1164
raise NotImplementedError(self.restore_uncommitted)
1166
def revision_tree(self, revision_id):
1167
"""See Tree.revision_tree.
1169
WorkingTree can supply revision_trees for the basis revision only
1170
because there is only one cached inventory in the bzr directory.
1172
raise NotImplementedError(self.revision_tree)
1174
def set_root_id(self, file_id):
1175
"""Set the root id for this tree."""
1176
if not self.supports_setting_file_ids():
1177
raise SettingFileIdUnsupported()
1178
with self.lock_tree_write():
1182
'WorkingTree.set_root_id with fileid=None')
1183
file_id = osutils.safe_file_id(file_id)
1184
self._set_root_id(file_id)
1186
def _set_root_id(self, file_id):
1187
"""Set the root id for this tree, in a format specific manner.
1189
:param file_id: The file id to assign to the root. It must not be
1190
present in the current inventory or an error will occur. It must
1191
not be None, but rather a valid file id.
1193
raise NotImplementedError(self._set_root_id)
1196
"""See Branch.unlock.
1198
WorkingTree locking just uses the Branch locking facilities.
1199
This is current because all working trees have an embedded branch
1200
within them. IF in the future, we were to make branch data shareable
1201
between multiple working trees, i.e. via shared storage, then we
1202
would probably want to lock both the local tree, and the branch.
1204
raise NotImplementedError(self.unlock)
1208
def update(self, change_reporter=None, possible_transports=None,
1209
revision=None, old_tip=_marker, show_base=False):
1210
"""Update a working tree along its branch.
1212
This will update the branch if its bound too, which means we have
1213
multiple trees involved:
1215
- The new basis tree of the master.
1216
- The old basis tree of the branch.
1217
- The old basis tree of the working tree.
1218
- The current working tree state.
1220
Pathologically, all three may be different, and non-ancestors of each
1221
other. Conceptually we want to:
1223
- Preserve the wt.basis->wt.state changes
1224
- Transform the wt.basis to the new master basis.
1225
- Apply a merge of the old branch basis to get any 'local' changes from
1227
- Restore the wt.basis->wt.state changes.
1229
There isn't a single operation at the moment to do that, so we:
1231
- Merge current state -> basis tree of the master w.r.t. the old tree
1233
- Do a 'normal' merge of the old branch basis if it is relevant.
1235
:param revision: The target revision to update to. Must be in the
1237
:param old_tip: If branch.update() has already been run, the value it
1238
returned (old tip of the branch or None). _marker is used
1241
if self.branch.get_bound_location() is not None:
1243
update_branch = (old_tip is self._marker)
1245
self.lock_tree_write()
1246
update_branch = False
1249
old_tip = self.branch.update(possible_transports)
1251
if old_tip is self._marker:
1253
return self._update_tree(old_tip, change_reporter, revision, show_base)
1257
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1259
"""Update a tree to the master branch.
1261
:param old_tip: if supplied, the previous tip revision the branch,
1262
before it was changed to the master branch's tip.
1264
# here if old_tip is not None, it is the old tip of the branch before
1265
# it was updated from the master branch. This should become a pending
1266
# merge in the working tree to preserve the user existing work. we
1267
# cant set that until we update the working trees last revision to be
1268
# one from the new branch, because it will just get absorbed by the
1269
# parent de-duplication logic.
1271
# We MUST save it even if an error occurs, because otherwise the users
1272
# local work is unreferenced and will appear to have been lost.
1274
with self.lock_tree_write():
1277
last_rev = self.get_parent_ids()[0]
1279
last_rev = _mod_revision.NULL_REVISION
1280
if revision is None:
1281
revision = self.branch.last_revision()
1283
old_tip = old_tip or _mod_revision.NULL_REVISION
1285
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1286
# the branch we are bound to was updated
1287
# merge those changes in first
1288
base_tree = self.basis_tree()
1289
other_tree = self.branch.repository.revision_tree(old_tip)
1290
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1291
base_tree, this_tree=self,
1292
change_reporter=change_reporter,
1293
show_base=show_base)
1295
self.add_parent_tree((old_tip, other_tree))
1296
note(gettext('Rerun update after fixing the conflicts.'))
1299
if last_rev != _mod_revision.ensure_null(revision):
1300
# the working tree is up to date with the branch
1301
# we can merge the specified revision from master
1302
to_tree = self.branch.repository.revision_tree(revision)
1303
to_root_id = to_tree.get_root_id()
1305
basis = self.basis_tree()
1306
with basis.lock_read():
1307
if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
1308
self.set_root_id(to_root_id)
1311
# determine the branch point
1312
graph = self.branch.repository.get_graph()
1313
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1315
base_tree = self.branch.repository.revision_tree(base_rev_id)
1317
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1319
change_reporter=change_reporter,
1320
show_base=show_base)
1321
self.set_last_revision(revision)
1322
# TODO - dedup parents list with things merged by pull ?
1323
# reuse the tree we've updated to to set the basis:
1324
parent_trees = [(revision, to_tree)]
1325
merges = self.get_parent_ids()[1:]
1326
# Ideally we ask the tree for the trees here, that way the working
1327
# tree can decide whether to give us the entire tree or give us a
1328
# lazy initialised tree. dirstate for instance will have the trees
1329
# in ram already, whereas a last-revision + basis-inventory tree
1330
# will not, but also does not need them when setting parents.
1331
for parent in merges:
1332
parent_trees.append(
1333
(parent, self.branch.repository.revision_tree(parent)))
1334
if not _mod_revision.is_null(old_tip):
1335
parent_trees.append(
1336
(old_tip, self.branch.repository.revision_tree(old_tip)))
1337
self.set_parent_trees(parent_trees)
1338
last_rev = parent_trees[0][0]
1341
def set_conflicts(self, arg):
1342
raise errors.UnsupportedOperation(self.set_conflicts, self)
1344
def add_conflicts(self, arg):
1345
raise errors.UnsupportedOperation(self.add_conflicts, self)
1347
def conflicts(self):
1348
raise NotImplementedError(self.conflicts)
1350
def walkdirs(self, prefix=""):
1351
"""Walk the directories of this tree.
1353
returns a generator which yields items in the form:
1354
((curren_directory_path, fileid),
1355
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1358
This API returns a generator, which is only valid during the current
1359
tree transaction - within a single lock_read or lock_write duration.
1361
If the tree is not locked, it may cause an error to be raised,
1362
depending on the tree implementation.
1364
disk_top = self.abspath(prefix)
1365
if disk_top.endswith('/'):
1366
disk_top = disk_top[:-1]
1367
top_strip_len = len(disk_top) + 1
1368
inventory_iterator = self._walkdirs(prefix)
1369
disk_iterator = osutils.walkdirs(disk_top, prefix)
1371
current_disk = next(disk_iterator)
1372
disk_finished = False
1373
except OSError as e:
1374
if not (e.errno == errno.ENOENT or
1375
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
1378
disk_finished = True
1380
current_inv = next(inventory_iterator)
1381
inv_finished = False
1382
except StopIteration:
1385
while not inv_finished or not disk_finished:
1387
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1388
cur_disk_dir_content) = current_disk
1390
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1391
cur_disk_dir_content) = ((None, None), None)
1392
if not disk_finished:
1393
# strip out .bzr dirs
1394
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
1395
len(cur_disk_dir_content) > 0):
1396
# osutils.walkdirs can be made nicer -
1397
# yield the path-from-prefix rather than the pathjoined
1399
bzrdir_loc = bisect_left(cur_disk_dir_content,
1401
if (bzrdir_loc < len(cur_disk_dir_content)
1402
and self.controldir.is_control_filename(
1403
cur_disk_dir_content[bzrdir_loc][0])):
1404
# we dont yield the contents of, or, .bzr itself.
1405
del cur_disk_dir_content[bzrdir_loc]
1407
# everything is unknown
1410
# everything is missing
1413
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
1415
# disk is before inventory - unknown
1416
dirblock = [(relpath, basename, kind, stat, None, None) for
1417
relpath, basename, kind, stat, top_path in
1418
cur_disk_dir_content]
1419
yield (cur_disk_dir_relpath, None), dirblock
1421
current_disk = next(disk_iterator)
1422
except StopIteration:
1423
disk_finished = True
1425
# inventory is before disk - missing.
1426
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
1427
for relpath, basename, dkind, stat, fileid, kind in
1429
yield (current_inv[0][0], current_inv[0][1]), dirblock
1431
current_inv = next(inventory_iterator)
1432
except StopIteration:
1435
# versioned present directory
1436
# merge the inventory and disk data together
1438
for relpath, subiterator in itertools.groupby(sorted(
1439
current_inv[1] + cur_disk_dir_content,
1440
key=operator.itemgetter(0)), operator.itemgetter(1)):
1441
path_elements = list(subiterator)
1442
if len(path_elements) == 2:
1443
inv_row, disk_row = path_elements
1444
# versioned, present file
1445
dirblock.append((inv_row[0],
1446
inv_row[1], disk_row[2],
1447
disk_row[3], inv_row[4],
1449
elif len(path_elements[0]) == 5:
1451
dirblock.append((path_elements[0][0],
1452
path_elements[0][1], path_elements[0][2],
1453
path_elements[0][3], None, None))
1454
elif len(path_elements[0]) == 6:
1455
# versioned, absent file.
1456
dirblock.append((path_elements[0][0],
1457
path_elements[0][1], 'unknown', None,
1458
path_elements[0][4], path_elements[0][5]))
1460
raise NotImplementedError('unreachable code')
1461
yield current_inv[0], dirblock
1463
current_inv = next(inventory_iterator)
1464
except StopIteration:
1467
current_disk = next(disk_iterator)
1468
except StopIteration:
1469
disk_finished = True
1471
def _walkdirs(self, prefix=""):
1472
"""Walk the directories of this tree.
1474
:param prefix: is used as the directrory to start with.
1475
:returns: a generator which yields items in the form::
1477
((curren_directory_path, fileid),
1478
[(file1_path, file1_name, file1_kind, None, file1_id,
1481
raise NotImplementedError(self._walkdirs)
1483
def auto_resolve(self):
1484
"""Automatically resolve text conflicts according to contents.
1486
Only text conflicts are auto_resolvable. Files with no conflict markers
1487
are considered 'resolved', because bzr always puts conflict markers
1488
into files that have text conflicts. The corresponding .THIS .BASE and
1489
.OTHER files are deleted, as per 'resolve'.
1491
:return: a tuple of ConflictLists: (un_resolved, resolved).
1493
with self.lock_tree_write():
1494
un_resolved = _mod_conflicts.ConflictList()
1495
resolved = _mod_conflicts.ConflictList()
1496
conflict_re = re.compile('^(<{7}|={7}|>{7})')
1497
for conflict in self.conflicts():
1498
if (conflict.typestring != 'text conflict' or
1499
self.kind(conflict.file_id) != 'file'):
1500
un_resolved.append(conflict)
1502
my_file = open(self.id2abspath(conflict.file_id), 'rb')
1504
for line in my_file:
1505
if conflict_re.search(line):
1506
un_resolved.append(conflict)
1509
resolved.append(conflict)
1512
resolved.remove_files(self)
1513
self.set_conflicts(un_resolved)
1514
return un_resolved, resolved
1516
def _validate(self):
1517
"""Validate internal structures.
1519
This is meant mostly for the test suite. To give it a chance to detect
1520
corruption after actions have occurred. The default implementation is a
1523
:return: None. An exception should be raised if there is an error.
1527
def check_state(self):
1528
"""Check that the working state is/isn't valid."""
1529
raise NotImplementedError(self.check_state)
1531
def reset_state(self, revision_ids=None):
1532
"""Reset the state of the working tree.
1534
This does a hard-reset to a last-known-good state. This is a way to
1535
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1537
raise NotImplementedError(self.reset_state)
1539
def _get_rules_searcher(self, default_searcher):
1540
"""See Tree._get_rules_searcher."""
1541
if self._rules_searcher is None:
1542
self._rules_searcher = super(WorkingTree,
1543
self)._get_rules_searcher(default_searcher)
1544
return self._rules_searcher
1546
def get_shelf_manager(self):
1547
"""Return the ShelfManager for this WorkingTree."""
1548
raise NotImplementedError(self.get_shelf_manager)
1551
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
1552
"""Registry for working tree formats."""
1554
def __init__(self, other_registry=None):
1555
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
1556
self._default_format = None
1557
self._default_format_key = None
1559
def get_default(self):
1560
"""Return the current default format."""
1561
if (self._default_format_key is not None and
1562
self._default_format is None):
1563
self._default_format = self.get(self._default_format_key)
1564
return self._default_format
1566
def set_default(self, format):
1567
"""Set the default format."""
1568
self._default_format = format
1569
self._default_format_key = None
1571
def set_default_key(self, format_string):
1572
"""Set the default format by its format string."""
1573
self._default_format_key = format_string
1574
self._default_format = None
1577
format_registry = WorkingTreeFormatRegistry()
1580
class WorkingTreeFormat(controldir.ControlComponentFormat):
1581
"""An encapsulation of the initialization and open routines for a format.
1583
Formats provide three things:
1584
* An initialization routine,
1588
Formats are placed in an dict by their format string for reference
1589
during workingtree opening. Its not required that these be instances, they
1590
can be classes themselves with class methods - it simply depends on
1591
whether state is needed for a given format or not.
1593
Once a format is deprecated, just deprecate the initialize and open
1594
methods on the format class. Do not deprecate the object, as the
1595
object will be created every time regardless.
1598
requires_rich_root = False
1600
upgrade_recommended = False
1602
requires_normalized_unicode_filenames = False
1604
case_sensitive_filename = "FoRMaT"
1606
missing_parent_conflicts = False
1607
"""If this format supports missing parent conflicts."""
1609
supports_versioned_directories = None
1611
supports_setting_file_ids = True
1612
"""If this format allows setting the file id."""
1614
supports_store_uncommitted = True
1615
"""If this format supports shelve-like functionality."""
1617
def initialize(self, controldir, revision_id=None, from_branch=None,
1618
accelerator_tree=None, hardlink=False):
1619
"""Initialize a new working tree in controldir.
1621
:param controldir: ControlDir to initialize the working tree in.
1622
:param revision_id: allows creating a working tree at a different
1623
revision than the branch is at.
1624
:param from_branch: Branch to checkout
1625
:param accelerator_tree: A tree which can be used for retrieving file
1626
contents more quickly than the revision tree, i.e. a workingtree.
1627
The revision tree will be used for cases where accelerator_tree's
1628
content is different.
1629
:param hardlink: If true, hard-link files from accelerator_tree,
1632
raise NotImplementedError(self.initialize)
1634
def __eq__(self, other):
1635
return self.__class__ is other.__class__
1637
def __ne__(self, other):
1638
return not (self == other)
1640
def get_format_description(self):
1641
"""Return the short description for this format."""
1642
raise NotImplementedError(self.get_format_description)
1644
def is_supported(self):
1645
"""Is this format supported?
1647
Supported formats can be initialized and opened.
1648
Unsupported formats may not support initialization or committing or
1649
some other features depending on the reason for not being supported.
1653
def supports_content_filtering(self):
1654
"""True if this format supports content filtering."""
1657
def supports_views(self):
1658
"""True if this format supports stored views."""
1661
def get_controldir_for_branch(self):
1662
"""Get the control directory format for creating branches.
1664
This is to support testing of working tree formats that can not exist
1665
in the same control directory as a branch.
1667
return self._matchingcontroldir
1670
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
1671
"breezy.bzr.workingtree_4", "WorkingTreeFormat4")
1672
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
1673
"breezy.bzr.workingtree_4", "WorkingTreeFormat5")
1674
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
1675
"breezy.bzr.workingtree_4", "WorkingTreeFormat6")
1676
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
1677
"breezy.bzr.workingtree_3", "WorkingTreeFormat3")
1678
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
breezy/workingtree.py
