293
@deprecated_function(deprecated_in((2, 2, 0)))
294
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
296
"""Get the trees and specific files to diff given a list of paths.
298
This method works out the trees to be diff'ed and the files of
299
interest within those trees.
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.
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.
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.
313
if True and a view is set, apply the view or check that the paths
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
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)
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.
330
This method works out the trees to be diff'ed and the files of
331
interest within those trees.
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.
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.
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.
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.
348
if True and a view is set, apply the view or check that the paths
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
280
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url,
282
"""Get the trees and specific files to diff given a list of paths.
284
This method works out the trees to be diff'ed and the files of
285
interest within those trees.
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.
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.
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.
299
if True and a view is set, apply the view or check that the paths
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
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:]
384
def lock_tree_or_branch(wt, br):
387
add_cleanup(wt.unlock)
390
add_cleanup(br.unlock)
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)
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)
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(
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
460
399
old_label='a/', new_label='b/',
461
400
extra_trees=None,
462
401
path_encoding='utf8',
465
403
"""Show in text form the changes from one tree to another.
467
:param to_file: The output stream.
468
:param specific_files:Include only changes to these files - None for all
470
:param external_diff_options: If set, use an external GNU diff and pass
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)
409
Include only changes to these files - None for all changes.
411
external_diff_options
412
If set, use an external GNU diff and pass these options.
415
If set, more Trees to use for looking up file ids
418
If set, the path will be encoded as specified, otherwise is supposed
477
if format_cls is None:
478
format_cls = DiffTree
479
421
old_tree.lock_read()
481
423
if extra_trees is not None:
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()
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)
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
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,
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
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]
753
687
def _execute(self, old_path, new_path):
754
688
command = self._get_command(old_path, new_path)
777
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
779
if not force_temp and isinstance(tree, WorkingTree):
780
return tree.abspath(tree.id2path(file_id))
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):
785
715
parent_dir = osutils.dirname(full_path)
801
mtime = tree.get_file_mtime(file_id)
802
except errors.FileTimestampUnavailable:
805
os.utime(full_path, (mtime, mtime))
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))
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)
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)
817
740
return old_disk_path, new_disk_path
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)
834
def edit_file(self, file_id):
835
"""Use this tool to edit a file.
837
A temporary copy will be edited, and the new contents will be
840
:param file_id: The id of the file to edit.
841
:return: The new contents of the file.
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,
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')
853
return new_file.read()
753
self._prepare_files(file_id, old_path, new_path)
754
self._execute(osutils.pathjoin('old', old_path),
755
osutils.pathjoin('new', new_path))
858
758
class DiffTree(object):
915
815
:param using: Commandline to use to invoke an external diff tool
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)]
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.
823
def diff_file(olab, olines, nlab, nlines, to_file):
927
824
external_diff(olab, olines, nlab, nlines, to_file, opts)
929
826
diff_file = internal_diff