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
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
86
class NullCommitReporter(object):
87
"""I report on progress of a commit."""
89
def snapshot_change(self, change, path):
92
def completed(self, revno, rev_id):
95
def deleted(self, file_id):
98
def escaped(self, escape_count, message):
101
def missing(self, path):
104
def renamed(self, change, old_path, new_path):
108
class ReportCommitToLog(NullCommitReporter):
110
def _note(self, format, *args):
113
Subclasses may choose to override this method.
117
def snapshot_change(self, change, path):
118
if change == 'unchanged':
120
if change == 'added' and path == '':
122
self._note("%s %s", change, path)
124
def completed(self, revno, rev_id):
125
self._note('Committed revision %d.', revno)
127
def deleted(self, file_id):
128
self._note('deleted %s', file_id)
130
def escaped(self, escape_count, message):
131
self._note("replaced %d control characters in message", escape_count)
133
def missing(self, path):
134
self._note('missing %s', path)
136
def renamed(self, change, old_path, new_path):
137
self._note('%s %s => %s', change, old_path, new_path)
140
class Commit(object):
141
"""Task of committing a new revision.
143
This is a MethodObject: it accumulates state as the commit is
144
prepared, and then it is discarded. It doesn't represent
145
historical revisions, just the act of recording a new one.
148
Modified to hold a list of files that have been deleted from
149
the working directory; these should be removed from the
155
if reporter is not None:
156
self.reporter = reporter
158
self.reporter = NullCommitReporter()
168
allow_pointless=True,
176
message_callback=None,
178
"""Commit working copy as a new revision.
180
:param message: the commit message (it or message_callback is required)
182
:param timestamp: if not None, seconds-since-epoch for a
183
postdated/predated commit.
185
:param specific_files: If true, commit only those files.
187
:param rev_id: If set, use this as the new revision id.
188
Useful for test or import commands that need to tightly
189
control what revisions are assigned. If you duplicate
190
a revision id that exists elsewhere it is your own fault.
191
If null (default), a time/random revision id is generated.
193
:param allow_pointless: If true (default), commit even if nothing
194
has changed and no merges are recorded.
196
:param strict: If true, don't allow a commit if the working tree
197
contains unknown files.
199
:param revprops: Properties for new revision
200
:param local: Perform a local only commit.
201
:param recursive: If set to 'down', commit in any subtrees that have
202
pending changes of any sort during this commit.
204
mutter('preparing to commit')
206
if working_tree is None:
207
raise BzrError("working_tree must be passed into commit().")
209
self.work_tree = working_tree
210
self.branch = self.work_tree.branch
211
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
212
if not self.branch.repository.supports_rich_root():
213
raise errors.RootNotRich()
214
if message_callback is None:
215
if message is not None:
216
if isinstance(message, str):
217
message = message.decode(bzrlib.user_encoding)
218
message_callback = lambda x: message
220
raise BzrError("The message or message_callback keyword"
221
" parameter is required for commit().")
223
self.bound_branch = None
225
self.master_branch = None
226
self.master_locked = False
228
self.specific_files = specific_files
229
self.allow_pointless = allow_pointless
230
self.revprops = revprops
231
self.message_callback = message_callback
232
self.timestamp = timestamp
233
self.timezone = timezone
234
self.committer = committer
236
self.verbose = verbose
238
if reporter is None and self.reporter is None:
239
self.reporter = NullCommitReporter()
240
elif reporter is not None:
241
self.reporter = reporter
243
self.work_tree.lock_write()
244
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
245
self.basis_tree = self.work_tree.basis_tree()
246
self.basis_tree.lock_read()
248
# Cannot commit with conflicts present.
249
if len(self.work_tree.conflicts()) > 0:
250
raise ConflictsInTree
252
# Setup the bound branch variables as needed.
253
self._check_bound_branch()
255
# Check that the working tree is up to date
256
old_revno, new_revno = self._check_out_of_date_tree()
258
if self.config is None:
259
self.config = self.branch.get_config()
261
# If provided, ensure the specified files are versioned
262
if specific_files is not None:
263
# Note: We don't actually need the IDs here. This routine
264
# is being called because it raises PathNotVerisonedError
265
# as a side effect of finding the IDs.
266
# XXX: Dont we have filter_unversioned to do this more
268
tree.find_ids_across_trees(specific_files,
269
[self.basis_tree, self.work_tree])
271
# Setup the progress bar. As the number of files that need to be
272
# committed in unknown, progress is reported as stages.
273
# We keep track of entries separately though and include that
274
# information in the progress bar during the relevant stages.
275
self.pb_stage_name = ""
276
self.pb_stage_count = 0
277
self.pb_stage_total = 5
278
if self.bound_branch:
279
self.pb_stage_total += 1
280
self.pb.show_pct = False
281
self.pb.show_spinner = False
282
self.pb.show_eta = False
283
self.pb.show_count = True
284
self.pb.show_bar = True
286
# After a merge, a selected file commit is not supported.
287
# See 'bzr help merge' for an explanation as to why.
288
self.basis_inv = self.basis_tree.inventory
289
self._gather_parents()
290
if len(self.parents) > 1 and self.specific_files:
291
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
293
# Collect the changes
294
self._set_progress_stage("Collecting changes",
295
entries_title="Directory")
296
self.builder = self.branch.get_commit_builder(self.parents,
297
self.config, timestamp, timezone, committer, revprops, rev_id)
298
# tell the builder about the chosen recursive behaviour
299
self.builder.recursive = recursive
302
self._update_builder_with_changes()
303
self._check_pointless()
305
# TODO: Now the new inventory is known, check for conflicts.
306
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
307
# weave lines, because nothing should be recorded until it is known
308
# that commit will succeed.
309
self._set_progress_stage("Saving data locally")
310
self.builder.finish_inventory()
312
# Prompt the user for a commit message if none provided
313
message = message_callback(self)
314
assert isinstance(message, unicode), type(message)
315
self.message = message
316
self._escape_commit_message()
318
# Add revision data to the local branch
319
self.rev_id = self.builder.commit(self.message)
325
self._process_pre_hooks(old_revno, new_revno)
327
# Upload revision data to the master.
328
# this will propagate merged revisions too if needed.
329
if self.bound_branch:
330
self._set_progress_stage("Uploading data to master branch")
331
self.master_branch.repository.fetch(self.branch.repository,
332
revision_id=self.rev_id)
333
# now the master has the revision data
334
# 'commit' to the master first so a timeout here causes the
335
# local branch to be out of date
336
self.master_branch.set_last_revision_info(new_revno,
339
# and now do the commit locally.
340
self.branch.set_last_revision_info(new_revno, self.rev_id)
342
# Make the working tree up to date with the branch
343
self._set_progress_stage("Updating the working tree")
344
rev_tree = self.builder.revision_tree()
345
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
346
self.reporter.completed(new_revno, self.rev_id)
347
self._process_post_hooks(old_revno, new_revno)
352
def _any_real_changes(self):
353
"""Are there real changes between new_inventory and basis?
355
For trees without rich roots, inv.root.revision changes every commit.
356
But if that is the only change, we want to treat it as though there
359
new_entries = self.builder.new_inventory.iter_entries()
360
basis_entries = self.basis_inv.iter_entries()
361
new_path, new_root_ie = new_entries.next()
362
basis_path, basis_root_ie = basis_entries.next()
364
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
365
def ie_equal_no_revision(this, other):
366
return ((this.file_id == other.file_id)
367
and (this.name == other.name)
368
and (this.symlink_target == other.symlink_target)
369
and (this.text_sha1 == other.text_sha1)
370
and (this.text_size == other.text_size)
371
and (this.text_id == other.text_id)
372
and (this.parent_id == other.parent_id)
373
and (this.kind == other.kind)
374
and (this.executable == other.executable)
375
and (this.reference_revision == other.reference_revision)
377
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
380
for new_ie, basis_ie in zip(new_entries, basis_entries):
381
if new_ie != basis_ie:
384
# No actual changes present
387
def _check_pointless(self):
388
if self.allow_pointless:
390
# A merge with no effect on files
391
if len(self.parents) > 1:
393
# work around the fact that a newly-initted tree does differ from its
395
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
396
raise PointlessCommit()
397
# Shortcut, if the number of entries changes, then we obviously have
399
if len(self.builder.new_inventory) != len(self.basis_inv):
401
# If length == 1, then we only have the root entry. Which means
402
# that there is no real difference (only the root could be different)
403
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
405
raise PointlessCommit()
407
def _check_bound_branch(self):
408
"""Check to see if the local branch is bound.
410
If it is bound, then most of the commit will actually be
411
done using the remote branch as the target branch.
412
Only at the end will the local branch be updated.
414
if self.local and not self.branch.get_bound_location():
415
raise errors.LocalRequiresBoundBranch()
418
self.master_branch = self.branch.get_master_branch()
420
if not self.master_branch:
421
# make this branch the reference branch for out of date checks.
422
self.master_branch = self.branch
425
# If the master branch is bound, we must fail
426
master_bound_location = self.master_branch.get_bound_location()
427
if master_bound_location:
428
raise errors.CommitToDoubleBoundBranch(self.branch,
429
self.master_branch, master_bound_location)
431
# TODO: jam 20051230 We could automatically push local
432
# commits to the remote branch if they would fit.
433
# But for now, just require remote to be identical
436
# Make sure the local branch is identical to the master
437
master_info = self.master_branch.last_revision_info()
438
local_info = self.branch.last_revision_info()
439
if local_info != master_info:
440
raise errors.BoundBranchOutOfDate(self.branch,
443
# Now things are ready to change the master branch
445
self.bound_branch = self.branch
446
self.master_branch.lock_write()
447
self.master_locked = True
449
def _check_out_of_date_tree(self):
450
"""Check that the working tree is up to date.
452
:return: old_revision_number,new_revision_number tuple
455
first_tree_parent = self.work_tree.get_parent_ids()[0]
457
# if there are no parents, treat our parent as 'None'
458
# this is so that we still consider the master branch
459
# - in a checkout scenario the tree may have no
460
# parents but the branch may do.
461
first_tree_parent = bzrlib.revision.NULL_REVISION
462
old_revno, master_last = self.master_branch.last_revision_info()
463
if master_last != first_tree_parent:
464
if master_last != bzrlib.revision.NULL_REVISION:
465
raise errors.OutOfDateTree(self.work_tree)
466
if self.branch.repository.has_revision(first_tree_parent):
467
new_revno = old_revno + 1
469
# ghost parents never appear in revision history.
471
return old_revno,new_revno
473
def _process_pre_hooks(self, old_revno, new_revno):
474
"""Process any registered pre commit hooks."""
475
self._set_progress_stage("Running pre_commit hooks")
476
self._process_hooks("pre_commit", old_revno, new_revno)
478
def _process_post_hooks(self, old_revno, new_revno):
479
"""Process any registered post commit hooks."""
480
# Process the post commit hooks, if any
481
self._set_progress_stage("Running post_commit hooks")
482
# old style commit hooks - should be deprecated ? (obsoleted in
484
if self.config.post_commit() is not None:
485
hooks = self.config.post_commit().split(' ')
486
# this would be nicer with twisted.python.reflect.namedAny
488
result = eval(hook + '(branch, rev_id)',
489
{'branch':self.branch,
491
'rev_id':self.rev_id})
492
# process new style post commit hooks
493
self._process_hooks("post_commit", old_revno, new_revno)
495
def _process_hooks(self, hook_name, old_revno, new_revno):
496
if not Branch.hooks[hook_name]:
499
# new style commit hooks:
500
if not self.bound_branch:
501
hook_master = self.branch
504
hook_master = self.master_branch
505
hook_local = self.branch
506
# With bound branches, when the master is behind the local branch,
507
# the 'old_revno' and old_revid values here are incorrect.
508
# XXX: FIXME ^. RBC 20060206
510
old_revid = self.parents[0]
512
old_revid = bzrlib.revision.NULL_REVISION
514
if hook_name == "pre_commit":
515
future_tree = self.builder.revision_tree()
516
tree_delta = future_tree.changes_from(self.basis_tree,
519
for hook in Branch.hooks[hook_name]:
520
# show the running hook in the progress bar. As hooks may
521
# end up doing nothing (e.g. because they are not configured by
522
# the user) this is still showing progress, not showing overall
523
# actions - its up to each plugin to show a UI if it want's to
524
# (such as 'Emailing diff to foo@example.com').
525
self.pb_stage_name = "Running %s hooks [%s]" % \
526
(hook_name, Branch.hooks.get_hook_name(hook))
527
self._emit_progress()
528
if 'hooks' in debug.debug_flags:
529
mutter("Invoking commit hook: %r", hook)
530
if hook_name == "post_commit":
531
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
533
elif hook_name == "pre_commit":
534
hook(hook_local, hook_master,
535
old_revno, old_revid, new_revno, self.rev_id,
536
tree_delta, future_tree)
539
"""Cleanup any open locks, progress bars etc."""
540
cleanups = [self._cleanup_bound_branch,
541
self.basis_tree.unlock,
542
self.work_tree.unlock,
544
found_exception = None
545
for cleanup in cleanups:
548
# we want every cleanup to run no matter what.
549
# so we have a catchall here, but we will raise the
550
# last encountered exception up the stack: and
551
# typically this will be useful enough.
554
if found_exception is not None:
555
# don't do a plan raise, because the last exception may have been
556
# trashed, e is our sure-to-work exception even though it loses the
557
# full traceback. XXX: RBC 20060421 perhaps we could check the
558
# exc_info and if its the same one do a plain raise otherwise
559
# 'raise e' as we do now.
562
def _cleanup_bound_branch(self):
563
"""Executed at the end of a try/finally to cleanup a bound branch.
565
If the branch wasn't bound, this is a no-op.
566
If it was, it resents self.branch to the local branch, instead
569
if not self.bound_branch:
571
if self.master_locked:
572
self.master_branch.unlock()
574
def _escape_commit_message(self):
575
"""Replace xml-incompatible control characters."""
576
# FIXME: RBC 20060419 this should be done by the revision
577
# serialiser not by commit. Then we can also add an unescaper
578
# in the deserializer and start roundtripping revision messages
579
# precisely. See repository_implementations/test_repository.py
581
# Python strings can include characters that can't be
582
# represented in well-formed XML; escape characters that
583
# aren't listed in the XML specification
584
# (http://www.w3.org/TR/REC-xml/#NT-Char).
585
self.message, escape_count = re.subn(
586
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
587
lambda match: match.group(0).encode('unicode_escape'),
590
self.reporter.escaped(escape_count, self.message)
592
def _gather_parents(self):
593
"""Record the parents of a merge for merge detection."""
594
# TODO: Make sure that this list doesn't contain duplicate
595
# entries and the order is preserved when doing this.
596
self.parents = self.work_tree.get_parent_ids()
597
self.parent_invs = [self.basis_inv]
598
for revision in self.parents[1:]:
599
if self.branch.repository.has_revision(revision):
600
mutter('commit parent revision {%s}', revision)
601
inventory = self.branch.repository.get_inventory(revision)
602
self.parent_invs.append(inventory)
604
mutter('commit parent ghost revision {%s}', revision)
606
def _update_builder_with_changes(self):
607
"""Update the commit builder with the data about what has changed.
609
# Build the revision inventory.
611
# This starts by creating a new empty inventory. Depending on
612
# which files are selected for commit, and what is present in the
613
# current tree, the new inventory is populated. inventory entries
614
# which are candidates for modification have their revision set to
615
# None; inventory entries that are carried over untouched have their
616
# revision set to their prior value.
618
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
619
# results to create a new inventory at the same time, which results
620
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
623
specific_files = self.specific_files
624
mutter("Selecting files for commit with filter %s", specific_files)
626
# Check and warn about old CommitBuilders
627
if not self.builder.record_root_entry:
628
symbol_versioning.warn('CommitBuilders should support recording'
629
' the root entry as of bzr 0.10.', DeprecationWarning,
631
self.builder.new_inventory.add(self.basis_inv.root.copy())
633
# Build the new inventory
634
self._populate_from_inventory(specific_files)
636
# If specific files are selected, then all un-selected files must be
637
# recorded in their previous state. For more details, see
638
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
640
for path, new_ie in self.basis_inv.iter_entries():
641
if new_ie.file_id in self.builder.new_inventory:
643
if is_inside_any(specific_files, path):
647
self.builder.record_entry_contents(ie, self.parent_invs, path,
650
# Report what was deleted. We could skip this when no deletes are
651
# detected to gain a performance win, but it arguably serves as a
652
# 'safety check' by informing the user whenever anything disappears.
653
for path, ie in self.basis_inv.iter_entries():
654
if ie.file_id not in self.builder.new_inventory:
655
self.reporter.deleted(path)
657
def _populate_from_inventory(self, specific_files):
658
"""Populate the CommitBuilder by walking the working tree inventory."""
660
# raise an exception as soon as we find a single unknown.
661
for unknown in self.work_tree.unknowns():
662
raise StrictCommitFailed()
665
deleted_paths = set()
666
work_inv = self.work_tree.inventory
667
assert work_inv.root is not None
668
entries = work_inv.iter_entries()
669
# XXX: Note that entries may have the wrong kind.
670
if not self.builder.record_root_entry:
672
for path, existing_ie in entries:
673
file_id = existing_ie.file_id
674
name = existing_ie.name
675
parent_id = existing_ie.parent_id
676
kind = existing_ie.kind
677
if kind == 'directory':
678
self._next_progress_entry()
680
# Skip files that have been deleted from the working tree.
681
# The deleted files/directories are also recorded so they
682
# can be explicitly unversioned later. Note that when a
683
# filter of specific files is given, we must only skip/record
684
# deleted files matching that filter.
685
if is_inside_any(deleted_paths, path):
687
if not specific_files or is_inside_any(specific_files, path):
688
# TODO: fix double-stat here.
689
if not self.work_tree.has_filename(path):
690
deleted_paths.add(path)
691
self.reporter.missing(path)
692
deleted_ids.append(file_id)
694
# TODO: have the builder do the nested commit just-in-time IF and
697
kind = self.work_tree.kind(file_id)
698
# TODO: specific_files filtering before nested tree processing
699
if kind == 'tree-reference' and self.builder.recursive == 'down':
700
self._commit_nested_tree(file_id, path)
701
except errors.NoSuchFile:
704
# Record an entry for this item
705
# Note: I don't particularly want to have the existing_ie
706
# parameter but the test suite currently (28-Jun-07) breaks
707
# without it thanks to a unicode normalisation issue. :-(
708
definitely_changed = kind != existing_ie.kind
709
self._record_entry(path, file_id, specific_files, kind, name,
710
parent_id, definitely_changed, existing_ie)
712
# Unversion IDs that were found to be deleted
713
self.work_tree.unversion(deleted_ids)
715
def _commit_nested_tree(self, file_id, path):
716
"Commit a nested tree."
717
sub_tree = self.work_tree.get_nested_tree(file_id, path)
718
# FIXME: be more comprehensive here:
719
# this works when both trees are in --trees repository,
720
# but when both are bound to a different repository,
721
# it fails; a better way of approaching this is to
722
# finally implement the explicit-caches approach design
723
# a while back - RBC 20070306.
724
if sub_tree.branch.repository.has_same_location(
725
self.work_tree.branch.repository):
726
sub_tree.branch.repository = \
727
self.work_tree.branch.repository
729
sub_tree.commit(message=None, revprops=self.revprops,
730
recursive=self.builder.recursive,
731
message_callback=self.message_callback,
732
timestamp=self.timestamp, timezone=self.timezone,
733
committer=self.committer,
734
allow_pointless=self.allow_pointless,
735
strict=self.strict, verbose=self.verbose,
736
local=self.local, reporter=self.reporter)
737
except errors.PointlessCommit:
740
def _record_entry(self, path, file_id, specific_files, kind, name,
741
parent_id, definitely_changed, existing_ie=None):
742
"Record the new inventory entry for a path if any."
743
# mutter('check %s {%s}', path, file_id)
744
if (not specific_files or
745
is_inside_or_parent_of_any(specific_files, path)):
746
# mutter('%s selected for commit', path)
747
if definitely_changed or existing_ie is None:
748
ie = inventory.make_entry(kind, name, parent_id, file_id)
750
ie = existing_ie.copy()
753
# mutter('%s not selected for commit', path)
754
if self.basis_inv.has_id(file_id):
755
ie = self.basis_inv[file_id].copy()
757
# this entry is new and not being committed
760
self.builder.record_entry_contents(ie, self.parent_invs,
761
path, self.work_tree)
762
self._report_change(ie, path)
765
def _report_change(self, ie, path):
766
"""Report a change to the user.
768
The change that has occurred is described relative to the basis
771
if (self.basis_inv.has_id(ie.file_id)):
772
basis_ie = self.basis_inv[ie.file_id]
775
change = ie.describe_change(basis_ie, ie)
776
if change in (InventoryEntry.RENAMED,
777
InventoryEntry.MODIFIED_AND_RENAMED):
778
old_path = self.basis_inv.id2path(ie.file_id)
779
self.reporter.renamed(change, old_path, path)
781
self.reporter.snapshot_change(change, path)
783
def _set_progress_stage(self, name, entries_title=None):
784
"""Set the progress stage and emit an update to the progress bar."""
785
self.pb_stage_name = name
786
self.pb_stage_count += 1
787
self.pb_entries_title = entries_title
788
if entries_title is not None:
789
self.pb_entries_count = 0
790
self.pb_entries_total = '?'
791
self._emit_progress()
793
def _next_progress_entry(self):
794
"""Emit an update to the progress bar and increment the entry count."""
795
self.pb_entries_count += 1
796
self._emit_progress()
798
def _emit_progress(self):
799
if self.pb_entries_title:
800
if self.pb_entries_total == '?':
801
text = "%s [%s %d] - Stage" % (self.pb_stage_name,
802
self.pb_entries_title, self.pb_entries_count)
804
text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
805
self.pb_entries_title, self.pb_entries_count,
806
str(self.pb_entries_total))
808
text = "%s - Stage" % (self.pb_stage_name)
809
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)