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
40
from .lazy_import import lazy_import
41
lazy_import(globals(), """
46
conflicts as _mod_conflicts,
49
filters as _mod_filters,
52
revision as _mod_revision,
63
from .i18n import gettext
64
from . import mutabletree
68
from .trace import mutter, note
71
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
74
class SettingFileIdUnsupported(errors.BzrError):
76
_fmt = "This format does not support setting file ids."
79
class ShelvingUnsupported(errors.BzrError):
81
_fmt = "This format does not support shelving changes."
84
class WorkingTree(mutabletree.MutableTree,
85
controldir.ControlComponent):
88
:ivar basedir: The root of the tree on disk. This is a unicode path object
89
(as opposed to a URL).
92
# override this to set the strategy for storing views
93
def _make_views(self):
94
return views.DisabledViews(self)
96
def __init__(self, basedir='.',
102
"""Construct a WorkingTree instance. This is not a public API.
104
:param branch: A branch to override probing for the branch.
106
self._format = _format
107
self.controldir = _controldir
109
raise errors.BzrError("Please use controldir.open_workingtree or "
110
"WorkingTree.open() to obtain a WorkingTree.")
111
basedir = osutils.safe_unicode(basedir)
112
mutter("opening working tree %r", basedir)
113
if branch is not None:
114
self._branch = branch
116
self._branch = self.controldir.open_branch()
117
self.basedir = osutils.realpath(basedir)
118
self._transport = _transport
119
self._rules_searcher = None
120
self.views = self._make_views()
123
def user_transport(self):
124
return self.controldir.user_transport
127
def control_transport(self):
128
return self._transport
130
def is_control_filename(self, filename):
131
"""True if filename is the name of a control file in this tree.
133
:param filename: A filename within the tree. This is a relative path
134
from the root of this tree.
136
This is true IF and ONLY IF the filename is part of the meta data
137
that bzr controls in this tree. I.E. a random .bzr directory placed
138
on disk will not be a control file for this tree.
140
return self.controldir.is_control_filename(filename)
143
fget=lambda self: self._branch,
144
doc="""The branch this WorkingTree is connected to.
146
This cannot be set - it is reflective of the actual disk structure
147
the working tree has been constructed from.
150
def has_versioned_directories(self):
151
"""See `Tree.has_versioned_directories`."""
152
return self._format.supports_versioned_directories
154
def supports_merge_modified(self):
155
"""Indicate whether this workingtree supports storing merge_modified.
157
return self._format.supports_merge_modified
159
def _supports_executable(self):
160
if sys.platform == 'win32':
162
# FIXME: Ideally this should check the file system
165
def break_lock(self):
166
"""Break a lock if one is present from another instance.
168
Uses the ui factory to ask for confirmation if the lock may be from
171
This will probe the repository for its lock as well.
173
raise NotImplementedError(self.break_lock)
175
def requires_rich_root(self):
176
return self._format.requires_rich_root
178
def supports_tree_reference(self):
181
def supports_content_filtering(self):
182
return self._format.supports_content_filtering()
184
def supports_views(self):
185
return self.views.supports_views()
187
def supports_setting_file_ids(self):
188
return self._format.supports_setting_file_ids
190
def get_config_stack(self):
191
"""Retrieve the config stack for this tree.
193
:return: A ``breezy.config.Stack``
195
# For the moment, just provide the branch config stack.
196
return self.branch.get_config_stack()
199
def open(path=None, _unsupported=False):
200
"""Open an existing working tree at path.
204
path = osutils.getcwd()
205
control = controldir.ControlDir.open(path, _unsupported=_unsupported)
206
return control.open_workingtree(unsupported=_unsupported)
209
def open_containing(path=None):
210
"""Open an existing working tree which has its root about path.
212
This probes for a working tree at path and searches upwards from there.
214
Basically we keep looking up until we find the control directory or
215
run into /. If there isn't one, raises NotBranchError.
216
TODO: give this a new exception.
217
If there is one, it is returned, along with the unused portion of path.
219
:return: The WorkingTree that contains 'path', and the rest of path
222
path = osutils.getcwd()
223
control, relpath = controldir.ControlDir.open_containing(path)
224
return control.open_workingtree(), relpath
227
def open_containing_paths(file_list, default_directory=None,
228
canonicalize=True, apply_view=True):
229
"""Open the WorkingTree that contains a set of paths.
231
Fail if the paths given are not all in a single tree.
233
This is used for the many command-line interfaces that take a list of
234
any number of files and that require they all be in the same tree.
236
if default_directory is None:
237
default_directory = u'.'
238
# recommended replacement for builtins.internal_tree_files
239
if file_list is None or len(file_list) == 0:
240
tree = WorkingTree.open_containing(default_directory)[0]
241
# XXX: doesn't really belong here, and seems to have the strange
242
# side effect of making it return a bunch of files, not the whole
243
# tree -- mbp 20100716
244
if tree.supports_views() and apply_view:
245
view_files = tree.views.lookup_view()
247
file_list = view_files
248
view_str = views.view_display_str(view_files)
249
note(gettext("Ignoring files outside view. View is %s") % view_str)
250
return tree, file_list
251
if default_directory == u'.':
254
seed = default_directory
255
file_list = [osutils.pathjoin(default_directory, f)
257
tree = WorkingTree.open_containing(seed)[0]
258
return tree, tree.safe_relpath_files(file_list, canonicalize,
259
apply_view=apply_view)
261
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
262
"""Convert file_list into a list of relpaths in tree.
264
:param self: A tree to operate on.
265
:param file_list: A list of user provided paths or None.
266
:param apply_view: if True and a view is set, apply it or check that
267
specified files are within it
268
:return: A list of relative paths.
269
:raises errors.PathNotChild: When a provided path is in a different self
272
if file_list is None:
274
if self.supports_views() and apply_view:
275
view_files = self.views.lookup_view()
279
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
280
# doesn't - fix that up here before we enter the loop.
282
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
285
for filename in file_list:
286
relpath = fixer(osutils.dereference_path(filename))
287
if view_files and not osutils.is_inside_any(view_files, relpath):
288
raise views.FileOutsideView(filename, view_files)
289
new_list.append(relpath)
293
def open_downlevel(path=None):
294
"""Open an unsupported working tree.
296
Only intended for advanced situations like upgrading part of a controldir.
298
return WorkingTree.open(path, _unsupported=True)
301
def find_trees(location):
302
def list_current(transport):
303
return [d for d in transport.list_dir('')
304
if not controldir.is_control_filename(d)]
305
def evaluate(controldir):
307
tree = controldir.open_workingtree()
308
except errors.NoWorkingTree:
312
t = transport.get_transport(location)
313
iterator = controldir.ControlDir.find_controldirs(t, evaluate=evaluate,
314
list_current=list_current)
315
return [tr for tr in iterator if tr is not None]
318
return "<%s of %s>" % (self.__class__.__name__,
319
getattr(self, 'basedir', None))
321
def abspath(self, filename):
322
return osutils.pathjoin(self.basedir, filename)
324
def basis_tree(self):
325
"""Return RevisionTree for the current last revision.
327
If the left most parent is a ghost then the returned tree will be an
328
empty tree - one obtained by calling
329
repository.revision_tree(NULL_REVISION).
332
revision_id = self.get_parent_ids()[0]
334
# no parents, return an empty revision tree.
335
# in the future this should return the tree for
336
# 'empty:' - the implicit root empty tree.
337
return self.branch.repository.revision_tree(
338
_mod_revision.NULL_REVISION)
340
return self.revision_tree(revision_id)
341
except errors.NoSuchRevision:
343
# No cached copy available, retrieve from the repository.
344
# FIXME? RBC 20060403 should we cache the tree locally
347
return self.branch.repository.revision_tree(revision_id)
348
except (errors.RevisionNotPresent, errors.NoSuchRevision):
349
# the basis tree *may* be a ghost or a low level error may have
350
# occurred. If the revision is present, its a problem, if its not
352
if self.branch.repository.has_revision(revision_id):
354
# the basis tree is a ghost so return an empty tree.
355
return self.branch.repository.revision_tree(
356
_mod_revision.NULL_REVISION)
358
def relpath(self, path):
359
"""Return the local path portion from a given path.
361
The path may be absolute or relative. If its a relative path it is
362
interpreted relative to the python current working directory.
364
return osutils.relpath(self.basedir, path)
366
def has_filename(self, filename):
367
return osutils.lexists(self.abspath(filename))
369
def get_file(self, path, file_id=None, filtered=True):
370
return self.get_file_with_stat(path, file_id, filtered=filtered)[0]
372
def get_file_with_stat(self, path, file_id=None, filtered=True,
373
_fstat=osutils.fstat):
374
"""See Tree.get_file_with_stat."""
375
abspath = self.abspath(path)
377
file_obj = open(abspath, 'rb')
378
except EnvironmentError as e:
379
if e.errno == errno.ENOENT:
380
raise errors.NoSuchFile(path)
382
stat_value = _fstat(file_obj.fileno())
383
if filtered and self.supports_content_filtering():
384
filters = self._content_filter_stack(path)
385
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
386
return (file_obj, stat_value)
388
def get_file_text(self, path, file_id=None, filtered=True):
389
with self.get_file(path, file_id, filtered=filtered) as my_file:
390
return my_file.read()
392
def get_file_lines(self, path, file_id=None, filtered=True):
393
"""See Tree.get_file_lines()"""
394
with self.get_file(path, file_id, filtered=filtered) as file:
395
return file.readlines()
397
def get_parent_ids(self):
398
"""See Tree.get_parent_ids.
400
This implementation reads the pending merges list and last_revision
401
value and uses that to decide what the parents list should be.
403
last_rev = _mod_revision.ensure_null(self._last_revision())
404
if _mod_revision.NULL_REVISION == last_rev:
409
merges_bytes = self._transport.get_bytes('pending-merges')
410
except errors.NoSuchFile:
413
for l in osutils.split_lines(merges_bytes):
414
revision_id = l.rstrip('\n')
415
parents.append(revision_id)
418
def get_root_id(self):
419
"""Return the id of this trees root"""
420
raise NotImplementedError(self.get_root_id)
422
def clone(self, to_controldir, revision_id=None):
423
"""Duplicate this working tree into to_bzr, including all state.
425
Specifically modified files are kept as modified, but
426
ignored and unknown files are discarded.
428
If you want to make a new line of development, see ControlDir.sprout()
431
If not None, the cloned tree will have its last revision set to
432
revision, and difference between the source trees last revision
433
and this one merged in.
435
with self.lock_read():
436
# assumes the target bzr dir format is compatible.
437
result = to_controldir.create_workingtree()
438
self.copy_content_into(result, revision_id)
441
def copy_content_into(self, tree, revision_id=None):
442
"""Copy the current content and user files of this tree into tree."""
443
with self.lock_read():
444
tree.set_root_id(self.get_root_id())
445
if revision_id is None:
446
merge.transform_tree(tree, self)
448
# TODO now merge from tree.last_revision to revision (to
449
# preserve user local changes)
451
other_tree = self.revision_tree(revision_id)
452
except errors.NoSuchRevision:
453
other_tree = self.branch.repository.revision_tree(
456
merge.transform_tree(tree, other_tree)
457
if revision_id == _mod_revision.NULL_REVISION:
460
new_parents = [revision_id]
461
tree.set_parent_ids(new_parents)
463
def get_file_size(self, path, file_id=None):
464
"""See Tree.get_file_size"""
465
# XXX: this returns the on-disk size; it should probably return the
468
return os.path.getsize(self.abspath(path))
470
if e.errno != errno.ENOENT:
475
def _gather_kinds(self, files, kinds):
476
"""See MutableTree._gather_kinds."""
477
with self.lock_tree_write():
478
for pos, f in enumerate(files):
479
if kinds[pos] is None:
480
fullpath = osutils.normpath(self.abspath(f))
482
kinds[pos] = osutils.file_kind(fullpath)
484
if e.errno == errno.ENOENT:
485
raise errors.NoSuchFile(fullpath)
487
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
488
"""Add revision_id as a parent.
490
This is equivalent to retrieving the current list of parent ids
491
and setting the list to its value plus revision_id.
493
:param revision_id: The revision id to add to the parent list. It may
494
be a ghost revision as long as its not the first parent to be
495
added, or the allow_leftmost_as_ghost parameter is set True.
496
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
498
with self.lock_write():
499
parents = self.get_parent_ids() + [revision_id]
500
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
501
or allow_leftmost_as_ghost)
503
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
504
"""Add revision_id, tree tuple as a parent.
506
This is equivalent to retrieving the current list of parent trees
507
and setting the list to its value plus parent_tuple. See also
508
add_parent_tree_id - if you only have a parent id available it will be
509
simpler to use that api. If you have the parent already available, using
510
this api is preferred.
512
:param parent_tuple: The (revision id, tree) to add to the parent list.
513
If the revision_id is a ghost, pass None for the tree.
514
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
516
with self.lock_tree_write():
517
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
518
if len(parent_ids) > 1:
519
# the leftmost may have already been a ghost, preserve that if it
521
allow_leftmost_as_ghost = True
522
self.set_parent_ids(parent_ids,
523
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
525
def add_pending_merge(self, *revision_ids):
526
with self.lock_tree_write():
527
# TODO: Perhaps should check at this point that the
528
# history of the revision is actually present?
529
parents = self.get_parent_ids()
531
for rev_id in revision_ids:
532
if rev_id in parents:
534
parents.append(rev_id)
537
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
539
def path_content_summary(self, path, _lstat=os.lstat,
540
_mapper=osutils.file_kind_from_stat_mode):
541
"""See Tree.path_content_summary."""
542
abspath = self.abspath(path)
544
stat_result = _lstat(abspath)
546
if getattr(e, 'errno', None) == errno.ENOENT:
548
return ('missing', None, None, None)
549
# propagate other errors
551
kind = _mapper(stat_result.st_mode)
553
return self._file_content_summary(path, stat_result)
554
elif kind == 'directory':
555
# perhaps it looks like a plain directory, but it's really a
557
if self._directory_is_tree_reference(path):
558
kind = 'tree-reference'
559
return kind, None, None, None
560
elif kind == 'symlink':
561
target = osutils.readlink(abspath)
562
return ('symlink', None, None, target)
564
return (kind, None, None, None)
566
def _file_content_summary(self, path, stat_result):
567
size = stat_result.st_size
568
executable = self._is_executable_from_path_and_stat(path, stat_result)
569
# try for a stat cache lookup
570
return ('file', size, executable, self._sha_from_stat(
573
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
574
"""Common ghost checking functionality from set_parent_*.
576
This checks that the left hand-parent exists if there are any
579
if len(revision_ids) > 0:
580
leftmost_id = revision_ids[0]
581
if (not allow_leftmost_as_ghost and not
582
self.branch.repository.has_revision(leftmost_id)):
583
raise errors.GhostRevisionUnusableHere(leftmost_id)
585
def _set_merges_from_parent_ids(self, parent_ids):
586
merges = parent_ids[1:]
587
self._transport.put_bytes('pending-merges', b'\n'.join(merges),
588
mode=self.controldir._get_file_mode())
590
def _filter_parent_ids_by_ancestry(self, revision_ids):
591
"""Check that all merged revisions are proper 'heads'.
593
This will always return the first revision_id, and any merged revisions
596
if len(revision_ids) == 0:
598
graph = self.branch.repository.get_graph()
599
heads = graph.heads(revision_ids)
600
new_revision_ids = revision_ids[:1]
601
for revision_id in revision_ids[1:]:
602
if revision_id in heads and revision_id not in new_revision_ids:
603
new_revision_ids.append(revision_id)
604
if new_revision_ids != revision_ids:
605
mutter('requested to set revision_ids = %s,'
606
' but filtered to %s', revision_ids, new_revision_ids)
607
return new_revision_ids
609
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
610
"""Set the parent ids to revision_ids.
612
See also set_parent_trees. This api will try to retrieve the tree data
613
for each element of revision_ids from the trees repository. If you have
614
tree data already available, it is more efficient to use
615
set_parent_trees rather than set_parent_ids. set_parent_ids is however
616
an easier API to use.
618
:param revision_ids: The revision_ids to set as the parent ids of this
619
working tree. Any of these may be ghosts.
621
with self.lock_tree_write():
622
self._check_parents_for_ghosts(revision_ids,
623
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
624
for revision_id in revision_ids:
625
_mod_revision.check_not_reserved_id(revision_id)
627
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
629
if len(revision_ids) > 0:
630
self.set_last_revision(revision_ids[0])
632
self.set_last_revision(_mod_revision.NULL_REVISION)
634
self._set_merges_from_parent_ids(revision_ids)
636
def set_pending_merges(self, rev_list):
637
with self.lock_tree_write():
638
parents = self.get_parent_ids()
639
leftmost = parents[:1]
640
new_parents = leftmost + rev_list
641
self.set_parent_ids(new_parents)
643
def set_merge_modified(self, modified_hashes):
644
"""Set the merge modified hashes."""
645
raise NotImplementedError(self.set_merge_modified)
647
def _sha_from_stat(self, path, stat_result):
648
"""Get a sha digest from the tree's stat cache.
650
The default implementation assumes no stat cache is present.
652
:param path: The path.
653
:param stat_result: The stat result being looked up.
657
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
658
merge_type=None, force=False):
659
"""Merge from a branch into this working tree.
661
:param branch: The branch to merge from.
662
:param to_revision: If non-None, the merge will merge to to_revision,
663
but not beyond it. to_revision does not need to be in the history
664
of the branch when it is supplied. If None, to_revision defaults to
665
branch.last_revision().
667
from .merge import Merger, Merge3Merger
668
with self.lock_write():
669
merger = Merger(self.branch, this_tree=self)
670
# check that there are no local alterations
671
if not force and self.has_changes():
672
raise errors.UncommittedChanges(self)
673
if to_revision is None:
674
to_revision = _mod_revision.ensure_null(branch.last_revision())
675
merger.other_rev_id = to_revision
676
if _mod_revision.is_null(merger.other_rev_id):
677
raise errors.NoCommits(branch)
678
self.branch.fetch(branch, last_revision=merger.other_rev_id)
679
merger.other_basis = merger.other_rev_id
680
merger.other_tree = self.branch.repository.revision_tree(
682
merger.other_branch = branch
683
if from_revision is None:
686
merger.set_base_revision(from_revision, branch)
687
if merger.base_rev_id == merger.other_rev_id:
688
raise errors.PointlessMerge
689
merger.backup_files = False
690
if merge_type is None:
691
merger.merge_type = Merge3Merger
693
merger.merge_type = merge_type
694
merger.set_interesting_files(None)
695
merger.show_base = False
696
merger.reprocess = False
697
conflicts = merger.do_merge()
701
def merge_modified(self):
702
"""Return a dictionary of files modified by a merge.
704
The list is initialized by WorkingTree.set_merge_modified, which is
705
typically called after we make some automatic updates to the tree
708
This returns a map of file_id->sha1, containing only files which are
709
still in the working tree and have that text hash.
711
raise NotImplementedError(self.merge_modified)
713
def mkdir(self, path, file_id=None):
714
"""See MutableTree.mkdir()."""
716
if self.supports_setting_file_ids():
717
file_id = generate_ids.gen_file_id(os.path.basename(path))
719
if not self.supports_setting_file_ids():
720
raise SettingFileIdUnsupported()
721
with self.lock_write():
722
os.mkdir(self.abspath(path))
723
self.add(path, file_id, 'directory')
726
def get_symlink_target(self, path, file_id=None):
727
abspath = self.abspath(path)
728
target = osutils.readlink(abspath)
731
def subsume(self, other_tree):
732
raise NotImplementedError(self.subsume)
734
def _setup_directory_is_tree_reference(self):
735
if self._branch.repository._format.supports_tree_reference:
736
self._directory_is_tree_reference = \
737
self._directory_may_be_tree_reference
739
self._directory_is_tree_reference = \
740
self._directory_is_never_tree_reference
742
def _directory_is_never_tree_reference(self, relpath):
745
def _directory_may_be_tree_reference(self, relpath):
746
# as a special case, if a directory contains control files then
747
# it's a tree reference, except that the root of the tree is not
748
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
749
# TODO: We could ask all the control formats whether they
750
# recognize this directory, but at the moment there's no cheap api
751
# to do that. Since we probably can only nest bzr checkouts and
752
# they always use this name it's ok for now. -- mbp 20060306
754
# FIXME: There is an unhandled case here of a subdirectory
755
# containing .bzr but not a branch; that will probably blow up
756
# when you try to commit it. It might happen if there is a
757
# checkout in a subdirectory. This can be avoided by not adding
760
def extract(self, path, file_id=None, format=None):
761
"""Extract a subtree from this tree.
763
A new branch will be created, relative to the path for this tree.
765
raise NotImplementedError(self.extract)
768
"""Write the in memory meta data to disk."""
769
raise NotImplementedError(self.flush)
771
def kind(self, relpath, file_id=None):
772
return osutils.file_kind(self.abspath(relpath))
774
def list_files(self, include_root=False, from_dir=None, recursive=True):
775
"""List all files as (path, class, kind, id, entry).
777
Lists, but does not descend into unversioned directories.
778
This does not include files that have been deleted in this
779
tree. Skips the control directory.
781
:param include_root: if True, return an entry for the root
782
:param from_dir: start from this directory or None for the root
783
:param recursive: whether to recurse into subdirectories or not
785
raise NotImplementedError(self.list_files)
787
def move(self, from_paths, to_dir=None, after=False):
790
to_dir must be known to the working tree.
792
If to_dir exists and is a directory, the files are moved into
793
it, keeping their old names.
795
Note that to_dir is only the last component of the new name;
796
this doesn't change the directory.
798
For each entry in from_paths the move mode will be determined
801
The first mode moves the file in the filesystem and updates the
802
working tree metadata. The second mode only updates the working tree
803
metadata without touching the file on the filesystem.
805
move uses the second mode if 'after == True' and the target is not
806
versioned but present in the working tree.
808
move uses the second mode if 'after == False' and the source is
809
versioned but no longer in the working tree, and the target is not
810
versioned but present in the working tree.
812
move uses the first mode if 'after == False' and the source is
813
versioned and present in the working tree, and the target is not
814
versioned and not present in the working tree.
816
Everything else results in an error.
818
This returns a list of (from_path, to_path) pairs for each
821
raise NotImplementedError(self.move)
823
def copy_one(self, from_rel, to_rel):
824
"""Copy a file in the tree to a new location.
826
This default implementation just copies the file, then
829
:param from_rel: From location (relative to tree root)
830
:param to_rel: Target location (relative to tree root)
832
shutil.copyfile(self.abspath(from_rel), self.abspath(to_rel))
836
"""Return all unknown files.
838
These are files in the working directory that are not versioned or
839
control files or ignored.
841
with self.lock_read():
842
# force the extras method to be fully executed before returning, to
843
# prevent race conditions with the lock
845
[subp for subp in self.extras() if not self.is_ignored(subp)])
847
def unversion(self, paths):
848
"""Remove the path in pahs from the current versioned set.
850
When a path is unversioned, all of its children are automatically
853
:param paths: The paths to stop versioning.
854
:raises NoSuchFile: if any path is not currently versioned.
856
raise NotImplementedError(self.unversion)
858
def pull(self, source, overwrite=False, stop_revision=None,
859
change_reporter=None, possible_transports=None, local=False,
861
with self.lock_write(), source.lock_read():
862
old_revision_info = self.branch.last_revision_info()
863
basis_tree = self.basis_tree()
864
count = self.branch.pull(source, overwrite, stop_revision,
865
possible_transports=possible_transports,
867
new_revision_info = self.branch.last_revision_info()
868
if new_revision_info != old_revision_info:
869
repository = self.branch.repository
870
if repository._format.fast_deltas:
871
parent_ids = self.get_parent_ids()
873
basis_id = parent_ids[0]
874
basis_tree = repository.revision_tree(basis_id)
875
with basis_tree.lock_read():
876
new_basis_tree = self.branch.basis_tree()
882
change_reporter=change_reporter,
884
basis_root_id = basis_tree.get_root_id()
885
new_root_id = new_basis_tree.get_root_id()
886
if new_root_id is not None and basis_root_id != new_root_id:
887
self.set_root_id(new_root_id)
888
# TODO - dedup parents list with things merged by pull ?
889
# reuse the revisiontree we merged against to set the new
892
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
894
(self.branch.last_revision(), new_basis_tree))
895
# we have to pull the merge trees out again, because
896
# merge_inner has set the ids. - this corner is not yet
897
# layered well enough to prevent double handling.
898
# XXX TODO: Fix the double handling: telling the tree about
899
# the already known parent data is wasteful.
900
merges = self.get_parent_ids()[1:]
901
parent_trees.extend([
902
(parent, repository.revision_tree(parent)) for
904
self.set_parent_trees(parent_trees)
907
def put_file_bytes_non_atomic(self, path, bytes, file_id=None):
908
"""See MutableTree.put_file_bytes_non_atomic."""
909
with self.lock_write(), file(self.abspath(path), 'wb') as stream:
913
"""Yield all unversioned files in this WorkingTree.
915
If there are any unversioned directories then only the directory is
916
returned, not all its children. But if there are unversioned files
917
under a versioned subdirectory, they are returned.
919
Currently returned depth-first, sorted by name within directories.
920
This is the same order used by 'osutils.walkdirs'.
922
raise NotImplementedError(self.extras)
924
def ignored_files(self):
925
"""Yield list of PATH, IGNORE_PATTERN"""
926
for subp in self.extras():
927
pat = self.is_ignored(subp)
931
def is_ignored(self, filename):
932
r"""Check whether the filename matches an ignore pattern.
934
raise NotImplementedError(self.is_ignored)
936
def stored_kind(self, path, file_id=None):
937
"""See Tree.stored_kind"""
938
raise NotImplementedError(self.stored_kind)
940
def _comparison_data(self, entry, path):
941
abspath = self.abspath(path)
943
stat_value = os.lstat(abspath)
945
if getattr(e, 'errno', None) == errno.ENOENT:
952
mode = stat_value.st_mode
953
kind = osutils.file_kind_from_stat_mode(mode)
954
if not self._supports_executable():
955
executable = entry is not None and entry.executable
957
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
958
return kind, executable, stat_value
960
def last_revision(self):
961
"""Return the last revision of the branch for this tree.
963
This format tree does not support a separate marker for last-revision
964
compared to the branch.
966
See MutableTree.last_revision
968
return self._last_revision()
970
def _last_revision(self):
971
"""helper for get_parent_ids."""
972
with self.lock_read():
973
return _mod_revision.ensure_null(self.branch.last_revision())
976
"""Check if this tree is locked."""
977
raise NotImplementedError(self.is_locked)
980
"""Lock the tree for reading.
982
This also locks the branch, and can be unlocked via self.unlock().
984
:return: A breezy.lock.LogicalLockResult.
986
raise NotImplementedError(self.lock_read)
988
def lock_tree_write(self):
989
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
991
:return: A breezy.lock.LogicalLockResult.
993
raise NotImplementedError(self.lock_tree_write)
995
def lock_write(self):
996
"""See MutableTree.lock_write, and WorkingTree.unlock.
998
:return: A breezy.lock.LogicalLockResult.
1000
raise NotImplementedError(self.lock_write)
1002
def get_physical_lock_status(self):
1003
raise NotImplementedError(self.get_physical_lock_status)
1005
def set_last_revision(self, new_revision):
1006
"""Change the last revision in the working tree."""
1007
raise NotImplementedError(self.set_last_revision)
1009
def _change_last_revision(self, new_revision):
1010
"""Template method part of set_last_revision to perform the change.
1012
This is used to allow WorkingTree3 instances to not affect branch
1013
when their last revision is set.
1015
if _mod_revision.is_null(new_revision):
1016
self.branch.set_last_revision_info(0, new_revision)
1018
_mod_revision.check_not_reserved_id(new_revision)
1020
self.branch.generate_revision_history(new_revision)
1021
except errors.NoSuchRevision:
1022
# not present in the repo - dont try to set it deeper than the tip
1023
self.branch._set_revision_history([new_revision])
1026
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1028
"""Remove nominated files from the working tree metadata.
1030
:files: File paths relative to the basedir.
1031
:keep_files: If true, the files will also be kept.
1032
:force: Delete files and directories, even if they are changed and
1033
even if the directories are not empty.
1035
raise NotImplementedError(self.remove)
1037
def revert(self, filenames=None, old_tree=None, backups=True,
1038
pb=None, report_changes=False):
1039
from .conflicts import resolve
1040
with self.lock_tree_write():
1041
if old_tree is None:
1042
basis_tree = self.basis_tree()
1043
basis_tree.lock_read()
1044
old_tree = basis_tree
1048
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1050
if filenames is None and len(self.get_parent_ids()) > 1:
1052
last_revision = self.last_revision()
1053
if last_revision != _mod_revision.NULL_REVISION:
1054
if basis_tree is None:
1055
basis_tree = self.basis_tree()
1056
basis_tree.lock_read()
1057
parent_trees.append((last_revision, basis_tree))
1058
self.set_parent_trees(parent_trees)
1061
resolve(self, filenames, ignore_misses=True, recursive=True)
1063
if basis_tree is not None:
1067
def store_uncommitted(self):
1068
"""Store uncommitted changes from the tree in the branch."""
1069
raise NotImplementedError(self.store_uncommitted)
1071
def restore_uncommitted(self):
1072
"""Restore uncommitted changes from the branch into the tree."""
1073
raise NotImplementedError(self.restore_uncommitted)
1075
def revision_tree(self, revision_id):
1076
"""See Tree.revision_tree.
1078
For trees that can be obtained from the working tree, this
1079
will do so. For other trees, it will fall back to the repository.
1081
raise NotImplementedError(self.revision_tree)
1083
def set_root_id(self, file_id):
1084
"""Set the root id for this tree."""
1085
if not self.supports_setting_file_ids():
1086
raise SettingFileIdUnsupported()
1087
with self.lock_tree_write():
1091
'WorkingTree.set_root_id with fileid=None')
1092
file_id = osutils.safe_file_id(file_id)
1093
self._set_root_id(file_id)
1095
def _set_root_id(self, file_id):
1096
"""Set the root id for this tree, in a format specific manner.
1098
:param file_id: The file id to assign to the root. It must not be
1099
present in the current inventory or an error will occur. It must
1100
not be None, but rather a valid file id.
1102
raise NotImplementedError(self._set_root_id)
1105
"""See Branch.unlock.
1107
WorkingTree locking just uses the Branch locking facilities.
1108
This is current because all working trees have an embedded branch
1109
within them. IF in the future, we were to make branch data shareable
1110
between multiple working trees, i.e. via shared storage, then we
1111
would probably want to lock both the local tree, and the branch.
1113
raise NotImplementedError(self.unlock)
1117
def update(self, change_reporter=None, possible_transports=None,
1118
revision=None, old_tip=_marker, show_base=False):
1119
"""Update a working tree along its branch.
1121
This will update the branch if its bound too, which means we have
1122
multiple trees involved:
1124
- The new basis tree of the master.
1125
- The old basis tree of the branch.
1126
- The old basis tree of the working tree.
1127
- The current working tree state.
1129
Pathologically, all three may be different, and non-ancestors of each
1130
other. Conceptually we want to:
1132
- Preserve the wt.basis->wt.state changes
1133
- Transform the wt.basis to the new master basis.
1134
- Apply a merge of the old branch basis to get any 'local' changes from
1136
- Restore the wt.basis->wt.state changes.
1138
There isn't a single operation at the moment to do that, so we:
1140
- Merge current state -> basis tree of the master w.r.t. the old tree
1142
- Do a 'normal' merge of the old branch basis if it is relevant.
1144
:param revision: The target revision to update to. Must be in the
1146
:param old_tip: If branch.update() has already been run, the value it
1147
returned (old tip of the branch or None). _marker is used
1150
if self.branch.get_bound_location() is not None:
1152
update_branch = (old_tip is self._marker)
1154
self.lock_tree_write()
1155
update_branch = False
1158
old_tip = self.branch.update(possible_transports)
1160
if old_tip is self._marker:
1162
return self._update_tree(old_tip, change_reporter, revision, show_base)
1166
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1168
"""Update a tree to the master branch.
1170
:param old_tip: if supplied, the previous tip revision the branch,
1171
before it was changed to the master branch's tip.
1173
# here if old_tip is not None, it is the old tip of the branch before
1174
# it was updated from the master branch. This should become a pending
1175
# merge in the working tree to preserve the user existing work. we
1176
# cant set that until we update the working trees last revision to be
1177
# one from the new branch, because it will just get absorbed by the
1178
# parent de-duplication logic.
1180
# We MUST save it even if an error occurs, because otherwise the users
1181
# local work is unreferenced and will appear to have been lost.
1183
with self.lock_tree_write():
1186
last_rev = self.get_parent_ids()[0]
1188
last_rev = _mod_revision.NULL_REVISION
1189
if revision is None:
1190
revision = self.branch.last_revision()
1192
old_tip = old_tip or _mod_revision.NULL_REVISION
1194
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1195
# the branch we are bound to was updated
1196
# merge those changes in first
1197
base_tree = self.basis_tree()
1198
other_tree = self.branch.repository.revision_tree(old_tip)
1199
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1200
base_tree, this_tree=self,
1201
change_reporter=change_reporter,
1202
show_base=show_base)
1204
self.add_parent_tree((old_tip, other_tree))
1205
note(gettext('Rerun update after fixing the conflicts.'))
1208
if last_rev != _mod_revision.ensure_null(revision):
1209
# the working tree is up to date with the branch
1210
# we can merge the specified revision from master
1211
to_tree = self.branch.repository.revision_tree(revision)
1212
to_root_id = to_tree.get_root_id()
1214
basis = self.basis_tree()
1215
with basis.lock_read():
1216
if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
1217
self.set_root_id(to_root_id)
1220
# determine the branch point
1221
graph = self.branch.repository.get_graph()
1222
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1224
base_tree = self.branch.repository.revision_tree(base_rev_id)
1226
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1228
change_reporter=change_reporter,
1229
show_base=show_base)
1230
self.set_last_revision(revision)
1231
# TODO - dedup parents list with things merged by pull ?
1232
# reuse the tree we've updated to to set the basis:
1233
parent_trees = [(revision, to_tree)]
1234
merges = self.get_parent_ids()[1:]
1235
# Ideally we ask the tree for the trees here, that way the working
1236
# tree can decide whether to give us the entire tree or give us a
1237
# lazy initialised tree. dirstate for instance will have the trees
1238
# in ram already, whereas a last-revision + basis-inventory tree
1239
# will not, but also does not need them when setting parents.
1240
for parent in merges:
1241
parent_trees.append(
1242
(parent, self.branch.repository.revision_tree(parent)))
1243
if not _mod_revision.is_null(old_tip):
1244
parent_trees.append(
1245
(old_tip, self.branch.repository.revision_tree(old_tip)))
1246
self.set_parent_trees(parent_trees)
1247
last_rev = parent_trees[0][0]
1250
def set_conflicts(self, arg):
1251
raise errors.UnsupportedOperation(self.set_conflicts, self)
1253
def add_conflicts(self, arg):
1254
raise errors.UnsupportedOperation(self.add_conflicts, self)
1256
def conflicts(self):
1257
raise NotImplementedError(self.conflicts)
1259
def walkdirs(self, prefix=""):
1260
"""Walk the directories of this tree.
1262
returns a generator which yields items in the form:
1263
((curren_directory_path, fileid),
1264
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1267
This API returns a generator, which is only valid during the current
1268
tree transaction - within a single lock_read or lock_write duration.
1270
If the tree is not locked, it may cause an error to be raised,
1271
depending on the tree implementation.
1273
raise NotImplementedError(self.walkdirs)
1275
def auto_resolve(self):
1276
"""Automatically resolve text conflicts according to contents.
1278
Only text conflicts are auto_resolvable. Files with no conflict markers
1279
are considered 'resolved', because bzr always puts conflict markers
1280
into files that have text conflicts. The corresponding .THIS .BASE and
1281
.OTHER files are deleted, as per 'resolve'.
1283
:return: a tuple of ConflictLists: (un_resolved, resolved).
1285
with self.lock_tree_write():
1286
un_resolved = _mod_conflicts.ConflictList()
1287
resolved = _mod_conflicts.ConflictList()
1288
conflict_re = re.compile('^(<{7}|={7}|>{7})')
1289
for conflict in self.conflicts():
1290
path = self.id2path(conflict.file_id)
1291
if (conflict.typestring != 'text conflict' or
1292
self.kind(path, conflict.file_id) != 'file'):
1293
un_resolved.append(conflict)
1295
with open(self.abspath(path), 'rb') as my_file:
1296
for line in my_file:
1297
if conflict_re.search(line):
1298
un_resolved.append(conflict)
1301
resolved.append(conflict)
1302
resolved.remove_files(self)
1303
self.set_conflicts(un_resolved)
1304
return un_resolved, resolved
1306
def _validate(self):
1307
"""Validate internal structures.
1309
This is meant mostly for the test suite. To give it a chance to detect
1310
corruption after actions have occurred. The default implementation is a
1313
:return: None. An exception should be raised if there is an error.
1317
def check_state(self):
1318
"""Check that the working state is/isn't valid."""
1319
raise NotImplementedError(self.check_state)
1321
def reset_state(self, revision_ids=None):
1322
"""Reset the state of the working tree.
1324
This does a hard-reset to a last-known-good state. This is a way to
1325
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1327
raise NotImplementedError(self.reset_state)
1329
def _get_rules_searcher(self, default_searcher):
1330
"""See Tree._get_rules_searcher."""
1331
if self._rules_searcher is None:
1332
self._rules_searcher = super(WorkingTree,
1333
self)._get_rules_searcher(default_searcher)
1334
return self._rules_searcher
1336
def get_shelf_manager(self):
1337
"""Return the ShelfManager for this WorkingTree."""
1338
raise NotImplementedError(self.get_shelf_manager)
1341
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
1342
"""Registry for working tree formats."""
1344
def __init__(self, other_registry=None):
1345
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
1346
self._default_format = None
1347
self._default_format_key = None
1349
def get_default(self):
1350
"""Return the current default format."""
1351
if (self._default_format_key is not None and
1352
self._default_format is None):
1353
self._default_format = self.get(self._default_format_key)
1354
return self._default_format
1356
def set_default(self, format):
1357
"""Set the default format."""
1358
self._default_format = format
1359
self._default_format_key = None
1361
def set_default_key(self, format_string):
1362
"""Set the default format by its format string."""
1363
self._default_format_key = format_string
1364
self._default_format = None
1367
format_registry = WorkingTreeFormatRegistry()
1370
class WorkingTreeFormat(controldir.ControlComponentFormat):
1371
"""An encapsulation of the initialization and open routines for a format.
1373
Formats provide three things:
1374
* An initialization routine,
1378
Formats are placed in an dict by their format string for reference
1379
during workingtree opening. Its not required that these be instances, they
1380
can be classes themselves with class methods - it simply depends on
1381
whether state is needed for a given format or not.
1383
Once a format is deprecated, just deprecate the initialize and open
1384
methods on the format class. Do not deprecate the object, as the
1385
object will be created every time regardless.
1388
requires_rich_root = False
1390
upgrade_recommended = False
1392
requires_normalized_unicode_filenames = False
1394
case_sensitive_filename = "FoRMaT"
1396
missing_parent_conflicts = False
1397
"""If this format supports missing parent conflicts."""
1399
supports_versioned_directories = None
1401
supports_merge_modified = True
1402
"""If this format supports storing merge modified hashes."""
1404
supports_setting_file_ids = True
1405
"""If this format allows setting the file id."""
1407
supports_store_uncommitted = True
1408
"""If this format supports shelve-like functionality."""
1410
supports_leftmost_parent_id_as_ghost = True
1412
supports_righthand_parent_id_as_ghost = True
1414
ignore_filename = None
1415
"""Name of file with ignore patterns, if any. """
1417
def initialize(self, controldir, revision_id=None, from_branch=None,
1418
accelerator_tree=None, hardlink=False):
1419
"""Initialize a new working tree in controldir.
1421
:param controldir: ControlDir to initialize the working tree in.
1422
:param revision_id: allows creating a working tree at a different
1423
revision than the branch is at.
1424
:param from_branch: Branch to checkout
1425
:param accelerator_tree: A tree which can be used for retrieving file
1426
contents more quickly than the revision tree, i.e. a workingtree.
1427
The revision tree will be used for cases where accelerator_tree's
1428
content is different.
1429
:param hardlink: If true, hard-link files from accelerator_tree,
1432
raise NotImplementedError(self.initialize)
1434
def __eq__(self, other):
1435
return self.__class__ is other.__class__
1437
def __ne__(self, other):
1438
return not (self == other)
1440
def get_format_description(self):
1441
"""Return the short description for this format."""
1442
raise NotImplementedError(self.get_format_description)
1444
def is_supported(self):
1445
"""Is this format supported?
1447
Supported formats can be initialized and opened.
1448
Unsupported formats may not support initialization or committing or
1449
some other features depending on the reason for not being supported.
1453
def supports_content_filtering(self):
1454
"""True if this format supports content filtering."""
1457
def supports_views(self):
1458
"""True if this format supports stored views."""
1461
def get_controldir_for_branch(self):
1462
"""Get the control directory format for creating branches.
1464
This is to support testing of working tree formats that can not exist
1465
in the same control directory as a branch.
1467
return self._matchingcontroldir
1470
format_registry.register_lazy(b"Bazaar Working Tree Format 4 (bzr 0.15)\n",
1471
"breezy.bzr.workingtree_4", "WorkingTreeFormat4")
1472
format_registry.register_lazy(b"Bazaar Working Tree Format 5 (bzr 1.11)\n",
1473
"breezy.bzr.workingtree_4", "WorkingTreeFormat5")
1474
format_registry.register_lazy(b"Bazaar Working Tree Format 6 (bzr 1.14)\n",
1475
"breezy.bzr.workingtree_4", "WorkingTreeFormat6")
1476
format_registry.register_lazy(b"Bazaar-NG Working Tree format 3",
1477
"breezy.bzr.workingtree_3", "WorkingTreeFormat3")
1478
format_registry.set_default_key(b"Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
breezy/workingtree.py
