293
@deprecated_function(deprecated_in((2, 2, 0)))
294
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
296
"""Get the trees and specific files to diff given a list of paths.
298
This method works out the trees to be diff'ed and the files of
299
interest within those trees.
302
the list of arguments passed to the diff command
303
:param revision_specs:
304
Zero, one or two RevisionSpecs from the diff command line,
305
saying what revisions to compare.
307
The url of the old branch or tree. If None, the tree to use is
308
taken from the first path, if any, or the current working tree.
310
The url of the new branch or tree. If None, the tree to use is
311
taken from the first path, if any, or the current working tree.
313
if True and a view is set, apply the view or check that the paths
316
a tuple of (old_tree, new_tree, old_branch, new_branch,
317
specific_files, extra_trees) where extra_trees is a sequence of
318
additional trees to search in for file-ids. The trees and branches
321
op = cleanup.OperationWithCleanups(get_trees_and_branches_to_diff_locked)
322
return op.run_simple(path_list, revision_specs, old_url, new_url,
323
op.add_cleanup, apply_view=apply_view)
271
def diff_cmd_helper(tree, specific_files, external_diff_options,
272
old_revision_spec=None, new_revision_spec=None,
274
old_label='a/', new_label='b/'):
275
"""Helper for cmd_diff.
280
:param specific_files:
281
The specific files to compare, or None
283
:param external_diff_options:
284
If non-None, run an external diff, and pass it these options
286
:param old_revision_spec:
287
If None, use basis tree as old revision, otherwise use the tree for
288
the specified revision.
290
:param new_revision_spec:
291
If None, use working tree as new revision, otherwise use the tree for
292
the specified revision.
326
def get_trees_and_branches_to_diff_locked(
327
path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
328
"""Get the trees and specific files to diff given a list of paths.
330
This method works out the trees to be diff'ed and the files of
331
interest within those trees.
334
the list of arguments passed to the diff command
335
:param revision_specs:
336
Zero, one or two RevisionSpecs from the diff command line,
337
saying what revisions to compare.
339
The url of the old branch or tree. If None, the tree to use is
340
taken from the first path, if any, or the current working tree.
342
The url of the new branch or tree. If None, the tree to use is
343
taken from the first path, if any, or the current working tree.
345
a callable like Command.add_cleanup. get_trees_and_branches_to_diff
346
will register cleanups that must be run to unlock the trees, etc.
348
if True and a view is set, apply the view or check that the paths
351
a tuple of (old_tree, new_tree, old_branch, new_branch,
352
specific_files, extra_trees) where extra_trees is a sequence of
353
additional trees to search in for file-ids. The trees and branches
354
will be read-locked until the cleanups registered via the add_cleanup
294
:param revision_specs:
295
Zero, one or two RevisionSpecs from the command line, saying what revisions
296
to compare. This can be passed as an alternative to the old_revision_spec
297
and new_revision_spec parameters.
299
The more general form is show_diff_trees(), where the caller
300
supplies any two trees.
357
# Get the old and new revision specs
358
old_revision_spec = None
359
new_revision_spec = None
303
# TODO: perhaps remove the old parameters old_revision_spec and
304
# new_revision_spec, since this is only really for use from cmd_diff and
305
# it now always passes through a sequence of revision_specs -- mbp
310
revision = spec.in_store(tree.branch)
312
revision = spec.in_store(None)
313
revision_id = revision.rev_id
314
branch = revision.branch
315
return branch.repository.revision_tree(revision_id)
360
317
if revision_specs is not None:
318
assert (old_revision_spec is None
319
and new_revision_spec is None)
361
320
if len(revision_specs) > 0:
362
321
old_revision_spec = revision_specs[0]
364
old_url = old_revision_spec.get_branch()
365
322
if len(revision_specs) > 1:
366
323
new_revision_spec = revision_specs[1]
368
new_url = new_revision_spec.get_branch()
371
make_paths_wt_relative = True
372
consider_relpath = True
373
if path_list is None or len(path_list) == 0:
374
# If no path is given, the current working tree is used
375
default_location = u'.'
376
consider_relpath = False
377
elif old_url is not None and new_url is not None:
378
other_paths = path_list
379
make_paths_wt_relative = False
381
default_location = path_list[0]
382
other_paths = path_list[1:]
384
def lock_tree_or_branch(wt, br):
387
add_cleanup(wt.unlock)
390
add_cleanup(br.unlock)
392
# Get the old location
395
old_url = default_location
396
working_tree, branch, relpath = \
397
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
398
lock_tree_or_branch(working_tree, branch)
399
if consider_relpath and relpath != '':
400
if working_tree is not None and apply_view:
401
views.check_path_in_view(working_tree, relpath)
402
specific_files.append(relpath)
403
old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
406
# Get the new location
408
new_url = default_location
409
if new_url != old_url:
410
working_tree, branch, relpath = \
411
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
412
lock_tree_or_branch(working_tree, branch)
413
if consider_relpath and relpath != '':
414
if working_tree is not None and apply_view:
415
views.check_path_in_view(working_tree, relpath)
416
specific_files.append(relpath)
417
new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
418
basis_is_default=working_tree is None)
421
# Get the specific files (all files is None, no files is [])
422
if make_paths_wt_relative and working_tree is not None:
424
from bzrlib.builtins import safe_relpath_files
425
other_paths = safe_relpath_files(working_tree, other_paths,
426
apply_view=apply_view)
427
except errors.FileInWrongBranch:
428
raise errors.BzrCommandError("Files are in different branches")
429
specific_files.extend(other_paths)
430
if len(specific_files) == 0:
431
specific_files = None
432
if (working_tree is not None and working_tree.supports_views()
434
view_files = working_tree.views.lookup_view()
436
specific_files = view_files
437
view_str = views.view_display_str(view_files)
438
note("*** Ignoring files outside view. View is %s" % view_str)
440
# Get extra trees that ought to be searched for file-ids
442
if working_tree is not None and working_tree not in (old_tree, new_tree):
443
extra_trees = (working_tree,)
444
return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
447
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
448
if branch is None and tree is not None:
450
if spec is None or spec.spec is None:
453
return tree.basis_tree()
455
return branch.basis_tree()
458
return spec.as_tree(branch)
325
if old_revision_spec is None:
326
old_tree = tree.basis_tree()
328
old_tree = spec_tree(old_revision_spec)
330
if (new_revision_spec is None
331
or new_revision_spec.spec is None):
334
new_tree = spec_tree(new_revision_spec)
336
if new_tree is not tree:
337
extra_trees = (tree,)
341
return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
342
external_diff_options,
343
old_label=old_label, new_label=new_label,
344
extra_trees=extra_trees)
461
347
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
462
348
external_diff_options=None,
463
349
old_label='a/', new_label='b/',
464
350
extra_trees=None,
465
path_encoding='utf8',
351
path_encoding='utf8'):
468
352
"""Show in text form the changes from one tree to another.
470
:param to_file: The output stream.
471
:param specific_files:Include only changes to these files - None for all
473
:param external_diff_options: If set, use an external GNU diff and pass
475
:param extra_trees: If set, more Trees to use for looking up file ids
476
:param path_encoding: If set, the path will be encoded as specified,
477
otherwise is supposed to be utf8
478
:param format_cls: Formatter class (DiffTree subclass)
355
If set, include only changes to these files.
357
external_diff_options
358
If set, use an external GNU diff and pass these options.
361
If set, more Trees to use for looking up file ids
364
If set, the path will be encoded as specified, otherwise is supposed
480
if format_cls is None:
481
format_cls = DiffTree
482
367
old_tree.lock_read()
484
369
if extra_trees is not None:
721
614
return self.CHANGED
724
class DiffFromTool(DiffPath):
726
def __init__(self, command_template, old_tree, new_tree, to_file,
727
path_encoding='utf-8'):
728
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
729
self.command_template = command_template
730
self._root = osutils.mkdtemp(prefix='bzr-diff-')
733
def from_string(klass, command_string, old_tree, new_tree, to_file,
734
path_encoding='utf-8'):
735
command_template = cmdline.split(command_string)
736
if '@' not in command_string:
737
command_template.extend(['@old_path', '@new_path'])
738
return klass(command_template, old_tree, new_tree, to_file,
742
def make_from_diff_tree(klass, command_string):
743
def from_diff_tree(diff_tree):
744
return klass.from_string(command_string, diff_tree.old_tree,
745
diff_tree.new_tree, diff_tree.to_file)
746
return from_diff_tree
748
def _get_command(self, old_path, new_path):
749
my_map = {'old_path': old_path, 'new_path': new_path}
750
return [AtTemplate(t).substitute(my_map) for t in
751
self.command_template]
753
def _execute(self, old_path, new_path):
754
command = self._get_command(old_path, new_path)
756
proc = subprocess.Popen(command, stdout=subprocess.PIPE,
759
if e.errno == errno.ENOENT:
760
raise errors.ExecutableMissing(command[0])
763
self.to_file.write(proc.stdout.read())
766
def _try_symlink_root(self, tree, prefix):
767
if (getattr(tree, 'abspath', None) is None
768
or not osutils.host_os_dereferences_symlinks()):
771
os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
773
if e.errno != errno.EEXIST:
777
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
779
if not force_temp and isinstance(tree, WorkingTree):
780
return tree.abspath(tree.id2path(file_id))
782
full_path = osutils.pathjoin(self._root, prefix, relpath)
783
if not force_temp and self._try_symlink_root(tree, prefix):
785
parent_dir = osutils.dirname(full_path)
787
os.makedirs(parent_dir)
789
if e.errno != errno.EEXIST:
791
source = tree.get_file(file_id, relpath)
793
target = open(full_path, 'wb')
795
osutils.pumpfile(source, target)
801
mtime = tree.get_file_mtime(file_id)
802
except errors.FileTimestampUnavailable:
805
os.utime(full_path, (mtime, mtime))
807
osutils.make_readonly(full_path)
810
def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
811
allow_write_new=False):
812
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
813
old_path, force_temp)
814
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
815
new_path, force_temp,
816
allow_write=allow_write_new)
817
return old_disk_path, new_disk_path
821
osutils.rmtree(self._root)
823
if e.errno != errno.ENOENT:
824
mutter("The temporary directory \"%s\" was not "
825
"cleanly removed: %s." % (self._root, e))
827
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
828
if (old_kind, new_kind) != ('file', 'file'):
829
return DiffPath.CANNOT_DIFF
830
(old_disk_path, new_disk_path) = self._prepare_files(
831
file_id, old_path, new_path)
832
self._execute(old_disk_path, new_disk_path)
834
def edit_file(self, file_id):
835
"""Use this tool to edit a file.
837
A temporary copy will be edited, and the new contents will be
840
:param file_id: The id of the file to edit.
841
:return: The new contents of the file.
843
old_path = self.old_tree.id2path(file_id)
844
new_path = self.new_tree.id2path(file_id)
845
new_abs_path = self._prepare_files(file_id, old_path, new_path,
846
allow_write_new=True,
848
command = self._get_command(osutils.pathjoin('old', old_path),
849
osutils.pathjoin('new', new_path))
850
subprocess.call(command, cwd=self._root)
851
new_file = open(new_abs_path, 'r')
853
return new_file.read()
858
617
class DiffTree(object):
859
618
"""Provides textual representations of the difference between two trees.
926
681
diff_file = internal_diff
927
682
diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
928
683
old_label, new_label, diff_file)
929
return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
684
return klass(old_tree, new_tree, to_file, path_encoding, diff_text)
932
686
def show_diff(self, specific_files, extra_trees=None):
933
687
"""Write tree diff to self.to_file
935
:param specific_files: the specific files to compare (recursive)
689
:param sepecific_files: the specific files to compare (recursive)
936
690
:param extra_trees: extra trees to use for mapping paths to file_ids
939
return self._show_diff(specific_files, extra_trees)
941
for differ in self.differs:
944
def _show_diff(self, specific_files, extra_trees):
945
692
# TODO: Generation of pseudo-diffs for added/deleted files could
946
693
# be usefully made into a much faster special case.
947
iterator = self.new_tree.iter_changes(self.old_tree,
948
specific_files=specific_files,
949
extra_trees=extra_trees,
950
require_versioned=True)
695
delta = self.new_tree.changes_from(self.old_tree,
696
specific_files=specific_files,
697
extra_trees=extra_trees, require_versioned=True)
952
def changes_key(change):
953
old_path, new_path = change[1]
958
def get_encoded_path(path):
960
return path.encode(self.path_encoding, "replace")
961
for (file_id, paths, changed_content, versioned, parent, name, kind,
962
executable) in sorted(iterator, key=changes_key):
963
# The root does not get diffed, and items with no known kind (that
964
# is, missing) in both trees are skipped as well.
965
if parent == (None, None) or kind == (None, None):
967
oldpath, newpath = paths
968
oldpath_encoded = get_encoded_path(paths[0])
969
newpath_encoded = get_encoded_path(paths[1])
970
old_present = (kind[0] is not None and versioned[0])
971
new_present = (kind[1] is not None and versioned[1])
972
renamed = (parent[0], name[0]) != (parent[1], name[1])
974
properties_changed = []
975
properties_changed.extend(get_executable_change(executable[0], executable[1]))
977
if properties_changed:
978
prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
982
if (old_present, new_present) == (True, False):
983
self.to_file.write("=== removed %s '%s'\n" %
984
(kind[0], oldpath_encoded))
986
elif (old_present, new_present) == (False, True):
987
self.to_file.write("=== added %s '%s'\n" %
988
(kind[1], newpath_encoded))
991
self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
992
(kind[0], oldpath_encoded, newpath_encoded, prop_str))
994
# if it was produced by iter_changes, it must be
995
# modified *somehow*, either content or execute bit.
996
self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
997
newpath_encoded, prop_str))
999
self._diff(file_id, oldpath, newpath, kind[0], kind[1])
700
for path, file_id, kind in delta.removed:
702
path_encoded = path.encode(self.path_encoding, "replace")
703
self.to_file.write("=== removed %s '%s'\n" % (kind, path_encoded))
704
self.diff(file_id, path, path)
706
for path, file_id, kind in delta.added:
708
path_encoded = path.encode(self.path_encoding, "replace")
709
self.to_file.write("=== added %s '%s'\n" % (kind, path_encoded))
710
self.diff(file_id, path, path)
711
for (old_path, new_path, file_id, kind,
712
text_modified, meta_modified) in delta.renamed:
714
prop_str = get_prop_change(meta_modified)
715
oldpath_encoded = old_path.encode(self.path_encoding, "replace")
716
newpath_encoded = new_path.encode(self.path_encoding, "replace")
717
self.to_file.write("=== renamed %s '%s' => '%s'%s\n" % (kind,
718
oldpath_encoded, newpath_encoded, prop_str))
720
self.diff(file_id, old_path, new_path)
721
for path, file_id, kind, text_modified, meta_modified in\
724
prop_str = get_prop_change(meta_modified)
725
path_encoded = path.encode(self.path_encoding, "replace")
726
self.to_file.write("=== modified %s '%s'%s\n" % (kind,
727
path_encoded, prop_str))
728
# The file may be in a different location in the old tree (because
729
# the containing dir was renamed, but the file itself was not)
731
old_path = self.old_tree.id2path(file_id)
732
self.diff(file_id, old_path, path)
1003
733
return has_changes
1005
735
def diff(self, file_id, old_path, new_path):
added
removed
bzrlib/diff.py
