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

◆ init()

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 215 of file progressbar.py.

     def __init__(self, maxval=None, widgets=None, term_width=None, poll=1,
                  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

◆ call()

def progressbar.ProgressBar.__call__	(	self,
		iterable
	)

Definition at line 247 of file progressbar.py.

     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
  
  

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

◆ iter()

def progressbar.ProgressBar.__iter__ ( self )

Definition at line 260 of file progressbar.py.

     def __iter__(self):
         return self

◆ next()

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
  
  

◆ _env_size()

def progressbar.ProgressBar._env_size ( self )

private

Definition at line 280 of file progressbar.py.

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

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

◆ _format_line()

def progressbar.ProgressBar._format_line ( self )

private

Definition at line 327 of file progressbar.py.

     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)

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

◆ _format_widgets()

def progressbar.ProgressBar._format_widgets ( self )

private

Definition at line 300 of file progressbar.py.

     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
  
  

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().

◆ _handle_resize()

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

private

Definition at line 286 of file progressbar.py.

     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

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

◆ _need_update()

def progressbar.ProgressBar._need_update ( self )

private

Definition at line 336 of file progressbar.py.

     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
  
  

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().

◆ _update_widgets()

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)

◆ finish()

def progressbar.ProgressBar.finish ( self )

Definition at line 403 of file progressbar.py.

     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)

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

Referenced by progressbar.ProgressBar.__next__().

◆ percentage()

def progressbar.ProgressBar.percentage ( self )

Definition at line 293 of file progressbar.py.

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

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

◆ start()

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.

     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
  
  

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

Referenced by progressbar.ProgressBar.__next__().

◆ update()

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

Definition at line 351 of file progressbar.py.

     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
  
  

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

Referenced by progressbar.ProgressBar.__next__(), MatrixUtil.Matrix.__setitem__(), MatrixUtil.Steps.__setitem__(), progressbar.ProgressBar._format_widgets(), progressbar.ProgressBar.finish(), and MatrixUtil.Steps.overwrite().

Member Data Documentation

◆ __iterable

progressbar.ProgressBar.__iterable

private

Definition at line 235 of file progressbar.py.

Referenced by progressbar.ProgressBar.__call__(), and progressbar.ProgressBar.__next__().

◆ slots

progressbar.ProgressBar.__slots__

staticprivate

Definition at line 206 of file progressbar.py.

◆ _DEFAULT_MAXVAL

progressbar.ProgressBar._DEFAULT_MAXVAL

staticprivate

Definition at line 212 of file progressbar.py.

Referenced by progressbar.ProgressBar.start().

◆ _DEFAULT_TERMSIZE

progressbar.ProgressBar._DEFAULT_TERMSIZE

staticprivate

Definition at line 213 of file progressbar.py.

Referenced by progressbar.ProgressBar._env_size().

◆ _time_sensitive

progressbar.ProgressBar._time_sensitive

private

Definition at line 347 of file progressbar.py.

Referenced by progressbar.ProgressBar._need_update().

◆ currval

progressbar.ProgressBar.currval

Definition at line 237 of file progressbar.py.

Referenced by progressbar.ProgressBar.__next__(), progressbar.ProgressBar._need_update(), progressbar.ProgressBar.percentage(), and progressbar.ProgressBar.update().

◆ fd

progressbar.ProgressBar.fd

Definition at line 220 of file progressbar.py.

Referenced by progressbar.ProgressBar._handle_resize(), and progressbar.ProgressBar.finish().

◆ finished

progressbar.ProgressBar.finished

Definition at line 238 of file progressbar.py.

Referenced by progressbar.ProgressBar._need_update(), and progressbar.ProgressBar.finish().

◆ last_update_time

progressbar.ProgressBar.last_update_time

Definition at line 239 of file progressbar.py.

Referenced by progressbar.ProgressBar._need_update().

◆ left_justify

progressbar.ProgressBar.left_justify

Definition at line 221 of file progressbar.py.

Referenced by progressbar.ProgressBar._format_line().

◆ maxval

progressbar.ProgressBar.maxval

Definition at line 218 of file progressbar.py.

Referenced by progressbar.ProgressBar.__call__(), progressbar.ProgressBar.finish(), progressbar.ProgressBar.percentage(), progressbar.ProgressBar.start(), and progressbar.ProgressBar.update().

◆ next

progressbar.ProgressBar.next

static

Definition at line 277 of file progressbar.py.

Referenced by progressbar.ProgressBar.__next__().

◆ next_update

progressbar.ProgressBar.next_update

Definition at line 369 of file progressbar.py.

Referenced by progressbar.ProgressBar._need_update().

◆ num_intervals

progressbar.ProgressBar.num_intervals

Definition at line 389 of file progressbar.py.

◆ poll

progressbar.ProgressBar.poll

Definition at line 240 of file progressbar.py.

Referenced by progressbar.ProgressBar._need_update().

◆ seconds_elapsed

progressbar.ProgressBar.seconds_elapsed

Definition at line 241 of file progressbar.py.

Referenced by progressbar.ProgressBar.update().

◆ signal_set

progressbar.ProgressBar.signal_set

Definition at line 223 of file progressbar.py.

Referenced by progressbar.ProgressBar.finish().

◆ start_time

progressbar.ProgressBar.start_time

Definition at line 242 of file progressbar.py.

Referenced by progressbar.ProgressBar.__next__(), and progressbar.ProgressBar.update().

◆ term_width

progressbar.ProgressBar.term_width

Definition at line 225 of file progressbar.py.

Referenced by progressbar.ProgressBar._format_line(), progressbar.ProgressBar._format_widgets(), and progressbar.ProgressBar._handle_resize().

◆ update_interval

progressbar.ProgressBar.update_interval

Definition at line 243 of file progressbar.py.

◆ widgets

progressbar.ProgressBar.widgets

Definition at line 219 of file progressbar.py.

Referenced by progressbar.ProgressBar._format_widgets().

Property Documentation

◆ percent

progressbar.ProgressBar.percent = property(percentage)

static

Definition at line 297 of file progressbar.py.

Public Member Functions

Public Attributes

Static Public Attributes

Properties

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __call__()

◆ __iter__()

◆ __next__()

◆ _env_size()

◆ _format_line()

◆ _format_widgets()

◆ _handle_resize()

◆ _need_update()

◆ _update_widgets()

◆ finish()

◆ percentage()

◆ start()

◆ update()

Member Data Documentation

◆ __iterable

◆ __slots__

◆ _DEFAULT_MAXVAL

◆ _DEFAULT_TERMSIZE

◆ _time_sensitive

◆ currval

◆ fd

◆ finished

◆ last_update_time

◆ left_justify

◆ maxval

◆ next

◆ next_update

◆ num_intervals

◆ poll

◆ seconds_elapsed

◆ signal_set

◆ start_time

◆ term_width

◆ update_interval

◆ widgets

Property Documentation

◆ percent

◆ init()

◆ call()

◆ iter()

◆ next()

◆ slots