← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Danny van Heumen
  • Date: 2010-03-09 21:42:11 UTC
  • mto: (4634.139.5 2.0)
  • mto: This revision was merged to the branch mainline in revision 5160.
  • Revision ID: danny@dannyvanheumen.nl-20100309214211-iqh42x6qcikgd9p3
Reverted now-useless TODO list.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd.
 
1
# Copyright (C) 2004, 2005, 2006 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 string
 
20
import shutil
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
 
    cmdline,
34
 
    cleanup,
 
33
    commands,
35
34
    errors,
36
35
    osutils,
37
36
    patiencediff,
39
38
    timestamp,
40
39
    views,
41
40
    )
42
 
 
43
 
from bzrlib.workingtree import WorkingTree
44
41
""")
45
42
 
46
 
from bzrlib.registry import (
47
 
    Registry,
48
 
    )
49
43
from bzrlib.symbol_versioning import (
50
44
    deprecated_function,
51
 
    deprecated_in,
52
45
    )
53
46
from bzrlib.trace import mutter, note, warning
54
47
 
55
48
 
56
 
class AtTemplate(string.Template):
57
 
    """Templating class that uses @ instead of $."""
58
 
 
59
 
    delimiter = '@'
60
 
 
61
 
 
62
49
# TODO: Rather than building a changeset object, we should probably
63
50
# invoke callbacks on an object.  That object can either accumulate a
64
51
# list, write them out directly, etc etc.
99
86
    if sequence_matcher is None:
100
87
        sequence_matcher = patiencediff.PatienceSequenceMatcher
101
88
    ud = patiencediff.unified_diff(oldlines, newlines,
102
 
                      fromfile=old_filename.encode(path_encoding, 'replace'),
103
 
                      tofile=new_filename.encode(path_encoding, 'replace'),
 
89
                      fromfile=old_filename.encode(path_encoding),
 
90
                      tofile=new_filename.encode(path_encoding),
104
91
                      sequencematcher=sequence_matcher)
105
92
 
106
93
    ud = list(ud)
290
277
                        new_abspath, e)
291
278
 
292
279
 
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.
 
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.
356
305
    """
357
306
    # Get the old and new revision specs
358
307
    old_revision_spec = None
381
330
        default_location = path_list[0]
382
331
        other_paths = path_list[1:]
383
332
 
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
 
 
392
333
    # Get the old location
393
334
    specific_files = []
394
335
    if old_url is None:
395
336
        old_url = default_location
396
337
    working_tree, branch, relpath = \
397
338
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
398
 
    lock_tree_or_branch(working_tree, branch)
399
339
    if consider_relpath and relpath != '':
400
340
        if working_tree is not None and apply_view:
401
341
            views.check_path_in_view(working_tree, relpath)
402
342
        specific_files.append(relpath)
403
343
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
404
 
    old_branch = branch
405
344
 
406
345
    # Get the new location
407
346
    if new_url is None:
409
348
    if new_url != old_url:
410
349
        working_tree, branch, relpath = \
411
350
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
412
 
        lock_tree_or_branch(working_tree, branch)
413
351
        if consider_relpath and relpath != '':
414
352
            if working_tree is not None and apply_view:
415
353
                views.check_path_in_view(working_tree, relpath)
416
354
            specific_files.append(relpath)
417
355
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
418
356
        basis_is_default=working_tree is None)
419
 
    new_branch = branch
420
357
 
421
358
    # Get the specific files (all files is None, no files is [])
422
359
    if make_paths_wt_relative and working_tree is not None:
423
 
        other_paths = working_tree.safe_relpath_files(
424
 
            other_paths,
 
360
        try:
 
361
            from bzrlib.builtins import safe_relpath_files
 
362
            other_paths = safe_relpath_files(working_tree, other_paths,
425
363
            apply_view=apply_view)
 
364
        except errors.FileInWrongBranch:
 
365
            raise errors.BzrCommandError("Files are in different branches")
426
366
    specific_files.extend(other_paths)
427
367
    if len(specific_files) == 0:
428
368
        specific_files = None
438
378
    extra_trees = None
439
379
    if working_tree is not None and working_tree not in (old_tree, new_tree):
440
380
        extra_trees = (working_tree,)
441
 
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
442
 
 
 
381
    return old_tree, new_tree, specific_files, extra_trees
443
382
 
444
383
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
445
384
    if branch is None and tree is not None:
460
399
                    old_label='a/', new_label='b/',
461
400
                    extra_trees=None,
462
401
                    path_encoding='utf8',
463
 
                    using=None,
464
 
                    format_cls=None):
 
402
                    using=None):
465
403
    """Show in text form the changes from one tree to another.
466
404
 
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)
 
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
476
420
    """
477
 
    if format_cls is None:
478
 
        format_cls = DiffTree
479
421
    old_tree.lock_read()
480
422
    try:
481
423
        if extra_trees is not None:
483
425
                tree.lock_read()
484
426
        new_tree.lock_read()
485
427
        try:
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)
 
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)
490
432
            return differ.show_diff(specific_files, extra_trees)
491
433
        finally:
492
434
            new_tree.unlock()
499
441
 
500
442
def _patch_header_date(tree, file_id, path):
501
443
    """Returns a timestamp suitable for use in a patch header."""
502
 
    try:
503
 
        mtime = tree.get_file_mtime(file_id, path)
504
 
    except errors.FileTimestampUnavailable:
505
 
        mtime = 0
 
444
    mtime = tree.get_file_mtime(file_id, path)
506
445
    return timestamp.format_patch_date(mtime)
507
446
 
508
447
 
703
642
        """
704
643
        def _get_text(tree, file_id, path):
705
644
            if file_id is not None:
706
 
                return tree.get_file_lines(file_id, path)
 
645
                return tree.get_file(file_id, path).readlines()
707
646
            else:
708
647
                return []
709
648
        try:
710
649
            from_text = _get_text(self.old_tree, from_file_id, from_path)
711
650
            to_text = _get_text(self.new_tree, to_file_id, to_path)
712
651
            self.text_differ(from_label, from_text, to_label, to_text,
713
 
                             self.to_file, path_encoding=self.path_encoding)
 
652
                             self.to_file)
714
653
        except errors.BinaryFile:
715
654
            self.to_file.write(
716
655
                  ("Binary files %s and %s differ\n" %
717
 
                  (from_label, to_label)).encode(self.path_encoding,'replace'))
 
656
                  (from_label, to_label)).encode(self.path_encoding))
718
657
        return self.CHANGED
719
658
 
720
659
 
729
668
    @classmethod
730
669
    def from_string(klass, command_string, old_tree, new_tree, to_file,
731
670
                    path_encoding='utf-8'):
732
 
        command_template = cmdline.split(command_string)
733
 
        if '@' not in command_string:
734
 
            command_template.extend(['@old_path', '@new_path'])
 
671
        command_template = commands.shlex_split_unicode(command_string)
 
672
        command_template.extend(['%(old_path)s', '%(new_path)s'])
735
673
        return klass(command_template, old_tree, new_tree, to_file,
736
674
                     path_encoding)
737
675
 
738
676
    @classmethod
739
 
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
 
677
    def make_from_diff_tree(klass, command_string):
740
678
        def from_diff_tree(diff_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,
 
679
            return klass.from_string(command_string, diff_tree.old_tree,
745
680
                                     diff_tree.new_tree, diff_tree.to_file)
746
681
        return from_diff_tree
747
682
 
748
683
    def _get_command(self, old_path, new_path):
749
684
        my_map = {'old_path': old_path, 'new_path': new_path}
750
 
        return [AtTemplate(t).substitute(my_map) for t in
751
 
                self.command_template]
 
685
        return [t % my_map for t in self.command_template]
752
686
 
753
687
    def _execute(self, old_path, new_path):
754
688
        command = self._get_command(old_path, new_path)
774
708
                raise
775
709
        return True
776
710
 
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
 
        
 
711
    def _write_file(self, file_id, tree, prefix, relpath):
782
712
        full_path = osutils.pathjoin(self._root, prefix, relpath)
783
 
        if not force_temp and self._try_symlink_root(tree, prefix):
 
713
        if self._try_symlink_root(tree, prefix):
784
714
            return full_path
785
715
        parent_dir = osutils.dirname(full_path)
786
716
        try:
797
727
                target.close()
798
728
        finally:
799
729
            source.close()
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)
 
730
        osutils.make_readonly(full_path)
 
731
        mtime = tree.get_file_mtime(file_id)
 
732
        os.utime(full_path, (mtime, mtime))
808
733
        return full_path
809
734
 
810
 
    def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
811
 
                       allow_write_new=False):
 
735
    def _prepare_files(self, file_id, old_path, new_path):
812
736
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
813
 
                                         old_path, force_temp)
 
737
                                         old_path)
814
738
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
815
 
                                         new_path, force_temp,
816
 
                                         allow_write=allow_write_new)
 
739
                                         new_path)
817
740
        return old_disk_path, new_disk_path
818
741
 
819
742
    def finish(self):
827
750
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
828
751
        if (old_kind, new_kind) != ('file', 'file'):
829
752
            return DiffPath.CANNOT_DIFF
830
 
        (old_disk_path, new_disk_path) = self._prepare_files(
831
 
                                                file_id, old_path, new_path)
832
 
        self._execute(old_disk_path, new_disk_path)
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()
 
753
        self._prepare_files(file_id, old_path, new_path)
 
754
        self._execute(osutils.pathjoin('old', old_path),
 
755
                      osutils.pathjoin('new', new_path))
856
756
 
857
757
 
858
758
class DiffTree(object):
915
815
        :param using: Commandline to use to invoke an external diff tool
916
816
        """
917
817
        if using is not None:
918
 
            extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
 
818
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
919
819
        else:
920
820
            extra_factories = []
921
821
        if external_diff_options:
922
822
            opts = external_diff_options.split()
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
 
                """
 
823
            def diff_file(olab, olines, nlab, nlines, to_file):
927
824
                external_diff(olab, olines, nlab, nlines, to_file, opts)
928
825
        else:
929
826
            diff_file = internal_diff
935
832
    def show_diff(self, specific_files, extra_trees=None):
936
833
        """Write tree diff to self.to_file
937
834
 
938
 
        :param specific_files: the specific files to compare (recursive)
 
835
        :param sepecific_files: the specific files to compare (recursive)
939
836
        :param extra_trees: extra trees to use for mapping paths to file_ids
940
837
        """
941
838
        try:
1031
928
            if error_path is None:
1032
929
                error_path = old_path
1033
930
            raise errors.NoDiffFound(error_path)
1034
 
 
1035
 
 
1036
 
format_registry = Registry()
1037
 
format_registry.register('default', DiffTree)