mpb

package module
v5.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 19, 2020 License: Unlicense Imports: 19 Imported by: 90

README

Multi Progress Bar

GoDoc Build Status Go Report Card

mpb is a Go lib for rendering progress bars in terminal applications.

Features

  • Multiple Bars: Multiple progress bars are supported
  • Dynamic Total: Set total while bar is running
  • Dynamic Add/Remove: Dynamically add or remove bars
  • Cancellation: Cancel whole rendering process
  • Predefined Decorators: Elapsed time, ewma based ETA, Percentage, Bytes counter
  • Decorator's width sync: Synchronized decorator's width among multiple bars

Usage

Rendering single bar
package main

import (
    "math/rand"
    "time"

    "github.com/vbauerster/mpb/v5"
    "github.com/vbauerster/mpb/v5/decor"
)

func main() {
    // initialize progress container, with custom width
    p := mpb.New(mpb.WithWidth(64))

    total := 100
    name := "Single Bar:"
    // adding a single bar, which will inherit container's width
    bar := p.AddBar(int64(total),
        // override DefaultBarStyle, which is "[=>-]<+"
        mpb.BarStyle("╢▌▌░╟"),
        mpb.PrependDecorators(
            // display our name with one space on the right
            decor.Name(name, decor.WC{W: len(name) + 1, C: decor.DidentRight}),
            // replace ETA decorator with "done" message, OnComplete event
            decor.OnComplete(
                decor.AverageETA(decor.ET_STYLE_GO, decor.WC{W: 4}), "done",
            ),
        ),
        mpb.AppendDecorators(decor.Percentage()),
    )
    // simulating some work
    max := 100 * time.Millisecond
    for i := 0; i < total; i++ {
        time.Sleep(time.Duration(rand.Intn(10)+1) * max / 10)
        bar.Increment()
    }
    // wait for our bar to complete and flush
    p.Wait()
}
Rendering multiple bars
    var wg sync.WaitGroup
    // pass &wg (optional), so p will wait for it eventually
    p := mpb.New(mpb.WithWaitGroup(&wg))
    total, numBars := 100, 3
    wg.Add(numBars)

    for i := 0; i < numBars; i++ {
        name := fmt.Sprintf("Bar#%d:", i)
        bar := p.AddBar(int64(total),
            mpb.PrependDecorators(
                // simple name decorator
                decor.Name(name),
                // decor.DSyncWidth bit enables column width synchronization
                decor.Percentage(decor.WCSyncSpace),
            ),
            mpb.AppendDecorators(
                // replace ETA decorator with "done" message, OnComplete event
                decor.OnComplete(
                    // ETA decorator with ewma age of 60
                    decor.EwmaETA(decor.ET_STYLE_GO, 60), "done",
                ),
            ),
        )
        // simulating some work
        go func() {
            defer wg.Done()
            rng := rand.New(rand.NewSource(time.Now().UnixNano()))
            max := 100 * time.Millisecond
            for i := 0; i < total; i++ {
                // start variable is solely for EWMA calculation
                // EWMA's unit of measure is an iteration's duration
                start := time.Now()
                time.Sleep(time.Duration(rng.Intn(10)+1) * max / 10)
                bar.Increment()
                // we need to call DecoratorEwmaUpdate to fulfill ewma decorator's contract
                bar.DecoratorEwmaUpdate(time.Since(start))
            }
        }()
    }
    // Waiting for passed &wg and for all bars to complete and flush
    p.Wait()
Dynamic total

dynamic total

Complex example

complex

Bytes counters

byte counters

Documentation

Overview

Package mpb is a library for rendering progress bars in terminal applications.

Example 
// initialize progress container, with custom width
p := mpb.New(mpb.WithWidth(64))

total := 100
name := "Single Bar:"
// adding a single bar, which will inherit container's width
bar := p.AddBar(int64(total),
	// override DefaultBarStyle, which is "[=>-]<+"
	mpb.BarStyle("╢▌▌░╟"),
	mpb.PrependDecorators(
		// display our name with one space on the right
		decor.Name(name, decor.WC{W: len(name) + 1, C: decor.DidentRight}),
		// replace ETA decorator with "done" message, OnComplete event
		decor.OnComplete(
			// ETA decorator with ewma age of 60, and width reservation of 4
			decor.EwmaETA(decor.ET_STYLE_GO, 60, decor.WC{W: 4}), "done",
		),
	),
	mpb.AppendDecorators(decor.Percentage()),
)
// simulating some work
max := 100 * time.Millisecond
for i := 0; i < total; i++ {
	// start variable is solely for EWMA calculation
	// EWMA's unit of measure is an iteration's duration
	start := time.Now()
	time.Sleep(time.Duration(rand.Intn(10)+1) * max / 10)
	bar.Increment()
	// we need to call DecoratorEwmaUpdate to fulfill ewma decorator's contract
	bar.DecoratorEwmaUpdate(time.Since(start))
}
// wait for our bar to complete and flush
p.Wait()

Output:

Index

Examples

Constants

View Source 
const DefaultBarStyle string = "[=>-]<+"

DefaultBarStyle is a string containing 7 runes. Each rune is a building block of a progress bar. 

'1st rune' stands for left boundary rune

'2nd rune' stands for fill rune

'3rd rune' stands for tip rune

'4th rune' stands for space rune

'5th rune' stands for right boundary rune

'6th rune' stands for reverse tip rune

'7th rune' stands for refill rune

Variables

View Source 
var DefaultSpinnerStyle = []string{"⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"}

DefaultSpinnerStyle is a slice of strings, which makes a spinner.

Functions

This section is empty.

Types

type Bar 

type Bar struct {
	// contains filtered or unexported fields
}

Bar represents a progress Bar.

func (*Bar) Abort 

func (b *Bar) Abort(drop bool)

Abort interrupts bar's running goroutine. Call this, if you'd like to stop/remove bar before completion event. It has no effect after completion event. If drop is true bar will be removed as well.

func (*Bar) Completed 

func (b *Bar) Completed() bool

Completed reports whether the bar is in completed state.

Example 
p := mpb.New()
bar := p.AddBar(100)

max := 100 * time.Millisecond
for !bar.Completed() {
	time.Sleep(time.Duration(rand.Intn(10)+1) * max / 10)
	bar.Increment()
}

p.Wait()

Output:

func (*Bar) Current 

func (b *Bar) Current() int64

Current returns bar's current number, in other words sum of all increments.

func (*Bar) DecoratorAverageAdjust 

func (b *Bar) DecoratorAverageAdjust(start time.Time)

DecoratorAverageAdjust adjusts all average based decorators. Call if you need to adjust start time of all average based decorators or after progress resume.

func (*Bar) DecoratorEwmaUpdate 

func (b *Bar) DecoratorEwmaUpdate(dur time.Duration)

DecoratorEwmaUpdate updates all EWMA based decorators. Should be called on each iteration, because EWMA's unit of measure is an iteration's duration. Panics if called before *Bar.Incr... family methods.

func (*Bar) ID 

func (b *Bar) ID() int

ID returs id of the bar.

func (*Bar) IncrBy 

func (b *Bar) IncrBy(n int)

IncrBy is a shorthand for b.IncrInt64(int64(n)).

func (*Bar) IncrInt64 

func (b *Bar) IncrInt64(n int64)

IncrInt64 increments progress by amount of n.

func (*Bar) Increment 

func (b *Bar) Increment()

Increment is a shorthand for b.IncrInt64(1).

func (*Bar) ProxyReader 

func (b *Bar) ProxyReader(r io.Reader) io.ReadCloser

ProxyReader wraps r with metrics required for progress tracking. Panics if r is nil.

Example 
// import crand "crypto/rand"

var total int64 = 1024 * 1024 * 500
reader := io.LimitReader(crand.Reader, total)

p := mpb.New()
bar := p.AddBar(total,
	mpb.AppendDecorators(
		decor.CountersKibiByte("% .2f / % .2f"),
	),
)

// create proxy reader
proxyReader := bar.ProxyReader(reader)
defer proxyReader.Close()

// and copy from reader, ignoring errors
io.Copy(ioutil.Discard, proxyReader)

p.Wait()

Output:

func (*Bar) SetCurrent 

func (b *Bar) SetCurrent(current int64)

SetCurrent sets progress' current to an arbitrary value. Setting a negative value will cause a panic.

func (*Bar) SetPriority 

func (b *Bar) SetPriority(priority int)

SetPriority changes bar's order among multiple bars. Zero is highest priority, i.e. bar will be on top. If you don't need to set priority dynamically, better use BarPriority option.

func (*Bar) SetRefill 

func (b *Bar) SetRefill(amount int64)

SetRefill fills bar with refill rune up to amount argument. Given default bar style is "[=>-]<+", refill rune is '+'. To set bar style use mpb.BarStyle(string) BarOption.

func (*Bar) SetTotal 

func (b *Bar) SetTotal(total int64, complete bool)

SetTotal sets total dynamically. If total is less than or equal to zero it takes progress' current value. A complete flag enables or disables complete event on `current >= total`.

func (*Bar) TraverseDecorators 

func (b *Bar) TraverseDecorators(cb func(decor.Decorator))

TraverseDecorators traverses all available decorators and calls cb func on each.

type BarFiller 

type BarFiller interface {
	Fill(w io.Writer, reqWidth int, stat decor.Statistics)
}

BarFiller interface. Bar (without decorators) renders itself by calling BarFiller's Fill method. 

`reqWidth` is requested width, which is set via:
func WithWidth(width int) ContainerOption
func BarWidth(width int) BarOption

Default implementations can be obtained via: 

func NewBarFiller(style string, reverse bool) BarFiller
func NewSpinnerFiller(style []string, alignment SpinnerAlignment) BarFiller

func NewBarFiller 

func NewBarFiller(style string, reverse bool) BarFiller

NewBarFiller constucts mpb.BarFiller, to be used with *Progress.Add(...) *Bar method.

func NewSpinnerFiller 

func NewSpinnerFiller(style []string, alignment SpinnerAlignment) BarFiller

NewSpinnerFiller constucts mpb.BarFiller, to be used with *Progress.Add(...) *Bar method.

type BarFillerFunc 

type BarFillerFunc func(w io.Writer, reqWidth int, stat decor.Statistics)

BarFillerFunc is function type adapter to convert function into BarFiller.

func (BarFillerFunc) Fill 

func (f BarFillerFunc) Fill(w io.Writer, reqWidth int, stat decor.Statistics)

type BarOption 

type BarOption func(*bState)

BarOption is a function option which changes the default behavior of a bar.

func AppendDecorators 

func AppendDecorators(decorators ...decor.Decorator) BarOption

AppendDecorators let you inject decorators to the bar's right side.

func BarExtender 

func BarExtender(filler BarFiller) BarOption

BarExtender is an option to extend bar to the next new line, with arbitrary output.

func BarFillerClearOnComplete 

func BarFillerClearOnComplete() BarOption

BarFillerClearOnComplete clears bar's filler on complete event. It's shortcut for BarFillerOnComplete("").

func BarFillerMiddleware added in v5.2.0 

func BarFillerMiddleware(middle func(BarFiller) BarFiller) BarOption

BarFillerMiddleware provides a way to augment default BarFiller.

func BarFillerOnComplete 

func BarFillerOnComplete(message string) BarOption

BarFillerOnComplete replaces bar's filler with message, on complete event.

func BarFillerTrim added in v5.4.0 

func BarFillerTrim() BarOption

BarFillerTrim bar filler is rendered with leading and trailing space like ' [===] ' by default. With this option leading and trailing space will be removed.

func BarID 

func BarID(id int) BarOption

BarID sets bar id.

func BarNoPop 

func BarNoPop() BarOption

BarNoPop disables bar pop out of container. Effective when PopCompletedMode of container is enabled.

func BarOptOn 

func BarOptOn(option BarOption, condition func() bool) BarOption

BarOptOn returns option when condition evaluates to true.

func BarPriority 

func BarPriority(priority int) BarOption

BarPriority sets bar's priority. Zero is highest priority, i.e. bar will be on top. If `BarReplaceOnComplete` option is supplied, this option is ignored.

func BarQueueAfter 

func BarQueueAfter(runningBar *Bar) BarOption

BarQueueAfter queues this (being constructed) bar to relplace runningBar after it has been completed.

func BarRemoveOnComplete 

func BarRemoveOnComplete() BarOption

BarRemoveOnComplete removes both bar's filler and its decorators on complete event.

func BarReverse 

func BarReverse() BarOption

BarReverse reverse mode, bar will progress from right to left.

func BarStyle 

func BarStyle(style string) BarOption

BarStyle overrides mpb.DefaultBarStyle which is "[=>-]<+". It's ok to pass string containing just 5 runes, for example "╢▌▌░╟", if you don't need to override '<' (reverse tip) and '+' (refill rune).

func BarWidth 

func BarWidth(width int) BarOption

BarWidth sets bar width independent of the container.

func MakeFillerTypeSpecificBarOption 

func MakeFillerTypeSpecificBarOption(
	typeChecker func(BarFiller) (interface{}, bool),
	cb func(interface{}),
) BarOption

MakeFillerTypeSpecificBarOption makes BarOption specific to Filler's actual type. If you implement your own Filler, so most probably you'll need this. See BarStyle or SpinnerStyle for example.

func PrependDecorators 

func PrependDecorators(decorators ...decor.Decorator) BarOption

PrependDecorators let you inject decorators to the bar's left side.

func SpinnerStyle 

func SpinnerStyle(frames []string) BarOption

SpinnerStyle sets custom spinner style. Effective when Filler type is spinner.

func TrimSpace 

func TrimSpace() BarOption

TrimSpace is an alias to BarFillerTrim.

type ContainerOption 

type ContainerOption func(*pState)

ContainerOption is a function option which changes the default behavior of progress container, if passed to mpb.New(...ContainerOption).

func ContainerOptOn 

func ContainerOptOn(option ContainerOption, condition func() bool) ContainerOption

ContainerOptOn returns option when condition evaluates to true.

func PopCompletedMode 

func PopCompletedMode() ContainerOption

PopCompletedMode will pop and stop rendering completed bars.

func WithDebugOutput 

func WithDebugOutput(w io.Writer) ContainerOption

WithDebugOutput sets debug output.

func WithManualRefresh 

func WithManualRefresh(ch <-chan time.Time) ContainerOption

WithManualRefresh disables internal auto refresh time.Ticker. Refresh will occur upon receive value from provided ch.

func WithOutput 

func WithOutput(w io.Writer) ContainerOption

WithOutput overrides default os.Stdout output. Setting it to nil will effectively disable auto refresh rate and discard any output, useful if you want to disable progress bars with little overhead.

func WithRefreshRate 

func WithRefreshRate(d time.Duration) ContainerOption

WithRefreshRate overrides default 120ms refresh rate.

func WithRenderDelay 

func WithRenderDelay(ch <-chan struct{}) ContainerOption

WithRenderDelay delays rendering. By default rendering starts as soon as bar is added, with this option it's possible to delay rendering process by keeping provided chan unclosed. In other words rendering will start as soon as provided chan is closed.

func WithShutdownNotifier 

func WithShutdownNotifier(ch chan struct{}) ContainerOption

WithShutdownNotifier provided chanel will be closed, after all bars have been rendered.

func WithWaitGroup 

func WithWaitGroup(wg *sync.WaitGroup) ContainerOption

WithWaitGroup provides means to have a single joint point. If *sync.WaitGroup is provided, you can safely call just p.Wait() without calling Wait() on provided *sync.WaitGroup. Makes sense when there are more than one bar to render.

func WithWidth 

func WithWidth(width int) ContainerOption

WithWidth sets container width. If not set underlying bars will occupy whole term width.

type Progress 

type Progress struct {
	// contains filtered or unexported fields
}

Progress represents the container that renders Progress bars

func New 

func New(options ...ContainerOption) *Progress

New creates new Progress container instance. It's not possible to reuse instance after *Progress.Wait() method has been called.

func NewWithContext 

func NewWithContext(ctx context.Context, options ...ContainerOption) *Progress

NewWithContext creates new Progress container instance with provided context. It's not possible to reuse instance after *Progress.Wait() method has been called.

func (*Progress) Add 

func (p *Progress) Add(total int64, filler BarFiller, options ...BarOption) *Bar

Add creates a bar which renders itself by provided filler. Set total to 0, if you plan to update it later. Panics if *Progress instance is done, i.e. called after *Progress.Wait().

func (*Progress) AddBar 

func (p *Progress) AddBar(total int64, options ...BarOption) *Bar

AddBar creates a new progress bar and adds it to the rendering queue.

func (*Progress) AddSpinner 

func (p *Progress) AddSpinner(total int64, alignment SpinnerAlignment, options ...BarOption) *Bar

AddSpinner creates a new spinner bar and adds it to the rendering queue.

func (*Progress) BarCount 

func (p *Progress) BarCount() int

BarCount returns bars count

func (*Progress) UpdateBarPriority 

func (p *Progress) UpdateBarPriority(b *Bar, priority int)

UpdateBarPriority same as *Bar.SetPriority(int).

func (*Progress) Wait 

func (p *Progress) Wait()

Wait waits for all bars to complete and finally shutdowns container. After this method has been called, there is no way to reuse *Progress instance.

type SpinnerAlignment 

type SpinnerAlignment int

SpinnerAlignment enum. 

const (
	SpinnerOnLeft SpinnerAlignment = iota
	SpinnerOnMiddle
	SpinnerOnRight
)

SpinnerAlignment kinds.

Source Files

View all Source files

Directories

Path Synopsis
Package decor provides common decorators for "github.com/vbauerster/mpb/v5" module.
 Package decor provides common decorators for "github.com/vbauerster/mpb/v5" module.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.