/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-10-08 16:15:00 UTC
  • mfrom: (4705.1.4 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 4733.
  • Revision ID: v.ladeuil+lp@free.fr-20091008161500-qki8uqv3fkzbdm90
Make diff.get_trees_and_branches_to_diff a public API

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.
290
277
                        new_abspath, e)
291
278
 
292
279
 
293
 
@deprecated_function(deprecated_in((2, 2, 0)))
294
280
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.
 
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)
409
349
    if new_url != old_url:
410
350
        working_tree, branch, relpath = \
411
351
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
412
 
        lock_tree_or_branch(working_tree, branch)
413
352
        if consider_relpath and relpath != '':
414
353
            if working_tree is not None and apply_view:
415
354
                views.check_path_in_view(working_tree, relpath)
443
382
        extra_trees = (working_tree,)
444
383
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
445
384
 
446
 
 
447
385
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
448
386
    if branch is None and tree is not None:
449
387
        branch = tree.branch
463
401
                    old_label='a/', new_label='b/',
464
402
                    extra_trees=None,
465
403
                    path_encoding='utf8',
466
 
                    using=None,
467
 
                    format_cls=None):
 
404
                    using=None):
468
405
    """Show in text form the changes from one tree to another.
469
406
 
470
 
    :param to_file: The output stream.
471
 
    :param specific_files:Include only changes to these files - None for all
472
 
        changes.
473
 
    :param external_diff_options: If set, use an external GNU diff and pass 
474
 
        these options.
475
 
    :param extra_trees: If set, more Trees to use for looking up file ids
476
 
    :param path_encoding: If set, the path will be encoded as specified, 
477
 
        otherwise is supposed to be utf8
478
 
    :param format_cls: Formatter class (DiffTree subclass)
 
407
    to_file
 
408
        The output stream.
 
409
 
 
410
    specific_files
 
411
        Include only changes to these files - None for all changes.
 
412
 
 
413
    external_diff_options
 
414
        If set, use an external GNU diff and pass these options.
 
415
 
 
416
    extra_trees
 
417
        If set, more Trees to use for looking up file ids
 
418
 
 
419
    path_encoding
 
420
        If set, the path will be encoded as specified, otherwise is supposed
 
421
        to be utf8
479
422
    """
480
 
    if format_cls is None:
481
 
        format_cls = DiffTree
482
423
    old_tree.lock_read()
483
424
    try:
484
425
        if extra_trees is not None:
486
427
                tree.lock_read()
487
428
        new_tree.lock_read()
488
429
        try:
489
 
            differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
490
 
                                                   path_encoding,
491
 
                                                   external_diff_options,
492
 
                                                   old_label, new_label, using)
 
430
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
 
431
                                                 path_encoding,
 
432
                                                 external_diff_options,
 
433
                                                 old_label, new_label, using)
493
434
            return differ.show_diff(specific_files, extra_trees)
494
435
        finally:
495
436
            new_tree.unlock()
502
443
 
503
444
def _patch_header_date(tree, file_id, path):
504
445
    """Returns a timestamp suitable for use in a patch header."""
505
 
    try:
506
 
        mtime = tree.get_file_mtime(file_id, path)
507
 
    except errors.FileTimestampUnavailable:
508
 
        mtime = 0
 
446
    mtime = tree.get_file_mtime(file_id, path)
509
447
    return timestamp.format_patch_date(mtime)
510
448
 
511
449
 
732
670
    @classmethod
733
671
    def from_string(klass, command_string, old_tree, new_tree, to_file,
734
672
                    path_encoding='utf-8'):
735
 
        command_template = cmdline.split(command_string)
736
 
        if '@' not in command_string:
737
 
            command_template.extend(['@old_path', '@new_path'])
 
673
        command_template = commands.shlex_split_unicode(command_string)
 
674
        command_template.extend(['%(old_path)s', '%(new_path)s'])
738
675
        return klass(command_template, old_tree, new_tree, to_file,
739
676
                     path_encoding)
740
677
 
747
684
 
748
685
    def _get_command(self, old_path, new_path):
749
686
        my_map = {'old_path': old_path, 'new_path': new_path}
750
 
        return [AtTemplate(t).substitute(my_map) for t in
751
 
                self.command_template]
 
687
        return [t % my_map for t in self.command_template]
752
688
 
753
689
    def _execute(self, old_path, new_path):
754
690
        command = self._get_command(old_path, new_path)
774
710
                raise
775
711
        return True
776
712
 
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
 
        
 
713
    def _write_file(self, file_id, tree, prefix, relpath):
782
714
        full_path = osutils.pathjoin(self._root, prefix, relpath)
783
 
        if not force_temp and self._try_symlink_root(tree, prefix):
 
715
        if self._try_symlink_root(tree, prefix):
784
716
            return full_path
785
717
        parent_dir = osutils.dirname(full_path)
786
718
        try:
797
729
                target.close()
798
730
        finally:
799
731
            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)
 
732
        osutils.make_readonly(full_path)
 
733
        mtime = tree.get_file_mtime(file_id)
 
734
        os.utime(full_path, (mtime, mtime))
808
735
        return full_path
809
736
 
810
 
    def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
811
 
                       allow_write_new=False):
 
737
    def _prepare_files(self, file_id, old_path, new_path):
812
738
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
813
 
                                         old_path, force_temp)
 
739
                                         old_path)
814
740
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
815
 
                                         new_path, force_temp,
816
 
                                         allow_write=allow_write_new)
 
741
                                         new_path)
817
742
        return old_disk_path, new_disk_path
818
743
 
819
744
    def finish(self):
827
752
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
828
753
        if (old_kind, new_kind) != ('file', 'file'):
829
754
            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()
 
755
        self._prepare_files(file_id, old_path, new_path)
 
756
        self._execute(osutils.pathjoin('old', old_path),
 
757
                      osutils.pathjoin('new', new_path))
856
758
 
857
759
 
858
760
class DiffTree(object):
932
834
    def show_diff(self, specific_files, extra_trees=None):
933
835
        """Write tree diff to self.to_file
934
836
 
935
 
        :param specific_files: the specific files to compare (recursive)
 
837
        :param sepecific_files: the specific files to compare (recursive)
936
838
        :param extra_trees: extra trees to use for mapping paths to file_ids
937
839
        """
938
840
        try:
1028
930
            if error_path is None:
1029
931
                error_path = old_path
1030
932
            raise errors.NoDiffFound(error_path)
1031
 
 
1032
 
 
1033
 
format_registry = Registry()
1034
 
format_registry.register('default', DiffTree)