287
def get_trees_and_branches_to_diff_locked(
288
path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
289
"""Get the trees and specific files to diff given a list of paths.
291
This method works out the trees to be diff'ed and the files of
292
interest within those trees.
295
the list of arguments passed to the diff command
296
:param revision_specs:
297
Zero, one or two RevisionSpecs from the diff command line,
298
saying what revisions to compare.
300
The url of the old branch or tree. If None, the tree to use is
301
taken from the first path, if any, or the current working tree.
303
The url of the new branch or tree. If None, the tree to use is
304
taken from the first path, if any, or the current working tree.
306
a callable like Command.add_cleanup. get_trees_and_branches_to_diff
307
will register cleanups that must be run to unlock the trees, etc.
309
if True and a view is set, apply the view or check that the paths
312
a tuple of (old_tree, new_tree, old_branch, new_branch,
313
specific_files, extra_trees) where extra_trees is a sequence of
314
additional trees to search in for file-ids. The trees and branches
315
will be read-locked until the cleanups registered via the add_cleanup
318
# Get the old and new revision specs
319
old_revision_spec = None
320
new_revision_spec = None
264
@deprecated_function(zero_eight)
265
def show_diff(b, from_spec, specific_files, external_diff_options=None,
266
revision2=None, output=None, b2=None):
267
"""Shortcut for showing the diff to the working tree.
269
Please use show_diff_trees instead.
275
None for 'basis tree', or otherwise the old revision to compare against.
277
The more general form is show_diff_trees(), where the caller
278
supplies any two trees.
283
if from_spec is None:
284
old_tree = b.bzrdir.open_workingtree()
286
old_tree = old_tree = old_tree.basis_tree()
288
old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
290
if revision2 is None:
292
new_tree = b.bzrdir.open_workingtree()
294
new_tree = b2.bzrdir.open_workingtree()
296
new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
298
return show_diff_trees(old_tree, new_tree, output, specific_files,
299
external_diff_options)
302
def diff_cmd_helper(tree, specific_files, external_diff_options,
303
old_revision_spec=None, new_revision_spec=None,
305
old_label='a/', new_label='b/'):
306
"""Helper for cmd_diff.
311
:param specific_files:
312
The specific files to compare, or None
314
:param external_diff_options:
315
If non-None, run an external diff, and pass it these options
317
:param old_revision_spec:
318
If None, use basis tree as old revision, otherwise use the tree for
319
the specified revision.
321
:param new_revision_spec:
322
If None, use working tree as new revision, otherwise use the tree for
323
the specified revision.
325
:param revision_specs:
326
Zero, one or two RevisionSpecs from the command line, saying what revisions
327
to compare. This can be passed as an alternative to the old_revision_spec
328
and new_revision_spec parameters.
330
The more general form is show_diff_trees(), where the caller
331
supplies any two trees.
334
# TODO: perhaps remove the old parameters old_revision_spec and
335
# new_revision_spec, since this is only really for use from cmd_diff and
336
# it now always passes through a sequence of revision_specs -- mbp
341
revision = spec.in_store(tree.branch)
343
revision = spec.in_store(None)
344
revision_id = revision.rev_id
345
branch = revision.branch
346
return branch.repository.revision_tree(revision_id)
321
348
if revision_specs is not None:
349
assert (old_revision_spec is None
350
and new_revision_spec is None)
322
351
if len(revision_specs) > 0:
323
352
old_revision_spec = revision_specs[0]
325
old_url = old_revision_spec.get_branch()
326
353
if len(revision_specs) > 1:
327
354
new_revision_spec = revision_specs[1]
329
new_url = new_revision_spec.get_branch()
332
make_paths_wt_relative = True
333
consider_relpath = True
334
if path_list is None or len(path_list) == 0:
335
# If no path is given, the current working tree is used
336
default_location = u'.'
337
consider_relpath = False
338
elif old_url is not None and new_url is not None:
339
other_paths = path_list
340
make_paths_wt_relative = False
342
default_location = path_list[0]
343
other_paths = path_list[1:]
345
def lock_tree_or_branch(wt, br):
348
add_cleanup(wt.unlock)
351
add_cleanup(br.unlock)
353
# Get the old location
356
old_url = default_location
357
working_tree, branch, relpath = \
358
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
359
lock_tree_or_branch(working_tree, branch)
360
if consider_relpath and relpath != '':
361
if working_tree is not None and apply_view:
362
views.check_path_in_view(working_tree, relpath)
363
specific_files.append(relpath)
364
old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
367
# Get the new location
369
new_url = default_location
370
if new_url != old_url:
371
working_tree, branch, relpath = \
372
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
373
lock_tree_or_branch(working_tree, branch)
374
if consider_relpath and relpath != '':
375
if working_tree is not None and apply_view:
376
views.check_path_in_view(working_tree, relpath)
377
specific_files.append(relpath)
378
new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
379
basis_is_default=working_tree is None)
382
# Get the specific files (all files is None, no files is [])
383
if make_paths_wt_relative and working_tree is not None:
384
other_paths = working_tree.safe_relpath_files(
386
apply_view=apply_view)
387
specific_files.extend(other_paths)
388
if len(specific_files) == 0:
389
specific_files = None
390
if (working_tree is not None and working_tree.supports_views()
392
view_files = working_tree.views.lookup_view()
394
specific_files = view_files
395
view_str = views.view_display_str(view_files)
396
note("*** Ignoring files outside view. View is %s" % view_str)
398
# Get extra trees that ought to be searched for file-ids
400
if working_tree is not None and working_tree not in (old_tree, new_tree):
401
extra_trees = (working_tree,)
402
return (old_tree, new_tree, old_branch, new_branch,
403
specific_files, extra_trees)
406
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
407
if branch is None and tree is not None:
409
if spec is None or spec.spec is None:
412
return tree.basis_tree()
414
return branch.basis_tree()
417
return spec.as_tree(branch)
356
if old_revision_spec is None:
357
old_tree = tree.basis_tree()
359
old_tree = spec_tree(old_revision_spec)
361
if (new_revision_spec is None
362
or new_revision_spec.spec is None):
365
new_tree = spec_tree(new_revision_spec)
367
if new_tree is not tree:
368
extra_trees = (tree,)
372
return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
373
external_diff_options,
374
old_label=old_label, new_label=new_label,
375
extra_trees=extra_trees)
420
378
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
421
379
external_diff_options=None,
422
380
old_label='a/', new_label='b/',
424
path_encoding='utf8',
427
382
"""Show in text form the changes from one tree to another.
429
:param to_file: The output stream.
430
:param specific_files: Include only changes to these files - None for all
432
:param external_diff_options: If set, use an external GNU diff and pass
434
:param extra_trees: If set, more Trees to use for looking up file ids
435
:param path_encoding: If set, the path will be encoded as specified,
436
otherwise is supposed to be utf8
437
:param format_cls: Formatter class (DiffTree subclass)
385
If set, include only changes to these files.
387
external_diff_options
388
If set, use an external GNU diff and pass these options.
391
If set, more Trees to use for looking up file ids
439
if format_cls is None:
440
format_cls = DiffTree
441
393
old_tree.lock_read()
443
395
if extra_trees is not None:
459
410
old_tree.unlock()
413
def _show_diff_trees(old_tree, new_tree, to_file,
414
specific_files, external_diff_options,
415
old_label='a/', new_label='b/', extra_trees=None):
417
# GNU Patch uses the epoch date to detect files that are being added
418
# or removed in a diff.
419
EPOCH_DATE = '1970-01-01 00:00:00 +0000'
421
# TODO: Generation of pseudo-diffs for added/deleted files could
422
# be usefully made into a much faster special case.
424
if external_diff_options:
425
assert isinstance(external_diff_options, basestring)
426
opts = external_diff_options.split()
427
def diff_file(olab, olines, nlab, nlines, to_file):
428
external_diff(olab, olines, nlab, nlines, to_file, opts)
430
diff_file = internal_diff
432
delta = new_tree.changes_from(old_tree,
433
specific_files=specific_files,
434
extra_trees=extra_trees, require_versioned=True)
437
for path, file_id, kind in delta.removed:
439
print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
440
old_name = '%s%s\t%s' % (old_label, path,
441
_patch_header_date(old_tree, file_id, path))
442
new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
443
old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
444
new_name, None, None, to_file)
445
for path, file_id, kind in delta.added:
447
print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
448
old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
449
new_name = '%s%s\t%s' % (new_label, path,
450
_patch_header_date(new_tree, file_id, path))
451
new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
452
old_name, None, None, to_file,
454
for (old_path, new_path, file_id, kind,
455
text_modified, meta_modified) in delta.renamed:
457
prop_str = get_prop_change(meta_modified)
458
print >>to_file, '=== renamed %s %r => %r%s' % (
459
kind, old_path.encode('utf8'),
460
new_path.encode('utf8'), prop_str)
461
old_name = '%s%s\t%s' % (old_label, old_path,
462
_patch_header_date(old_tree, file_id,
464
new_name = '%s%s\t%s' % (new_label, new_path,
465
_patch_header_date(new_tree, file_id,
467
_maybe_diff_file_or_symlink(old_name, old_tree, file_id,
469
text_modified, kind, to_file, diff_file)
470
for path, file_id, kind, text_modified, meta_modified in delta.modified:
472
prop_str = get_prop_change(meta_modified)
473
print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
474
# The file may be in a different location in the old tree (because
475
# the containing dir was renamed, but the file itself was not)
476
old_path = old_tree.id2path(file_id)
477
old_name = '%s%s\t%s' % (old_label, old_path,
478
_patch_header_date(old_tree, file_id, old_path))
479
new_name = '%s%s\t%s' % (new_label, path,
480
_patch_header_date(new_tree, file_id, path))
482
_maybe_diff_file_or_symlink(old_name, old_tree, file_id,
484
True, kind, to_file, diff_file)
462
489
def _patch_header_date(tree, file_id, path):
463
490
"""Returns a timestamp suitable for use in a patch header."""
465
mtime = tree.get_file_mtime(file_id, path)
466
except errors.FileTimestampUnavailable:
491
mtime = tree.get_file_mtime(file_id, path)
492
assert mtime is not None, \
493
"got an mtime of None for file-id %s, path %s in tree %s" % (
468
495
return timestamp.format_patch_date(mtime)
471
def get_executable_change(old_is_x, new_is_x):
472
descr = { True:"+x", False:"-x", None:"??" }
473
if old_is_x != new_is_x:
474
return ["%s to %s" % (descr[old_is_x], descr[new_is_x],)]
498
def _raise_if_nonexistent(paths, old_tree, new_tree):
499
"""Complain if paths are not in either inventory or tree.
501
It's OK with the files exist in either tree's inventory, or
502
if they exist in the tree but are not versioned.
504
This can be used by operations such as bzr status that can accept
505
unknown or ignored files.
507
mutter("check paths: %r", paths)
510
s = old_tree.filter_unversioned_files(paths)
511
s = new_tree.filter_unversioned_files(s)
512
s = [path for path in s if not new_tree.has_filename(path)]
514
raise errors.PathsDoNotExist(sorted(s))
517
def get_prop_change(meta_modified):
519
return " (properties changed)"
479
class DiffPath(object):
480
"""Base type for command object that compare files"""
482
# The type or contents of the file were unsuitable for diffing
483
CANNOT_DIFF = 'CANNOT_DIFF'
484
# The file has changed in a semantic way
486
# The file content may have changed, but there is no semantic change
487
UNCHANGED = 'UNCHANGED'
489
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8'):
492
:param old_tree: The tree to show as the old tree in the comparison
493
:param new_tree: The tree to show as new in the comparison
494
:param to_file: The file to write comparison data to
495
:param path_encoding: The character encoding to write paths in
497
self.old_tree = old_tree
498
self.new_tree = new_tree
499
self.to_file = to_file
500
self.path_encoding = path_encoding
506
def from_diff_tree(klass, diff_tree):
507
return klass(diff_tree.old_tree, diff_tree.new_tree,
508
diff_tree.to_file, diff_tree.path_encoding)
511
def _diff_many(differs, file_id, old_path, new_path, old_kind, new_kind):
512
for file_differ in differs:
513
result = file_differ.diff(file_id, old_path, new_path, old_kind,
515
if result is not DiffPath.CANNOT_DIFF:
518
return DiffPath.CANNOT_DIFF
521
class DiffKindChange(object):
522
"""Special differ for file kind changes.
524
Represents kind change as deletion + creation. Uses the other differs
527
def __init__(self, differs):
528
self.differs = differs
534
def from_diff_tree(klass, diff_tree):
535
return klass(diff_tree.differs)
537
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
538
"""Perform comparison
540
:param file_id: The file_id of the file to compare
541
:param old_path: Path of the file in the old tree
542
:param new_path: Path of the file in the new tree
543
:param old_kind: Old file-kind of the file
544
:param new_kind: New file-kind of the file
546
if None in (old_kind, new_kind):
547
return DiffPath.CANNOT_DIFF
548
result = DiffPath._diff_many(self.differs, file_id, old_path,
549
new_path, old_kind, None)
550
if result is DiffPath.CANNOT_DIFF:
552
return DiffPath._diff_many(self.differs, file_id, old_path, new_path,
556
class DiffDirectory(DiffPath):
558
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
559
"""Perform comparison between two directories. (dummy)
562
if 'directory' not in (old_kind, new_kind):
563
return self.CANNOT_DIFF
564
if old_kind not in ('directory', None):
565
return self.CANNOT_DIFF
566
if new_kind not in ('directory', None):
567
return self.CANNOT_DIFF
571
class DiffSymlink(DiffPath):
573
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
574
"""Perform comparison between two symlinks
576
:param file_id: The file_id of the file to compare
577
:param old_path: Path of the file in the old tree
578
:param new_path: Path of the file in the new tree
579
:param old_kind: Old file-kind of the file
580
:param new_kind: New file-kind of the file
582
if 'symlink' not in (old_kind, new_kind):
583
return self.CANNOT_DIFF
584
if old_kind == 'symlink':
585
old_target = self.old_tree.get_symlink_target(file_id)
586
elif old_kind is None:
589
return self.CANNOT_DIFF
590
if new_kind == 'symlink':
591
new_target = self.new_tree.get_symlink_target(file_id)
592
elif new_kind is None:
595
return self.CANNOT_DIFF
596
return self.diff_symlink(old_target, new_target)
598
def diff_symlink(self, old_target, new_target):
599
if old_target is None:
600
self.to_file.write('=== target is %r\n' % new_target)
601
elif new_target is None:
602
self.to_file.write('=== target was %r\n' % old_target)
604
self.to_file.write('=== target changed %r => %r\n' %
605
(old_target, new_target))
609
class DiffText(DiffPath):
611
# GNU Patch uses the epoch date to detect files that are being added
612
# or removed in a diff.
613
EPOCH_DATE = '1970-01-01 00:00:00 +0000'
615
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
616
old_label='', new_label='', text_differ=internal_diff):
617
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
618
self.text_differ = text_differ
619
self.old_label = old_label
620
self.new_label = new_label
621
self.path_encoding = path_encoding
623
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
624
"""Compare two files in unified diff format
626
:param file_id: The file_id of the file to compare
627
:param old_path: Path of the file in the old tree
628
:param new_path: Path of the file in the new tree
629
:param old_kind: Old file-kind of the file
630
:param new_kind: New file-kind of the file
632
if 'file' not in (old_kind, new_kind):
633
return self.CANNOT_DIFF
634
from_file_id = to_file_id = file_id
635
if old_kind == 'file':
636
old_date = _patch_header_date(self.old_tree, file_id, old_path)
637
elif old_kind is None:
638
old_date = self.EPOCH_DATE
641
return self.CANNOT_DIFF
642
if new_kind == 'file':
643
new_date = _patch_header_date(self.new_tree, file_id, new_path)
644
elif new_kind is None:
645
new_date = self.EPOCH_DATE
648
return self.CANNOT_DIFF
649
from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
650
to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
651
return self.diff_text(from_file_id, to_file_id, from_label, to_label,
654
def diff_text(self, from_file_id, to_file_id, from_label, to_label,
655
from_path=None, to_path=None):
656
"""Diff the content of given files in two trees
658
:param from_file_id: The id of the file in the from tree. If None,
659
the file is not present in the from tree.
660
:param to_file_id: The id of the file in the to tree. This may refer
661
to a different file from from_file_id. If None,
662
the file is not present in the to tree.
663
:param from_path: The path in the from tree or None if unknown.
664
:param to_path: The path in the to tree or None if unknown.
666
def _get_text(tree, file_id, path):
667
if file_id is not None:
668
return tree.get_file_lines(file_id, path)
672
from_text = _get_text(self.old_tree, from_file_id, from_path)
673
to_text = _get_text(self.new_tree, to_file_id, to_path)
674
self.text_differ(from_label, from_text, to_label, to_text,
675
self.to_file, path_encoding=self.path_encoding)
676
except errors.BinaryFile:
678
("Binary files %s and %s differ\n" %
679
(from_label, to_label)).encode(self.path_encoding,'replace'))
683
class DiffFromTool(DiffPath):
685
def __init__(self, command_template, old_tree, new_tree, to_file,
686
path_encoding='utf-8'):
687
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
688
self.command_template = command_template
689
self._root = osutils.mkdtemp(prefix='bzr-diff-')
692
def from_string(klass, command_string, old_tree, new_tree, to_file,
693
path_encoding='utf-8'):
694
command_template = cmdline.split(command_string)
695
if '@' not in command_string:
696
command_template.extend(['@old_path', '@new_path'])
697
return klass(command_template, old_tree, new_tree, to_file,
701
def make_from_diff_tree(klass, command_string, external_diff_options=None):
702
def from_diff_tree(diff_tree):
703
full_command_string = [command_string]
704
if external_diff_options is not None:
705
full_command_string += ' ' + external_diff_options
706
return klass.from_string(full_command_string, diff_tree.old_tree,
707
diff_tree.new_tree, diff_tree.to_file)
708
return from_diff_tree
710
def _get_command(self, old_path, new_path):
711
my_map = {'old_path': old_path, 'new_path': new_path}
712
command = [AtTemplate(t).substitute(my_map) for t in
713
self.command_template]
714
if sys.platform == 'win32': # Popen doesn't accept unicode on win32
717
if isinstance(c, unicode):
718
command_encoded.append(c.encode('mbcs'))
720
command_encoded.append(c)
721
return command_encoded
725
def _execute(self, old_path, new_path):
726
command = self._get_command(old_path, new_path)
728
proc = subprocess.Popen(command, stdout=subprocess.PIPE,
731
if e.errno == errno.ENOENT:
732
raise errors.ExecutableMissing(command[0])
735
self.to_file.write(proc.stdout.read())
738
def _try_symlink_root(self, tree, prefix):
739
if (getattr(tree, 'abspath', None) is None
740
or not osutils.host_os_dereferences_symlinks()):
743
os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
745
if e.errno != errno.EEXIST:
751
"""Returns safe encoding for passing file path to diff tool"""
752
if sys.platform == 'win32':
755
# Don't fallback to 'utf-8' because subprocess may not be able to
756
# handle utf-8 correctly when locale is not utf-8.
757
return sys.getfilesystemencoding() or 'ascii'
759
def _is_safepath(self, path):
760
"""Return true if `path` may be able to pass to subprocess."""
763
return path == path.encode(fenc).decode(fenc)
767
def _safe_filename(self, prefix, relpath):
768
"""Replace unsafe character in `relpath` then join `self._root`,
769
`prefix` and `relpath`."""
771
# encoded_str.replace('?', '_') may break multibyte char.
772
# So we should encode, decode, then replace(u'?', u'_')
773
relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
774
relpath_tmp = relpath_tmp.replace(u'?', u'_')
775
return osutils.pathjoin(self._root, prefix, relpath_tmp)
777
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
779
if not force_temp and isinstance(tree, WorkingTree):
780
full_path = tree.abspath(tree.id2path(file_id))
781
if self._is_safepath(full_path):
784
full_path = self._safe_filename(prefix, relpath)
785
if not force_temp and self._try_symlink_root(tree, prefix):
787
parent_dir = osutils.dirname(full_path)
789
os.makedirs(parent_dir)
791
if e.errno != errno.EEXIST:
793
source = tree.get_file(file_id, relpath)
795
target = open(full_path, 'wb')
797
osutils.pumpfile(source, target)
803
mtime = tree.get_file_mtime(file_id)
804
except errors.FileTimestampUnavailable:
807
os.utime(full_path, (mtime, mtime))
809
osutils.make_readonly(full_path)
812
def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
813
allow_write_new=False):
814
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
815
old_path, force_temp)
816
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
817
new_path, force_temp,
818
allow_write=allow_write_new)
819
return old_disk_path, new_disk_path
823
osutils.rmtree(self._root)
825
if e.errno != errno.ENOENT:
826
mutter("The temporary directory \"%s\" was not "
827
"cleanly removed: %s." % (self._root, e))
829
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
830
if (old_kind, new_kind) != ('file', 'file'):
831
return DiffPath.CANNOT_DIFF
832
(old_disk_path, new_disk_path) = self._prepare_files(
833
file_id, old_path, new_path)
834
self._execute(old_disk_path, new_disk_path)
836
def edit_file(self, file_id):
837
"""Use this tool to edit a file.
839
A temporary copy will be edited, and the new contents will be
842
:param file_id: The id of the file to edit.
843
:return: The new contents of the file.
845
old_path = self.old_tree.id2path(file_id)
846
new_path = self.new_tree.id2path(file_id)
847
old_abs_path, new_abs_path = self._prepare_files(
848
file_id, old_path, new_path,
849
allow_write_new=True,
851
command = self._get_command(old_abs_path, new_abs_path)
852
subprocess.call(command, cwd=self._root)
853
new_file = open(new_abs_path, 'rb')
855
return new_file.read()
860
class DiffTree(object):
861
"""Provides textual representations of the difference between two trees.
863
A DiffTree examines two trees and where a file-id has altered
864
between them, generates a textual representation of the difference.
865
DiffTree uses a sequence of DiffPath objects which are each
866
given the opportunity to handle a given altered fileid. The list
867
of DiffPath objects can be extended globally by appending to
868
DiffTree.diff_factories, or for a specific diff operation by
869
supplying the extra_factories option to the appropriate method.
872
# list of factories that can provide instances of DiffPath objects
873
# may be extended by plugins.
874
diff_factories = [DiffSymlink.from_diff_tree,
875
DiffDirectory.from_diff_tree]
877
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
878
diff_text=None, extra_factories=None):
881
:param old_tree: Tree to show as old in the comparison
882
:param new_tree: Tree to show as new in the comparison
883
:param to_file: File to write comparision to
884
:param path_encoding: Character encoding to write paths in
885
:param diff_text: DiffPath-type object to use as a last resort for
887
:param extra_factories: Factories of DiffPaths to try before any other
889
if diff_text is None:
890
diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
891
'', '', internal_diff)
892
self.old_tree = old_tree
893
self.new_tree = new_tree
894
self.to_file = to_file
895
self.path_encoding = path_encoding
897
if extra_factories is not None:
898
self.differs.extend(f(self) for f in extra_factories)
899
self.differs.extend(f(self) for f in self.diff_factories)
900
self.differs.extend([diff_text, DiffKindChange.from_diff_tree(self)])
903
def from_trees_options(klass, old_tree, new_tree, to_file,
904
path_encoding, external_diff_options, old_label,
906
"""Factory for producing a DiffTree.
908
Designed to accept options used by show_diff_trees.
910
:param old_tree: The tree to show as old in the comparison
911
:param new_tree: The tree to show as new in the comparison
912
:param to_file: File to write comparisons to
913
:param path_encoding: Character encoding to use for writing paths
914
:param external_diff_options: If supplied, use the installed diff
915
binary to perform file comparison, using supplied options.
916
:param old_label: Prefix to use for old file labels
917
:param new_label: Prefix to use for new file labels
918
:param using: Commandline to use to invoke an external diff tool
920
if using is not None:
921
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
924
if external_diff_options:
925
opts = external_diff_options.split()
926
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None):
927
""":param path_encoding: not used but required
928
to match the signature of internal_diff.
930
external_diff(olab, olines, nlab, nlines, to_file, opts)
932
diff_file = internal_diff
933
diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
934
old_label, new_label, diff_file)
935
return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
938
def show_diff(self, specific_files, extra_trees=None):
939
"""Write tree diff to self.to_file
941
:param specific_files: the specific files to compare (recursive)
942
:param extra_trees: extra trees to use for mapping paths to file_ids
945
return self._show_diff(specific_files, extra_trees)
947
for differ in self.differs:
950
def _show_diff(self, specific_files, extra_trees):
951
# TODO: Generation of pseudo-diffs for added/deleted files could
952
# be usefully made into a much faster special case.
953
iterator = self.new_tree.iter_changes(self.old_tree,
954
specific_files=specific_files,
955
extra_trees=extra_trees,
956
require_versioned=True)
958
def changes_key(change):
959
old_path, new_path = change[1]
964
def get_encoded_path(path):
966
return path.encode(self.path_encoding, "replace")
967
for (file_id, paths, changed_content, versioned, parent, name, kind,
968
executable) in sorted(iterator, key=changes_key):
969
# The root does not get diffed, and items with no known kind (that
970
# is, missing) in both trees are skipped as well.
971
if parent == (None, None) or kind == (None, None):
973
oldpath, newpath = paths
974
oldpath_encoded = get_encoded_path(paths[0])
975
newpath_encoded = get_encoded_path(paths[1])
976
old_present = (kind[0] is not None and versioned[0])
977
new_present = (kind[1] is not None and versioned[1])
978
renamed = (parent[0], name[0]) != (parent[1], name[1])
980
properties_changed = []
981
properties_changed.extend(get_executable_change(executable[0], executable[1]))
983
if properties_changed:
984
prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
988
if (old_present, new_present) == (True, False):
989
self.to_file.write("=== removed %s '%s'\n" %
990
(kind[0], oldpath_encoded))
992
elif (old_present, new_present) == (False, True):
993
self.to_file.write("=== added %s '%s'\n" %
994
(kind[1], newpath_encoded))
997
self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
998
(kind[0], oldpath_encoded, newpath_encoded, prop_str))
1000
# if it was produced by iter_changes, it must be
1001
# modified *somehow*, either content or execute bit.
1002
self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
1003
newpath_encoded, prop_str))
1005
self._diff(file_id, oldpath, newpath, kind[0], kind[1])
1011
def diff(self, file_id, old_path, new_path):
1012
"""Perform a diff of a single file
1014
:param file_id: file-id of the file
1015
:param old_path: The path of the file in the old tree
1016
:param new_path: The path of the file in the new tree
1019
old_kind = self.old_tree.kind(file_id)
1020
except (errors.NoSuchId, errors.NoSuchFile):
1023
new_kind = self.new_tree.kind(file_id)
1024
except (errors.NoSuchId, errors.NoSuchFile):
1026
self._diff(file_id, old_path, new_path, old_kind, new_kind)
1029
def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
1030
result = DiffPath._diff_many(self.differs, file_id, old_path,
1031
new_path, old_kind, new_kind)
1032
if result is DiffPath.CANNOT_DIFF:
1033
error_path = new_path
1034
if error_path is None:
1035
error_path = old_path
1036
raise errors.NoDiffFound(error_path)
1039
format_registry = Registry()
1040
format_registry.register('default', DiffTree)
524
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
525
new_path, new_tree, text_modified,
526
kind, to_file, diff_file):
528
new_entry = new_tree.inventory[file_id]
529
old_tree.inventory[file_id].diff(diff_file,
added
removed
bzrlib/diff.py
