~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Martin Pool
  • Date: 2010-02-25 06:17:27 UTC
  • mfrom: (5055 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5057.
  • Revision ID: mbp@sourcefrog.net-20100225061727-4sd9lt0qmdc6087t
merge news

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 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
21
import string
21
22
import sys
22
23
 
25
26
import errno
26
27
import subprocess
27
28
import tempfile
 
29
import time
28
30
 
29
31
from bzrlib import (
 
32
    branch as _mod_branch,
30
33
    bzrdir,
31
34
    cmdline,
32
 
    cleanup,
33
35
    errors,
34
36
    osutils,
35
37
    patiencediff,
41
43
from bzrlib.workingtree import WorkingTree
42
44
""")
43
45
 
44
 
from bzrlib.registry import (
45
 
    Registry,
46
 
    )
47
46
from bzrlib.symbol_versioning import (
48
47
    deprecated_function,
49
 
    deprecated_in,
50
48
    )
51
49
from bzrlib.trace import mutter, note, warning
52
50
 
97
95
    if sequence_matcher is None:
98
96
        sequence_matcher = patiencediff.PatienceSequenceMatcher
99
97
    ud = patiencediff.unified_diff(oldlines, newlines,
100
 
                      fromfile=old_filename.encode(path_encoding, 'replace'),
101
 
                      tofile=new_filename.encode(path_encoding, 'replace'),
 
98
                      fromfile=old_filename.encode(path_encoding),
 
99
                      tofile=new_filename.encode(path_encoding),
102
100
                      sequencematcher=sequence_matcher)
103
101
 
104
102
    ud = list(ud)
288
286
                        new_abspath, e)
289
287
 
290
288
 
291
 
@deprecated_function(deprecated_in((2, 2, 0)))
292
289
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
293
290
                                   apply_view=True):
294
291
    """Get the trees and specific files to diff given a list of paths.
313
310
    :returns:
314
311
        a tuple of (old_tree, new_tree, old_branch, new_branch,
315
312
        specific_files, extra_trees) where extra_trees is a sequence of
316
 
        additional trees to search in for file-ids.  The trees and branches
317
 
        are not locked.
318
 
    """
319
 
    op = cleanup.OperationWithCleanups(get_trees_and_branches_to_diff_locked)
320
 
    return op.run_simple(path_list, revision_specs, old_url, new_url,
321
 
            op.add_cleanup, apply_view=apply_view)
322
 
    
323
 
 
324
 
def get_trees_and_branches_to_diff_locked(
325
 
    path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
326
 
    """Get the trees and specific files to diff given a list of paths.
327
 
 
328
 
    This method works out the trees to be diff'ed and the files of
329
 
    interest within those trees.
330
 
 
331
 
    :param path_list:
332
 
        the list of arguments passed to the diff command
333
 
    :param revision_specs:
334
 
        Zero, one or two RevisionSpecs from the diff command line,
335
 
        saying what revisions to compare.
336
 
    :param old_url:
337
 
        The url of the old branch or tree. If None, the tree to use is
338
 
        taken from the first path, if any, or the current working tree.
339
 
    :param new_url:
340
 
        The url of the new branch or tree. If None, the tree to use is
341
 
        taken from the first path, if any, or the current working tree.
342
 
    :param add_cleanup:
343
 
        a callable like Command.add_cleanup.  get_trees_and_branches_to_diff
344
 
        will register cleanups that must be run to unlock the trees, etc.
345
 
    :param apply_view:
346
 
        if True and a view is set, apply the view or check that the paths
347
 
        are within it
348
 
    :returns:
349
 
        a tuple of (old_tree, new_tree, old_branch, new_branch,
350
 
        specific_files, extra_trees) where extra_trees is a sequence of
351
 
        additional trees to search in for file-ids.  The trees and branches
352
 
        will be read-locked until the cleanups registered via the add_cleanup
353
 
        param are run.
 
313
        additional trees to search in for file-ids.
354
314
    """
355
315
    # Get the old and new revision specs
356
316
    old_revision_spec = None
379
339
        default_location = path_list[0]
380
340
        other_paths = path_list[1:]
381
341
 
382
 
    def lock_tree_or_branch(wt, br):
383
 
        if wt is not None:
384
 
            wt.lock_read()
385
 
            add_cleanup(wt.unlock)
386
 
        elif br is not None:
387
 
            br.lock_read()
388
 
            add_cleanup(br.unlock)
389
 
 
390
342
    # Get the old location
391
343
    specific_files = []
392
344
    if old_url is None:
393
345
        old_url = default_location
394
346
    working_tree, branch, relpath = \
395
347
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
396
 
    lock_tree_or_branch(working_tree, branch)
397
348
    if consider_relpath and relpath != '':
398
349
        if working_tree is not None and apply_view:
399
350
            views.check_path_in_view(working_tree, relpath)
407
358
    if new_url != old_url:
408
359
        working_tree, branch, relpath = \
409
360
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
410
 
        lock_tree_or_branch(working_tree, branch)
411
361
        if consider_relpath and relpath != '':
412
362
            if working_tree is not None and apply_view:
413
363
                views.check_path_in_view(working_tree, relpath)
418
368
 
419
369
    # Get the specific files (all files is None, no files is [])
420
370
    if make_paths_wt_relative and working_tree is not None:
421
 
        other_paths = working_tree.safe_relpath_files(
422
 
            other_paths,
 
371
        try:
 
372
            from bzrlib.builtins import safe_relpath_files
 
373
            other_paths = safe_relpath_files(working_tree, other_paths,
423
374
            apply_view=apply_view)
 
375
        except errors.FileInWrongBranch:
 
376
            raise errors.BzrCommandError("Files are in different branches")
424
377
    specific_files.extend(other_paths)
425
378
    if len(specific_files) == 0:
426
379
        specific_files = None
458
411
                    old_label='a/', new_label='b/',
459
412
                    extra_trees=None,
460
413
                    path_encoding='utf8',
461
 
                    using=None,
462
 
                    format_cls=None):
 
414
                    using=None):
463
415
    """Show in text form the changes from one tree to another.
464
416
 
465
 
    :param to_file: The output stream.
466
 
    :param specific_files:Include only changes to these files - None for all
467
 
        changes.
468
 
    :param external_diff_options: If set, use an external GNU diff and pass 
469
 
        these options.
470
 
    :param extra_trees: If set, more Trees to use for looking up file ids
471
 
    :param path_encoding: If set, the path will be encoded as specified, 
472
 
        otherwise is supposed to be utf8
473
 
    :param format_cls: Formatter class (DiffTree subclass)
 
417
    to_file
 
418
        The output stream.
 
419
 
 
420
    specific_files
 
421
        Include only changes to these files - None for all changes.
 
422
 
 
423
    external_diff_options
 
424
        If set, use an external GNU diff and pass these options.
 
425
 
 
426
    extra_trees
 
427
        If set, more Trees to use for looking up file ids
 
428
 
 
429
    path_encoding
 
430
        If set, the path will be encoded as specified, otherwise is supposed
 
431
        to be utf8
474
432
    """
475
 
    if format_cls is None:
476
 
        format_cls = DiffTree
477
433
    old_tree.lock_read()
478
434
    try:
479
435
        if extra_trees is not None:
481
437
                tree.lock_read()
482
438
        new_tree.lock_read()
483
439
        try:
484
 
            differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
485
 
                                                   path_encoding,
486
 
                                                   external_diff_options,
487
 
                                                   old_label, new_label, using)
 
440
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
 
441
                                                 path_encoding,
 
442
                                                 external_diff_options,
 
443
                                                 old_label, new_label, using)
488
444
            return differ.show_diff(specific_files, extra_trees)
489
445
        finally:
490
446
            new_tree.unlock()
701
657
        """
702
658
        def _get_text(tree, file_id, path):
703
659
            if file_id is not None:
704
 
                return tree.get_file_lines(file_id, path)
 
660
                return tree.get_file(file_id, path).readlines()
705
661
            else:
706
662
                return []
707
663
        try:
708
664
            from_text = _get_text(self.old_tree, from_file_id, from_path)
709
665
            to_text = _get_text(self.new_tree, to_file_id, to_path)
710
666
            self.text_differ(from_label, from_text, to_label, to_text,
711
 
                             self.to_file, path_encoding=self.path_encoding)
 
667
                             self.to_file)
712
668
        except errors.BinaryFile:
713
669
            self.to_file.write(
714
670
                  ("Binary files %s and %s differ\n" %
715
 
                  (from_label, to_label)).encode(self.path_encoding,'replace'))
 
671
                  (from_label, to_label)).encode(self.path_encoding))
716
672
        return self.CHANGED
717
673
 
718
674
 
734
690
                     path_encoding)
735
691
 
736
692
    @classmethod
737
 
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
 
693
    def make_from_diff_tree(klass, command_string):
738
694
        def from_diff_tree(diff_tree):
739
 
            full_command_string = [command_string]
740
 
            if external_diff_options is not None:
741
 
                full_command_string += ' ' + external_diff_options
742
 
            return klass.from_string(full_command_string, diff_tree.old_tree,
 
695
            return klass.from_string(command_string, diff_tree.old_tree,
743
696
                                     diff_tree.new_tree, diff_tree.to_file)
744
697
        return from_diff_tree
745
698
 
795
748
                target.close()
796
749
        finally:
797
750
            source.close()
 
751
        if not allow_write:
 
752
            osutils.make_readonly(full_path)
798
753
        try:
799
754
            mtime = tree.get_file_mtime(file_id)
800
755
        except errors.FileTimestampUnavailable:
801
 
            pass
802
 
        else:
803
 
            os.utime(full_path, (mtime, mtime))
804
 
        if not allow_write:
805
 
            osutils.make_readonly(full_path)
 
756
            mtime = 0
 
757
        os.utime(full_path, (mtime, mtime))
806
758
        return full_path
807
759
 
808
760
    def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
913
865
        :param using: Commandline to use to invoke an external diff tool
914
866
        """
915
867
        if using is not None:
916
 
            extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
 
868
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
917
869
        else:
918
870
            extra_factories = []
919
871
        if external_diff_options:
920
872
            opts = external_diff_options.split()
921
 
            def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None):
922
 
                """:param path_encoding: not used but required
923
 
                        to match the signature of internal_diff.
924
 
                """
 
873
            def diff_file(olab, olines, nlab, nlines, to_file):
925
874
                external_diff(olab, olines, nlab, nlines, to_file, opts)
926
875
        else:
927
876
            diff_file = internal_diff
933
882
    def show_diff(self, specific_files, extra_trees=None):
934
883
        """Write tree diff to self.to_file
935
884
 
936
 
        :param specific_files: the specific files to compare (recursive)
 
885
        :param sepecific_files: the specific files to compare (recursive)
937
886
        :param extra_trees: extra trees to use for mapping paths to file_ids
938
887
        """
939
888
        try:
1029
978
            if error_path is None:
1030
979
                error_path = old_path
1031
980
            raise errors.NoDiffFound(error_path)
1032
 
 
1033
 
 
1034
 
format_registry = Registry()
1035
 
format_registry.register('default', DiffTree)