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)
279
@deprecated_function(one_zero)
280
def diff_cmd_helper(tree, specific_files, external_diff_options,
281
old_revision_spec=None, new_revision_spec=None,
283
old_label='a/', new_label='b/'):
284
"""Helper for cmd_diff.
289
:param specific_files:
290
The specific files to compare, or None
292
:param external_diff_options:
293
If non-None, run an external diff, and pass it these options
295
:param old_revision_spec:
296
If None, use basis tree as old revision, otherwise use the tree for
297
the specified revision.
299
:param new_revision_spec:
300
If None, use working tree as new revision, otherwise use the tree for
301
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):
303
:param revision_specs:
304
Zero, one or two RevisionSpecs from the command line, saying what revisions
305
to compare. This can be passed as an alternative to the old_revision_spec
306
and new_revision_spec parameters.
308
The more general form is show_diff_trees(), where the caller
309
supplies any two trees.
312
# TODO: perhaps remove the old parameters old_revision_spec and
313
# new_revision_spec, since this is only really for use from cmd_diff and
314
# it now always passes through a sequence of revision_specs -- mbp
319
revision = spec.in_store(tree.branch)
321
revision = spec.in_store(None)
322
revision_id = revision.rev_id
323
branch = revision.branch
324
return branch.repository.revision_tree(revision_id)
326
if revision_specs is not None:
327
assert (old_revision_spec is None
328
and new_revision_spec is None)
329
if len(revision_specs) > 0:
330
old_revision_spec = revision_specs[0]
331
if len(revision_specs) > 1:
332
new_revision_spec = revision_specs[1]
334
if old_revision_spec is None:
335
old_tree = tree.basis_tree()
337
old_tree = spec_tree(old_revision_spec)
339
if (new_revision_spec is None
340
or new_revision_spec.spec is None):
343
new_tree = spec_tree(new_revision_spec)
345
if new_tree is not tree:
346
extra_trees = (tree,)
350
return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
351
external_diff_options,
352
old_label=old_label, new_label=new_label,
353
extra_trees=extra_trees)
356
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url):
328
357
"""Get the trees and specific files to diff given a list of paths.
330
359
This method works out the trees to be diff'ed and the files of
342
371
The url of the new branch or tree. If None, the tree to use is
343
372
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
374
a tuple of (old_tree, new_tree, specific_files, extra_trees) where
375
extra_trees is a sequence of additional trees to search in for
357
378
# Get the old and new revision specs
358
379
old_revision_spec = None
381
402
default_location = path_list[0]
382
403
other_paths = path_list[1:]
384
def lock_tree_or_branch(wt, br):
387
add_cleanup(wt.unlock)
390
add_cleanup(br.unlock)
392
405
# Get the old location
393
406
specific_files = []
394
407
if old_url is None:
395
408
old_url = default_location
396
409
working_tree, branch, relpath = \
397
410
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
398
lock_tree_or_branch(working_tree, branch)
399
411
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
412
specific_files.append(relpath)
403
413
old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
406
415
# Get the new location
407
416
if new_url is None:
409
418
if new_url != old_url:
410
419
working_tree, branch, relpath = \
411
420
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
412
lock_tree_or_branch(working_tree, branch)
413
421
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
422
specific_files.append(relpath)
417
423
new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
418
424
basis_is_default=working_tree is None)
421
426
# Get the specific files (all files is None, no files is [])
422
427
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")
428
other_paths = _relative_paths_in_tree(working_tree, other_paths)
429
429
specific_files.extend(other_paths)
430
430
if len(specific_files) == 0:
431
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
433
# Get extra trees that ought to be searched for file-ids
441
434
extra_trees = None
442
435
if working_tree is not None and working_tree not in (old_tree, new_tree):
443
436
extra_trees = (working_tree,)
444
return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
437
return old_tree, new_tree, specific_files, extra_trees
447
440
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
455
448
return branch.basis_tree()
458
return spec.as_tree(branch)
451
if not spec.needs_branch():
452
branch = _mod_branch.Branch.open(spec.get_branch())
453
revision_id = spec.as_revision_id(branch)
454
return branch.repository.revision_tree(revision_id)
457
def _relative_paths_in_tree(tree, paths):
458
"""Get the relative paths within a working tree.
460
Each path may be either an absolute path or a path relative to the
461
current working directory.
464
for filename in paths:
466
result.append(tree.relpath(osutils.dereference_path(filename)))
467
except errors.PathNotChild:
468
raise errors.BzrCommandError("Files are in different branches")
461
472
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
463
474
old_label='a/', new_label='b/',
464
475
extra_trees=None,
465
476
path_encoding='utf8',
468
478
"""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)
484
Include only changes to these files - None for all changes.
486
external_diff_options
487
If set, use an external GNU diff and pass these options.
490
If set, more Trees to use for looking up file ids
493
If set, the path will be encoded as specified, otherwise is supposed
480
if format_cls is None:
481
format_cls = DiffTree
482
496
old_tree.lock_read()
484
498
if extra_trees is not None:
503
517
def _patch_header_date(tree, file_id, path):
504
518
"""Returns a timestamp suitable for use in a patch header."""
506
mtime = tree.get_file_mtime(file_id, path)
507
except errors.FileTimestampUnavailable:
519
mtime = tree.get_file_mtime(file_id, path)
520
assert mtime is not None, \
521
"got an mtime of None for file-id %s, path %s in tree %s" % (
509
523
return timestamp.format_patch_date(mtime)
526
def _raise_if_nonexistent(paths, old_tree, new_tree):
527
"""Complain if paths are not in either inventory or tree.
529
It's OK with the files exist in either tree's inventory, or
530
if they exist in the tree but are not versioned.
532
This can be used by operations such as bzr status that can accept
533
unknown or ignored files.
535
mutter("check paths: %r", paths)
538
s = old_tree.filter_unversioned_files(paths)
539
s = new_tree.filter_unversioned_files(s)
540
s = [path for path in s if not new_tree.has_filename(path)]
542
raise errors.PathsDoNotExist(sorted(s))
545
@deprecated_function(one_three)
546
def get_prop_change(meta_modified):
548
return " (properties changed)"
512
552
def get_executable_change(old_is_x, new_is_x):
513
553
descr = { True:"+x", False:"-x", None:"??" }
514
554
if old_is_x != new_is_x:
689
729
return self.CANNOT_DIFF
690
730
from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
691
731
to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
692
return self.diff_text(from_file_id, to_file_id, from_label, to_label,
732
return self.diff_text(from_file_id, to_file_id, from_label, to_label)
695
def diff_text(self, from_file_id, to_file_id, from_label, to_label,
696
from_path=None, to_path=None):
734
def diff_text(self, from_file_id, to_file_id, from_label, to_label):
697
735
"""Diff the content of given files in two trees
699
737
:param from_file_id: The id of the file in the from tree. If None,
701
739
:param to_file_id: The id of the file in the to tree. This may refer
702
740
to a different file from from_file_id. If None,
703
741
the file is not present in the to tree.
704
:param from_path: The path in the from tree or None if unknown.
705
:param to_path: The path in the to tree or None if unknown.
707
def _get_text(tree, file_id, path):
743
def _get_text(tree, file_id):
708
744
if file_id is not None:
709
return tree.get_file(file_id, path).readlines()
745
return tree.get_file(file_id).readlines()
713
from_text = _get_text(self.old_tree, from_file_id, from_path)
714
to_text = _get_text(self.new_tree, to_file_id, to_path)
749
from_text = _get_text(self.old_tree, from_file_id)
750
to_text = _get_text(self.new_tree, to_file_id)
715
751
self.text_differ(from_label, from_text, to_label, to_text,
717
753
except errors.BinaryFile:
727
763
path_encoding='utf-8'):
728
764
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
729
765
self.command_template = command_template
730
self._root = osutils.mkdtemp(prefix='bzr-diff-')
766
self._root = tempfile.mkdtemp(prefix='bzr-diff-')
733
769
def from_string(klass, command_string, old_tree, new_tree, to_file,
734
770
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'])
771
command_template = commands.shlex_split_unicode(command_string)
772
command_template.extend(['%(old_path)s', '%(new_path)s'])
738
773
return klass(command_template, old_tree, new_tree, to_file,
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))
811
def _write_file(self, file_id, tree, prefix, relpath):
782
812
full_path = osutils.pathjoin(self._root, prefix, relpath)
783
if not force_temp and self._try_symlink_root(tree, prefix):
813
if self._try_symlink_root(tree, prefix):
785
815
parent_dir = osutils.dirname(full_path)
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)
830
osutils.make_readonly(full_path)
831
mtime = tree.get_file_mtime(file_id)
832
os.utime(full_path, (mtime, mtime))
810
def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
811
allow_write_new=False):
835
def _prepare_files(self, file_id, old_path, new_path):
812
836
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
813
old_path, force_temp)
814
838
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
815
new_path, force_temp,
816
allow_write=allow_write_new)
817
840
return old_disk_path, new_disk_path
819
842
def finish(self):
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))
843
osutils.rmtree(self._root)
827
845
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
828
846
if (old_kind, new_kind) != ('file', 'file'):
829
847
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()
848
self._prepare_files(file_id, old_path, new_path)
849
self._execute(osutils.pathjoin('old', old_path),
850
osutils.pathjoin('new', new_path))
858
853
class DiffTree(object):
960
956
return path.encode(self.path_encoding, "replace")
961
957
for (file_id, paths, changed_content, versioned, parent, name, kind,
962
958
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):
959
if parent == (None, None):
967
961
oldpath, newpath = paths
968
962
oldpath_encoded = get_encoded_path(paths[0])
added
removed
bzrlib/diff.py
