/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Vincent Ladeuil
  • Date: 2009-06-22 12:52:39 UTC
  • mto: (4471.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4472.
  • Revision ID: v.ladeuil+lp@free.fr-20090622125239-kabo9smxt9c3vnir
Use a consistent scheme for naming pyrex source files.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
1
 
# Copyright (C) 2005-2011 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
25
25
import errno
26
26
import subprocess
27
27
import tempfile
 
28
import time
28
29
 
29
30
from bzrlib import (
 
31
    branch as _mod_branch,
30
32
    bzrdir,
31
 
    cmdline,
32
 
    cleanup,
 
33
    commands,
33
34
    errors,
34
35
    osutils,
35
36
    patiencediff,
37
38
    timestamp,
38
39
    views,
39
40
    )
40
 
 
41
 
from bzrlib.workingtree import WorkingTree
42
41
""")
43
42
 
44
 
from bzrlib.registry import (
45
 
    Registry,
46
 
    )
47
43
from bzrlib.symbol_versioning import (
48
44
    deprecated_function,
49
 
    deprecated_in,
50
45
    )
51
46
from bzrlib.trace import mutter, note, warning
52
47
 
53
48
 
54
 
class AtTemplate(string.Template):
55
 
    """Templating class that uses @ instead of $."""
56
 
 
57
 
    delimiter = '@'
58
 
 
59
 
 
60
49
# TODO: Rather than building a changeset object, we should probably
61
50
# invoke callbacks on an object.  That object can either accumulate a
62
51
# list, write them out directly, etc etc.
97
86
    if sequence_matcher is None:
98
87
        sequence_matcher = patiencediff.PatienceSequenceMatcher
99
88
    ud = patiencediff.unified_diff(oldlines, newlines,
100
 
                      fromfile=old_filename.encode(path_encoding, 'replace'),
101
 
                      tofile=new_filename.encode(path_encoding, 'replace'),
 
89
                      fromfile=old_filename.encode(path_encoding),
 
90
                      tofile=new_filename.encode(path_encoding),
102
91
                      sequencematcher=sequence_matcher)
103
92
 
104
93
    ud = list(ud)
182
171
 
183
172
        if not diff_opts:
184
173
            diff_opts = []
185
 
        if sys.platform == 'win32':
186
 
            # Popen doesn't do the proper encoding for external commands
187
 
            # Since we are dealing with an ANSI api, use mbcs encoding
188
 
            old_filename = old_filename.encode('mbcs')
189
 
            new_filename = new_filename.encode('mbcs')
190
174
        diffcmd = ['diff',
191
175
                   '--label', old_filename,
192
176
                   old_abspath,
288
272
                        new_abspath, e)
289
273
 
290
274
 
291
 
@deprecated_function(deprecated_in((2, 2, 0)))
292
 
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
293
 
                                   apply_view=True):
294
 
    """Get the trees and specific files to diff given a list of paths.
295
 
 
296
 
    This method works out the trees to be diff'ed and the files of
297
 
    interest within those trees.
298
 
 
299
 
    :param path_list:
300
 
        the list of arguments passed to the diff command
301
 
    :param revision_specs:
302
 
        Zero, one or two RevisionSpecs from the diff command line,
303
 
        saying what revisions to compare.
304
 
    :param old_url:
305
 
        The url of the old branch or tree. If None, the tree to use is
306
 
        taken from the first path, if any, or the current working tree.
307
 
    :param new_url:
308
 
        The url of the new branch or tree. If None, the tree to use is
309
 
        taken from the first path, if any, or the current working tree.
310
 
    :param apply_view:
311
 
        if True and a view is set, apply the view or check that the paths
312
 
        are within it
313
 
    :returns:
314
 
        a tuple of (old_tree, new_tree, old_branch, new_branch,
315
 
        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.
 
275
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url,
 
276
    apply_view=True):
 
277
    """Get the trees and specific files to diff given a list of paths.
 
278
 
 
279
    This method works out the trees to be diff'ed and the files of
 
280
    interest within those trees.
 
281
 
 
282
    :param path_list:
 
283
        the list of arguments passed to the diff command
 
284
    :param revision_specs:
 
285
        Zero, one or two RevisionSpecs from the diff command line,
 
286
        saying what revisions to compare.
 
287
    :param old_url:
 
288
        The url of the old branch or tree. If None, the tree to use is
 
289
        taken from the first path, if any, or the current working tree.
 
290
    :param new_url:
 
291
        The url of the new branch or tree. If None, the tree to use is
 
292
        taken from the first path, if any, or the current working tree.
 
293
    :param apply_view:
 
294
        if True and a view is set, apply the view or check that the paths
 
295
        are within it
 
296
    :returns:
 
297
        a tuple of (old_tree, new_tree, specific_files, extra_trees) where
 
298
        extra_trees is a sequence of additional trees to search in for
 
299
        file-ids.
354
300
    """
355
301
    # Get the old and new revision specs
356
302
    old_revision_spec = None
379
325
        default_location = path_list[0]
380
326
        other_paths = path_list[1:]
381
327
 
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
328
    # Get the old location
391
329
    specific_files = []
392
330
    if old_url is None:
393
331
        old_url = default_location
394
332
    working_tree, branch, relpath = \
395
333
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
396
 
    lock_tree_or_branch(working_tree, branch)
397
334
    if consider_relpath and relpath != '':
398
335
        if working_tree is not None and apply_view:
399
336
            views.check_path_in_view(working_tree, relpath)
400
337
        specific_files.append(relpath)
401
338
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
402
 
    old_branch = branch
403
339
 
404
340
    # Get the new location
405
341
    if new_url is None:
407
343
    if new_url != old_url:
408
344
        working_tree, branch, relpath = \
409
345
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
410
 
        lock_tree_or_branch(working_tree, branch)
411
346
        if consider_relpath and relpath != '':
412
347
            if working_tree is not None and apply_view:
413
348
                views.check_path_in_view(working_tree, relpath)
414
349
            specific_files.append(relpath)
415
350
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
416
351
        basis_is_default=working_tree is None)
417
 
    new_branch = branch
418
352
 
419
353
    # Get the specific files (all files is None, no files is [])
420
354
    if make_paths_wt_relative and working_tree is not None:
421
 
        other_paths = working_tree.safe_relpath_files(
422
 
            other_paths,
 
355
        try:
 
356
            from bzrlib.builtins import safe_relpath_files
 
357
            other_paths = safe_relpath_files(working_tree, other_paths,
423
358
            apply_view=apply_view)
 
359
        except errors.FileInWrongBranch:
 
360
            raise errors.BzrCommandError("Files are in different branches")
424
361
    specific_files.extend(other_paths)
425
362
    if len(specific_files) == 0:
426
363
        specific_files = None
436
373
    extra_trees = None
437
374
    if working_tree is not None and working_tree not in (old_tree, new_tree):
438
375
        extra_trees = (working_tree,)
439
 
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
440
 
 
 
376
    return old_tree, new_tree, specific_files, extra_trees
441
377
 
442
378
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
443
379
    if branch is None and tree is not None:
458
394
                    old_label='a/', new_label='b/',
459
395
                    extra_trees=None,
460
396
                    path_encoding='utf8',
461
 
                    using=None,
462
 
                    format_cls=None):
 
397
                    using=None):
463
398
    """Show in text form the changes from one tree to another.
464
399
 
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)
 
400
    to_file
 
401
        The output stream.
 
402
 
 
403
    specific_files
 
404
        Include only changes to these files - None for all changes.
 
405
 
 
406
    external_diff_options
 
407
        If set, use an external GNU diff and pass these options.
 
408
 
 
409
    extra_trees
 
410
        If set, more Trees to use for looking up file ids
 
411
 
 
412
    path_encoding
 
413
        If set, the path will be encoded as specified, otherwise is supposed
 
414
        to be utf8
474
415
    """
475
 
    if format_cls is None:
476
 
        format_cls = DiffTree
477
416
    old_tree.lock_read()
478
417
    try:
479
418
        if extra_trees is not None:
481
420
                tree.lock_read()
482
421
        new_tree.lock_read()
483
422
        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)
 
423
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
 
424
                                                 path_encoding,
 
425
                                                 external_diff_options,
 
426
                                                 old_label, new_label, using)
488
427
            return differ.show_diff(specific_files, extra_trees)
489
428
        finally:
490
429
            new_tree.unlock()
497
436
 
498
437
def _patch_header_date(tree, file_id, path):
499
438
    """Returns a timestamp suitable for use in a patch header."""
500
 
    try:
501
 
        mtime = tree.get_file_mtime(file_id, path)
502
 
    except errors.FileTimestampUnavailable:
503
 
        mtime = 0
 
439
    mtime = tree.get_file_mtime(file_id, path)
504
440
    return timestamp.format_patch_date(mtime)
505
441
 
506
442
 
701
637
        """
702
638
        def _get_text(tree, file_id, path):
703
639
            if file_id is not None:
704
 
                return tree.get_file_lines(file_id, path)
 
640
                return tree.get_file(file_id, path).readlines()
705
641
            else:
706
642
                return []
707
643
        try:
708
644
            from_text = _get_text(self.old_tree, from_file_id, from_path)
709
645
            to_text = _get_text(self.new_tree, to_file_id, to_path)
710
646
            self.text_differ(from_label, from_text, to_label, to_text,
711
 
                             self.to_file, path_encoding=self.path_encoding)
 
647
                             self.to_file)
712
648
        except errors.BinaryFile:
713
649
            self.to_file.write(
714
650
                  ("Binary files %s and %s differ\n" %
715
 
                  (from_label, to_label)).encode(self.path_encoding,'replace'))
 
651
                  (from_label, to_label)).encode(self.path_encoding))
716
652
        return self.CHANGED
717
653
 
718
654
 
727
663
    @classmethod
728
664
    def from_string(klass, command_string, old_tree, new_tree, to_file,
729
665
                    path_encoding='utf-8'):
730
 
        command_template = cmdline.split(command_string)
731
 
        if '@' not in command_string:
732
 
            command_template.extend(['@old_path', '@new_path'])
 
666
        command_template = commands.shlex_split_unicode(command_string)
 
667
        command_template.extend(['%(old_path)s', '%(new_path)s'])
733
668
        return klass(command_template, old_tree, new_tree, to_file,
734
669
                     path_encoding)
735
670
 
736
671
    @classmethod
737
 
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
 
672
    def make_from_diff_tree(klass, command_string):
738
673
        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,
 
674
            return klass.from_string(command_string, diff_tree.old_tree,
743
675
                                     diff_tree.new_tree, diff_tree.to_file)
744
676
        return from_diff_tree
745
677
 
746
678
    def _get_command(self, old_path, new_path):
747
679
        my_map = {'old_path': old_path, 'new_path': new_path}
748
 
        return [AtTemplate(t).substitute(my_map) for t in
749
 
                self.command_template]
 
680
        return [t % my_map for t in self.command_template]
750
681
 
751
682
    def _execute(self, old_path, new_path):
752
683
        command = self._get_command(old_path, new_path)
772
703
                raise
773
704
        return True
774
705
 
775
 
    def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
776
 
                    allow_write=False):
777
 
        if not force_temp and isinstance(tree, WorkingTree):
778
 
            return tree.abspath(tree.id2path(file_id))
779
 
        
 
706
    def _write_file(self, file_id, tree, prefix, relpath):
780
707
        full_path = osutils.pathjoin(self._root, prefix, relpath)
781
 
        if not force_temp and self._try_symlink_root(tree, prefix):
 
708
        if self._try_symlink_root(tree, prefix):
782
709
            return full_path
783
710
        parent_dir = osutils.dirname(full_path)
784
711
        try:
795
722
                target.close()
796
723
        finally:
797
724
            source.close()
798
 
        try:
799
 
            mtime = tree.get_file_mtime(file_id)
800
 
        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)
 
725
        osutils.make_readonly(full_path)
 
726
        mtime = tree.get_file_mtime(file_id)
 
727
        os.utime(full_path, (mtime, mtime))
806
728
        return full_path
807
729
 
808
 
    def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
809
 
                       allow_write_new=False):
 
730
    def _prepare_files(self, file_id, old_path, new_path):
810
731
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
811
 
                                         old_path, force_temp)
 
732
                                         old_path)
812
733
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
813
 
                                         new_path, force_temp,
814
 
                                         allow_write=allow_write_new)
 
734
                                         new_path)
815
735
        return old_disk_path, new_disk_path
816
736
 
817
737
    def finish(self):
825
745
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
826
746
        if (old_kind, new_kind) != ('file', 'file'):
827
747
            return DiffPath.CANNOT_DIFF
828
 
        (old_disk_path, new_disk_path) = self._prepare_files(
829
 
                                                file_id, old_path, new_path)
830
 
        self._execute(old_disk_path, new_disk_path)
831
 
 
832
 
    def edit_file(self, file_id):
833
 
        """Use this tool to edit a file.
834
 
 
835
 
        A temporary copy will be edited, and the new contents will be
836
 
        returned.
837
 
 
838
 
        :param file_id: The id of the file to edit.
839
 
        :return: The new contents of the file.
840
 
        """
841
 
        old_path = self.old_tree.id2path(file_id)
842
 
        new_path = self.new_tree.id2path(file_id)
843
 
        new_abs_path = self._prepare_files(file_id, old_path, new_path,
844
 
                                           allow_write_new=True,
845
 
                                           force_temp=True)[1]
846
 
        command = self._get_command(osutils.pathjoin('old', old_path),
847
 
                                    osutils.pathjoin('new', new_path))
848
 
        subprocess.call(command, cwd=self._root)
849
 
        new_file = open(new_abs_path, 'r')
850
 
        try:
851
 
            return new_file.read()
852
 
        finally:
853
 
            new_file.close()
 
748
        self._prepare_files(file_id, old_path, new_path)
 
749
        self._execute(osutils.pathjoin('old', old_path),
 
750
                      osutils.pathjoin('new', new_path))
854
751
 
855
752
 
856
753
class DiffTree(object):
913
810
        :param using: Commandline to use to invoke an external diff tool
914
811
        """
915
812
        if using is not None:
916
 
            extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
 
813
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
917
814
        else:
918
815
            extra_factories = []
919
816
        if external_diff_options:
920
817
            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
 
                """
 
818
            def diff_file(olab, olines, nlab, nlines, to_file):
925
819
                external_diff(olab, olines, nlab, nlines, to_file, opts)
926
820
        else:
927
821
            diff_file = internal_diff
933
827
    def show_diff(self, specific_files, extra_trees=None):
934
828
        """Write tree diff to self.to_file
935
829
 
936
 
        :param specific_files: the specific files to compare (recursive)
 
830
        :param sepecific_files: the specific files to compare (recursive)
937
831
        :param extra_trees: extra trees to use for mapping paths to file_ids
938
832
        """
939
833
        try:
1029
923
            if error_path is None:
1030
924
                error_path = old_path
1031
925
            raise errors.NoDiffFound(error_path)
1032
 
 
1033
 
 
1034
 
format_registry = Registry()
1035
 
format_registry.register('default', DiffTree)