1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# The newly committed revision is going to have a shape corresponding
19
# to that of the working inventory. Files that are not in the
20
# working tree and that were in the predecessor are reported as
21
# removed --- this can include files that were either removed from the
22
# inventory or deleted in the working tree. If they were only
23
# deleted from disk, they are removed from the working inventory.
25
# We then consider the remaining entries, which will be in the new
26
# version. Directory entries are simply copied across. File entries
27
# must be checked to see if a new version of the file should be
28
# recorded. For each parent revision inventory, we check to see what
29
# version of the file was present. If the file was present in at
30
# least one tree, and if it was the same version in all the trees,
31
# then we can just refer to that version. Otherwise, a new version
32
# representing the merger of the file versions must be added.
34
# TODO: Update hashcache before and after - or does the WorkingTree
37
# TODO: Rather than mashing together the ancestry and storing it back,
38
# perhaps the weave should have single method which does it all in one
39
# go, avoiding a lot of redundant work.
41
# TODO: Perhaps give a warning if one of the revisions marked as
42
# merged is already in the ancestry, and then don't record it as a
45
# TODO: If the file is newly merged but unchanged from the version it
46
# merges from, then it should still be reported as newly added
47
# relative to the basis revision.
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
# the rest of the code; add a deprecation of the old name.
57
from cStringIO import StringIO
65
from bzrlib.branch import Branch
67
from bzrlib.errors import (BzrError, PointlessCommit,
71
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
72
is_inside_or_parent_of_any,
73
quotefn, sha_file, split_lines)
74
from bzrlib.testament import Testament
75
from bzrlib.trace import mutter, note, warning, is_quiet
76
from bzrlib.xml5 import serializer_v5
77
from bzrlib.inventory import Inventory, InventoryEntry
78
from bzrlib import symbol_versioning
79
from bzrlib.symbol_versioning import (deprecated_passed,
82
from bzrlib.workingtree import WorkingTree
83
from bzrlib.urlutils import unescape_for_display
87
class NullCommitReporter(object):
88
"""I report on progress of a commit."""
90
def started(self, revno, revid, location=None):
93
def snapshot_change(self, change, path):
96
def completed(self, revno, rev_id):
99
def deleted(self, file_id):
102
def escaped(self, escape_count, message):
105
def missing(self, path):
108
def renamed(self, change, old_path, new_path):
111
def is_verbose(self):
115
class ReportCommitToLog(NullCommitReporter):
117
def _note(self, format, *args):
120
Subclasses may choose to override this method.
124
def snapshot_change(self, change, path):
125
if change == 'unchanged':
127
if change == 'added' and path == '':
129
self._note("%s %s", change, path)
131
def started(self, revno, rev_id, location=None):
132
if location is not None:
133
location = ' to "' + unescape_for_display(location, 'utf-8') + '"'
136
self._note('Committing revision %d%s.', revno, location)
138
def completed(self, revno, rev_id):
139
self._note('Committed revision %d.', revno)
141
def deleted(self, file_id):
142
self._note('deleted %s', file_id)
144
def escaped(self, escape_count, message):
145
self._note("replaced %d control characters in message", escape_count)
147
def missing(self, path):
148
self._note('missing %s', path)
150
def renamed(self, change, old_path, new_path):
151
self._note('%s %s => %s', change, old_path, new_path)
153
def is_verbose(self):
157
class Commit(object):
158
"""Task of committing a new revision.
160
This is a MethodObject: it accumulates state as the commit is
161
prepared, and then it is discarded. It doesn't represent
162
historical revisions, just the act of recording a new one.
165
Modified to hold a list of files that have been deleted from
166
the working directory; these should be removed from the
172
"""Create a Commit object.
174
:param reporter: the default reporter to use or None to decide later
176
self.reporter = reporter
186
allow_pointless=True,
194
message_callback=None,
196
"""Commit working copy as a new revision.
198
:param message: the commit message (it or message_callback is required)
200
:param timestamp: if not None, seconds-since-epoch for a
201
postdated/predated commit.
203
:param specific_files: If true, commit only those files.
205
:param rev_id: If set, use this as the new revision id.
206
Useful for test or import commands that need to tightly
207
control what revisions are assigned. If you duplicate
208
a revision id that exists elsewhere it is your own fault.
209
If null (default), a time/random revision id is generated.
211
:param allow_pointless: If true (default), commit even if nothing
212
has changed and no merges are recorded.
214
:param strict: If true, don't allow a commit if the working tree
215
contains unknown files.
217
:param revprops: Properties for new revision
218
:param local: Perform a local only commit.
219
:param reporter: the reporter to use or None for the default
220
:param verbose: if True and the reporter is not None, report everything
221
:param recursive: If set to 'down', commit in any subtrees that have
222
pending changes of any sort during this commit.
224
mutter('preparing to commit')
226
if working_tree is None:
227
raise BzrError("working_tree must be passed into commit().")
229
self.work_tree = working_tree
230
self.branch = self.work_tree.branch
231
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
232
if not self.branch.repository.supports_rich_root():
233
raise errors.RootNotRich()
234
if message_callback is None:
235
if message is not None:
236
if isinstance(message, str):
237
message = message.decode(bzrlib.user_encoding)
238
message_callback = lambda x: message
240
raise BzrError("The message or message_callback keyword"
241
" parameter is required for commit().")
243
self.bound_branch = None
245
self.master_branch = None
246
self.master_locked = False
248
self.specific_files = specific_files
249
self.allow_pointless = allow_pointless
250
self.recursive = recursive
251
self.revprops = revprops
252
self.message_callback = message_callback
253
self.timestamp = timestamp
254
self.timezone = timezone
255
self.committer = committer
257
self.verbose = verbose
259
self.work_tree.lock_write()
260
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
261
self.basis_tree = self.work_tree.basis_tree()
262
self.basis_tree.lock_read()
264
# Cannot commit with conflicts present.
265
if len(self.work_tree.conflicts()) > 0:
266
raise ConflictsInTree
268
# Setup the bound branch variables as needed.
269
self._check_bound_branch()
271
# Check that the working tree is up to date
272
old_revno, new_revno = self._check_out_of_date_tree()
274
# Complete configuration setup
275
if reporter is not None:
276
self.reporter = reporter
277
elif self.reporter is None:
278
self.reporter = self._select_reporter()
279
if self.config is None:
280
self.config = self.branch.get_config()
282
# If provided, ensure the specified files are versioned
283
if specific_files is not None:
284
# Note: We don't actually need the IDs here. This routine
285
# is being called because it raises PathNotVerisonedError
286
# as a side effect of finding the IDs.
287
# XXX: Dont we have filter_unversioned to do this more
289
tree.find_ids_across_trees(specific_files,
290
[self.basis_tree, self.work_tree])
292
# Setup the progress bar. As the number of files that need to be
293
# committed in unknown, progress is reported as stages.
294
# We keep track of entries separately though and include that
295
# information in the progress bar during the relevant stages.
296
self.pb_stage_name = ""
297
self.pb_stage_count = 0
298
self.pb_stage_total = 5
299
if self.bound_branch:
300
self.pb_stage_total += 1
301
self.pb.show_pct = False
302
self.pb.show_spinner = False
303
self.pb.show_eta = False
304
self.pb.show_count = True
305
self.pb.show_bar = True
307
# After a merge, a selected file commit is not supported.
308
# See 'bzr help merge' for an explanation as to why.
309
self.basis_inv = self.basis_tree.inventory
310
self._gather_parents()
311
if len(self.parents) > 1 and self.specific_files:
312
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
314
# Collect the changes
315
self._set_progress_stage("Collecting changes",
316
entries_title="Directory")
317
self.builder = self.branch.get_commit_builder(self.parents,
318
self.config, timestamp, timezone, committer, revprops, rev_id)
321
# find the location being committed to
322
if self.bound_branch:
323
master_location = self.master_branch.base
325
master_location = self.branch.base
327
# report the start of the commit
328
self.reporter.started(new_revno, self.rev_id, master_location)
330
self._update_builder_with_changes()
331
self._check_pointless()
333
# TODO: Now the new inventory is known, check for conflicts.
334
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
335
# weave lines, because nothing should be recorded until it is known
336
# that commit will succeed.
337
self._set_progress_stage("Saving data locally")
338
self.builder.finish_inventory()
340
# Prompt the user for a commit message if none provided
341
message = message_callback(self)
342
assert isinstance(message, unicode), type(message)
343
self.message = message
344
self._escape_commit_message()
346
# Add revision data to the local branch
347
self.rev_id = self.builder.commit(self.message)
353
self._process_pre_hooks(old_revno, new_revno)
355
# Upload revision data to the master.
356
# this will propagate merged revisions too if needed.
357
if self.bound_branch:
358
self._set_progress_stage("Uploading data to master branch")
359
self.master_branch.repository.fetch(self.branch.repository,
360
revision_id=self.rev_id)
361
# now the master has the revision data
362
# 'commit' to the master first so a timeout here causes the
363
# local branch to be out of date
364
self.master_branch.set_last_revision_info(new_revno,
367
# and now do the commit locally.
368
self.branch.set_last_revision_info(new_revno, self.rev_id)
370
# Make the working tree up to date with the branch
371
self._set_progress_stage("Updating the working tree")
372
rev_tree = self.builder.revision_tree()
373
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
374
self.reporter.completed(new_revno, self.rev_id)
375
self._process_post_hooks(old_revno, new_revno)
380
def _select_reporter(self):
381
"""Select the CommitReporter to use."""
383
return NullCommitReporter()
384
return ReportCommitToLog()
386
def _any_real_changes(self):
387
"""Are there real changes between new_inventory and basis?
389
For trees without rich roots, inv.root.revision changes every commit.
390
But if that is the only change, we want to treat it as though there
393
new_entries = self.builder.new_inventory.iter_entries()
394
basis_entries = self.basis_inv.iter_entries()
395
new_path, new_root_ie = new_entries.next()
396
basis_path, basis_root_ie = basis_entries.next()
398
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
399
def ie_equal_no_revision(this, other):
400
return ((this.file_id == other.file_id)
401
and (this.name == other.name)
402
and (this.symlink_target == other.symlink_target)
403
and (this.text_sha1 == other.text_sha1)
404
and (this.text_size == other.text_size)
405
and (this.text_id == other.text_id)
406
and (this.parent_id == other.parent_id)
407
and (this.kind == other.kind)
408
and (this.executable == other.executable)
409
and (this.reference_revision == other.reference_revision)
411
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
414
for new_ie, basis_ie in zip(new_entries, basis_entries):
415
if new_ie != basis_ie:
418
# No actual changes present
421
def _check_pointless(self):
422
if self.allow_pointless:
424
# A merge with no effect on files
425
if len(self.parents) > 1:
427
# work around the fact that a newly-initted tree does differ from its
429
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
430
raise PointlessCommit()
431
# Shortcut, if the number of entries changes, then we obviously have
433
if len(self.builder.new_inventory) != len(self.basis_inv):
435
# If length == 1, then we only have the root entry. Which means
436
# that there is no real difference (only the root could be different)
437
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
439
raise PointlessCommit()
441
def _check_bound_branch(self):
442
"""Check to see if the local branch is bound.
444
If it is bound, then most of the commit will actually be
445
done using the remote branch as the target branch.
446
Only at the end will the local branch be updated.
448
if self.local and not self.branch.get_bound_location():
449
raise errors.LocalRequiresBoundBranch()
452
self.master_branch = self.branch.get_master_branch()
454
if not self.master_branch:
455
# make this branch the reference branch for out of date checks.
456
self.master_branch = self.branch
459
# If the master branch is bound, we must fail
460
master_bound_location = self.master_branch.get_bound_location()
461
if master_bound_location:
462
raise errors.CommitToDoubleBoundBranch(self.branch,
463
self.master_branch, master_bound_location)
465
# TODO: jam 20051230 We could automatically push local
466
# commits to the remote branch if they would fit.
467
# But for now, just require remote to be identical
470
# Make sure the local branch is identical to the master
471
master_info = self.master_branch.last_revision_info()
472
local_info = self.branch.last_revision_info()
473
if local_info != master_info:
474
raise errors.BoundBranchOutOfDate(self.branch,
477
# Now things are ready to change the master branch
479
self.bound_branch = self.branch
480
self.master_branch.lock_write()
481
self.master_locked = True
483
def _check_out_of_date_tree(self):
484
"""Check that the working tree is up to date.
486
:return: old_revision_number,new_revision_number tuple
489
first_tree_parent = self.work_tree.get_parent_ids()[0]
491
# if there are no parents, treat our parent as 'None'
492
# this is so that we still consider the master branch
493
# - in a checkout scenario the tree may have no
494
# parents but the branch may do.
495
first_tree_parent = bzrlib.revision.NULL_REVISION
496
old_revno, master_last = self.master_branch.last_revision_info()
497
if master_last != first_tree_parent:
498
if master_last != bzrlib.revision.NULL_REVISION:
499
raise errors.OutOfDateTree(self.work_tree)
500
if self.branch.repository.has_revision(first_tree_parent):
501
new_revno = old_revno + 1
503
# ghost parents never appear in revision history.
505
return old_revno,new_revno
507
def _process_pre_hooks(self, old_revno, new_revno):
508
"""Process any registered pre commit hooks."""
509
self._set_progress_stage("Running pre_commit hooks")
510
self._process_hooks("pre_commit", old_revno, new_revno)
512
def _process_post_hooks(self, old_revno, new_revno):
513
"""Process any registered post commit hooks."""
514
# Process the post commit hooks, if any
515
self._set_progress_stage("Running post_commit hooks")
516
# old style commit hooks - should be deprecated ? (obsoleted in
518
if self.config.post_commit() is not None:
519
hooks = self.config.post_commit().split(' ')
520
# this would be nicer with twisted.python.reflect.namedAny
522
result = eval(hook + '(branch, rev_id)',
523
{'branch':self.branch,
525
'rev_id':self.rev_id})
526
# process new style post commit hooks
527
self._process_hooks("post_commit", old_revno, new_revno)
529
def _process_hooks(self, hook_name, old_revno, new_revno):
530
if not Branch.hooks[hook_name]:
533
# new style commit hooks:
534
if not self.bound_branch:
535
hook_master = self.branch
538
hook_master = self.master_branch
539
hook_local = self.branch
540
# With bound branches, when the master is behind the local branch,
541
# the 'old_revno' and old_revid values here are incorrect.
542
# XXX: FIXME ^. RBC 20060206
544
old_revid = self.parents[0]
546
old_revid = bzrlib.revision.NULL_REVISION
548
if hook_name == "pre_commit":
549
future_tree = self.builder.revision_tree()
550
tree_delta = future_tree.changes_from(self.basis_tree,
553
for hook in Branch.hooks[hook_name]:
554
# show the running hook in the progress bar. As hooks may
555
# end up doing nothing (e.g. because they are not configured by
556
# the user) this is still showing progress, not showing overall
557
# actions - its up to each plugin to show a UI if it want's to
558
# (such as 'Emailing diff to foo@example.com').
559
self.pb_stage_name = "Running %s hooks [%s]" % \
560
(hook_name, Branch.hooks.get_hook_name(hook))
561
self._emit_progress()
562
if 'hooks' in debug.debug_flags:
563
mutter("Invoking commit hook: %r", hook)
564
if hook_name == "post_commit":
565
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
567
elif hook_name == "pre_commit":
568
hook(hook_local, hook_master,
569
old_revno, old_revid, new_revno, self.rev_id,
570
tree_delta, future_tree)
573
"""Cleanup any open locks, progress bars etc."""
574
cleanups = [self._cleanup_bound_branch,
575
self.basis_tree.unlock,
576
self.work_tree.unlock,
578
found_exception = None
579
for cleanup in cleanups:
582
# we want every cleanup to run no matter what.
583
# so we have a catchall here, but we will raise the
584
# last encountered exception up the stack: and
585
# typically this will be useful enough.
588
if found_exception is not None:
589
# don't do a plan raise, because the last exception may have been
590
# trashed, e is our sure-to-work exception even though it loses the
591
# full traceback. XXX: RBC 20060421 perhaps we could check the
592
# exc_info and if its the same one do a plain raise otherwise
593
# 'raise e' as we do now.
596
def _cleanup_bound_branch(self):
597
"""Executed at the end of a try/finally to cleanup a bound branch.
599
If the branch wasn't bound, this is a no-op.
600
If it was, it resents self.branch to the local branch, instead
603
if not self.bound_branch:
605
if self.master_locked:
606
self.master_branch.unlock()
608
def _escape_commit_message(self):
609
"""Replace xml-incompatible control characters."""
610
# FIXME: RBC 20060419 this should be done by the revision
611
# serialiser not by commit. Then we can also add an unescaper
612
# in the deserializer and start roundtripping revision messages
613
# precisely. See repository_implementations/test_repository.py
615
# Python strings can include characters that can't be
616
# represented in well-formed XML; escape characters that
617
# aren't listed in the XML specification
618
# (http://www.w3.org/TR/REC-xml/#NT-Char).
619
self.message, escape_count = re.subn(
620
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
621
lambda match: match.group(0).encode('unicode_escape'),
624
self.reporter.escaped(escape_count, self.message)
626
def _gather_parents(self):
627
"""Record the parents of a merge for merge detection."""
628
# TODO: Make sure that this list doesn't contain duplicate
629
# entries and the order is preserved when doing this.
630
self.parents = self.work_tree.get_parent_ids()
631
self.parent_invs = [self.basis_inv]
632
for revision in self.parents[1:]:
633
if self.branch.repository.has_revision(revision):
634
mutter('commit parent revision {%s}', revision)
635
inventory = self.branch.repository.get_inventory(revision)
636
self.parent_invs.append(inventory)
638
mutter('commit parent ghost revision {%s}', revision)
640
def _update_builder_with_changes(self):
641
"""Update the commit builder with the data about what has changed.
643
# Build the revision inventory.
645
# This starts by creating a new empty inventory. Depending on
646
# which files are selected for commit, and what is present in the
647
# current tree, the new inventory is populated. inventory entries
648
# which are candidates for modification have their revision set to
649
# None; inventory entries that are carried over untouched have their
650
# revision set to their prior value.
652
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
653
# results to create a new inventory at the same time, which results
654
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
657
specific_files = self.specific_files
658
mutter("Selecting files for commit with filter %s", specific_files)
660
# Check and warn about old CommitBuilders
661
if not self.builder.record_root_entry:
662
symbol_versioning.warn('CommitBuilders should support recording'
663
' the root entry as of bzr 0.10.', DeprecationWarning,
665
self.builder.new_inventory.add(self.basis_inv.root.copy())
667
# Build the new inventory
668
self._populate_from_inventory(specific_files)
670
# If specific files are selected, then all un-selected files must be
671
# recorded in their previous state. For more details, see
672
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
674
for path, new_ie in self.basis_inv.iter_entries():
675
if new_ie.file_id in self.builder.new_inventory:
677
if is_inside_any(specific_files, path):
681
self.builder.record_entry_contents(ie, self.parent_invs, path,
684
# Report what was deleted.
685
if self.reporter.is_verbose():
686
for path, ie in self.basis_inv.iter_entries():
687
if ie.file_id not in self.builder.new_inventory:
688
self.reporter.deleted(path)
690
def _populate_from_inventory(self, specific_files):
691
"""Populate the CommitBuilder by walking the working tree inventory."""
693
# raise an exception as soon as we find a single unknown.
694
for unknown in self.work_tree.unknowns():
695
raise StrictCommitFailed()
697
report_changes = self.reporter.is_verbose()
699
deleted_paths = set()
700
work_inv = self.work_tree.inventory
701
assert work_inv.root is not None
702
entries = work_inv.iter_entries_by_dir()
703
if not self.builder.record_root_entry:
705
for path, existing_ie in entries:
706
file_id = existing_ie.file_id
707
name = existing_ie.name
708
parent_id = existing_ie.parent_id
709
kind = existing_ie.kind
710
if kind == 'directory':
711
self._next_progress_entry()
713
# Skip files that have been deleted from the working tree.
714
# The deleted files/directories are also recorded so they
715
# can be explicitly unversioned later. Note that when a
716
# filter of specific files is given, we must only skip/record
717
# deleted files matching that filter.
718
if is_inside_any(deleted_paths, path):
720
if not specific_files or is_inside_any(specific_files, path):
721
if not self.work_tree.has_filename(path):
722
deleted_paths.add(path)
723
self.reporter.missing(path)
724
deleted_ids.append(file_id)
727
kind = self.work_tree.kind(file_id)
728
# TODO: specific_files filtering before nested tree processing
729
if kind == 'tree-reference' and self.recursive == 'down':
730
self._commit_nested_tree(file_id, path)
731
except errors.NoSuchFile:
734
# Record an entry for this item
735
# Note: I don't particularly want to have the existing_ie
736
# parameter but the test suite currently (28-Jun-07) breaks
737
# without it thanks to a unicode normalisation issue. :-(
738
definitely_changed = kind != existing_ie.kind
739
self._record_entry(path, file_id, specific_files, kind, name,
740
parent_id, definitely_changed, existing_ie, report_changes)
742
# Unversion IDs that were found to be deleted
743
self.work_tree.unversion(deleted_ids)
745
def _commit_nested_tree(self, file_id, path):
746
"Commit a nested tree."
747
sub_tree = self.work_tree.get_nested_tree(file_id, path)
748
# FIXME: be more comprehensive here:
749
# this works when both trees are in --trees repository,
750
# but when both are bound to a different repository,
751
# it fails; a better way of approaching this is to
752
# finally implement the explicit-caches approach design
753
# a while back - RBC 20070306.
754
if sub_tree.branch.repository.has_same_location(
755
self.work_tree.branch.repository):
756
sub_tree.branch.repository = \
757
self.work_tree.branch.repository
759
sub_tree.commit(message=None, revprops=self.revprops,
760
recursive=self.recursive,
761
message_callback=self.message_callback,
762
timestamp=self.timestamp, timezone=self.timezone,
763
committer=self.committer,
764
allow_pointless=self.allow_pointless,
765
strict=self.strict, verbose=self.verbose,
766
local=self.local, reporter=self.reporter)
767
except errors.PointlessCommit:
770
def _record_entry(self, path, file_id, specific_files, kind, name,
771
parent_id, definitely_changed, existing_ie=None,
772
report_changes=True):
773
"Record the new inventory entry for a path if any."
774
# mutter('check %s {%s}', path, file_id)
775
if (not specific_files or
776
is_inside_or_parent_of_any(specific_files, path)):
777
# mutter('%s selected for commit', path)
778
if definitely_changed or existing_ie is None:
779
ie = inventory.make_entry(kind, name, parent_id, file_id)
781
ie = existing_ie.copy()
784
# mutter('%s not selected for commit', path)
785
if self.basis_inv.has_id(file_id):
786
ie = self.basis_inv[file_id].copy()
788
# this entry is new and not being committed
791
self.builder.record_entry_contents(ie, self.parent_invs,
792
path, self.work_tree)
794
self._report_change(ie, path)
797
def _report_change(self, ie, path):
798
"""Report a change to the user.
800
The change that has occurred is described relative to the basis
803
if (self.basis_inv.has_id(ie.file_id)):
804
basis_ie = self.basis_inv[ie.file_id]
807
change = ie.describe_change(basis_ie, ie)
808
if change in (InventoryEntry.RENAMED,
809
InventoryEntry.MODIFIED_AND_RENAMED):
810
old_path = self.basis_inv.id2path(ie.file_id)
811
self.reporter.renamed(change, old_path, path)
813
self.reporter.snapshot_change(change, path)
815
def _set_progress_stage(self, name, entries_title=None):
816
"""Set the progress stage and emit an update to the progress bar."""
817
self.pb_stage_name = name
818
self.pb_stage_count += 1
819
self.pb_entries_title = entries_title
820
if entries_title is not None:
821
self.pb_entries_count = 0
822
self.pb_entries_total = '?'
823
self._emit_progress()
825
def _next_progress_entry(self):
826
"""Emit an update to the progress bar and increment the entry count."""
827
self.pb_entries_count += 1
828
self._emit_progress()
830
def _emit_progress(self):
831
if self.pb_entries_title:
832
if self.pb_entries_total == '?':
833
text = "%s [%s %d] - Stage" % (self.pb_stage_name,
834
self.pb_entries_title, self.pb_entries_count)
836
text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
837
self.pb_entries_title, self.pb_entries_count,
838
str(self.pb_entries_total))
840
text = "%s - Stage" % (self.pb_stage_name)
841
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)