progressbar.ProgressBar Class Reference

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.

References progressbar.ProgressBar.__iterable, progressbar.ProgressBar.currval, CrabWatch.CrabWatch.finish, edmTracerLogToSimpleConfig.PathParser.finish(), HcalTB02Analysis.finish(), edmTracerLogToSimpleConfig.ConsumesParser.finish(), ztee.GZipLog.finish(), edm::service::ELdestination.finish(), ZdcTestAnalysis.finish(), AlignmentProducerBase.finish(), edm::service::ELadministrator.finish(), CaloTowersCreationAlgo.finish(), dqm-mbProfile.Profile.finish(), edm::pathStatusExpression::ShuntingYardAlgorithm.finish(), esMonitoring.FDOutputListener.finish(), progressbar.ProgressBar.finish(), progressbar.ProgressBar.next, service.Service.start(), edm::StreamerOutputModule< Consumer >.start(), edm::StreamerOutputModuleBase.start(), MyWatcher.start(), RawEventFileWriterForBU.start(), edm::service::ConcurrentModuleTimer.start(), cmsPerfSuite.PerfSuiteTimer.start, reco::formula::ArrayAdaptor.start(), edm::StreamerFileWriter.start(), l1t::Interval< TimeType, PayloadType >.start(), Mapper::definition< ScannerT >.start(), evf::RecoEventOutputModuleForFU< Consumer >.start(), evf::RecoEventWriterForFU.start(), Vispa.Main.RotatingIcon.RotatingIcon.start(), cond::persistency::Transaction.start(), edm::WallclockTimer.start(), hlt::CPUTimer.start(), edm::CPUTimer.start(), StripCompactDigiSimLinks::TrackRecord.start, Vispa.Share.ThreadChain.ThreadChain.start(), evf::EvFBuildingThrottle.start(), SiStripMonitorCluster::ClusterProperties.start, evf::FastMonitoringThread.start(), cond::RunInfo_t.start, DQMNet.start(), SpecParParser::definition< ScannerT >.start(), cond::CSScopedSession.start(), cond::persistency::TransactionScope.start(), Types.LuminosityBlockRange.start(), PhysicsTools::VarProcessor::ValueIterator.start, o2olib.O2ORunMgr.start, Types.EventRange.start(), esMonitoring.FDOutputListener.start, progressbar.ProgressBar.start(), svgfig.LineAxis.start, looper.Looper.start_time, progressbar.ProgressBar.start_time, DDDWorldObserver< Event >.update(), KillSecondariesRunAction.update(), KillSecondariesTrackAction.update(), SaveSimTrack.update(), Basic2DGenericPFlowClusterizer.update(), PFMultiDepthClusterizer.update(), reco::KalmanGhostTrackUpdater.update(), PrintTrackNumberAction.update(), GenericMVAComputerCache.update(), PFlow2DClusterizerWithTime.update(), LagrangeChildUpdator.update(), VertexTrackUpdator< N >.update(), DummyVertexTrackUpdator< N >.update(), FastFedCablingTask.update(), TrajectoryStateUpdator.update(), MSLayersAtAngle.update(), ApvTimingTask.update(), DaqScopeModeTask.update(), ErrorCorrelation.update(), FedTimingTask.update(), VpspScanTask.update(), DDG4ProductionCuts.update(), ApvTimingHistosUsingDb.update(), NoiseHistosUsingDb.update(), OptoScanHistosUsingDb.update(), PedestalsHistosUsingDb.update(), PedsFullNoiseHistosUsingDb.update(), PedsOnlyHistosUsingDb.update(), VpspScanHistosUsingDb.update(), OptoScanTask.update(), PedestalsTask.update(), AlignableDet.update(), GsfMultiStateUpdator.update(), CalibrationScanTask.update(), CalibrationTask.update(), FineDelayTask.update(), LatencyTask.update(), MonopoleSteppingAction.update(), edm::SubProcessParentageHelper.update(), FastFedCablingHistosUsingDb.update(), cond::persistency::ITagTable.update(), SCRegressionCalculator< VarCalc >.update(), PFClusterEnergyCorrectorBase.update(), PFCPositionCalculatorBase.update(), SamplingHistosUsingDb.update(), FedCablingTask.update(), AlignableDetUnit.update(), PrintSensitive.update(), RHStopTracer.update(), KFStrip1DUpdator.update(), LatencyHistosUsingDb.update(), TkPhase2OTMeasurementDet.update(), CalibrationHistosUsingDb.update(), TkPixelMeasurementDet.update(), NoiseTask.update(), PedsOnlyTask.update(), FineDelayHistosUsingDb.update(), ChildUpdator.update(), edm::RunningAverage.update(), PedsFullNoiseTask.update(), HGCalTBMB.update(), CountProcessesAction.update(), PrintGeomInfoAction.update(), PrintMaterialBudgetInfo.update(), progressbar.Widget.update(), KinematicConstrainedVertexUpdator.update(), PrintGeomSummary.update(), AlignableCSCChamber.update(), KFSwitching1DUpdator.update(), PhysicsTools::MVAComputerCache.update(), BaselinePFSCRegression.update(), cond::persistency::GLOBAL_TAG::Table.update(), StoreSecondary.update(), BinomialProbability.update(), RealisticSimClusterMapper.update(), AlignableTracker.update(), MuonServiceProxy.update(), pathelpers::Record.update(), HGCSD.update(), cond::persistency::TAG::Table.update(), PFClusterBuilderBase.update(), KFUpdator.update(), GflashG4Watcher.update(), Observer< T >.update(), funct::Master< F >.update(), AlignableComposite.update(), TrackingMaterialProducer.update(), ECAL2DPositionCalcWithDepthCorr.update(), KalmanVertexTrackUpdator< N >.update(), SimG4FluxProducer.update(), CheckSecondary.update(), CaloTrkProcessing.update(), pos::PixelConfig.update(), FWJobMetadataManager.update(), SiTrackerMultiRecHitUpdator.update(), HcaluLUTTPGCoder.update(), TrackingVerboseAction.update(), PhysicsTools::TreeReader.update(), HcalTestAnalysis.update(), BasicMultiTrajectoryState.update(), reco::GhostTrackFitter::PredictionUpdater.update(), KalmanVertexUpdator< N >.update(), SingleParticleEvent.update(), MuonTrajectoryUpdator.update(), HCalSD.update(), AlignableMuon.update(), SiStripPartition.update(), fwlite::RecordWriter.update(), SiStripConfObject.update(), FiberSD.update(), FWParameterSetterBase.update(), KinematicConstrainedVertexUpdatorT< nTrk, nConstraint >.update(), HGCPassive.update(), edm::service::CondorStatusService.update(), TotemTestGem.update(), progressbar.Timer.update(), MuonUpdatorAtVertex.update(), PltSD.update(), Bcm1fSD.update(), Alignable.update(), simwatcher::BeginOfTrackCounter.update(), DQMOldReceiver.update(), HcalTB02Analysis.update(), TkAccumulatingSensitiveDetector.update(), LaserAlignmentSimulation.update(), BHMSD.update(), FastTimerSD.update(), ApvAnalysisFactory.update(), progressbar.WidgetHFill.update(), InitialClusteringStepBase.update(), TotemSD.update(), SimTracer.update(), HcalForwardAnalysis.update(), DTVDriftCalibration::cellInfo.update(), MuonSensitiveDetector.update(), DTSegmentUpdator.update(), DAClusterizerInZ.update(), sistrip::RawToDigiUnpacker.update(), HcalTB04Analysis.update(), sim_act::Signaler< T >.update(), EcalTBH4Trigger.update(), DoCastorAnalysis.update(), ZdcTestAnalysis.update(), CastorTestAnalysis.update(), PhysicsTools::TreeReader::Value.update(), CaloSD.update(), cond::persistency::IPayloadMigrationTable.update(), BetafuncEvtVtxGenerator.update(), BscSD.update(), DynamicTruncation.update(), PhysicsTools::MVAModuleHelper< Record, Object, Filler >::Value.update(), progressbar.Bar.update(), FP420SD.update(), jsoncollector::IntJ.update(), HLTScalersClient::CountLSFifo_t.update(), edm::BMixingModule.update(), evf::FastMonitoringService::Encoding.update(), progressbar.BouncingBar.update(), edm::service::SimpleMemoryCheck.update(), GaussianSumUtilities1D.update(), CastorShowerLibraryMaker.update(), cond::persistency::IGTTable.update(), PFECALSuperClusterAlgo.update(), DTRecSegment2D.update(), StandAloneMuonFilter.update(), MonitorElement.update(), jsoncollector::DoubleJ.update(), FWPSetTableManager.update(), CommissioningTask.update(), DQMNet::Peer.update, TrajectoryStateOnSurface.update(), progressbar.FormatLabel.update(), G4StepStatistics.update(), DQMNet::AutoPeer.update, FWLiteESRecordWriterAnalyzer.update(), StMeasurementDetSet.update(), FP420Test.update(), Folder.update(), DAClusterizerInZ_vect.update(), BscTest.update(), jsoncollector::StringJ.update(), dqm-mbProfile.Profile.update(), DAClusterizerInZT_vect.update(), jsoncollector::HistoJ< T >.update(), BasicTrajectoryState.update(), progressbar.ProgressBar.update(), edmStreamStallGrapher.Stack.update(), PxMeasurementDetSet.update(), Phase2OTMeasurementDetSet.update(), and edmNew::DetSetVector< T >.update().

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

Referenced by progressbar.ProgressBar.__next__(), MatrixUtil.Matrix.__setitem__(), MatrixUtil.Steps.__setitem__(), progressbar.ProgressBar._format_widgets(), Vispa.Gui.VispaWidget.VispaWidget.autosize(), Vispa.Views.LineDecayView.LineDecayContainer.createObject(), Vispa.Views.LineDecayView.LineDecayContainer.deselectAllObjects(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner.deselectAllWidgets(), Vispa.Gui.VispaWidget.VispaWidget.enableAutosizing(), progressbar.ProgressBar.finish(), Vispa.Gui.MenuWidget.MenuWidget.leaveEvent(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner.mouseMoveEvent(), Vispa.Gui.MenuWidget.MenuWidget.mouseMoveEvent(), Vispa.Views.LineDecayView.LineDecayContainer.mouseMoveEvent(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner.mouseReleaseEvent(), Vispa.Views.LineDecayView.LineDecayContainer.objectMoved(), MatrixUtil.Steps.overwrite(), Vispa.Views.LineDecayView.LineDecayContainer.removeObject(), Vispa.Gui.ConnectableWidget.ConnectableWidget.removePorts(), Vispa.Gui.FindDialog.FindDialog.reset(), Vispa.Gui.PortConnection.PointToPointConnection.select(), Vispa.Gui.VispaWidget.VispaWidget.select(), Vispa.Views.LineDecayView.LineDecayContainer.select(), Vispa.Gui.VispaWidget.VispaWidget.setText(), Vispa.Gui.VispaWidget.VispaWidget.setTitle(), Vispa.Gui.ZoomableWidget.ZoomableWidget.setZoom(), Vispa.Views.LineDecayView.LineDecayContainer.setZoom(), and Vispa.Gui.PortConnection.PointToPointConnection.updateConnection().

    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

Member Data Documentation

progressbar.ProgressBar.__iterable

private

Definition at line 236 of file progressbar.py.

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

progressbar.ProgressBar.__slots__

staticprivate

Definition at line 206 of file progressbar.py.

progressbar.ProgressBar._DEFAULT_MAXVAL

staticprivate

Definition at line 212 of file progressbar.py.

Referenced by progressbar.ProgressBar.start().

progressbar.ProgressBar._DEFAULT_TERMSIZE

staticprivate

Definition at line 213 of file progressbar.py.

Referenced by progressbar.ProgressBar._env_size().

progressbar.ProgressBar._time_sensitive

private

Definition at line 347 of file progressbar.py.

Referenced by progressbar.ProgressBar._need_update().

progressbar.ProgressBar.currval

Definition at line 238 of file progressbar.py.

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

progressbar.ProgressBar.fd

Definition at line 221 of file progressbar.py.

Referenced by progressbar.ProgressBar._handle_resize().

progressbar.ProgressBar.finished

Definition at line 239 of file progressbar.py.

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

progressbar.ProgressBar.last_update_time

Definition at line 240 of file progressbar.py.

Referenced by progressbar.ProgressBar._need_update().

progressbar.ProgressBar.left_justify

Definition at line 222 of file progressbar.py.

Referenced by progressbar.ProgressBar._format_line().

progressbar.ProgressBar.maxval

Definition at line 219 of file progressbar.py.

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

progressbar.ProgressBar.next

static

Definition at line 277 of file progressbar.py.

Referenced by progressbar.ProgressBar.__next__().

progressbar.ProgressBar.next_update

Definition at line 369 of file progressbar.py.

Referenced by progressbar.ProgressBar._need_update().

progressbar.ProgressBar.num_intervals

Definition at line 389 of file progressbar.py.

progressbar.ProgressBar.poll

Definition at line 241 of file progressbar.py.

Referenced by progressbar.ProgressBar._need_update().

progressbar.ProgressBar.seconds_elapsed

Definition at line 242 of file progressbar.py.

Referenced by progressbar.ProgressBar.update().

progressbar.ProgressBar.signal_set

Definition at line 224 of file progressbar.py.

Referenced by progressbar.ProgressBar.finish().

progressbar.ProgressBar.start_time

Definition at line 243 of file progressbar.py.

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

progressbar.ProgressBar.term_width

Definition at line 226 of file progressbar.py.

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

progressbar.ProgressBar.update_interval

Definition at line 244 of file progressbar.py.

progressbar.ProgressBar.widgets

Definition at line 220 of file progressbar.py.

Referenced by progressbar.ProgressBar._format_widgets(), Vispa.Views.BoxDecayView.BoxDecayView.collapseAll(), Vispa.Views.BoxDecayView.BoxDecayView.expandAll(), and Vispa.Views.BoxDecayView.BoxDecayView.expandToDepth().

Property Documentation

progressbar.ProgressBar.percent = property(percentage)

static

Definition at line 297 of file progressbar.py.