← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-09-01 08:02:42 UTC
  • mfrom: (5390.3.3 faster-revert-593560)
  • Revision ID: pqm@pqm.ubuntu.com-20100901080242-esg62ody4frwmy66
(spiv) Avoid repeatedly calling self.target.all_file_ids() in
 InterTree.iter_changes. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
1
 
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
 
1
# Copyright (C) 2005-2010 Canonical Ltd.
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
17
17
import difflib
18
18
import os
19
19
import re
20
 
import shutil
 
20
import string
21
21
import sys
22
22
 
23
23
from bzrlib.lazy_import import lazy_import
30
30
from bzrlib import (
31
31
    branch as _mod_branch,
32
32
    bzrdir,
33
 
    commands,
 
33
    cmdline,
 
34
    cleanup,
34
35
    errors,
35
36
    osutils,
36
37
    patiencediff,
38
39
    timestamp,
39
40
    views,
40
41
    )
 
42
 
 
43
from bzrlib.workingtree import WorkingTree
41
44
""")
42
45
 
 
46
from bzrlib.registry import (
 
47
    Registry,
 
48
    )
43
49
from bzrlib.symbol_versioning import (
44
50
    deprecated_function,
 
51
    deprecated_in,
45
52
    )
46
53
from bzrlib.trace import mutter, note, warning
47
54
 
48
55
 
 
56
class AtTemplate(string.Template):
 
57
    """Templating class that uses @ instead of $."""
 
58
 
 
59
    delimiter = '@'
 
60
 
 
61
 
49
62
# TODO: Rather than building a changeset object, we should probably
50
63
# invoke callbacks on an object.  That object can either accumulate a
51
64
# list, write them out directly, etc etc.
86
99
    if sequence_matcher is None:
87
100
        sequence_matcher = patiencediff.PatienceSequenceMatcher
88
101
    ud = patiencediff.unified_diff(oldlines, newlines,
89
 
                      fromfile=old_filename.encode(path_encoding),
90
 
                      tofile=new_filename.encode(path_encoding),
 
102
                      fromfile=old_filename.encode(path_encoding, 'replace'),
 
103
                      tofile=new_filename.encode(path_encoding, 'replace'),
91
104
                      sequencematcher=sequence_matcher)
92
105
 
93
106
    ud = list(ud)
277
290
                        new_abspath, e)
278
291
 
279
292
 
280
 
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url,
281
 
    apply_view=True):
282
 
    """Get the trees and specific files to diff given a list of paths.
283
 
 
284
 
    This method works out the trees to be diff'ed and the files of
285
 
    interest within those trees.
286
 
 
287
 
    :param path_list:
288
 
        the list of arguments passed to the diff command
289
 
    :param revision_specs:
290
 
        Zero, one or two RevisionSpecs from the diff command line,
291
 
        saying what revisions to compare.
292
 
    :param old_url:
293
 
        The url of the old branch or tree. If None, the tree to use is
294
 
        taken from the first path, if any, or the current working tree.
295
 
    :param new_url:
296
 
        The url of the new branch or tree. If None, the tree to use is
297
 
        taken from the first path, if any, or the current working tree.
298
 
    :param apply_view:
299
 
        if True and a view is set, apply the view or check that the paths
300
 
        are within it
301
 
    :returns:
302
 
        a tuple of (old_tree, new_tree, specific_files, extra_trees) where
303
 
        extra_trees is a sequence of additional trees to search in for
304
 
        file-ids.
 
293
@deprecated_function(deprecated_in((2, 2, 0)))
 
294
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
 
295
                                   apply_view=True):
 
296
    """Get the trees and specific files to diff given a list of paths.
 
297
 
 
298
    This method works out the trees to be diff'ed and the files of
 
299
    interest within those trees.
 
300
 
 
301
    :param path_list:
 
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.
 
306
    :param old_url:
 
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.
 
309
    :param new_url:
 
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.
 
312
    :param apply_view:
 
313
        if True and a view is set, apply the view or check that the paths
 
314
        are within it
 
315
    :returns:
 
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
 
319
        are not locked.
 
320
    """
 
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)
 
324
    
 
325
 
 
326
def get_trees_and_branches_to_diff_locked(
 
327
    path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
 
328
    """Get the trees and specific files to diff given a list of paths.
 
329
 
 
330
    This method works out the trees to be diff'ed and the files of
 
331
    interest within those trees.
 
332
 
 
333
    :param path_list:
 
334
        the list of arguments passed to the diff command
 
335
    :param revision_specs:
 
336
        Zero, one or two RevisionSpecs from the diff command line,
 
337
        saying what revisions to compare.
 
338
    :param old_url:
 
339
        The url of the old branch or tree. If None, the tree to use is
 
340
        taken from the first path, if any, or the current working tree.
 
341
    :param new_url:
 
342
        The url of the new branch or tree. If None, the tree to use is
 
343
        taken from the first path, if any, or the current working tree.
 
344
    :param add_cleanup:
 
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.
 
347
    :param apply_view:
 
348
        if True and a view is set, apply the view or check that the paths
 
349
        are within it
 
350
    :returns:
 
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
 
355
        param are run.
305
356
    """
306
357
    # Get the old and new revision specs
307
358
    old_revision_spec = None
330
381
        default_location = path_list[0]
331
382
        other_paths = path_list[1:]
332
383
 
 
384
    def lock_tree_or_branch(wt, br):
 
385
        if wt is not None:
 
386
            wt.lock_read()
 
387
            add_cleanup(wt.unlock)
 
388
        elif br is not None:
 
389
            br.lock_read()
 
390
            add_cleanup(br.unlock)
 
391
 
333
392
    # Get the old location
334
393
    specific_files = []
335
394
    if old_url is None:
336
395
        old_url = default_location
337
396
    working_tree, branch, relpath = \
338
397
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
 
398
    lock_tree_or_branch(working_tree, branch)
339
399
    if consider_relpath and relpath != '':
340
400
        if working_tree is not None and apply_view:
341
401
            views.check_path_in_view(working_tree, relpath)
342
402
        specific_files.append(relpath)
343
403
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
 
404
    old_branch = branch
344
405
 
345
406
    # Get the new location
346
407
    if new_url is None:
348
409
    if new_url != old_url:
349
410
        working_tree, branch, relpath = \
350
411
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
 
412
        lock_tree_or_branch(working_tree, branch)
351
413
        if consider_relpath and relpath != '':
352
414
            if working_tree is not None and apply_view:
353
415
                views.check_path_in_view(working_tree, relpath)
354
416
            specific_files.append(relpath)
355
417
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
356
418
        basis_is_default=working_tree is None)
 
419
    new_branch = branch
357
420
 
358
421
    # Get the specific files (all files is None, no files is [])
359
422
    if make_paths_wt_relative and working_tree is not None:
360
 
        try:
361
 
            from bzrlib.builtins import safe_relpath_files
362
 
            other_paths = safe_relpath_files(working_tree, other_paths,
 
423
        other_paths = working_tree.safe_relpath_files(
 
424
            other_paths,
363
425
            apply_view=apply_view)
364
 
        except errors.FileInWrongBranch:
365
 
            raise errors.BzrCommandError("Files are in different branches")
366
426
    specific_files.extend(other_paths)
367
427
    if len(specific_files) == 0:
368
428
        specific_files = None
378
438
    extra_trees = None
379
439
    if working_tree is not None and working_tree not in (old_tree, new_tree):
380
440
        extra_trees = (working_tree,)
381
 
    return old_tree, new_tree, specific_files, extra_trees
 
441
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
 
442
 
382
443
 
383
444
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
384
445
    if branch is None and tree is not None:
399
460
                    old_label='a/', new_label='b/',
400
461
                    extra_trees=None,
401
462
                    path_encoding='utf8',
402
 
                    using=None):
 
463
                    using=None,
 
464
                    format_cls=None):
403
465
    """Show in text form the changes from one tree to another.
404
466
 
405
 
    to_file
406
 
        The output stream.
407
 
 
408
 
    specific_files
409
 
        Include only changes to these files - None for all changes.
410
 
 
411
 
    external_diff_options
412
 
        If set, use an external GNU diff and pass these options.
413
 
 
414
 
    extra_trees
415
 
        If set, more Trees to use for looking up file ids
416
 
 
417
 
    path_encoding
418
 
        If set, the path will be encoded as specified, otherwise is supposed
419
 
        to be utf8
 
467
    :param to_file: The output stream.
 
468
    :param specific_files:Include only changes to these files - None for all
 
469
        changes.
 
470
    :param external_diff_options: If set, use an external GNU diff and pass 
 
471
        these options.
 
472
    :param extra_trees: If set, more Trees to use for looking up file ids
 
473
    :param path_encoding: If set, the path will be encoded as specified, 
 
474
        otherwise is supposed to be utf8
 
475
    :param format_cls: Formatter class (DiffTree subclass)
420
476
    """
 
477
    if format_cls is None:
 
478
        format_cls = DiffTree
421
479
    old_tree.lock_read()
422
480
    try:
423
481
        if extra_trees is not None:
425
483
                tree.lock_read()
426
484
        new_tree.lock_read()
427
485
        try:
428
 
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
429
 
                                                 path_encoding,
430
 
                                                 external_diff_options,
431
 
                                                 old_label, new_label, using)
 
486
            differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
 
487
                                                   path_encoding,
 
488
                                                   external_diff_options,
 
489
                                                   old_label, new_label, using)
432
490
            return differ.show_diff(specific_files, extra_trees)
433
491
        finally:
434
492
            new_tree.unlock()
441
499
 
442
500
def _patch_header_date(tree, file_id, path):
443
501
    """Returns a timestamp suitable for use in a patch header."""
444
 
    mtime = tree.get_file_mtime(file_id, path)
 
502
    try:
 
503
        mtime = tree.get_file_mtime(file_id, path)
 
504
    except errors.FileTimestampUnavailable:
 
505
        mtime = 0
445
506
    return timestamp.format_patch_date(mtime)
446
507
 
447
508
 
642
703
        """
643
704
        def _get_text(tree, file_id, path):
644
705
            if file_id is not None:
645
 
                return tree.get_file(file_id, path).readlines()
 
706
                return tree.get_file_lines(file_id, path)
646
707
            else:
647
708
                return []
648
709
        try:
649
710
            from_text = _get_text(self.old_tree, from_file_id, from_path)
650
711
            to_text = _get_text(self.new_tree, to_file_id, to_path)
651
712
            self.text_differ(from_label, from_text, to_label, to_text,
652
 
                             self.to_file)
 
713
                             self.to_file, path_encoding=self.path_encoding)
653
714
        except errors.BinaryFile:
654
715
            self.to_file.write(
655
716
                  ("Binary files %s and %s differ\n" %
656
 
                  (from_label, to_label)).encode(self.path_encoding))
 
717
                  (from_label, to_label)).encode(self.path_encoding,'replace'))
657
718
        return self.CHANGED
658
719
 
659
720
 
668
729
    @classmethod
669
730
    def from_string(klass, command_string, old_tree, new_tree, to_file,
670
731
                    path_encoding='utf-8'):
671
 
        command_template = commands.shlex_split_unicode(command_string)
672
 
        command_template.extend(['%(old_path)s', '%(new_path)s'])
 
732
        command_template = cmdline.split(command_string)
 
733
        if '@' not in command_string:
 
734
            command_template.extend(['@old_path', '@new_path'])
673
735
        return klass(command_template, old_tree, new_tree, to_file,
674
736
                     path_encoding)
675
737
 
676
738
    @classmethod
677
 
    def make_from_diff_tree(klass, command_string):
 
739
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
678
740
        def from_diff_tree(diff_tree):
679
 
            return klass.from_string(command_string, diff_tree.old_tree,
 
741
            full_command_string = [command_string]
 
742
            if external_diff_options is not None:
 
743
                full_command_string += ' ' + external_diff_options
 
744
            return klass.from_string(full_command_string, diff_tree.old_tree,
680
745
                                     diff_tree.new_tree, diff_tree.to_file)
681
746
        return from_diff_tree
682
747
 
683
748
    def _get_command(self, old_path, new_path):
684
749
        my_map = {'old_path': old_path, 'new_path': new_path}
685
 
        return [t % my_map for t in self.command_template]
 
750
        return [AtTemplate(t).substitute(my_map) for t in
 
751
                self.command_template]
686
752
 
687
753
    def _execute(self, old_path, new_path):
688
754
        command = self._get_command(old_path, new_path)
708
774
                raise
709
775
        return True
710
776
 
711
 
    def _write_file(self, file_id, tree, prefix, relpath):
 
777
    def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
 
778
                    allow_write=False):
 
779
        if not force_temp and isinstance(tree, WorkingTree):
 
780
            return tree.abspath(tree.id2path(file_id))
 
781
        
712
782
        full_path = osutils.pathjoin(self._root, prefix, relpath)
713
 
        if self._try_symlink_root(tree, prefix):
 
783
        if not force_temp and self._try_symlink_root(tree, prefix):
714
784
            return full_path
715
785
        parent_dir = osutils.dirname(full_path)
716
786
        try:
727
797
                target.close()
728
798
        finally:
729
799
            source.close()
730
 
        osutils.make_readonly(full_path)
731
 
        mtime = tree.get_file_mtime(file_id)
732
 
        os.utime(full_path, (mtime, mtime))
 
800
        try:
 
801
            mtime = tree.get_file_mtime(file_id)
 
802
        except errors.FileTimestampUnavailable:
 
803
            pass
 
804
        else:
 
805
            os.utime(full_path, (mtime, mtime))
 
806
        if not allow_write:
 
807
            osutils.make_readonly(full_path)
733
808
        return full_path
734
809
 
735
 
    def _prepare_files(self, file_id, old_path, new_path):
 
810
    def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
 
811
                       allow_write_new=False):
736
812
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
737
 
                                         old_path)
 
813
                                         old_path, force_temp)
738
814
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
739
 
                                         new_path)
 
815
                                         new_path, force_temp,
 
816
                                         allow_write=allow_write_new)
740
817
        return old_disk_path, new_disk_path
741
818
 
742
819
    def finish(self):
750
827
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
751
828
        if (old_kind, new_kind) != ('file', 'file'):
752
829
            return DiffPath.CANNOT_DIFF
753
 
        self._prepare_files(file_id, old_path, new_path)
754
 
        self._execute(osutils.pathjoin('old', old_path),
755
 
                      osutils.pathjoin('new', new_path))
 
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)
 
833
 
 
834
    def edit_file(self, file_id):
 
835
        """Use this tool to edit a file.
 
836
 
 
837
        A temporary copy will be edited, and the new contents will be
 
838
        returned.
 
839
 
 
840
        :param file_id: The id of the file to edit.
 
841
        :return: The new contents of the file.
 
842
        """
 
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,
 
847
                                           force_temp=True)[1]
 
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')
 
852
        try:
 
853
            return new_file.read()
 
854
        finally:
 
855
            new_file.close()
756
856
 
757
857
 
758
858
class DiffTree(object):
815
915
        :param using: Commandline to use to invoke an external diff tool
816
916
        """
817
917
        if using is not None:
818
 
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
 
918
            extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
819
919
        else:
820
920
            extra_factories = []
821
921
        if external_diff_options:
822
922
            opts = external_diff_options.split()
823
 
            def diff_file(olab, olines, nlab, nlines, to_file):
 
923
            def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None):
 
924
                """:param path_encoding: not used but required
 
925
                        to match the signature of internal_diff.
 
926
                """
824
927
                external_diff(olab, olines, nlab, nlines, to_file, opts)
825
928
        else:
826
929
            diff_file = internal_diff
832
935
    def show_diff(self, specific_files, extra_trees=None):
833
936
        """Write tree diff to self.to_file
834
937
 
835
 
        :param sepecific_files: the specific files to compare (recursive)
 
938
        :param specific_files: the specific files to compare (recursive)
836
939
        :param extra_trees: extra trees to use for mapping paths to file_ids
837
940
        """
838
941
        try:
928
1031
            if error_path is None:
929
1032
                error_path = old_path
930
1033
            raise errors.NoDiffFound(error_path)
 
1034
 
 
1035
 
 
1036
format_registry = Registry()
 
1037
format_registry.register('default', DiffTree)