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
244
self.any_entries_changed = False
245
self.any_entries_deleted = False
247
self.master_branch = None
248
self.master_locked = False
250
self.specific_files = specific_files
251
self.allow_pointless = allow_pointless
252
self.recursive = recursive
253
self.revprops = revprops
254
self.message_callback = message_callback
255
self.timestamp = timestamp
256
self.timezone = timezone
257
self.committer = committer
259
self.verbose = verbose
261
self.work_tree.lock_write()
262
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
263
self.basis_tree = self.work_tree.basis_tree()
264
self.basis_tree.lock_read()
266
# Cannot commit with conflicts present.
267
if len(self.work_tree.conflicts()) > 0:
268
raise ConflictsInTree
270
# Setup the bound branch variables as needed.
271
self._check_bound_branch()
273
# Check that the working tree is up to date
274
old_revno, new_revno = self._check_out_of_date_tree()
276
# Complete configuration setup
277
if reporter is not None:
278
self.reporter = reporter
279
elif self.reporter is None:
280
self.reporter = self._select_reporter()
281
if self.config is None:
282
self.config = self.branch.get_config()
284
# If provided, ensure the specified files are versioned
285
if specific_files is not None:
286
# Note: We don't actually need the IDs here. This routine
287
# is being called because it raises PathNotVerisonedError
288
# as a side effect of finding the IDs.
289
# XXX: Dont we have filter_unversioned to do this more
291
tree.find_ids_across_trees(specific_files,
292
[self.basis_tree, self.work_tree])
294
# Setup the progress bar. As the number of files that need to be
295
# committed in unknown, progress is reported as stages.
296
# We keep track of entries separately though and include that
297
# information in the progress bar during the relevant stages.
298
self.pb_stage_name = ""
299
self.pb_stage_count = 0
300
self.pb_stage_total = 5
301
if self.bound_branch:
302
self.pb_stage_total += 1
303
self.pb.show_pct = False
304
self.pb.show_spinner = False
305
self.pb.show_eta = False
306
self.pb.show_count = True
307
self.pb.show_bar = True
309
# After a merge, a selected file commit is not supported.
310
# See 'bzr help merge' for an explanation as to why.
311
self.basis_inv = self.basis_tree.inventory
312
self._gather_parents()
313
if len(self.parents) > 1 and self.specific_files:
314
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
316
# Collect the changes
317
self._set_progress_stage("Collecting changes",
318
entries_title="Directory")
319
self.builder = self.branch.get_commit_builder(self.parents,
320
self.config, timestamp, timezone, committer, revprops, rev_id)
323
# find the location being committed to
324
if self.bound_branch:
325
master_location = self.master_branch.base
327
master_location = self.branch.base
329
# report the start of the commit
330
self.reporter.started(new_revno, self.rev_id, master_location)
332
self._update_builder_with_changes()
333
self._check_pointless()
335
# TODO: Now the new inventory is known, check for conflicts.
336
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
337
# weave lines, because nothing should be recorded until it is known
338
# that commit will succeed.
339
self._set_progress_stage("Saving data locally")
340
self.builder.finish_inventory()
342
# Prompt the user for a commit message if none provided
343
message = message_callback(self)
344
assert isinstance(message, unicode), type(message)
345
self.message = message
346
self._escape_commit_message()
348
# Add revision data to the local branch
349
self.rev_id = self.builder.commit(self.message)
355
self._process_pre_hooks(old_revno, new_revno)
357
# Upload revision data to the master.
358
# this will propagate merged revisions too if needed.
359
if self.bound_branch:
360
self._set_progress_stage("Uploading data to master branch")
361
self.master_branch.repository.fetch(self.branch.repository,
362
revision_id=self.rev_id)
363
# now the master has the revision data
364
# 'commit' to the master first so a timeout here causes the
365
# local branch to be out of date
366
self.master_branch.set_last_revision_info(new_revno,
369
# and now do the commit locally.
370
self.branch.set_last_revision_info(new_revno, self.rev_id)
372
# Make the working tree up to date with the branch
373
self._set_progress_stage("Updating the working tree")
374
rev_tree = self.builder.revision_tree()
375
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
376
self.reporter.completed(new_revno, self.rev_id)
377
self._process_post_hooks(old_revno, new_revno)
382
def _select_reporter(self):
383
"""Select the CommitReporter to use."""
385
return NullCommitReporter()
386
return ReportCommitToLog()
388
def _check_pointless(self):
389
if self.allow_pointless:
391
# A merge with no effect on files
392
if len(self.parents) > 1:
394
# work around the fact that a newly-initted tree does differ from its
396
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
397
raise PointlessCommit()
398
# Shortcut, if the number of entries changes, then we obviously have
400
if len(self.builder.new_inventory) != len(self.basis_inv):
402
# If length == 1, then we only have the root entry. Which means
403
# that there is no real difference (only the root could be different)
404
if len(self.builder.new_inventory) != 1 and (self.any_entries_changed
405
or self.any_entries_deleted):
407
raise PointlessCommit()
409
def _check_bound_branch(self):
410
"""Check to see if the local branch is bound.
412
If it is bound, then most of the commit will actually be
413
done using the remote branch as the target branch.
414
Only at the end will the local branch be updated.
416
if self.local and not self.branch.get_bound_location():
417
raise errors.LocalRequiresBoundBranch()
420
self.master_branch = self.branch.get_master_branch()
422
if not self.master_branch:
423
# make this branch the reference branch for out of date checks.
424
self.master_branch = self.branch
427
# If the master branch is bound, we must fail
428
master_bound_location = self.master_branch.get_bound_location()
429
if master_bound_location:
430
raise errors.CommitToDoubleBoundBranch(self.branch,
431
self.master_branch, master_bound_location)
433
# TODO: jam 20051230 We could automatically push local
434
# commits to the remote branch if they would fit.
435
# But for now, just require remote to be identical
438
# Make sure the local branch is identical to the master
439
master_info = self.master_branch.last_revision_info()
440
local_info = self.branch.last_revision_info()
441
if local_info != master_info:
442
raise errors.BoundBranchOutOfDate(self.branch,
445
# Now things are ready to change the master branch
447
self.bound_branch = self.branch
448
self.master_branch.lock_write()
449
self.master_locked = True
451
def _check_out_of_date_tree(self):
452
"""Check that the working tree is up to date.
454
:return: old_revision_number,new_revision_number tuple
457
first_tree_parent = self.work_tree.get_parent_ids()[0]
459
# if there are no parents, treat our parent as 'None'
460
# this is so that we still consider the master branch
461
# - in a checkout scenario the tree may have no
462
# parents but the branch may do.
463
first_tree_parent = bzrlib.revision.NULL_REVISION
464
old_revno, master_last = self.master_branch.last_revision_info()
465
if master_last != first_tree_parent:
466
if master_last != bzrlib.revision.NULL_REVISION:
467
raise errors.OutOfDateTree(self.work_tree)
468
if self.branch.repository.has_revision(first_tree_parent):
469
new_revno = old_revno + 1
471
# ghost parents never appear in revision history.
473
return old_revno,new_revno
475
def _process_pre_hooks(self, old_revno, new_revno):
476
"""Process any registered pre commit hooks."""
477
self._set_progress_stage("Running pre_commit hooks")
478
self._process_hooks("pre_commit", old_revno, new_revno)
480
def _process_post_hooks(self, old_revno, new_revno):
481
"""Process any registered post commit hooks."""
482
# Process the post commit hooks, if any
483
self._set_progress_stage("Running post_commit hooks")
484
# old style commit hooks - should be deprecated ? (obsoleted in
486
if self.config.post_commit() is not None:
487
hooks = self.config.post_commit().split(' ')
488
# this would be nicer with twisted.python.reflect.namedAny
490
result = eval(hook + '(branch, rev_id)',
491
{'branch':self.branch,
493
'rev_id':self.rev_id})
494
# process new style post commit hooks
495
self._process_hooks("post_commit", old_revno, new_revno)
497
def _process_hooks(self, hook_name, old_revno, new_revno):
498
if not Branch.hooks[hook_name]:
501
# new style commit hooks:
502
if not self.bound_branch:
503
hook_master = self.branch
506
hook_master = self.master_branch
507
hook_local = self.branch
508
# With bound branches, when the master is behind the local branch,
509
# the 'old_revno' and old_revid values here are incorrect.
510
# XXX: FIXME ^. RBC 20060206
512
old_revid = self.parents[0]
514
old_revid = bzrlib.revision.NULL_REVISION
516
if hook_name == "pre_commit":
517
future_tree = self.builder.revision_tree()
518
tree_delta = future_tree.changes_from(self.basis_tree,
521
for hook in Branch.hooks[hook_name]:
522
# show the running hook in the progress bar. As hooks may
523
# end up doing nothing (e.g. because they are not configured by
524
# the user) this is still showing progress, not showing overall
525
# actions - its up to each plugin to show a UI if it want's to
526
# (such as 'Emailing diff to foo@example.com').
527
self.pb_stage_name = "Running %s hooks [%s]" % \
528
(hook_name, Branch.hooks.get_hook_name(hook))
529
self._emit_progress()
530
if 'hooks' in debug.debug_flags:
531
mutter("Invoking commit hook: %r", hook)
532
if hook_name == "post_commit":
533
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
535
elif hook_name == "pre_commit":
536
hook(hook_local, hook_master,
537
old_revno, old_revid, new_revno, self.rev_id,
538
tree_delta, future_tree)
541
"""Cleanup any open locks, progress bars etc."""
542
cleanups = [self._cleanup_bound_branch,
543
self.basis_tree.unlock,
544
self.work_tree.unlock,
546
found_exception = None
547
for cleanup in cleanups:
550
# we want every cleanup to run no matter what.
551
# so we have a catchall here, but we will raise the
552
# last encountered exception up the stack: and
553
# typically this will be useful enough.
556
if found_exception is not None:
557
# don't do a plan raise, because the last exception may have been
558
# trashed, e is our sure-to-work exception even though it loses the
559
# full traceback. XXX: RBC 20060421 perhaps we could check the
560
# exc_info and if its the same one do a plain raise otherwise
561
# 'raise e' as we do now.
564
def _cleanup_bound_branch(self):
565
"""Executed at the end of a try/finally to cleanup a bound branch.
567
If the branch wasn't bound, this is a no-op.
568
If it was, it resents self.branch to the local branch, instead
571
if not self.bound_branch:
573
if self.master_locked:
574
self.master_branch.unlock()
576
def _escape_commit_message(self):
577
"""Replace xml-incompatible control characters."""
578
# FIXME: RBC 20060419 this should be done by the revision
579
# serialiser not by commit. Then we can also add an unescaper
580
# in the deserializer and start roundtripping revision messages
581
# precisely. See repository_implementations/test_repository.py
583
# Python strings can include characters that can't be
584
# represented in well-formed XML; escape characters that
585
# aren't listed in the XML specification
586
# (http://www.w3.org/TR/REC-xml/#NT-Char).
587
self.message, escape_count = re.subn(
588
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
589
lambda match: match.group(0).encode('unicode_escape'),
592
self.reporter.escaped(escape_count, self.message)
594
def _gather_parents(self):
595
"""Record the parents of a merge for merge detection."""
596
# TODO: Make sure that this list doesn't contain duplicate
597
# entries and the order is preserved when doing this.
598
self.parents = self.work_tree.get_parent_ids()
599
self.parent_invs = [self.basis_inv]
600
for revision in self.parents[1:]:
601
if self.branch.repository.has_revision(revision):
602
mutter('commit parent revision {%s}', revision)
603
inventory = self.branch.repository.get_inventory(revision)
604
self.parent_invs.append(inventory)
606
mutter('commit parent ghost revision {%s}', revision)
608
def _update_builder_with_changes(self):
609
"""Update the commit builder with the data about what has changed.
611
# Build the revision inventory.
613
# This starts by creating a new empty inventory. Depending on
614
# which files are selected for commit, and what is present in the
615
# current tree, the new inventory is populated. inventory entries
616
# which are candidates for modification have their revision set to
617
# None; inventory entries that are carried over untouched have their
618
# revision set to their prior value.
620
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
621
# results to create a new inventory at the same time, which results
622
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
625
specific_files = self.specific_files
626
mutter("Selecting files for commit with filter %s", specific_files)
628
# Check and warn about old CommitBuilders
629
if not self.builder.record_root_entry:
630
symbol_versioning.warn('CommitBuilders should support recording'
631
' the root entry as of bzr 0.10.', DeprecationWarning,
633
self.builder.new_inventory.add(self.basis_inv.root.copy())
635
# Build the new inventory
636
self._populate_from_inventory(specific_files)
638
# If specific files are selected, then all un-selected files must be
639
# recorded in their previous state. For more details, see
640
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
642
for path, new_ie in self.basis_inv.iter_entries():
643
if new_ie.file_id in self.builder.new_inventory:
645
if is_inside_any(specific_files, path):
649
if self.builder.record_entry_contents(ie, self.parent_invs, path,
651
self.any_entries_changed = True
653
# note that deletes have occurred
654
if set(self.basis_inv._byid.keys()) - set(self.builder.new_inventory._byid.keys()):
655
self.any_entries_deleted = True
656
# Report what was deleted.
657
if self.any_entries_deleted and self.reporter.is_verbose():
658
for path, ie in self.basis_inv.iter_entries():
659
if ie.file_id not in self.builder.new_inventory:
660
self.reporter.deleted(path)
662
def _populate_from_inventory(self, specific_files):
663
"""Populate the CommitBuilder by walking the working tree inventory."""
665
# raise an exception as soon as we find a single unknown.
666
for unknown in self.work_tree.unknowns():
667
raise StrictCommitFailed()
669
report_changes = self.reporter.is_verbose()
671
deleted_paths = set()
672
work_inv = self.work_tree.inventory
673
assert work_inv.root is not None
674
entries = work_inv.iter_entries_by_dir()
675
if not self.builder.record_root_entry:
677
for path, existing_ie in entries:
678
file_id = existing_ie.file_id
679
name = existing_ie.name
680
parent_id = existing_ie.parent_id
681
kind = existing_ie.kind
682
if kind == 'directory':
683
self._next_progress_entry()
685
# Skip files that have been deleted from the working tree.
686
# The deleted files/directories are also recorded so they
687
# can be explicitly unversioned later. Note that when a
688
# filter of specific files is given, we must only skip/record
689
# deleted files matching that filter.
690
if is_inside_any(deleted_paths, path):
692
if not specific_files or is_inside_any(specific_files, path):
693
if not self.work_tree.has_filename(path):
694
deleted_paths.add(path)
695
self.reporter.missing(path)
696
deleted_ids.append(file_id)
699
kind = self.work_tree.kind(file_id)
700
# TODO: specific_files filtering before nested tree processing
701
if kind == 'tree-reference' and self.recursive == 'down':
702
self._commit_nested_tree(file_id, path)
703
except errors.NoSuchFile:
706
# Record an entry for this item
707
# Note: I don't particularly want to have the existing_ie
708
# parameter but the test suite currently (28-Jun-07) breaks
709
# without it thanks to a unicode normalisation issue. :-(
710
definitely_changed = kind != existing_ie.kind
711
self._record_entry(path, file_id, specific_files, kind, name,
712
parent_id, definitely_changed, existing_ie, report_changes)
714
# Unversion IDs that were found to be deleted
715
self.work_tree.unversion(deleted_ids)
717
def _commit_nested_tree(self, file_id, path):
718
"Commit a nested tree."
719
sub_tree = self.work_tree.get_nested_tree(file_id, path)
720
# FIXME: be more comprehensive here:
721
# this works when both trees are in --trees repository,
722
# but when both are bound to a different repository,
723
# it fails; a better way of approaching this is to
724
# finally implement the explicit-caches approach design
725
# a while back - RBC 20070306.
726
if sub_tree.branch.repository.has_same_location(
727
self.work_tree.branch.repository):
728
sub_tree.branch.repository = \
729
self.work_tree.branch.repository
731
sub_tree.commit(message=None, revprops=self.revprops,
732
recursive=self.recursive,
733
message_callback=self.message_callback,
734
timestamp=self.timestamp, timezone=self.timezone,
735
committer=self.committer,
736
allow_pointless=self.allow_pointless,
737
strict=self.strict, verbose=self.verbose,
738
local=self.local, reporter=self.reporter)
739
except errors.PointlessCommit:
742
def _record_entry(self, path, file_id, specific_files, kind, name,
743
parent_id, definitely_changed, existing_ie=None,
744
report_changes=True):
745
"Record the new inventory entry for a path if any."
746
# mutter('check %s {%s}', path, file_id)
747
if (not specific_files or
748
is_inside_or_parent_of_any(specific_files, path)):
749
# mutter('%s selected for commit', path)
750
if definitely_changed or existing_ie is None:
751
ie = inventory.make_entry(kind, name, parent_id, file_id)
753
ie = existing_ie.copy()
756
# mutter('%s not selected for commit', path)
757
if self.basis_inv.has_id(file_id):
758
ie = self.basis_inv[file_id].copy()
760
# this entry is new and not being committed
763
if self.builder.record_entry_contents(ie, self.parent_invs,
764
path, self.work_tree):
765
self.any_entries_changed = True
767
self._report_change(ie, path)
770
def _report_change(self, ie, path):
771
"""Report a change to the user.
773
The change that has occurred is described relative to the basis
776
if (self.basis_inv.has_id(ie.file_id)):
777
basis_ie = self.basis_inv[ie.file_id]
780
change = ie.describe_change(basis_ie, ie)
781
if change in (InventoryEntry.RENAMED,
782
InventoryEntry.MODIFIED_AND_RENAMED):
783
old_path = self.basis_inv.id2path(ie.file_id)
784
self.reporter.renamed(change, old_path, path)
786
self.reporter.snapshot_change(change, path)
788
def _set_progress_stage(self, name, entries_title=None):
789
"""Set the progress stage and emit an update to the progress bar."""
790
self.pb_stage_name = name
791
self.pb_stage_count += 1
792
self.pb_entries_title = entries_title
793
if entries_title is not None:
794
self.pb_entries_count = 0
795
self.pb_entries_total = '?'
796
self._emit_progress()
798
def _next_progress_entry(self):
799
"""Emit an update to the progress bar and increment the entry count."""
800
self.pb_entries_count += 1
801
self._emit_progress()
803
def _emit_progress(self):
804
if self.pb_entries_title:
805
if self.pb_entries_total == '?':
806
text = "%s [%s %d] - Stage" % (self.pb_stage_name,
807
self.pb_entries_title, self.pb_entries_count)
809
text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
810
self.pb_entries_title, self.pb_entries_count,
811
str(self.pb_entries_total))
813
text = "%s - Stage" % (self.pb_stage_name)
814
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)