Inheritance diagram for progressbar.ProgressBar:

Public Member Functions
def	__call__ (self, iterable)

def	__init__ (self, maxval=None, widgets=None, term_width=None, poll=1, left_justify=True, fd=sys.stderr)

def	__iter__ (self)

def	__next__ (self)

def	finish (self)

def	percentage (self)

def	start (self)

def	update (self, value=None)

Public Attributes
	currval

	fd

	finished

	last_update_time

	left_justify

	maxval

	next_update

	num_intervals

	poll

	seconds_elapsed

	signal_set

	start_time

	term_width

	update_interval

	widgets

Static Public Attributes
	next

Properties
	percent = property(percentage)

Private Member Functions
def	_env_size (self)

def	_format_line (self)

def	_format_widgets (self)

def	_handle_resize (self, signum=None, frame=None)

def	_need_update (self)

def	_update_widgets (self)

Private Attributes
	__iterable

	_time_sensitive

Static Private Attributes
	__slots__

	_DEFAULT_MAXVAL

	_DEFAULT_TERMSIZE

Detailed Description

The ProgressBar class which updates and prints the bar.

A common way of using it is like:
>>> pbar = ProgressBar().start()
>>> for i in range(100):
...    # do something
...    pbar.update(i+1)
...
>>> pbar.finish()

You can also use a ProgressBar as an iterator:
>>> progress = ProgressBar()
>>> for i in progress(some_iterable):
...    # do something
...

Since the progress bar is incredibly customizable you can specify
different widgets of any type in any order. You can even write your own
widgets! However, since there are already a good number of widgets you
should probably play around with them before moving on to create your own
widgets.

The term_width parameter represents the current terminal width. If the
parameter is set to an integer then the progress bar will use that,
otherwise it will attempt to determine the terminal width falling back to
80 columns if the width cannot be determined.

When implementing a widget's update method you are passed a reference to
the current progress bar. As a result, you have access to the
ProgressBar's methods and attributes. Although there is nothing preventing
you from changing the ProgressBar you should treat it as read only.

Useful methods and attributes include (Public API):
 - currval: current progress (0 <= currval <= maxval)
 - maxval: maximum (and final) value
 - finished: True if the bar has finished (reached 100%)
 - start_time: the time when start() method of ProgressBar was called
 - seconds_elapsed: seconds elapsed since start_time and last call to
                    update
 - percentage(): progress in percent [0..100]

Definition at line 163 of file progressbar.py.

Constructor & Destructor Documentation

def progressbar.ProgressBar.__init__	(	self,
		maxval = `None`,
		widgets = `None`,
		term_width = `None`,
		poll = `1`,
		left_justify = `True`,
		fd = `sys.stderr`
	)

Initializes a progress bar with sane defaults

Definition at line 216 of file progressbar.py.

                  left_justify=True, fd=sys.stderr):
         '''Initializes a progress bar with sane defaults'''
 
         self.maxval = maxval
         self.widgets = widgets
         self.fd = fd
         self.left_justify = left_justify
 
         self.signal_set = False
         if term_width is not None:
             self.term_width = term_width
         else:
             try:
                 self._handle_resize()
                 signal.signal(signal.SIGWINCH, self._handle_resize)
                 self.signal_set = True
             except (SystemExit, KeyboardInterrupt): raise
             except:
                 self.term_width = self._env_size()
 
         self.__iterable = None
         self._update_widgets()
         self.currval = 0
         self.finished = False
         self.last_update_time = None
         self.poll = poll
         self.seconds_elapsed = 0
         self.start_time = None
         self.update_interval = 1
 
 

Member Function Documentation

def progressbar.ProgressBar.__call__	(	self,
		iterable
	)

Definition at line 247 of file progressbar.py.

References progressbar.ProgressBar.__iterable, and progressbar.ProgressBar.maxval.

     def __call__(self, iterable):
         'Use a ProgressBar to iterate through an iterable'
 
         try:
             self.maxval = len(iterable)
         except:
             if self.maxval is None:
                 self.maxval = UnknownLength
 
         self.__iterable = iter(iterable)
         return self
 
 

def progressbar.ProgressBar.__iter__ ( self )

Definition at line 260 of file progressbar.py.

     def __iter__(self):
         return self

def progressbar.ProgressBar.__next__ ( self )

Definition at line 264 of file progressbar.py.

     def __next__(self):
         try:
             value = next(self.__iterable)
             if self.start_time is None: self.start()
             else: self.update(self.currval + 1)
             return value
         except StopIteration:
             self.finish()
             raise
 
 

def progressbar.ProgressBar._env_size ( self )

private

Definition at line 280 of file progressbar.py.

References progressbar.ProgressBar._DEFAULT_TERMSIZE, and createfilelist.int.

     def _env_size(self):
         'Tries to find the term_width from the environment.'
 
         return int(os.environ.get('COLUMNS', self._DEFAULT_TERMSIZE)) - 1

def progressbar.ProgressBar._format_line ( self )

private

Definition at line 327 of file progressbar.py.

References progressbar.ProgressBar._format_widgets(), join(), progressbar.ProgressBar.left_justify, and progressbar.ProgressBar.term_width.

     def _format_line(self):
         'Joins the widgets and justifies the line'
 
         widgets = ''.join(self._format_widgets())
 
         if self.left_justify: return widgets.ljust(self.term_width)
         else: return widgets.rjust(self.term_width)

def progressbar.ProgressBar._format_widgets ( self )

private

Definition at line 300 of file progressbar.py.

References progressbar.format_updatable(), createfilelist.int, SiStripPI.max, progressbar.ProgressBar.term_width, progressbar.ProgressBar.update(), and progressbar.ProgressBar.widgets.

Referenced by progressbar.ProgressBar._format_line().

     def _format_widgets(self):
         result = []
         expanding = []
         width = self.term_width
 
         for index, widget in enumerate(self.widgets):
             if isinstance(widget, WidgetHFill):
                 result.append(widget)
                 expanding.insert(0, index)
             else:
                 widget = format_updatable(widget, self)
                 result.append(widget)
                 width -= len(widget)
 
         count = len(expanding)
         while count:
             portion = max(int(math.ceil(width * 1. / count)), 0)
             index = expanding.pop()
             count -= 1
 
             widget = result[index].update(self, portion)
             width -= len(widget)
             result[index] = widget
 
         return result
 
 

def progressbar.ProgressBar._handle_resize	(	self,
		signum = `None`,
		frame = `None`
	)

private

Definition at line 286 of file progressbar.py.

References mps_check.array, hippyaddtobaddatafiles.KeepWhileOpenFile.fd, progressbar.ProgressBar.fd, and progressbar.ProgressBar.term_width.

     def _handle_resize(self, signum=None, frame=None):
         'Tries to catch resize signals sent from the terminal.'
 
         h, w = array('h', ioctl(self.fd, termios.TIOCGWINSZ, '\0' * 8))[:2]
         self.term_width = w

def progressbar.ProgressBar._need_update ( self )

private

Definition at line 336 of file progressbar.py.

References progressbar.ProgressBar._time_sensitive, progressbar.ProgressBar.currval, progressbar.ProgressBar.finished, progressbar.ProgressBar.last_update_time, progressbar.ProgressBar.next_update, and progressbar.ProgressBar.poll.

Referenced by progressbar.ProgressBar.update().

     def _need_update(self):
         'Returns whether the ProgressBar should redraw the line.'
         if self.currval >= self.next_update or self.finished: return True
 
         delta = time.time() - self.last_update_time
         return self._time_sensitive and delta > self.poll
 
 

def progressbar.ProgressBar._update_widgets ( self )

private

Definition at line 344 of file progressbar.py.

     def _update_widgets(self):
         'Checks all widgets for the time sensitive bit'
 
         self._time_sensitive = any(getattr(w, 'TIME_SENSITIVE', False)
             for w in self.widgets)

def progressbar.ProgressBar.finish ( self )

Definition at line 403 of file progressbar.py.

References progressbar.ProgressBar.finished, progressbar.ProgressBar.maxval, progressbar.ProgressBar.signal_set, frozendict.frozendict.update, DDDWorldObserver< Event >.update(), KillSecondariesRunAction.update(), KillSecondariesTrackAction.update(), SaveSimTrack.update(), DaqScopeModeHistosUsingDb.update(), FastFedCablingTask.update(), ApvTimingHistosUsingDb.update(), VertexTrackUpdator< N >.update(), DummyVertexTrackUpdator< N >.update(), NoiseHistosUsingDb.update(), OptoScanHistosUsingDb.update(), PedsFullNoiseHistosUsingDb.update(), PedestalsHistosUsingDb.update(), PedsOnlyHistosUsingDb.update(), VpspScanHistosUsingDb.update(), ApvTimingTask.update(), PrintTrackNumberAction.update(), GenericMVAComputerCache.update(), FedTimingTask.update(), VpspScanTask.update(), reco::KalmanGhostTrackUpdater.update(), OptoScanTask.update(), PedestalsTask.update(), LagrangeChildUpdator.update(), AlignableDet.update(), FastFedCablingHistosUsingDb.update(), TrajectoryStateUpdator.update(), LatencyTask.update(), Basic2DGenericPFlowClusterizer.update(), FineDelayTask.update(), PFMultiDepthClusterizer.update(), ErrorCorrelation.update(), GsfMultiStateUpdator.update(), MSLayersAtAngle.update(), FedCablingTask.update(), PFlow2DClusterizerWithTime.update(), LatencyHistosUsingDb.update(), PrintSensitive.update(), AlignableDetUnit.update(), MonopoleSteppingAction.update(), edm::SubProcessParentageHelper.update(), FineDelayHistosUsingDb.update(), KFStrip1DUpdator.update(), CalibrationScanTask.update(), CalibrationTask.update(), SCRegressionCalculator< VarCalc >.update(), KFSwitching1DUpdator.update(), PFClusterEnergyCorrectorBase.update(), CalibrationHistosUsingDb.update(), RHStopTracer.update(), PFCPositionCalculatorBase.update(), TkPhase2OTMeasurementDet.update(), NoiseTask.update(), TkPixelMeasurementDet.update(), PedsOnlyTask.update(), ChildUpdator.update(), CountProcessesAction.update(), PrintGeomInfoAction.update(), PrintGeomSummary.update(), PedsFullNoiseTask.update(), KinematicConstrainedVertexUpdator.update(), AlignableTracker.update(), DaqScopeModeTask.update(), BaselinePFSCRegression.update(), PrintMaterialBudgetInfo.update(), progressbar.Widget.update(), AlignableCSCChamber.update(), HGCScintSD.update(), FastTimerSD.update(), PhysicsTools::MVAComputerCache.update(), HGCalSD.update(), HFNoseSD.update(), StoreSecondary.update(), funct::Master< F >.update(), edm::RunningAverage.update(), HGCSD.update(), HGCalTBMB.update(), Observer< T >.update(), AlignableComposite.update(), BinomialProbability.update(), KFUpdator.update(), GflashG4Watcher.update(), pathelpers::Record.update(), RealisticSimClusterMapper.update(), PFClusterBuilderBase.update(), KalmanVertexTrackUpdator< N >.update(), SimG4FluxProducer.update(), cond::persistency::GLOBAL_TAG::Table.update(), BasicMultiTrajectoryState.update(), cond::persistency::ITagTable.update(), L1TMuonBarrelKalmanAlgo.update(), CheckSecondary.update(), MuonServiceProxy.update(), ECAL2DPositionCalcWithDepthCorr.update(), KalmanVertexUpdator< N >.update(), AlignableMuon.update(), PhysicsTools::TreeReader.update(), FWJobMetadataManager.update(), TrackingMaterialProducer.update(), HcalTestAnalysis.update(), TrackingVerboseAction.update(), SiTrackerMultiRecHitUpdator.update(), fastsim::Geometry.update(), fwlite::RecordWriter.update(), MuonTrajectoryUpdator.update(), SiStripPartition.update(), SiStripConfObject.update(), reco::GhostTrackFitter::PredictionUpdater.update(), TotemTestGem.update(), pos::PixelConfig.update(), TimingSD.update(), CaloTrkProcessing.update(), edm::service::CondorStatusService.update(), cond::persistency::TAG::Table.update(), FWParameterSetterBase.update(), FiberSD.update(), KinematicConstrainedVertexUpdatorT< nTrk, nConstraint >.update(), Alignable.update(), DAClusterizerInZ.update(), TotemRPSD.update(), HGCPassive.update(), DQMOldReceiver.update(), HCalSD.update(), progressbar.Timer.update(), MuonSensitiveDetector.update(), TkAccumulatingSensitiveDetector.update(), PPSDiamondSD.update(), simwatcher::BeginOfTrackCounter.update(), HcaluLUTTPGCoder.update(), MuonUpdatorAtVertex.update(), LaserAlignmentSimulation.update(), DictTypes.SortedAndFixedKeysDict.update, ApvAnalysisFactory.update(), DTVDriftCalibration::cellInfo.update(), HcalForwardAnalysis.update(), TotemSD.update(), sim_act::Signaler< T >.update(), PPSPixelSD.update(), progressbar.WidgetHFill.update(), SimTracer.update(), CaloSteppingAction.update(), FP420SD.update(), DTSegmentUpdator.update(), HcalTB02Analysis.update(), DoCastorAnalysis.update(), ZdcTestAnalysis.update(), CastorTestAnalysis.update(), DictTypes.FixedKeysDict.update, PhysicsTools::TreeReader::Value.update(), EcalTBH4Trigger.update(), SingleParticleEvent.update(), BetafuncEvtVtxGenerator.update(), CaloSD.update(), sistrip::RawToDigiUnpacker.update(), InitialClusteringStepBase.update(), PhysicsTools::MVAModuleHelper< Record, Object, Filler >::Value.update(), HcalTB04Analysis.update(), jsoncollector::IntJ.update(), HLTScalersClient::CountLSFifo_t.update(), progressbar.Bar.update(), TrajectoryStateOnSurface.update(), evf::FastMonitoringService::Encoding.update(), GaussianSumUtilities1D.update(), PFECALSuperClusterAlgo.update(), edm::service::SimpleMemoryCheck.update(), DynamicTruncation.update(), edm::BMixingModule.update(), progressbar.BouncingBar.update(), CastorShowerLibraryMaker.update(), DTRecSegment2D.update(), jsoncollector::DoubleJ.update(), cond::persistency::IPayloadMigrationTable.update(), DQMNet::Peer.update, FWPSetTableManager.update(), StandAloneMuonFilter.update(), G4StepStatistics.update(), DQMNet::AutoPeer.update, progressbar.FormatLabel.update(), DAClusterizerInZ_vect.update(), FWLiteESRecordWriterAnalyzer.update(), CommissioningTask.update(), StMeasurementDetSet.update(), jsoncollector::StringJ.update(), FP420Test.update(), BscTest.update(), cond::persistency::IGTTable.update(), dqm-mbProfile.Profile.update(), Folder.update(), DAClusterizerInZT_vect.update(), dqm::impl::MonitorElement.update(), jsoncollector::HistoJ< T >.update(), BasicTrajectoryState.update(), PxMeasurementDetSet.update(), progressbar.ProgressBar.update(), Phase2OTMeasurementDetSet.update(), edmStreamStallGrapher.Stack.update(), crabFunctions.CrabTask.update(), edmNew::DetSetVector< T >.update(), and Config.FilteredStream.update.

Referenced by progressbar.ProgressBar.__next__().

     def finish(self):
         'Puts the ProgressBar bar in the finished state.'
 
         self.finished = True
         self.update(self.maxval)
         self.fd.write('\n')
         if self.signal_set:
             signal.signal(signal.SIGWINCH, signal.SIG_DFL)

def progressbar.ProgressBar.percentage ( self )

Definition at line 293 of file progressbar.py.

References progressbar.ProgressBar.currval, and progressbar.ProgressBar.maxval.

     def percentage(self):
         'Returns the progress as a percentage.'
         return self.currval * 100.0 / self.maxval
 

def progressbar.ProgressBar.start ( self )

Starts measuring time, and prints the bar at 0%.

It returns self so you can use it like this:
>>> pbar = ProgressBar().start()
>>> for i in range(100):
...    # do something
...    pbar.update(i+1)
...
>>> pbar.finish()

Definition at line 374 of file progressbar.py.

References progressbar.ProgressBar._DEFAULT_MAXVAL, and progressbar.ProgressBar.maxval.

Referenced by progressbar.ProgressBar.__next__().

     def start(self):
         '''Starts measuring time, and prints the bar at 0%.
 
         It returns self so you can use it like this:
         >>> pbar = ProgressBar().start()
         >>> for i in range(100):
         ...    # do something
         ...    pbar.update(i+1)
         ...
         >>> pbar.finish()
         '''
 
         if self.maxval is None:
             self.maxval = self._DEFAULT_MAXVAL
 
         self.num_intervals = max(100, self.term_width)
         self.next_update = 0
 
         if self.maxval is not UnknownLength:
             if self.maxval < 0: raise ValueError('Value out of range')
             self.update_interval = self.maxval / self.num_intervals
 
 
         self.start_time = self.last_update_time = time.time()
         self.update(0)
 
         return self
 
 

def progressbar.ProgressBar.update	(	self,
		value = `None`
	)

Definition at line 351 of file progressbar.py.

References progressbar.ProgressBar._need_update(), progressbar.ProgressBar.currval, progressbar.ProgressBar.maxval, progressbar.ProgressBar.seconds_elapsed, looper.Looper.start_time, and progressbar.ProgressBar.start_time.

     def update(self, value=None):
         'Updates the ProgressBar to a new value.'
 
         if value is not None and value is not UnknownLength:
             if (self.maxval is not UnknownLength
                 and not 0 <= value <= self.maxval):
 
                 raise ValueError('Value out of range')
 
             self.currval = value
 
 
         if not self._need_update(): return
         if self.start_time is None:
             raise RuntimeError('You must call "start" before calling "update"')
 
         now = time.time()
         self.seconds_elapsed = now - self.start_time
         self.next_update = self.currval + self.update_interval
         self.fd.write(self._format_line() + '\r')
         self.last_update_time = now
 
 