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,
66
from .decorators import needs_read_lock, needs_write_lock
67
from .i18n import gettext
68
from . import mutabletree
69
from .mutabletree import needs_tree_write_lock
73
from .trace import mutter, note
76
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
79
class TreeEntry(object):
80
"""An entry that implements the minimum interface used by commands.
82
This needs further inspection, it may be better to have
83
InventoryEntries without ids - though that seems wrong. For now,
84
this is a parallel hierarchy to InventoryEntry, and needs to become
85
one of several things: decorates to that hierarchy, children of, or
87
Another note is that these objects are currently only used when there is
88
no InventoryEntry available - i.e. for unversioned objects.
89
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
92
def __eq__(self, other):
93
# yes, this us ugly, TODO: best practice __eq__ style.
94
return (isinstance(other, TreeEntry)
95
and other.__class__ == self.__class__)
97
def kind_character(self):
101
class TreeDirectory(TreeEntry):
102
"""See TreeEntry. This is a directory in a working tree."""
104
def __eq__(self, other):
105
return (isinstance(other, TreeDirectory)
106
and other.__class__ == self.__class__)
108
def kind_character(self):
112
class TreeFile(TreeEntry):
113
"""See TreeEntry. This is a regular file in a working tree."""
115
def __eq__(self, other):
116
return (isinstance(other, TreeFile)
117
and other.__class__ == self.__class__)
119
def kind_character(self):
123
class TreeLink(TreeEntry):
124
"""See TreeEntry. This is a symlink in a working tree."""
126
def __eq__(self, other):
127
return (isinstance(other, TreeLink)
128
and other.__class__ == self.__class__)
130
def kind_character(self):
134
class WorkingTree(mutabletree.MutableTree,
135
controldir.ControlComponent):
136
"""Working copy tree.
138
:ivar basedir: The root of the tree on disk. This is a unicode path object
139
(as opposed to a URL).
142
# override this to set the strategy for storing views
143
def _make_views(self):
144
return views.DisabledViews(self)
146
def __init__(self, basedir='.',
152
"""Construct a WorkingTree instance. This is not a public API.
154
:param branch: A branch to override probing for the branch.
156
self._format = _format
157
self.controldir = _controldir
159
raise errors.BzrError("Please use controldir.open_workingtree or "
160
"WorkingTree.open() to obtain a WorkingTree.")
161
basedir = osutils.safe_unicode(basedir)
162
mutter("opening working tree %r", basedir)
163
if branch is not None:
164
self._branch = branch
166
self._branch = self.controldir.open_branch()
167
self.basedir = osutils.realpath(basedir)
168
self._transport = _transport
169
self._rules_searcher = None
170
self.views = self._make_views()
173
def user_transport(self):
174
return self.controldir.user_transport
177
def control_transport(self):
178
return self._transport
180
def is_control_filename(self, filename):
181
"""True if filename is the name of a control file in this tree.
183
:param filename: A filename within the tree. This is a relative path
184
from the root of this tree.
186
This is true IF and ONLY IF the filename is part of the meta data
187
that bzr controls in this tree. I.E. a random .bzr directory placed
188
on disk will not be a control file for this tree.
190
return self.controldir.is_control_filename(filename)
193
fget=lambda self: self._branch,
194
doc="""The branch this WorkingTree is connected to.
196
This cannot be set - it is reflective of the actual disk structure
197
the working tree has been constructed from.
200
def has_versioned_directories(self):
201
"""See `Tree.has_versioned_directories`."""
202
return self._format.supports_versioned_directories
204
def _supports_executable(self):
205
if sys.platform == 'win32':
207
# FIXME: Ideally this should check the file system
210
def break_lock(self):
211
"""Break a lock if one is present from another instance.
213
Uses the ui factory to ask for confirmation if the lock may be from
216
This will probe the repository for its lock as well.
218
raise NotImplementedError(self.break_lock)
220
def requires_rich_root(self):
221
return self._format.requires_rich_root
223
def supports_tree_reference(self):
226
def supports_content_filtering(self):
227
return self._format.supports_content_filtering()
229
def supports_views(self):
230
return self.views.supports_views()
232
def get_config_stack(self):
233
"""Retrieve the config stack for this tree.
235
:return: A ``breezy.config.Stack``
237
# For the moment, just provide the branch config stack.
238
return self.branch.get_config_stack()
241
def open(path=None, _unsupported=False):
242
"""Open an existing working tree at path.
246
path = osutils.getcwd()
247
control = controldir.ControlDir.open(path, _unsupported=_unsupported)
248
return control.open_workingtree(unsupported=_unsupported)
251
def open_containing(path=None):
252
"""Open an existing working tree which has its root about path.
254
This probes for a working tree at path and searches upwards from there.
256
Basically we keep looking up until we find the control directory or
257
run into /. If there isn't one, raises NotBranchError.
258
TODO: give this a new exception.
259
If there is one, it is returned, along with the unused portion of path.
261
:return: The WorkingTree that contains 'path', and the rest of path
264
path = osutils.getcwd()
265
control, relpath = controldir.ControlDir.open_containing(path)
266
return control.open_workingtree(), relpath
269
def open_containing_paths(file_list, default_directory=None,
270
canonicalize=True, apply_view=True):
271
"""Open the WorkingTree that contains a set of paths.
273
Fail if the paths given are not all in a single tree.
275
This is used for the many command-line interfaces that take a list of
276
any number of files and that require they all be in the same tree.
278
if default_directory is None:
279
default_directory = u'.'
280
# recommended replacement for builtins.internal_tree_files
281
if file_list is None or len(file_list) == 0:
282
tree = WorkingTree.open_containing(default_directory)[0]
283
# XXX: doesn't really belong here, and seems to have the strange
284
# side effect of making it return a bunch of files, not the whole
285
# tree -- mbp 20100716
286
if tree.supports_views() and apply_view:
287
view_files = tree.views.lookup_view()
289
file_list = view_files
290
view_str = views.view_display_str(view_files)
291
note(gettext("Ignoring files outside view. View is %s") % view_str)
292
return tree, file_list
293
if default_directory == u'.':
296
seed = default_directory
297
file_list = [osutils.pathjoin(default_directory, f)
299
tree = WorkingTree.open_containing(seed)[0]
300
return tree, tree.safe_relpath_files(file_list, canonicalize,
301
apply_view=apply_view)
303
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
304
"""Convert file_list into a list of relpaths in tree.
306
:param self: A tree to operate on.
307
:param file_list: A list of user provided paths or None.
308
:param apply_view: if True and a view is set, apply it or check that
309
specified files are within it
310
:return: A list of relative paths.
311
:raises errors.PathNotChild: When a provided path is in a different self
314
if file_list is None:
316
if self.supports_views() and apply_view:
317
view_files = self.views.lookup_view()
321
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
322
# doesn't - fix that up here before we enter the loop.
324
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
327
for filename in file_list:
328
relpath = fixer(osutils.dereference_path(filename))
329
if view_files and not osutils.is_inside_any(view_files, relpath):
330
raise views.FileOutsideView(filename, view_files)
331
new_list.append(relpath)
335
def open_downlevel(path=None):
336
"""Open an unsupported working tree.
338
Only intended for advanced situations like upgrading part of a controldir.
340
return WorkingTree.open(path, _unsupported=True)
343
def find_trees(location):
344
def list_current(transport):
345
return [d for d in transport.list_dir('')
346
if not controldir.is_control_filename(d)]
347
def evaluate(controldir):
349
tree = controldir.open_workingtree()
350
except errors.NoWorkingTree:
354
t = transport.get_transport(location)
355
iterator = controldir.ControlDir.find_controldirs(t, evaluate=evaluate,
356
list_current=list_current)
357
return [tr for tr in iterator if tr is not None]
360
return "<%s of %s>" % (self.__class__.__name__,
361
getattr(self, 'basedir', None))
363
def abspath(self, filename):
364
return osutils.pathjoin(self.basedir, filename)
366
def basis_tree(self):
367
"""Return RevisionTree for the current last revision.
369
If the left most parent is a ghost then the returned tree will be an
370
empty tree - one obtained by calling
371
repository.revision_tree(NULL_REVISION).
374
revision_id = self.get_parent_ids()[0]
376
# no parents, return an empty revision tree.
377
# in the future this should return the tree for
378
# 'empty:' - the implicit root empty tree.
379
return self.branch.repository.revision_tree(
380
_mod_revision.NULL_REVISION)
382
return self.revision_tree(revision_id)
383
except errors.NoSuchRevision:
385
# No cached copy available, retrieve from the repository.
386
# FIXME? RBC 20060403 should we cache the inventory locally
389
return self.branch.repository.revision_tree(revision_id)
390
except (errors.RevisionNotPresent, errors.NoSuchRevision):
391
# the basis tree *may* be a ghost or a low level error may have
392
# occurred. If the revision is present, its a problem, if its not
394
if self.branch.repository.has_revision(revision_id):
396
# the basis tree is a ghost so return an empty tree.
397
return self.branch.repository.revision_tree(
398
_mod_revision.NULL_REVISION)
400
def relpath(self, path):
401
"""Return the local path portion from a given path.
403
The path may be absolute or relative. If its a relative path it is
404
interpreted relative to the python current working directory.
406
return osutils.relpath(self.basedir, path)
408
def has_filename(self, filename):
409
return osutils.lexists(self.abspath(filename))
411
def get_file(self, file_id, path=None, filtered=True):
412
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
414
def get_file_with_stat(self, file_id, path=None, filtered=True,
415
_fstat=osutils.fstat):
416
"""See Tree.get_file_with_stat."""
418
path = self.id2path(file_id)
419
file_obj = self.get_file_byname(path, filtered=False)
420
stat_value = _fstat(file_obj.fileno())
421
if filtered and self.supports_content_filtering():
422
filters = self._content_filter_stack(path)
423
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
424
return (file_obj, stat_value)
426
def get_file_text(self, file_id, path=None, filtered=True):
427
my_file = self.get_file(file_id, path=path, filtered=filtered)
429
return my_file.read()
433
def get_file_byname(self, filename, filtered=True):
434
path = self.abspath(filename)
436
if filtered and self.supports_content_filtering():
437
filters = self._content_filter_stack(filename)
438
return _mod_filters.filtered_input_file(f, filters)
442
def get_file_lines(self, file_id, path=None, filtered=True):
443
"""See Tree.get_file_lines()"""
444
file = self.get_file(file_id, path, filtered=filtered)
446
return file.readlines()
450
def get_parent_ids(self):
451
"""See Tree.get_parent_ids.
453
This implementation reads the pending merges list and last_revision
454
value and uses that to decide what the parents list should be.
456
last_rev = _mod_revision.ensure_null(self._last_revision())
457
if _mod_revision.NULL_REVISION == last_rev:
462
merges_bytes = self._transport.get_bytes('pending-merges')
463
except errors.NoSuchFile:
466
for l in osutils.split_lines(merges_bytes):
467
revision_id = l.rstrip('\n')
468
parents.append(revision_id)
471
def get_root_id(self):
472
"""Return the id of this trees root"""
473
raise NotImplementedError(self.get_root_id)
476
def clone(self, to_controldir, revision_id=None):
477
"""Duplicate this working tree into to_bzr, including all state.
479
Specifically modified files are kept as modified, but
480
ignored and unknown files are discarded.
482
If you want to make a new line of development, see ControlDir.sprout()
485
If not None, the cloned tree will have its last revision set to
486
revision, and difference between the source trees last revision
487
and this one merged in.
489
# assumes the target bzr dir format is compatible.
490
result = to_controldir.create_workingtree()
491
self.copy_content_into(result, revision_id)
495
def copy_content_into(self, tree, revision_id=None):
496
"""Copy the current content and user files of this tree into tree."""
497
tree.set_root_id(self.get_root_id())
498
if revision_id is None:
499
merge.transform_tree(tree, self)
501
# TODO now merge from tree.last_revision to revision (to preserve
502
# user local changes)
504
other_tree = self.revision_tree(revision_id)
505
except errors.NoSuchRevision:
506
other_tree = self.branch.repository.revision_tree(revision_id)
508
merge.transform_tree(tree, other_tree)
509
if revision_id == _mod_revision.NULL_REVISION:
512
new_parents = [revision_id]
513
tree.set_parent_ids(new_parents)
515
def id2abspath(self, file_id):
516
return self.abspath(self.id2path(file_id))
518
def get_file_size(self, file_id):
519
"""See Tree.get_file_size"""
520
# XXX: this returns the on-disk size; it should probably return the
523
return os.path.getsize(self.id2abspath(file_id))
525
if e.errno != errno.ENOENT:
530
@needs_tree_write_lock
531
def _gather_kinds(self, files, kinds):
532
"""See MutableTree._gather_kinds."""
533
for pos, f in enumerate(files):
534
if kinds[pos] is None:
535
fullpath = osutils.normpath(self.abspath(f))
537
kinds[pos] = osutils.file_kind(fullpath)
539
if e.errno == errno.ENOENT:
540
raise errors.NoSuchFile(fullpath)
543
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
544
"""Add revision_id as a parent.
546
This is equivalent to retrieving the current list of parent ids
547
and setting the list to its value plus revision_id.
549
:param revision_id: The revision id to add to the parent list. It may
550
be a ghost revision as long as its not the first parent to be
551
added, or the allow_leftmost_as_ghost parameter is set True.
552
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
554
parents = self.get_parent_ids() + [revision_id]
555
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
556
or allow_leftmost_as_ghost)
558
@needs_tree_write_lock
559
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
560
"""Add revision_id, tree tuple as a parent.
562
This is equivalent to retrieving the current list of parent trees
563
and setting the list to its value plus parent_tuple. See also
564
add_parent_tree_id - if you only have a parent id available it will be
565
simpler to use that api. If you have the parent already available, using
566
this api is preferred.
568
:param parent_tuple: The (revision id, tree) to add to the parent list.
569
If the revision_id is a ghost, pass None for the tree.
570
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
572
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
573
if len(parent_ids) > 1:
574
# the leftmost may have already been a ghost, preserve that if it
576
allow_leftmost_as_ghost = True
577
self.set_parent_ids(parent_ids,
578
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
580
@needs_tree_write_lock
581
def add_pending_merge(self, *revision_ids):
582
# TODO: Perhaps should check at this point that the
583
# history of the revision is actually present?
584
parents = self.get_parent_ids()
586
for rev_id in revision_ids:
587
if rev_id in parents:
589
parents.append(rev_id)
592
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
594
def path_content_summary(self, path, _lstat=os.lstat,
595
_mapper=osutils.file_kind_from_stat_mode):
596
"""See Tree.path_content_summary."""
597
abspath = self.abspath(path)
599
stat_result = _lstat(abspath)
601
if getattr(e, 'errno', None) == errno.ENOENT:
603
return ('missing', None, None, None)
604
# propagate other errors
606
kind = _mapper(stat_result.st_mode)
608
return self._file_content_summary(path, stat_result)
609
elif kind == 'directory':
610
# perhaps it looks like a plain directory, but it's really a
612
if self._directory_is_tree_reference(path):
613
kind = 'tree-reference'
614
return kind, None, None, None
615
elif kind == 'symlink':
616
target = osutils.readlink(abspath)
617
return ('symlink', None, None, target)
619
return (kind, None, None, None)
621
def _file_content_summary(self, path, stat_result):
622
size = stat_result.st_size
623
executable = self._is_executable_from_path_and_stat(path, stat_result)
624
# try for a stat cache lookup
625
return ('file', size, executable, self._sha_from_stat(
628
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
629
"""Common ghost checking functionality from set_parent_*.
631
This checks that the left hand-parent exists if there are any
634
if len(revision_ids) > 0:
635
leftmost_id = revision_ids[0]
636
if (not allow_leftmost_as_ghost and not
637
self.branch.repository.has_revision(leftmost_id)):
638
raise errors.GhostRevisionUnusableHere(leftmost_id)
640
def _set_merges_from_parent_ids(self, parent_ids):
641
merges = parent_ids[1:]
642
self._transport.put_bytes('pending-merges', '\n'.join(merges),
643
mode=self.controldir._get_file_mode())
645
def _filter_parent_ids_by_ancestry(self, revision_ids):
646
"""Check that all merged revisions are proper 'heads'.
648
This will always return the first revision_id, and any merged revisions
651
if len(revision_ids) == 0:
653
graph = self.branch.repository.get_graph()
654
heads = graph.heads(revision_ids)
655
new_revision_ids = revision_ids[:1]
656
for revision_id in revision_ids[1:]:
657
if revision_id in heads and revision_id not in new_revision_ids:
658
new_revision_ids.append(revision_id)
659
if new_revision_ids != revision_ids:
660
mutter('requested to set revision_ids = %s,'
661
' but filtered to %s', revision_ids, new_revision_ids)
662
return new_revision_ids
664
@needs_tree_write_lock
665
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
666
"""Set the parent ids to revision_ids.
668
See also set_parent_trees. This api will try to retrieve the tree data
669
for each element of revision_ids from the trees repository. If you have
670
tree data already available, it is more efficient to use
671
set_parent_trees rather than set_parent_ids. set_parent_ids is however
672
an easier API to use.
674
:param revision_ids: The revision_ids to set as the parent ids of this
675
working tree. Any of these may be ghosts.
677
self._check_parents_for_ghosts(revision_ids,
678
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
679
for revision_id in revision_ids:
680
_mod_revision.check_not_reserved_id(revision_id)
682
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
684
if len(revision_ids) > 0:
685
self.set_last_revision(revision_ids[0])
687
self.set_last_revision(_mod_revision.NULL_REVISION)
689
self._set_merges_from_parent_ids(revision_ids)
691
@needs_tree_write_lock
692
def set_pending_merges(self, rev_list):
693
parents = self.get_parent_ids()
694
leftmost = parents[:1]
695
new_parents = leftmost + rev_list
696
self.set_parent_ids(new_parents)
698
@needs_tree_write_lock
699
def set_merge_modified(self, modified_hashes):
700
"""Set the merge modified hashes."""
701
raise NotImplementedError(self.set_merge_modified)
703
def _sha_from_stat(self, path, stat_result):
704
"""Get a sha digest from the tree's stat cache.
706
The default implementation assumes no stat cache is present.
708
:param path: The path.
709
:param stat_result: The stat result being looked up.
713
@needs_write_lock # because merge pulls data into the branch.
714
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
715
merge_type=None, force=False):
716
"""Merge from a branch into this working tree.
718
:param branch: The branch to merge from.
719
:param to_revision: If non-None, the merge will merge to to_revision,
720
but not beyond it. to_revision does not need to be in the history
721
of the branch when it is supplied. If None, to_revision defaults to
722
branch.last_revision().
724
from .merge import Merger, Merge3Merger
725
merger = Merger(self.branch, this_tree=self)
726
# check that there are no local alterations
727
if not force and self.has_changes():
728
raise errors.UncommittedChanges(self)
729
if to_revision is None:
730
to_revision = _mod_revision.ensure_null(branch.last_revision())
731
merger.other_rev_id = to_revision
732
if _mod_revision.is_null(merger.other_rev_id):
733
raise errors.NoCommits(branch)
734
self.branch.fetch(branch, last_revision=merger.other_rev_id)
735
merger.other_basis = merger.other_rev_id
736
merger.other_tree = self.branch.repository.revision_tree(
738
merger.other_branch = branch
739
if from_revision is None:
742
merger.set_base_revision(from_revision, branch)
743
if merger.base_rev_id == merger.other_rev_id:
744
raise errors.PointlessMerge
745
merger.backup_files = False
746
if merge_type is None:
747
merger.merge_type = Merge3Merger
749
merger.merge_type = merge_type
750
merger.set_interesting_files(None)
751
merger.show_base = False
752
merger.reprocess = False
753
conflicts = merger.do_merge()
757
def merge_modified(self):
758
"""Return a dictionary of files modified by a merge.
760
The list is initialized by WorkingTree.set_merge_modified, which is
761
typically called after we make some automatic updates to the tree
764
This returns a map of file_id->sha1, containing only files which are
765
still in the working inventory and have that text hash.
767
raise NotImplementedError(self.merge_modified)
770
def mkdir(self, path, file_id=None):
771
"""See MutableTree.mkdir()."""
773
file_id = generate_ids.gen_file_id(os.path.basename(path))
774
os.mkdir(self.abspath(path))
775
self.add(path, file_id, 'directory')
778
def get_symlink_target(self, file_id, path=None):
780
abspath = self.abspath(path)
782
abspath = self.id2abspath(file_id)
783
target = osutils.readlink(abspath)
786
def subsume(self, other_tree):
787
raise NotImplementedError(self.subsume)
789
def _setup_directory_is_tree_reference(self):
790
if self._branch.repository._format.supports_tree_reference:
791
self._directory_is_tree_reference = \
792
self._directory_may_be_tree_reference
794
self._directory_is_tree_reference = \
795
self._directory_is_never_tree_reference
797
def _directory_is_never_tree_reference(self, relpath):
800
def _directory_may_be_tree_reference(self, relpath):
801
# as a special case, if a directory contains control files then
802
# it's a tree reference, except that the root of the tree is not
803
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
804
# TODO: We could ask all the control formats whether they
805
# recognize this directory, but at the moment there's no cheap api
806
# to do that. Since we probably can only nest bzr checkouts and
807
# they always use this name it's ok for now. -- mbp 20060306
809
# FIXME: There is an unhandled case here of a subdirectory
810
# containing .bzr but not a branch; that will probably blow up
811
# when you try to commit it. It might happen if there is a
812
# checkout in a subdirectory. This can be avoided by not adding
815
def extract(self, file_id, format=None):
816
"""Extract a subtree from this tree.
818
A new branch will be created, relative to the path for this tree.
820
raise NotImplementedError(self.extract)
823
"""Write the in memory meta data to disk."""
824
raise NotImplementedError(self.flush)
826
def _kind(self, relpath):
827
return osutils.file_kind(self.abspath(relpath))
829
def list_files(self, include_root=False, from_dir=None, recursive=True):
830
"""List all files as (path, class, kind, id, entry).
832
Lists, but does not descend into unversioned directories.
833
This does not include files that have been deleted in this
834
tree. Skips the control directory.
836
:param include_root: if True, return an entry for the root
837
:param from_dir: start from this directory or None for the root
838
:param recursive: whether to recurse into subdirectories or not
840
raise NotImplementedError(self.list_files)
842
def move(self, from_paths, to_dir=None, after=False):
845
to_dir must be known to the working tree.
847
If to_dir exists and is a directory, the files are moved into
848
it, keeping their old names.
850
Note that to_dir is only the last component of the new name;
851
this doesn't change the directory.
853
For each entry in from_paths the move mode will be determined
856
The first mode moves the file in the filesystem and updates the
857
working tree metadata. The second mode only updates the working tree
858
metadata without touching the file on the filesystem.
860
move uses the second mode if 'after == True' and the target is not
861
versioned but present in the working tree.
863
move uses the second mode if 'after == False' and the source is
864
versioned but no longer in the working tree, and the target is not
865
versioned but present in the working tree.
867
move uses the first mode if 'after == False' and the source is
868
versioned and present in the working tree, and the target is not
869
versioned and not present in the working tree.
871
Everything else results in an error.
873
This returns a list of (from_path, to_path) pairs for each
876
raise NotImplementedError(self.move)
878
@needs_tree_write_lock
879
def rename_one(self, from_rel, to_rel, after=False):
882
This can change the directory or the filename or both.
884
rename_one has several 'modes' to work. First, it can rename a physical
885
file and change the file_id. That is the normal mode. Second, it can
886
only change the file_id without touching any physical file.
888
rename_one uses the second mode if 'after == True' and 'to_rel' is
889
either not versioned or newly added, and present in the working tree.
891
rename_one uses the second mode if 'after == False' and 'from_rel' is
892
versioned but no longer in the working tree, and 'to_rel' is not
893
versioned but present in the working tree.
895
rename_one uses the first mode if 'after == False' and 'from_rel' is
896
versioned and present in the working tree, and 'to_rel' is not
897
versioned and not present in the working tree.
899
Everything else results in an error.
901
raise NotImplementedError(self.rename_one)
905
"""Return all unknown files.
907
These are files in the working directory that are not versioned or
908
control files or ignored.
910
# force the extras method to be fully executed before returning, to
911
# prevent race conditions with the lock
913
[subp for subp in self.extras() if not self.is_ignored(subp)])
915
def unversion(self, file_ids):
916
"""Remove the file ids in file_ids from the current versioned set.
918
When a file_id is unversioned, all of its children are automatically
921
:param file_ids: The file ids to stop versioning.
922
:raises: NoSuchId if any fileid is not currently versioned.
924
raise NotImplementedError(self.unversion)
927
def pull(self, source, overwrite=False, stop_revision=None,
928
change_reporter=None, possible_transports=None, local=False,
932
old_revision_info = self.branch.last_revision_info()
933
basis_tree = self.basis_tree()
934
count = self.branch.pull(source, overwrite, stop_revision,
935
possible_transports=possible_transports,
937
new_revision_info = self.branch.last_revision_info()
938
if new_revision_info != old_revision_info:
939
repository = self.branch.repository
940
if repository._format.fast_deltas:
941
parent_ids = self.get_parent_ids()
943
basis_id = parent_ids[0]
944
basis_tree = repository.revision_tree(basis_id)
945
basis_tree.lock_read()
947
new_basis_tree = self.branch.basis_tree()
953
change_reporter=change_reporter,
955
basis_root_id = basis_tree.get_root_id()
956
new_root_id = new_basis_tree.get_root_id()
957
if new_root_id is not None and basis_root_id != new_root_id:
958
self.set_root_id(new_root_id)
961
# TODO - dedup parents list with things merged by pull ?
962
# reuse the revisiontree we merged against to set the new
965
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
967
(self.branch.last_revision(), new_basis_tree))
968
# we have to pull the merge trees out again, because
969
# merge_inner has set the ids. - this corner is not yet
970
# layered well enough to prevent double handling.
971
# XXX TODO: Fix the double handling: telling the tree about
972
# the already known parent data is wasteful.
973
merges = self.get_parent_ids()[1:]
974
parent_trees.extend([
975
(parent, repository.revision_tree(parent)) for
977
self.set_parent_trees(parent_trees)
983
def put_file_bytes_non_atomic(self, file_id, bytes):
984
"""See MutableTree.put_file_bytes_non_atomic."""
985
stream = file(self.id2abspath(file_id), 'wb')
992
"""Yield all unversioned files in this WorkingTree.
994
If there are any unversioned directories then only the directory is
995
returned, not all its children. But if there are unversioned files
996
under a versioned subdirectory, they are returned.
998
Currently returned depth-first, sorted by name within directories.
999
This is the same order used by 'osutils.walkdirs'.
1001
raise NotImplementedError(self.extras)
1003
def ignored_files(self):
1004
"""Yield list of PATH, IGNORE_PATTERN"""
1005
for subp in self.extras():
1006
pat = self.is_ignored(subp)
1010
def is_ignored(self, filename):
1011
r"""Check whether the filename matches an ignore pattern.
1013
raise NotImplementedError(self.is_ignored)
1015
def kind(self, file_id):
1016
return osutils.file_kind(self.id2abspath(file_id))
1018
def stored_kind(self, file_id):
1019
"""See Tree.stored_kind"""
1020
raise NotImplementedError(self.stored_kind)
1022
def _comparison_data(self, entry, path):
1023
abspath = self.abspath(path)
1025
stat_value = os.lstat(abspath)
1026
except OSError as e:
1027
if getattr(e, 'errno', None) == errno.ENOENT:
1034
mode = stat_value.st_mode
1035
kind = osutils.file_kind_from_stat_mode(mode)
1036
if not self._supports_executable():
1037
executable = entry is not None and entry.executable
1039
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1040
return kind, executable, stat_value
1042
def _file_size(self, entry, stat_value):
1043
return stat_value.st_size
1045
def last_revision(self):
1046
"""Return the last revision of the branch for this tree.
1048
This format tree does not support a separate marker for last-revision
1049
compared to the branch.
1051
See MutableTree.last_revision
1053
return self._last_revision()
1056
def _last_revision(self):
1057
"""helper for get_parent_ids."""
1058
return _mod_revision.ensure_null(self.branch.last_revision())
1060
def is_locked(self):
1061
"""Check if this tree is locked."""
1062
raise NotImplementedError(self.is_locked)
1064
def lock_read(self):
1065
"""Lock the tree for reading.
1067
This also locks the branch, and can be unlocked via self.unlock().
1069
:return: A breezy.lock.LogicalLockResult.
1071
raise NotImplementedError(self.lock_read)
1073
def lock_tree_write(self):
1074
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1076
:return: A breezy.lock.LogicalLockResult.
1078
raise NotImplementedError(self.lock_tree_write)
1080
def lock_write(self):
1081
"""See MutableTree.lock_write, and WorkingTree.unlock.
1083
:return: A breezy.lock.LogicalLockResult.
1085
raise NotImplementedError(self.lock_write)
1087
def get_physical_lock_status(self):
1088
raise NotImplementedError(self.get_physical_lock_status)
1090
def set_last_revision(self, new_revision):
1091
"""Change the last revision in the working tree."""
1092
raise NotImplementedError(self.set_last_revision)
1094
def _change_last_revision(self, new_revision):
1095
"""Template method part of set_last_revision to perform the change.
1097
This is used to allow WorkingTree3 instances to not affect branch
1098
when their last revision is set.
1100
if _mod_revision.is_null(new_revision):
1101
self.branch.set_last_revision_info(0, new_revision)
1103
_mod_revision.check_not_reserved_id(new_revision)
1105
self.branch.generate_revision_history(new_revision)
1106
except errors.NoSuchRevision:
1107
# not present in the repo - dont try to set it deeper than the tip
1108
self.branch._set_revision_history([new_revision])
1111
@needs_tree_write_lock
1112
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1114
"""Remove nominated files from the working tree metadata.
1116
:files: File paths relative to the basedir.
1117
:keep_files: If true, the files will also be kept.
1118
:force: Delete files and directories, even if they are changed and
1119
even if the directories are not empty.
1121
if isinstance(files, (str, text_type)):
1126
all_files = set() # specified and nested files
1127
unknown_nested_files=set()
1129
to_file = sys.stdout
1131
files_to_backup = []
1133
def recurse_directory_to_add_files(directory):
1134
# Recurse directory and add all files
1135
# so we can check if they have changed.
1136
for parent_info, file_infos in self.walkdirs(directory):
1137
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1138
# Is it versioned or ignored?
1139
if self.path2id(relpath):
1140
# Add nested content for deletion.
1141
all_files.add(relpath)
1143
# Files which are not versioned
1144
# should be treated as unknown.
1145
files_to_backup.append(relpath)
1147
for filename in files:
1148
# Get file name into canonical form.
1149
abspath = self.abspath(filename)
1150
filename = self.relpath(abspath)
1151
if len(filename) > 0:
1152
all_files.add(filename)
1153
recurse_directory_to_add_files(filename)
1155
files = list(all_files)
1158
return # nothing to do
1160
# Sort needed to first handle directory content before the directory
1161
files.sort(reverse=True)
1163
# Bail out if we are going to delete files we shouldn't
1164
if not keep_files and not force:
1165
for (file_id, path, content_change, versioned, parent_id, name,
1166
kind, executable) in self.iter_changes(self.basis_tree(),
1167
include_unchanged=True, require_versioned=False,
1168
want_unversioned=True, specific_files=files):
1169
if versioned[0] == False:
1170
# The record is unknown or newly added
1171
files_to_backup.append(path[1])
1172
elif (content_change and (kind[1] is not None) and
1173
osutils.is_inside_any(files, path[1])):
1174
# Versioned and changed, but not deleted, and still
1175
# in one of the dirs to be deleted.
1176
files_to_backup.append(path[1])
1178
def backup(file_to_backup):
1179
backup_name = self.controldir._available_backup_name(file_to_backup)
1180
osutils.rename(abs_path, self.abspath(backup_name))
1181
return "removed %s (but kept a copy: %s)" % (file_to_backup,
1184
# Build inv_delta and delete files where applicable,
1185
# do this before any modifications to meta data.
1187
fid = self.path2id(f)
1190
message = "%s is not versioned." % (f,)
1193
# having removed it, it must be either ignored or unknown
1194
if self.is_ignored(f):
1198
# XXX: Really should be a more abstract reporter interface
1199
kind_ch = osutils.kind_marker(self.kind(fid))
1200
to_file.write(new_status + ' ' + f + kind_ch + '\n')
1202
inv_delta.append((f, None, fid, None))
1203
message = "removed %s" % (f,)
1206
abs_path = self.abspath(f)
1207
if osutils.lexists(abs_path):
1208
if (osutils.isdir(abs_path) and
1209
len(os.listdir(abs_path)) > 0):
1211
osutils.rmtree(abs_path)
1212
message = "deleted %s" % (f,)
1216
if f in files_to_backup:
1219
osutils.delete_any(abs_path)
1220
message = "deleted %s" % (f,)
1221
elif message is not None:
1222
# Only care if we haven't done anything yet.
1223
message = "%s does not exist." % (f,)
1225
# Print only one message (if any) per file.
1226
if message is not None:
1228
self.apply_inventory_delta(inv_delta)
1230
@needs_tree_write_lock
1231
def revert(self, filenames=None, old_tree=None, backups=True,
1232
pb=None, report_changes=False):
1233
from .conflicts import resolve
1234
if old_tree is None:
1235
basis_tree = self.basis_tree()
1236
basis_tree.lock_read()
1237
old_tree = basis_tree
1241
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1243
if filenames is None and len(self.get_parent_ids()) > 1:
1245
last_revision = self.last_revision()
1246
if last_revision != _mod_revision.NULL_REVISION:
1247
if basis_tree is None:
1248
basis_tree = self.basis_tree()
1249
basis_tree.lock_read()
1250
parent_trees.append((last_revision, basis_tree))
1251
self.set_parent_trees(parent_trees)
1254
resolve(self, filenames, ignore_misses=True, recursive=True)
1256
if basis_tree is not None:
1261
def store_uncommitted(self):
1262
"""Store uncommitted changes from the tree in the branch."""
1263
target_tree = self.basis_tree()
1264
shelf_creator = shelf.ShelfCreator(self, target_tree)
1266
if not shelf_creator.shelve_all():
1268
self.branch.store_uncommitted(shelf_creator)
1269
shelf_creator.transform()
1271
shelf_creator.finalize()
1272
note('Uncommitted changes stored in branch "%s".', self.branch.nick)
1275
def restore_uncommitted(self):
1276
"""Restore uncommitted changes from the branch into the tree."""
1277
unshelver = self.branch.get_unshelver(self)
1278
if unshelver is None:
1281
merger = unshelver.make_merger()
1282
merger.ignore_zero = True
1284
self.branch.store_uncommitted(None)
1286
unshelver.finalize()
1288
def revision_tree(self, revision_id):
1289
"""See Tree.revision_tree.
1291
WorkingTree can supply revision_trees for the basis revision only
1292
because there is only one cached inventory in the bzr directory.
1294
raise NotImplementedError(self.revision_tree)
1296
@needs_tree_write_lock
1297
def set_root_id(self, file_id):
1298
"""Set the root id for this tree."""
1302
'WorkingTree.set_root_id with fileid=None')
1303
file_id = osutils.safe_file_id(file_id)
1304
self._set_root_id(file_id)
1306
def _set_root_id(self, file_id):
1307
"""Set the root id for this tree, in a format specific manner.
1309
:param file_id: The file id to assign to the root. It must not be
1310
present in the current inventory or an error will occur. It must
1311
not be None, but rather a valid file id.
1313
raise NotImplementedError(self._set_root_id)
1316
"""See Branch.unlock.
1318
WorkingTree locking just uses the Branch locking facilities.
1319
This is current because all working trees have an embedded branch
1320
within them. IF in the future, we were to make branch data shareable
1321
between multiple working trees, i.e. via shared storage, then we
1322
would probably want to lock both the local tree, and the branch.
1324
raise NotImplementedError(self.unlock)
1328
def update(self, change_reporter=None, possible_transports=None,
1329
revision=None, old_tip=_marker, show_base=False):
1330
"""Update a working tree along its branch.
1332
This will update the branch if its bound too, which means we have
1333
multiple trees involved:
1335
- The new basis tree of the master.
1336
- The old basis tree of the branch.
1337
- The old basis tree of the working tree.
1338
- The current working tree state.
1340
Pathologically, all three may be different, and non-ancestors of each
1341
other. Conceptually we want to:
1343
- Preserve the wt.basis->wt.state changes
1344
- Transform the wt.basis to the new master basis.
1345
- Apply a merge of the old branch basis to get any 'local' changes from
1347
- Restore the wt.basis->wt.state changes.
1349
There isn't a single operation at the moment to do that, so we:
1351
- Merge current state -> basis tree of the master w.r.t. the old tree
1353
- Do a 'normal' merge of the old branch basis if it is relevant.
1355
:param revision: The target revision to update to. Must be in the
1357
:param old_tip: If branch.update() has already been run, the value it
1358
returned (old tip of the branch or None). _marker is used
1361
if self.branch.get_bound_location() is not None:
1363
update_branch = (old_tip is self._marker)
1365
self.lock_tree_write()
1366
update_branch = False
1369
old_tip = self.branch.update(possible_transports)
1371
if old_tip is self._marker:
1373
return self._update_tree(old_tip, change_reporter, revision, show_base)
1377
@needs_tree_write_lock
1378
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1380
"""Update a tree to the master branch.
1382
:param old_tip: if supplied, the previous tip revision the branch,
1383
before it was changed to the master branch's tip.
1385
# here if old_tip is not None, it is the old tip of the branch before
1386
# it was updated from the master branch. This should become a pending
1387
# merge in the working tree to preserve the user existing work. we
1388
# cant set that until we update the working trees last revision to be
1389
# one from the new branch, because it will just get absorbed by the
1390
# parent de-duplication logic.
1392
# We MUST save it even if an error occurs, because otherwise the users
1393
# local work is unreferenced and will appear to have been lost.
1397
last_rev = self.get_parent_ids()[0]
1399
last_rev = _mod_revision.NULL_REVISION
1400
if revision is None:
1401
revision = self.branch.last_revision()
1403
old_tip = old_tip or _mod_revision.NULL_REVISION
1405
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1406
# the branch we are bound to was updated
1407
# merge those changes in first
1408
base_tree = self.basis_tree()
1409
other_tree = self.branch.repository.revision_tree(old_tip)
1410
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1411
base_tree, this_tree=self,
1412
change_reporter=change_reporter,
1413
show_base=show_base)
1415
self.add_parent_tree((old_tip, other_tree))
1416
note(gettext('Rerun update after fixing the conflicts.'))
1419
if last_rev != _mod_revision.ensure_null(revision):
1420
# the working tree is up to date with the branch
1421
# we can merge the specified revision from master
1422
to_tree = self.branch.repository.revision_tree(revision)
1423
to_root_id = to_tree.get_root_id()
1425
basis = self.basis_tree()
1428
if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
1429
self.set_root_id(to_root_id)
1434
# determine the branch point
1435
graph = self.branch.repository.get_graph()
1436
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1438
base_tree = self.branch.repository.revision_tree(base_rev_id)
1440
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1442
change_reporter=change_reporter,
1443
show_base=show_base)
1444
self.set_last_revision(revision)
1445
# TODO - dedup parents list with things merged by pull ?
1446
# reuse the tree we've updated to to set the basis:
1447
parent_trees = [(revision, to_tree)]
1448
merges = self.get_parent_ids()[1:]
1449
# Ideally we ask the tree for the trees here, that way the working
1450
# tree can decide whether to give us the entire tree or give us a
1451
# lazy initialised tree. dirstate for instance will have the trees
1452
# in ram already, whereas a last-revision + basis-inventory tree
1453
# will not, but also does not need them when setting parents.
1454
for parent in merges:
1455
parent_trees.append(
1456
(parent, self.branch.repository.revision_tree(parent)))
1457
if not _mod_revision.is_null(old_tip):
1458
parent_trees.append(
1459
(old_tip, self.branch.repository.revision_tree(old_tip)))
1460
self.set_parent_trees(parent_trees)
1461
last_rev = parent_trees[0][0]
1464
def set_conflicts(self, arg):
1465
raise errors.UnsupportedOperation(self.set_conflicts, self)
1467
def add_conflicts(self, arg):
1468
raise errors.UnsupportedOperation(self.add_conflicts, self)
1470
def conflicts(self):
1471
raise NotImplementedError(self.conflicts)
1473
def walkdirs(self, prefix=""):
1474
"""Walk the directories of this tree.
1476
returns a generator which yields items in the form:
1477
((curren_directory_path, fileid),
1478
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1481
This API returns a generator, which is only valid during the current
1482
tree transaction - within a single lock_read or lock_write duration.
1484
If the tree is not locked, it may cause an error to be raised,
1485
depending on the tree implementation.
1487
disk_top = self.abspath(prefix)
1488
if disk_top.endswith('/'):
1489
disk_top = disk_top[:-1]
1490
top_strip_len = len(disk_top) + 1
1491
inventory_iterator = self._walkdirs(prefix)
1492
disk_iterator = osutils.walkdirs(disk_top, prefix)
1494
current_disk = next(disk_iterator)
1495
disk_finished = False
1496
except OSError as e:
1497
if not (e.errno == errno.ENOENT or
1498
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
1501
disk_finished = True
1503
current_inv = next(inventory_iterator)
1504
inv_finished = False
1505
except StopIteration:
1508
while not inv_finished or not disk_finished:
1510
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1511
cur_disk_dir_content) = current_disk
1513
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1514
cur_disk_dir_content) = ((None, None), None)
1515
if not disk_finished:
1516
# strip out .bzr dirs
1517
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
1518
len(cur_disk_dir_content) > 0):
1519
# osutils.walkdirs can be made nicer -
1520
# yield the path-from-prefix rather than the pathjoined
1522
bzrdir_loc = bisect_left(cur_disk_dir_content,
1524
if (bzrdir_loc < len(cur_disk_dir_content)
1525
and self.controldir.is_control_filename(
1526
cur_disk_dir_content[bzrdir_loc][0])):
1527
# we dont yield the contents of, or, .bzr itself.
1528
del cur_disk_dir_content[bzrdir_loc]
1530
# everything is unknown
1533
# everything is missing
1536
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
1538
# disk is before inventory - unknown
1539
dirblock = [(relpath, basename, kind, stat, None, None) for
1540
relpath, basename, kind, stat, top_path in
1541
cur_disk_dir_content]
1542
yield (cur_disk_dir_relpath, None), dirblock
1544
current_disk = next(disk_iterator)
1545
except StopIteration:
1546
disk_finished = True
1548
# inventory is before disk - missing.
1549
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
1550
for relpath, basename, dkind, stat, fileid, kind in
1552
yield (current_inv[0][0], current_inv[0][1]), dirblock
1554
current_inv = next(inventory_iterator)
1555
except StopIteration:
1558
# versioned present directory
1559
# merge the inventory and disk data together
1561
for relpath, subiterator in itertools.groupby(sorted(
1562
current_inv[1] + cur_disk_dir_content,
1563
key=operator.itemgetter(0)), operator.itemgetter(1)):
1564
path_elements = list(subiterator)
1565
if len(path_elements) == 2:
1566
inv_row, disk_row = path_elements
1567
# versioned, present file
1568
dirblock.append((inv_row[0],
1569
inv_row[1], disk_row[2],
1570
disk_row[3], inv_row[4],
1572
elif len(path_elements[0]) == 5:
1574
dirblock.append((path_elements[0][0],
1575
path_elements[0][1], path_elements[0][2],
1576
path_elements[0][3], None, None))
1577
elif len(path_elements[0]) == 6:
1578
# versioned, absent file.
1579
dirblock.append((path_elements[0][0],
1580
path_elements[0][1], 'unknown', None,
1581
path_elements[0][4], path_elements[0][5]))
1583
raise NotImplementedError('unreachable code')
1584
yield current_inv[0], dirblock
1586
current_inv = next(inventory_iterator)
1587
except StopIteration:
1590
current_disk = next(disk_iterator)
1591
except StopIteration:
1592
disk_finished = True
1594
def _walkdirs(self, prefix=""):
1595
"""Walk the directories of this tree.
1597
:param prefix: is used as the directrory to start with.
1598
:returns: a generator which yields items in the form::
1600
((curren_directory_path, fileid),
1601
[(file1_path, file1_name, file1_kind, None, file1_id,
1604
raise NotImplementedError(self._walkdirs)
1606
@needs_tree_write_lock
1607
def auto_resolve(self):
1608
"""Automatically resolve text conflicts according to contents.
1610
Only text conflicts are auto_resolvable. Files with no conflict markers
1611
are considered 'resolved', because bzr always puts conflict markers
1612
into files that have text conflicts. The corresponding .THIS .BASE and
1613
.OTHER files are deleted, as per 'resolve'.
1615
:return: a tuple of ConflictLists: (un_resolved, resolved).
1617
un_resolved = _mod_conflicts.ConflictList()
1618
resolved = _mod_conflicts.ConflictList()
1619
conflict_re = re.compile('^(<{7}|={7}|>{7})')
1620
for conflict in self.conflicts():
1621
if (conflict.typestring != 'text conflict' or
1622
self.kind(conflict.file_id) != 'file'):
1623
un_resolved.append(conflict)
1625
my_file = open(self.id2abspath(conflict.file_id), 'rb')
1627
for line in my_file:
1628
if conflict_re.search(line):
1629
un_resolved.append(conflict)
1632
resolved.append(conflict)
1635
resolved.remove_files(self)
1636
self.set_conflicts(un_resolved)
1637
return un_resolved, resolved
1639
def _validate(self):
1640
"""Validate internal structures.
1642
This is meant mostly for the test suite. To give it a chance to detect
1643
corruption after actions have occurred. The default implementation is a
1646
:return: None. An exception should be raised if there is an error.
1650
def check_state(self):
1651
"""Check that the working state is/isn't valid."""
1652
raise NotImplementedError(self.check_state)
1654
def reset_state(self, revision_ids=None):
1655
"""Reset the state of the working tree.
1657
This does a hard-reset to a last-known-good state. This is a way to
1658
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1660
raise NotImplementedError(self.reset_state)
1662
def _get_rules_searcher(self, default_searcher):
1663
"""See Tree._get_rules_searcher."""
1664
if self._rules_searcher is None:
1665
self._rules_searcher = super(WorkingTree,
1666
self)._get_rules_searcher(default_searcher)
1667
return self._rules_searcher
1669
def get_shelf_manager(self):
1670
"""Return the ShelfManager for this WorkingTree."""
1671
from .shelf import ShelfManager
1672
return ShelfManager(self, self._transport)
1675
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
1676
"""Registry for working tree formats."""
1678
def __init__(self, other_registry=None):
1679
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
1680
self._default_format = None
1681
self._default_format_key = None
1683
def get_default(self):
1684
"""Return the current default format."""
1685
if (self._default_format_key is not None and
1686
self._default_format is None):
1687
self._default_format = self.get(self._default_format_key)
1688
return self._default_format
1690
def set_default(self, format):
1691
"""Set the default format."""
1692
self._default_format = format
1693
self._default_format_key = None
1695
def set_default_key(self, format_string):
1696
"""Set the default format by its format string."""
1697
self._default_format_key = format_string
1698
self._default_format = None
1701
format_registry = WorkingTreeFormatRegistry()
1704
class WorkingTreeFormat(controldir.ControlComponentFormat):
1705
"""An encapsulation of the initialization and open routines for a format.
1707
Formats provide three things:
1708
* An initialization routine,
1712
Formats are placed in an dict by their format string for reference
1713
during workingtree opening. Its not required that these be instances, they
1714
can be classes themselves with class methods - it simply depends on
1715
whether state is needed for a given format or not.
1717
Once a format is deprecated, just deprecate the initialize and open
1718
methods on the format class. Do not deprecate the object, as the
1719
object will be created every time regardless.
1722
requires_rich_root = False
1724
upgrade_recommended = False
1726
requires_normalized_unicode_filenames = False
1728
case_sensitive_filename = "FoRMaT"
1730
missing_parent_conflicts = False
1731
"""If this format supports missing parent conflicts."""
1733
supports_versioned_directories = None
1735
def initialize(self, controldir, revision_id=None, from_branch=None,
1736
accelerator_tree=None, hardlink=False):
1737
"""Initialize a new working tree in controldir.
1739
:param controldir: ControlDir to initialize the working tree in.
1740
:param revision_id: allows creating a working tree at a different
1741
revision than the branch is at.
1742
:param from_branch: Branch to checkout
1743
:param accelerator_tree: A tree which can be used for retrieving file
1744
contents more quickly than the revision tree, i.e. a workingtree.
1745
The revision tree will be used for cases where accelerator_tree's
1746
content is different.
1747
:param hardlink: If true, hard-link files from accelerator_tree,
1750
raise NotImplementedError(self.initialize)
1752
def __eq__(self, other):
1753
return self.__class__ is other.__class__
1755
def __ne__(self, other):
1756
return not (self == other)
1758
def get_format_description(self):
1759
"""Return the short description for this format."""
1760
raise NotImplementedError(self.get_format_description)
1762
def is_supported(self):
1763
"""Is this format supported?
1765
Supported formats can be initialized and opened.
1766
Unsupported formats may not support initialization or committing or
1767
some other features depending on the reason for not being supported.
1771
def supports_content_filtering(self):
1772
"""True if this format supports content filtering."""
1775
def supports_views(self):
1776
"""True if this format supports stored views."""
1779
def get_controldir_for_branch(self):
1780
"""Get the control directory format for creating branches.
1782
This is to support testing of working tree formats that can not exist
1783
in the same control directory as a branch.
1785
return self._matchingbzrdir
1788
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
1789
"breezy.bzr.workingtree_4", "WorkingTreeFormat4")
1790
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
1791
"breezy.bzr.workingtree_4", "WorkingTreeFormat5")
1792
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
1793
"breezy.bzr.workingtree_4", "WorkingTreeFormat6")
1794
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
1795
"breezy.bzr.workingtree_3", "WorkingTreeFormat3")
1796
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
breezy/workingtree.py
