202
125
diffcmd.append('-u')
205
128
diffcmd.extend(diff_opts)
207
pipe = _spawn_external_diff(diffcmd, capture_errors=True)
208
out,err = pipe.communicate()
211
# internal_diff() adds a trailing newline, add one here for consistency
214
# 'diff' gives retcode == 2 for all sorts of errors
215
# one of those is 'Binary files differ'.
216
# Bad options could also be the problem.
217
# 'Binary files' is not a real error, so we suppress that error.
220
# Since we got here, we want to make sure to give an i18n error
221
pipe = _spawn_external_diff(diffcmd, capture_errors=False)
222
out, err = pipe.communicate()
224
# Write out the new i18n diff response
225
to_file.write(out+'\n')
226
if pipe.returncode != 2:
227
raise errors.BzrError(
228
'external diff failed with exit code 2'
229
' when run with LANG=C and LC_ALL=C,'
230
' but not when run natively: %r' % (diffcmd,))
232
first_line = lang_c_out.split('\n', 1)[0]
233
# Starting with diffutils 2.8.4 the word "binary" was dropped.
234
m = re.match('^(binary )?files.*differ$', first_line, re.I)
236
raise errors.BzrError('external diff failed with exit code 2;'
237
' command: %r' % (diffcmd,))
239
# Binary files differ, just return
242
# If we got to here, we haven't written out the output of diff
130
rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
132
if rc != 0 and rc != 1:
246
133
# returns 1 if files differ; that's OK
248
135
msg = 'signal %d' % (-rc)
250
137
msg = 'exit code %d' % rc
252
raise errors.BzrError('external diff failed with %s; command: %r'
139
raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
257
141
oldtmpf.close() # and delete
259
# Clean up. Warn in case the files couldn't be deleted
260
# (in case windows still holds the file open, but not
261
# if the files have already been deleted)
263
os.remove(old_abspath)
265
if e.errno not in (errno.ENOENT,):
266
warning('Failed to delete temporary file: %s %s',
269
os.remove(new_abspath)
271
if e.errno not in (errno.ENOENT,):
272
warning('Failed to delete temporary file: %s %s',
276
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url,
278
"""Get the trees and specific files to diff given a list of paths.
280
This method works out the trees to be diff'ed and the files of
281
interest within those trees.
284
the list of arguments passed to the diff command
285
:param revision_specs:
286
Zero, one or two RevisionSpecs from the diff command line,
287
saying what revisions to compare.
289
The url of the old branch or tree. If None, the tree to use is
290
taken from the first path, if any, or the current working tree.
292
The url of the new branch or tree. If None, the tree to use is
293
taken from the first path, if any, or the current working tree.
295
if True and a view is set, apply the view or check that the paths
298
a tuple of (old_tree, new_tree, specific_files, extra_trees) where
299
extra_trees is a sequence of additional trees to search in for
146
def show_diff(b, revision, specific_files, external_diff_options=None):
147
"""Shortcut for showing the diff to the working tree.
153
None for each, or otherwise the old revision to compare against.
155
The more general form is show_diff_trees(), where the caller
156
supplies any two trees.
302
# Get the old and new revision specs
303
old_revision_spec = None
304
new_revision_spec = None
305
if revision_specs is not None:
306
if len(revision_specs) > 0:
307
old_revision_spec = revision_specs[0]
309
old_url = old_revision_spec.get_branch()
310
if len(revision_specs) > 1:
311
new_revision_spec = revision_specs[1]
313
new_url = new_revision_spec.get_branch()
316
make_paths_wt_relative = True
317
consider_relpath = True
318
if path_list is None or len(path_list) == 0:
319
# If no path is given, the current working tree is used
320
default_location = u'.'
321
consider_relpath = False
322
elif old_url is not None and new_url is not None:
323
other_paths = path_list
324
make_paths_wt_relative = False
161
old_tree = b.basis_tree()
326
default_location = path_list[0]
327
other_paths = path_list[1:]
329
# Get the old location
332
old_url = default_location
333
working_tree, branch, relpath = \
334
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
335
if consider_relpath and relpath != '':
336
if working_tree is not None and apply_view:
337
views.check_path_in_view(working_tree, relpath)
338
specific_files.append(relpath)
339
old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
341
# Get the new location
343
new_url = default_location
344
if new_url != old_url:
345
working_tree, branch, relpath = \
346
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
347
if consider_relpath and relpath != '':
348
if working_tree is not None and apply_view:
349
views.check_path_in_view(working_tree, relpath)
350
specific_files.append(relpath)
351
new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
352
basis_is_default=working_tree is None)
354
# Get the specific files (all files is None, no files is [])
355
if make_paths_wt_relative and working_tree is not None:
357
from bzrlib.builtins import safe_relpath_files
358
other_paths = safe_relpath_files(working_tree, other_paths,
359
apply_view=apply_view)
360
except errors.FileInWrongBranch:
361
raise errors.BzrCommandError("Files are in different branches")
362
specific_files.extend(other_paths)
363
if len(specific_files) == 0:
364
specific_files = None
365
if (working_tree is not None and working_tree.supports_views()
367
view_files = working_tree.views.lookup_view()
369
specific_files = view_files
370
view_str = views.view_display_str(view_files)
371
note("*** ignoring files outside view: %s" % view_str)
373
# Get extra trees that ought to be searched for file-ids
375
if working_tree is not None and working_tree not in (old_tree, new_tree):
376
extra_trees = (working_tree,)
377
return old_tree, new_tree, specific_files, extra_trees
379
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
380
if branch is None and tree is not None:
382
if spec is None or spec.spec is None:
385
return tree.basis_tree()
387
return branch.basis_tree()
390
return spec.as_tree(branch)
163
old_tree = b.revision_tree(b.lookup_revision(revision))
165
new_tree = b.working_tree()
167
show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
168
external_diff_options)
393
172
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
394
external_diff_options=None,
395
old_label='a/', new_label='b/',
397
path_encoding='utf8',
173
external_diff_options=None):
399
174
"""Show in text form the changes from one tree to another.
405
Include only changes to these files - None for all changes.
177
If set, include only changes to these files.
407
179
external_diff_options
408
180
If set, use an external GNU diff and pass these options.
411
If set, more Trees to use for looking up file ids
414
If set, the path will be encoded as specified, otherwise is supposed
419
if extra_trees is not None:
420
for tree in extra_trees:
424
differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
426
external_diff_options,
427
old_label, new_label, using)
428
return differ.show_diff(specific_files, extra_trees)
431
if extra_trees is not None:
432
for tree in extra_trees:
438
def _patch_header_date(tree, file_id, path):
439
"""Returns a timestamp suitable for use in a patch header."""
440
mtime = tree.get_file_mtime(file_id, path)
441
return timestamp.format_patch_date(mtime)
444
@deprecated_function(one_three)
445
def get_prop_change(meta_modified):
447
return " (properties changed)"
451
def get_executable_change(old_is_x, new_is_x):
452
descr = { True:"+x", False:"-x", None:"??" }
453
if old_is_x != new_is_x:
454
return ["%s to %s" % (descr[old_is_x], descr[new_is_x],)]
459
class DiffPath(object):
460
"""Base type for command object that compare files"""
462
# The type or contents of the file were unsuitable for diffing
463
CANNOT_DIFF = 'CANNOT_DIFF'
464
# The file has changed in a semantic way
466
# The file content may have changed, but there is no semantic change
467
UNCHANGED = 'UNCHANGED'
469
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8'):
472
:param old_tree: The tree to show as the old tree in the comparison
473
:param new_tree: The tree to show as new in the comparison
474
:param to_file: The file to write comparison data to
475
:param path_encoding: The character encoding to write paths in
477
self.old_tree = old_tree
478
self.new_tree = new_tree
479
self.to_file = to_file
480
self.path_encoding = path_encoding
486
def from_diff_tree(klass, diff_tree):
487
return klass(diff_tree.old_tree, diff_tree.new_tree,
488
diff_tree.to_file, diff_tree.path_encoding)
491
def _diff_many(differs, file_id, old_path, new_path, old_kind, new_kind):
492
for file_differ in differs:
493
result = file_differ.diff(file_id, old_path, new_path, old_kind,
495
if result is not DiffPath.CANNOT_DIFF:
498
return DiffPath.CANNOT_DIFF
501
class DiffKindChange(object):
502
"""Special differ for file kind changes.
504
Represents kind change as deletion + creation. Uses the other differs
507
def __init__(self, differs):
508
self.differs = differs
514
def from_diff_tree(klass, diff_tree):
515
return klass(diff_tree.differs)
517
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
518
"""Perform comparison
520
:param file_id: The file_id of the file to compare
521
:param old_path: Path of the file in the old tree
522
:param new_path: Path of the file in the new tree
523
:param old_kind: Old file-kind of the file
524
:param new_kind: New file-kind of the file
526
if None in (old_kind, new_kind):
527
return DiffPath.CANNOT_DIFF
528
result = DiffPath._diff_many(self.differs, file_id, old_path,
529
new_path, old_kind, None)
530
if result is DiffPath.CANNOT_DIFF:
532
return DiffPath._diff_many(self.differs, file_id, old_path, new_path,
536
class DiffDirectory(DiffPath):
538
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
539
"""Perform comparison between two directories. (dummy)
542
if 'directory' not in (old_kind, new_kind):
543
return self.CANNOT_DIFF
544
if old_kind not in ('directory', None):
545
return self.CANNOT_DIFF
546
if new_kind not in ('directory', None):
547
return self.CANNOT_DIFF
551
class DiffSymlink(DiffPath):
553
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
554
"""Perform comparison between two symlinks
556
:param file_id: The file_id of the file to compare
557
:param old_path: Path of the file in the old tree
558
:param new_path: Path of the file in the new tree
559
:param old_kind: Old file-kind of the file
560
:param new_kind: New file-kind of the file
562
if 'symlink' not in (old_kind, new_kind):
563
return self.CANNOT_DIFF
564
if old_kind == 'symlink':
565
old_target = self.old_tree.get_symlink_target(file_id)
566
elif old_kind is None:
569
return self.CANNOT_DIFF
570
if new_kind == 'symlink':
571
new_target = self.new_tree.get_symlink_target(file_id)
572
elif new_kind is None:
575
return self.CANNOT_DIFF
576
return self.diff_symlink(old_target, new_target)
578
def diff_symlink(self, old_target, new_target):
579
if old_target is None:
580
self.to_file.write('=== target is %r\n' % new_target)
581
elif new_target is None:
582
self.to_file.write('=== target was %r\n' % old_target)
584
self.to_file.write('=== target changed %r => %r\n' %
585
(old_target, new_target))
589
class DiffText(DiffPath):
591
# GNU Patch uses the epoch date to detect files that are being added
592
# or removed in a diff.
593
EPOCH_DATE = '1970-01-01 00:00:00 +0000'
595
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
596
old_label='', new_label='', text_differ=internal_diff):
597
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
598
self.text_differ = text_differ
599
self.old_label = old_label
600
self.new_label = new_label
601
self.path_encoding = path_encoding
603
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
604
"""Compare two files in unified diff format
606
:param file_id: The file_id of the file to compare
607
:param old_path: Path of the file in the old tree
608
:param new_path: Path of the file in the new tree
609
:param old_kind: Old file-kind of the file
610
:param new_kind: New file-kind of the file
612
if 'file' not in (old_kind, new_kind):
613
return self.CANNOT_DIFF
614
from_file_id = to_file_id = file_id
615
if old_kind == 'file':
616
old_date = _patch_header_date(self.old_tree, file_id, old_path)
617
elif old_kind is None:
618
old_date = self.EPOCH_DATE
621
return self.CANNOT_DIFF
622
if new_kind == 'file':
623
new_date = _patch_header_date(self.new_tree, file_id, new_path)
624
elif new_kind is None:
625
new_date = self.EPOCH_DATE
628
return self.CANNOT_DIFF
629
from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
630
to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
631
return self.diff_text(from_file_id, to_file_id, from_label, to_label)
633
def diff_text(self, from_file_id, to_file_id, from_label, to_label):
634
"""Diff the content of given files in two trees
636
:param from_file_id: The id of the file in the from tree. If None,
637
the file is not present in the from tree.
638
:param to_file_id: The id of the file in the to tree. This may refer
639
to a different file from from_file_id. If None,
640
the file is not present in the to tree.
642
def _get_text(tree, file_id):
643
if file_id is not None:
644
return tree.get_file(file_id).readlines()
648
from_text = _get_text(self.old_tree, from_file_id)
649
to_text = _get_text(self.new_tree, to_file_id)
650
self.text_differ(from_label, from_text, to_label, to_text,
652
except errors.BinaryFile:
654
("Binary files %s and %s differ\n" %
655
(from_label, to_label)).encode(self.path_encoding))
659
class DiffFromTool(DiffPath):
661
def __init__(self, command_template, old_tree, new_tree, to_file,
662
path_encoding='utf-8'):
663
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
664
self.command_template = command_template
665
self._root = osutils.mkdtemp(prefix='bzr-diff-')
668
def from_string(klass, command_string, old_tree, new_tree, to_file,
669
path_encoding='utf-8'):
670
command_template = commands.shlex_split_unicode(command_string)
671
command_template.extend(['%(old_path)s', '%(new_path)s'])
672
return klass(command_template, old_tree, new_tree, to_file,
676
def make_from_diff_tree(klass, command_string):
677
def from_diff_tree(diff_tree):
678
return klass.from_string(command_string, diff_tree.old_tree,
679
diff_tree.new_tree, diff_tree.to_file)
680
return from_diff_tree
682
def _get_command(self, old_path, new_path):
683
my_map = {'old_path': old_path, 'new_path': new_path}
684
return [t % my_map for t in self.command_template]
686
def _execute(self, old_path, new_path):
687
command = self._get_command(old_path, new_path)
689
proc = subprocess.Popen(command, stdout=subprocess.PIPE,
692
if e.errno == errno.ENOENT:
693
raise errors.ExecutableMissing(command[0])
696
self.to_file.write(proc.stdout.read())
699
def _try_symlink_root(self, tree, prefix):
700
if (getattr(tree, 'abspath', None) is None
701
or not osutils.host_os_dereferences_symlinks()):
704
os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
706
if e.errno != errno.EEXIST:
710
def _write_file(self, file_id, tree, prefix, relpath):
711
full_path = osutils.pathjoin(self._root, prefix, relpath)
712
if self._try_symlink_root(tree, prefix):
714
parent_dir = osutils.dirname(full_path)
716
os.makedirs(parent_dir)
718
if e.errno != errno.EEXIST:
720
source = tree.get_file(file_id, relpath)
722
target = open(full_path, 'wb')
724
osutils.pumpfile(source, target)
729
osutils.make_readonly(full_path)
730
mtime = tree.get_file_mtime(file_id)
731
os.utime(full_path, (mtime, mtime))
734
def _prepare_files(self, file_id, old_path, new_path):
735
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
737
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
739
return old_disk_path, new_disk_path
742
osutils.rmtree(self._root)
744
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
745
if (old_kind, new_kind) != ('file', 'file'):
746
return DiffPath.CANNOT_DIFF
747
self._prepare_files(file_id, old_path, new_path)
748
self._execute(osutils.pathjoin('old', old_path),
749
osutils.pathjoin('new', new_path))
752
class DiffTree(object):
753
"""Provides textual representations of the difference between two trees.
755
A DiffTree examines two trees and where a file-id has altered
756
between them, generates a textual representation of the difference.
757
DiffTree uses a sequence of DiffPath objects which are each
758
given the opportunity to handle a given altered fileid. The list
759
of DiffPath objects can be extended globally by appending to
760
DiffTree.diff_factories, or for a specific diff operation by
761
supplying the extra_factories option to the appropriate method.
764
# list of factories that can provide instances of DiffPath objects
765
# may be extended by plugins.
766
diff_factories = [DiffSymlink.from_diff_tree,
767
DiffDirectory.from_diff_tree]
769
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
770
diff_text=None, extra_factories=None):
773
:param old_tree: Tree to show as old in the comparison
774
:param new_tree: Tree to show as new in the comparison
775
:param to_file: File to write comparision to
776
:param path_encoding: Character encoding to write paths in
777
:param diff_text: DiffPath-type object to use as a last resort for
779
:param extra_factories: Factories of DiffPaths to try before any other
781
if diff_text is None:
782
diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
783
'', '', internal_diff)
784
self.old_tree = old_tree
785
self.new_tree = new_tree
786
self.to_file = to_file
787
self.path_encoding = path_encoding
789
if extra_factories is not None:
790
self.differs.extend(f(self) for f in extra_factories)
791
self.differs.extend(f(self) for f in self.diff_factories)
792
self.differs.extend([diff_text, DiffKindChange.from_diff_tree(self)])
795
def from_trees_options(klass, old_tree, new_tree, to_file,
796
path_encoding, external_diff_options, old_label,
798
"""Factory for producing a DiffTree.
800
Designed to accept options used by show_diff_trees.
801
:param old_tree: The tree to show as old in the comparison
802
:param new_tree: The tree to show as new in the comparison
803
:param to_file: File to write comparisons to
804
:param path_encoding: Character encoding to use for writing paths
805
:param external_diff_options: If supplied, use the installed diff
806
binary to perform file comparison, using supplied options.
807
:param old_label: Prefix to use for old file labels
808
:param new_label: Prefix to use for new file labels
809
:param using: Commandline to use to invoke an external diff tool
811
if using is not None:
812
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
815
if external_diff_options:
816
opts = external_diff_options.split()
817
def diff_file(olab, olines, nlab, nlines, to_file):
818
external_diff(olab, olines, nlab, nlines, to_file, opts)
820
diff_file = internal_diff
821
diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
822
old_label, new_label, diff_file)
823
return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
826
def show_diff(self, specific_files, extra_trees=None):
827
"""Write tree diff to self.to_file
829
:param sepecific_files: the specific files to compare (recursive)
830
:param extra_trees: extra trees to use for mapping paths to file_ids
833
return self._show_diff(specific_files, extra_trees)
835
for differ in self.differs:
838
def _show_diff(self, specific_files, extra_trees):
839
# TODO: Generation of pseudo-diffs for added/deleted files could
840
# be usefully made into a much faster special case.
841
iterator = self.new_tree.iter_changes(self.old_tree,
842
specific_files=specific_files,
843
extra_trees=extra_trees,
844
require_versioned=True)
846
def changes_key(change):
847
old_path, new_path = change[1]
852
def get_encoded_path(path):
854
return path.encode(self.path_encoding, "replace")
855
for (file_id, paths, changed_content, versioned, parent, name, kind,
856
executable) in sorted(iterator, key=changes_key):
857
# The root does not get diffed, and items with no known kind (that
858
# is, missing) in both trees are skipped as well.
859
if parent == (None, None) or kind == (None, None):
861
oldpath, newpath = paths
862
oldpath_encoded = get_encoded_path(paths[0])
863
newpath_encoded = get_encoded_path(paths[1])
864
old_present = (kind[0] is not None and versioned[0])
865
new_present = (kind[1] is not None and versioned[1])
866
renamed = (parent[0], name[0]) != (parent[1], name[1])
868
properties_changed = []
869
properties_changed.extend(get_executable_change(executable[0], executable[1]))
871
if properties_changed:
872
prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
876
if (old_present, new_present) == (True, False):
877
self.to_file.write("=== removed %s '%s'\n" %
878
(kind[0], oldpath_encoded))
880
elif (old_present, new_present) == (False, True):
881
self.to_file.write("=== added %s '%s'\n" %
882
(kind[1], newpath_encoded))
885
self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
886
(kind[0], oldpath_encoded, newpath_encoded, prop_str))
888
# if it was produced by iter_changes, it must be
889
# modified *somehow*, either content or execute bit.
890
self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
891
newpath_encoded, prop_str))
893
self.diff(file_id, oldpath, newpath)
899
def diff(self, file_id, old_path, new_path):
900
"""Perform a diff of a single file
902
:param file_id: file-id of the file
903
:param old_path: The path of the file in the old tree
904
:param new_path: The path of the file in the new tree
907
old_kind = self.old_tree.kind(file_id)
908
except (errors.NoSuchId, errors.NoSuchFile):
911
new_kind = self.new_tree.kind(file_id)
912
except (errors.NoSuchId, errors.NoSuchFile):
915
result = DiffPath._diff_many(self.differs, file_id, old_path,
916
new_path, old_kind, new_kind)
917
if result is DiffPath.CANNOT_DIFF:
918
error_path = new_path
919
if error_path is None:
920
error_path = old_path
921
raise errors.NoDiffFound(error_path)
183
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
187
DEVNULL = '/dev/null'
188
# Windows users, don't panic about this filename -- it is a
189
# special signal to GNU patch that the file should be created or
190
# deleted respectively.
192
# TODO: Generation of pseudo-diffs for added/deleted files could
193
# be usefully made into a much faster special case.
195
if external_diff_options:
196
assert isinstance(external_diff_options, basestring)
197
opts = external_diff_options.split()
198
def diff_file(olab, olines, nlab, nlines, to_file):
199
external_diff(olab, olines, nlab, nlines, to_file, opts)
201
diff_file = internal_diff
204
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
205
specific_files=specific_files)
207
for path, file_id, kind in delta.removed:
208
print >>to_file, '*** removed %s %r' % (kind, path)
210
diff_file(old_label + path,
211
old_tree.get_file(file_id).readlines(),
216
for path, file_id, kind in delta.added:
217
print >>to_file, '*** added %s %r' % (kind, path)
222
new_tree.get_file(file_id).readlines(),
225
for old_path, new_path, file_id, kind, text_modified in delta.renamed:
226
print >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
228
diff_file(old_label + old_path,
229
old_tree.get_file(file_id).readlines(),
230
new_label + new_path,
231
new_tree.get_file(file_id).readlines(),
234
for path, file_id, kind in delta.modified:
235
print >>to_file, '*** modified %s %r' % (kind, path)
237
diff_file(old_label + path,
238
old_tree.get_file(file_id).readlines(),
240
new_tree.get_file(file_id).readlines(),
added
removed
bzrlib/diff.py
