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)
290
def get_trees_and_branches_to_diff_locked(
291
path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
292
"""Get the trees and specific files to diff given a list of paths.
294
This method works out the trees to be diff'ed and the files of
295
interest within those trees.
298
the list of arguments passed to the diff command
299
:param revision_specs:
300
Zero, one or two RevisionSpecs from the diff command line,
301
saying what revisions to compare.
303
The url of the old branch or tree. If None, the tree to use is
304
taken from the first path, if any, or the current working tree.
306
The url of the new branch or tree. If None, the tree to use is
307
taken from the first path, if any, or the current working tree.
309
a callable like Command.add_cleanup. get_trees_and_branches_to_diff
310
will register cleanups that must be run to unlock the trees, etc.
312
if True and a view is set, apply the view or check that the paths
315
a tuple of (old_tree, new_tree, old_branch, new_branch,
316
specific_files, extra_trees) where extra_trees is a sequence of
317
additional trees to search in for file-ids. The trees and branches
318
will be read-locked until the cleanups registered via the add_cleanup
321
# Get the old and new revision specs
322
old_revision_spec = None
323
new_revision_spec = None
348
324
if revision_specs is not None:
349
assert (old_revision_spec is None
350
and new_revision_spec is None)
351
325
if len(revision_specs) > 0:
352
326
old_revision_spec = revision_specs[0]
328
old_url = old_revision_spec.get_branch()
353
329
if len(revision_specs) > 1:
354
330
new_revision_spec = revision_specs[1]
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)
332
new_url = new_revision_spec.get_branch()
335
make_paths_wt_relative = True
336
consider_relpath = True
337
if path_list is None or len(path_list) == 0:
338
# If no path is given, the current working tree is used
339
default_location = u'.'
340
consider_relpath = False
341
elif old_url is not None and new_url is not None:
342
other_paths = path_list
343
make_paths_wt_relative = False
345
default_location = path_list[0]
346
other_paths = path_list[1:]
348
def lock_tree_or_branch(wt, br):
351
add_cleanup(wt.unlock)
354
add_cleanup(br.unlock)
356
# Get the old location
359
old_url = default_location
360
working_tree, branch, relpath = \
361
controldir.ControlDir.open_containing_tree_or_branch(old_url)
362
lock_tree_or_branch(working_tree, branch)
363
if consider_relpath and relpath != '':
364
if working_tree is not None and apply_view:
365
views.check_path_in_view(working_tree, relpath)
366
specific_files.append(relpath)
367
old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
370
# Get the new location
372
new_url = default_location
373
if new_url != old_url:
374
working_tree, branch, relpath = \
375
controldir.ControlDir.open_containing_tree_or_branch(new_url)
376
lock_tree_or_branch(working_tree, branch)
377
if consider_relpath and relpath != '':
378
if working_tree is not None and apply_view:
379
views.check_path_in_view(working_tree, relpath)
380
specific_files.append(relpath)
381
new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
382
basis_is_default=working_tree is None)
385
# Get the specific files (all files is None, no files is [])
386
if make_paths_wt_relative and working_tree is not None:
387
other_paths = working_tree.safe_relpath_files(
389
apply_view=apply_view)
390
specific_files.extend(other_paths)
391
if len(specific_files) == 0:
392
specific_files = None
393
if (working_tree is not None and working_tree.supports_views()
395
view_files = working_tree.views.lookup_view()
397
specific_files = view_files
398
view_str = views.view_display_str(view_files)
399
note(gettext("*** Ignoring files outside view. View is %s") % view_str)
401
# Get extra trees that ought to be searched for file-ids
403
if working_tree is not None and working_tree not in (old_tree, new_tree):
404
extra_trees = (working_tree,)
405
return (old_tree, new_tree, old_branch, new_branch,
406
specific_files, extra_trees)
409
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
410
if branch is None and tree is not None:
412
if spec is None or spec.spec is None:
415
return tree.basis_tree()
417
return branch.basis_tree()
420
return spec.as_tree(branch)
378
423
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
379
424
external_diff_options=None,
380
425
old_label='a/', new_label='b/',
427
path_encoding='utf8',
382
430
"""Show in text form the changes from one tree to another.
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
432
:param to_file: The output stream.
433
:param specific_files: Include only changes to these files - None for all
435
:param external_diff_options: If set, use an external GNU diff and pass
437
:param extra_trees: If set, more Trees to use for looking up file ids
438
:param path_encoding: If set, the path will be encoded as specified,
439
otherwise is supposed to be utf8
440
:param format_cls: Formatter class (DiffTree subclass)
442
if format_cls is None:
443
format_cls = DiffTree
393
444
old_tree.lock_read()
395
446
if extra_trees is not None:
410
462
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):
465
def _patch_header_date(tree, file_id, path):
466
"""Returns a timestamp suitable for use in a patch header."""
468
mtime = tree.get_file_mtime(file_id, path)
469
except errors.FileTimestampUnavailable:
471
return timestamp.format_patch_date(mtime)
474
def get_executable_change(old_is_x, new_is_x):
475
descr = { True:"+x", False:"-x", None:"??" }
476
if old_is_x != new_is_x:
477
return ["%s to %s" % (descr[old_is_x], descr[new_is_x],)]
482
class DiffPath(object):
483
"""Base type for command object that compare files"""
485
# The type or contents of the file were unsuitable for diffing
486
CANNOT_DIFF = 'CANNOT_DIFF'
487
# The file has changed in a semantic way
489
# The file content may have changed, but there is no semantic change
490
UNCHANGED = 'UNCHANGED'
492
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8'):
495
:param old_tree: The tree to show as the old tree in the comparison
496
:param new_tree: The tree to show as new in the comparison
497
:param to_file: The file to write comparison data to
498
:param path_encoding: The character encoding to write paths in
500
self.old_tree = old_tree
501
self.new_tree = new_tree
502
self.to_file = to_file
503
self.path_encoding = path_encoding
509
def from_diff_tree(klass, diff_tree):
510
return klass(diff_tree.old_tree, diff_tree.new_tree,
511
diff_tree.to_file, diff_tree.path_encoding)
514
def _diff_many(differs, file_id, old_path, new_path, old_kind, new_kind):
515
for file_differ in differs:
516
result = file_differ.diff(file_id, old_path, new_path, old_kind,
518
if result is not DiffPath.CANNOT_DIFF:
521
return DiffPath.CANNOT_DIFF
524
class DiffKindChange(object):
525
"""Special differ for file kind changes.
527
Represents kind change as deletion + creation. Uses the other differs
530
def __init__(self, differs):
531
self.differs = differs
537
def from_diff_tree(klass, diff_tree):
538
return klass(diff_tree.differs)
540
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
541
"""Perform comparison
543
:param file_id: The file_id of the file to compare
544
:param old_path: Path of the file in the old tree
545
:param new_path: Path of the file in the new tree
546
:param old_kind: Old file-kind of the file
547
:param new_kind: New file-kind of the file
549
if None in (old_kind, new_kind):
550
return DiffPath.CANNOT_DIFF
551
result = DiffPath._diff_many(self.differs, file_id, old_path,
552
new_path, old_kind, None)
553
if result is DiffPath.CANNOT_DIFF:
555
return DiffPath._diff_many(self.differs, file_id, old_path, new_path,
559
class DiffDirectory(DiffPath):
561
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
562
"""Perform comparison between two directories. (dummy)
565
if 'directory' not in (old_kind, new_kind):
566
return self.CANNOT_DIFF
567
if old_kind not in ('directory', None):
568
return self.CANNOT_DIFF
569
if new_kind not in ('directory', None):
570
return self.CANNOT_DIFF
574
class DiffSymlink(DiffPath):
576
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
577
"""Perform comparison between two symlinks
579
:param file_id: The file_id of the file to compare
580
:param old_path: Path of the file in the old tree
581
:param new_path: Path of the file in the new tree
582
:param old_kind: Old file-kind of the file
583
:param new_kind: New file-kind of the file
585
if 'symlink' not in (old_kind, new_kind):
586
return self.CANNOT_DIFF
587
if old_kind == 'symlink':
588
old_target = self.old_tree.get_symlink_target(file_id)
589
elif old_kind is None:
592
return self.CANNOT_DIFF
593
if new_kind == 'symlink':
594
new_target = self.new_tree.get_symlink_target(file_id)
595
elif new_kind is None:
598
return self.CANNOT_DIFF
599
return self.diff_symlink(old_target, new_target)
601
def diff_symlink(self, old_target, new_target):
602
if old_target is None:
603
self.to_file.write('=== target is %r\n' % new_target)
604
elif new_target is None:
605
self.to_file.write('=== target was %r\n' % old_target)
607
self.to_file.write('=== target changed %r => %r\n' %
608
(old_target, new_target))
612
class DiffText(DiffPath):
417
614
# GNU Patch uses the epoch date to detect files that are being added
418
615
# or removed in a diff.
419
616
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)
489
def _patch_header_date(tree, file_id, path):
490
"""Returns a timestamp suitable for use in a patch header."""
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" % (
495
return timestamp.format_patch_date(mtime)
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.
618
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
619
old_label='', new_label='', text_differ=internal_diff):
620
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
621
self.text_differ = text_differ
622
self.old_label = old_label
623
self.new_label = new_label
624
self.path_encoding = path_encoding
626
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
627
"""Compare two files in unified diff format
629
:param file_id: The file_id of the file to compare
630
:param old_path: Path of the file in the old tree
631
:param new_path: Path of the file in the new tree
632
:param old_kind: Old file-kind of the file
633
:param new_kind: New file-kind of the file
635
if 'file' not in (old_kind, new_kind):
636
return self.CANNOT_DIFF
637
from_file_id = to_file_id = file_id
638
if old_kind == 'file':
639
old_date = _patch_header_date(self.old_tree, file_id, old_path)
640
elif old_kind is None:
641
old_date = self.EPOCH_DATE
644
return self.CANNOT_DIFF
645
if new_kind == 'file':
646
new_date = _patch_header_date(self.new_tree, file_id, new_path)
647
elif new_kind is None:
648
new_date = self.EPOCH_DATE
651
return self.CANNOT_DIFF
652
from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
653
to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
654
return self.diff_text(from_file_id, to_file_id, from_label, to_label,
657
def diff_text(self, from_file_id, to_file_id, from_label, to_label,
658
from_path=None, to_path=None):
659
"""Diff the content of given files in two trees
661
:param from_file_id: The id of the file in the from tree. If None,
662
the file is not present in the from tree.
663
:param to_file_id: The id of the file in the to tree. This may refer
664
to a different file from from_file_id. If None,
665
the file is not present in the to tree.
666
:param from_path: The path in the from tree or None if unknown.
667
:param to_path: The path in the to tree or None if unknown.
669
def _get_text(tree, file_id, path):
670
if file_id is not None:
671
return tree.get_file_lines(file_id, path)
675
from_text = _get_text(self.old_tree, from_file_id, from_path)
676
to_text = _get_text(self.new_tree, to_file_id, to_path)
677
self.text_differ(from_label, from_text, to_label, to_text,
678
self.to_file, path_encoding=self.path_encoding)
679
except errors.BinaryFile:
681
("Binary files %s and %s differ\n" %
682
(from_label, to_label)).encode(self.path_encoding,'replace'))
686
class DiffFromTool(DiffPath):
688
def __init__(self, command_template, old_tree, new_tree, to_file,
689
path_encoding='utf-8'):
690
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
691
self.command_template = command_template
692
self._root = osutils.mkdtemp(prefix='bzr-diff-')
695
def from_string(klass, command_string, old_tree, new_tree, to_file,
696
path_encoding='utf-8'):
697
command_template = cmdline.split(command_string)
698
if '@' not in command_string:
699
command_template.extend(['@old_path', '@new_path'])
700
return klass(command_template, old_tree, new_tree, to_file,
704
def make_from_diff_tree(klass, command_string, external_diff_options=None):
705
def from_diff_tree(diff_tree):
706
full_command_string = [command_string]
707
if external_diff_options is not None:
708
full_command_string += ' ' + external_diff_options
709
return klass.from_string(full_command_string, diff_tree.old_tree,
710
diff_tree.new_tree, diff_tree.to_file)
711
return from_diff_tree
713
def _get_command(self, old_path, new_path):
714
my_map = {'old_path': old_path, 'new_path': new_path}
715
command = [AtTemplate(t).substitute(my_map) for t in
716
self.command_template]
717
if sys.platform == 'win32': # Popen doesn't accept unicode on win32
720
if isinstance(c, unicode):
721
command_encoded.append(c.encode('mbcs'))
723
command_encoded.append(c)
724
return command_encoded
728
def _execute(self, old_path, new_path):
729
command = self._get_command(old_path, new_path)
731
proc = subprocess.Popen(command, stdout=subprocess.PIPE,
734
if e.errno == errno.ENOENT:
735
raise errors.ExecutableMissing(command[0])
738
self.to_file.write(proc.stdout.read())
741
def _try_symlink_root(self, tree, prefix):
742
if (getattr(tree, 'abspath', None) is None
743
or not osutils.host_os_dereferences_symlinks()):
746
os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
748
if e.errno != errno.EEXIST:
754
"""Returns safe encoding for passing file path to diff tool"""
755
if sys.platform == 'win32':
758
# Don't fallback to 'utf-8' because subprocess may not be able to
759
# handle utf-8 correctly when locale is not utf-8.
760
return sys.getfilesystemencoding() or 'ascii'
762
def _is_safepath(self, path):
763
"""Return true if `path` may be able to pass to subprocess."""
766
return path == path.encode(fenc).decode(fenc)
770
def _safe_filename(self, prefix, relpath):
771
"""Replace unsafe character in `relpath` then join `self._root`,
772
`prefix` and `relpath`."""
774
# encoded_str.replace('?', '_') may break multibyte char.
775
# So we should encode, decode, then replace(u'?', u'_')
776
relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
777
relpath_tmp = relpath_tmp.replace(u'?', u'_')
778
return osutils.pathjoin(self._root, prefix, relpath_tmp)
780
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
782
if not force_temp and isinstance(tree, WorkingTree):
783
full_path = tree.abspath(tree.id2path(file_id))
784
if self._is_safepath(full_path):
787
full_path = self._safe_filename(prefix, relpath)
788
if not force_temp and self._try_symlink_root(tree, prefix):
790
parent_dir = osutils.dirname(full_path)
792
os.makedirs(parent_dir)
794
if e.errno != errno.EEXIST:
796
source = tree.get_file(file_id, relpath)
798
target = open(full_path, 'wb')
800
osutils.pumpfile(source, target)
806
mtime = tree.get_file_mtime(file_id)
807
except errors.FileTimestampUnavailable:
810
os.utime(full_path, (mtime, mtime))
812
osutils.make_readonly(full_path)
815
def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
816
allow_write_new=False):
817
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
818
old_path, force_temp)
819
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
820
new_path, force_temp,
821
allow_write=allow_write_new)
822
return old_disk_path, new_disk_path
826
osutils.rmtree(self._root)
828
if e.errno != errno.ENOENT:
829
mutter("The temporary directory \"%s\" was not "
830
"cleanly removed: %s." % (self._root, e))
832
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
833
if (old_kind, new_kind) != ('file', 'file'):
834
return DiffPath.CANNOT_DIFF
835
(old_disk_path, new_disk_path) = self._prepare_files(
836
file_id, old_path, new_path)
837
self._execute(old_disk_path, new_disk_path)
839
def edit_file(self, file_id):
840
"""Use this tool to edit a file.
842
A temporary copy will be edited, and the new contents will be
845
:param file_id: The id of the file to edit.
846
:return: The new contents of the file.
848
old_path = self.old_tree.id2path(file_id)
849
new_path = self.new_tree.id2path(file_id)
850
old_abs_path, new_abs_path = self._prepare_files(
851
file_id, old_path, new_path,
852
allow_write_new=True,
854
command = self._get_command(old_abs_path, new_abs_path)
855
subprocess.call(command, cwd=self._root)
856
new_file = open(new_abs_path, 'rb')
858
return new_file.read()
863
class DiffTree(object):
864
"""Provides textual representations of the difference between two trees.
866
A DiffTree examines two trees and where a file-id has altered
867
between them, generates a textual representation of the difference.
868
DiffTree uses a sequence of DiffPath objects which are each
869
given the opportunity to handle a given altered fileid. The list
870
of DiffPath objects can be extended globally by appending to
871
DiffTree.diff_factories, or for a specific diff operation by
872
supplying the extra_factories option to the appropriate method.
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)"
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,
875
# list of factories that can provide instances of DiffPath objects
876
# may be extended by plugins.
877
diff_factories = [DiffSymlink.from_diff_tree,
878
DiffDirectory.from_diff_tree]
880
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
881
diff_text=None, extra_factories=None):
884
:param old_tree: Tree to show as old in the comparison
885
:param new_tree: Tree to show as new in the comparison
886
:param to_file: File to write comparision to
887
:param path_encoding: Character encoding to write paths in
888
:param diff_text: DiffPath-type object to use as a last resort for
890
:param extra_factories: Factories of DiffPaths to try before any other
892
if diff_text is None:
893
diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
894
'', '', internal_diff)
895
self.old_tree = old_tree
896
self.new_tree = new_tree
897
self.to_file = to_file
898
self.path_encoding = path_encoding
900
if extra_factories is not None:
901
self.differs.extend(f(self) for f in extra_factories)
902
self.differs.extend(f(self) for f in self.diff_factories)
903
self.differs.extend([diff_text, DiffKindChange.from_diff_tree(self)])
906
def from_trees_options(klass, old_tree, new_tree, to_file,
907
path_encoding, external_diff_options, old_label,
909
"""Factory for producing a DiffTree.
911
Designed to accept options used by show_diff_trees.
913
:param old_tree: The tree to show as old in the comparison
914
:param new_tree: The tree to show as new in the comparison
915
:param to_file: File to write comparisons to
916
:param path_encoding: Character encoding to use for writing paths
917
:param external_diff_options: If supplied, use the installed diff
918
binary to perform file comparison, using supplied options.
919
:param old_label: Prefix to use for old file labels
920
:param new_label: Prefix to use for new file labels
921
:param using: Commandline to use to invoke an external diff tool
923
if using is not None:
924
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
927
if external_diff_options:
928
opts = external_diff_options.split()
929
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None):
930
""":param path_encoding: not used but required
931
to match the signature of internal_diff.
933
external_diff(olab, olines, nlab, nlines, to_file, opts)
935
diff_file = internal_diff
936
diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
937
old_label, new_label, diff_file)
938
return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
941
def show_diff(self, specific_files, extra_trees=None):
942
"""Write tree diff to self.to_file
944
:param specific_files: the specific files to compare (recursive)
945
:param extra_trees: extra trees to use for mapping paths to file_ids
948
return self._show_diff(specific_files, extra_trees)
950
for differ in self.differs:
953
def _show_diff(self, specific_files, extra_trees):
954
# TODO: Generation of pseudo-diffs for added/deleted files could
955
# be usefully made into a much faster special case.
956
iterator = self.new_tree.iter_changes(self.old_tree,
957
specific_files=specific_files,
958
extra_trees=extra_trees,
959
require_versioned=True)
961
def changes_key(change):
962
old_path, new_path = change[1]
967
def get_encoded_path(path):
969
return path.encode(self.path_encoding, "replace")
970
for (file_id, paths, changed_content, versioned, parent, name, kind,
971
executable) in sorted(iterator, key=changes_key):
972
# The root does not get diffed, and items with no known kind (that
973
# is, missing) in both trees are skipped as well.
974
if parent == (None, None) or kind == (None, None):
976
oldpath, newpath = paths
977
oldpath_encoded = get_encoded_path(paths[0])
978
newpath_encoded = get_encoded_path(paths[1])
979
old_present = (kind[0] is not None and versioned[0])
980
new_present = (kind[1] is not None and versioned[1])
981
renamed = (parent[0], name[0]) != (parent[1], name[1])
983
properties_changed = []
984
properties_changed.extend(get_executable_change(executable[0], executable[1]))
986
if properties_changed:
987
prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
991
if (old_present, new_present) == (True, False):
992
self.to_file.write("=== removed %s '%s'\n" %
993
(kind[0], oldpath_encoded))
995
elif (old_present, new_present) == (False, True):
996
self.to_file.write("=== added %s '%s'\n" %
997
(kind[1], newpath_encoded))
1000
self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
1001
(kind[0], oldpath_encoded, newpath_encoded, prop_str))
1003
# if it was produced by iter_changes, it must be
1004
# modified *somehow*, either content or execute bit.
1005
self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
1006
newpath_encoded, prop_str))
1008
self._diff(file_id, oldpath, newpath, kind[0], kind[1])
1014
def diff(self, file_id, old_path, new_path):
1015
"""Perform a diff of a single file
1017
:param file_id: file-id of the file
1018
:param old_path: The path of the file in the old tree
1019
:param new_path: The path of the file in the new tree
1022
old_kind = self.old_tree.kind(file_id)
1023
except (errors.NoSuchId, errors.NoSuchFile):
1026
new_kind = self.new_tree.kind(file_id)
1027
except (errors.NoSuchId, errors.NoSuchFile):
1029
self._diff(file_id, old_path, new_path, old_kind, new_kind)
1032
def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
1033
result = DiffPath._diff_many(self.differs, file_id, old_path,
1034
new_path, old_kind, new_kind)
1035
if result is DiffPath.CANNOT_DIFF:
1036
error_path = new_path
1037
if error_path is None:
1038
error_path = old_path
1039
raise errors.NoDiffFound(error_path)
1042
format_registry = Registry()
1043
format_registry.register('default', DiffTree)
added
removed
bzrlib/diff.py
