golang程序进度条实现示例详解
作者:jonylee 发布时间:2024-04-25 13:22:45
引言
最近在工作中写一个批处理脚本,令人抓狂的是每次都不知道脚本要跑到啥时候结束,于是想到给程序添加个进度条。
逛了一圈,没找到特别趁手的轮子,本着有手就行的原则,今天简单地给大家撸一个终端进度条。
原理
终端进度条打印的原理是通过输入\r将光标位置移动到当前行的行首,重新打印一份进度信息。
如果是使用\n,则光标会另起一行打印信息。
上才艺
首先从核心功能出发,进度条要告诉我的信息有
一共要完成多少任务
现在完成了多少任务
到什么时候才能完成全部任务
根据上面的需求
画了个大概的样子长这样 [█████████████████████████]100/100 [eta]16:33:39
抽象的用户调用函数有3个
New()新建进度条实例 Done()推进进度条进展 Finish()完成进度条
是不是和sync.WaitGroup很像。
调用代码
func main() {
bar := progress.New(100)
for i := 0; i < 100; i++ {
time.Sleep(time.Second / 10)
bar.Done(1)
}
bar.Finish()
}
所以根据用户调用需求,首先定义进度条结构体。
type Bar struct {
total int64 // 总进度
current int64 // 当前进度
filler string // 进度填充字符
filler_length int64 // 进度条长度
time_format string // 进度条时间格式
interval time.Duration // 打印时间间隔
begin time.Time // 任务开始时间
}
然后根据用户调用的函数,给出函数实现,当然这里面加了一些函数参数可选项。
可以在初始化实例的时候自定义一些元素,比如填充字符,比如时间格式或者是每隔多少时间刷新一次进度条等等。
// New 新建进度条实例
func New(total int64, opts ...func(*Bar)) *Bar {
bar := &Bar{
total: total,
filler: "█",
filler_length: 25,
time_format: "15:04:05", // 2006-01-02T15:04:05
interval: time.Second,
begin: time.Now(),
}
for _, opt := range opts {
opt(bar)
}
// 定时打印
ticker := time.NewTicker(bar.interval)
go func() {
for bar.current < bar.total {
fmt.Print(bar.get_progress_string())// 打印进度
<-ticker.C
}
}()
return bar
}
// Done 更新完成进度
func (bar *Bar) Done(i int64) {
bar.current += i
}
// Finish 完成最后进度条
func (bar *Bar) Finish() {
fmt.Println(bar.get_progress_string())
}
// WithFiller 设置进度条填充字符
func WithFiller(filler string) func(*Bar) {
return func(bar *Bar) {
if len(bar.filler) != 0 {
bar.filler = filler
}
}
}
那么处理完了用户怎么使用之后,我们就来开始处理怎么给用户展示进度条效果。
要想根据进度填充不同的字符比例,先算进度百分比,长下面这样子。
//get_percent 获取进度百分比,区间0-100
func (bar *Bar) get_percent() int64 {
return bar.current * 100 / bar.total
}
因为我们进度条并不需要那么精确,所有这里都用的是整数来处理,更方便一些,不用做各种类型转换。
那么拿到百分比之后,就能根据进度条总长度来计算要填充多少个█。
接下来算任务什么时候完成,这里用的算法是,用当前完成了多少个任务和花了多少时间来估算总任务数的要花费多少时间,得到预计什么时候完成,代码是这样子的:
//get_eta 获取eta时间
func (bar *Bar) get_eta(now time.Time) string {
eta := (now.Unix() - bar.begin.Unix()) * 100 / (bar.get_percent() + 1)
return bar.begin.Add(time.Second * time.Duration(eta)).Format(bar.time_format)
}
最后,我们来处理下需要在控制台打印的字符串,同时作为非核心需求,我们还想看批处理操作的速度,所以这里用QPS来表达我们整个任务处理的速度。
QPS表达任务处理速度
//get_progress_string 获取打印控制台字符串
func (bar *Bar) get_progress_string() string {
fills := bar.get_percent() * bar.filler_length / 100
for i := int64(0); i < bar.filler_length; i++ {
switch {
case i < fills:
chunks[i] = bar.filler
default:
chunks[i] = " "
}
}
now := time.Now()
eta := bar.get_eta(now)
qps := bar.current / (now.Unix() - bar.begin.Unix() + 1)
return fmt.Sprintf("\r[%s]%d/%d [eta]%s [qps]%d ", strings.Join(chunks, ""), bar.current, bar.total, eta, qps)
}
最终呈现的效果 [█████████████████████████]100/100 [eta]16:33:39 [qps]9
当然,为了更酷炫一点,同时还引入了emoji字符,能够根据字符自适应地调整显示效果。
下面是项目github地址,供大家参考
https://github.com/jony-lee/go-progress-ba
知识点总结
下面是知识点总结
使用\r来将控制台光标定位到行首实现行内进度条刷新。
使用函数可选参数来实现用户自定义设置。
使用函数time.NewTicker()实现定时刷新控制台进度条。
来源:https://juejin.cn/post/7136519767720099871
猜你喜欢
- 前言该脚本的代码大部分是参考自阿里云的官方帮助文档。1, 脚本语言使用的是python, 我个人只是了解python,没有太深入的知识功底2
- 用类和对象实现一个银行账户的资金交易管理, 包括存款、取款和打印交易详情, 交易详情中包含每次交易的时间、存款或者取款的金额、每次交易后的余
- 近期,有小伙伴问我关于怎么使用python进行散点图的绘制,这个东西很简单,但是怎么讲相关性的值标注在图形上略显麻烦,因此,在这里记录一下,
- 前言今天,一起用 Python 来理一理红楼梦里的那些关系不要问我为啥是红楼梦,而不是水浒三国或西游,因为我也鉴定的认为,红楼才是无可争议的
- 目录一.models数据库映射二.serializers序列化三.url路由四.Views视图类一.models数据库映射from djan
- Conda GuideConda简介conda是一个包,依赖和环境管理工具,适用于多种语言,如: Python, R, Scala, Jav
- 这篇文章主要介绍了python基于event实现线程间通信控制,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,
- 那你也许会问及,怎样获取当前系统日期的最大时间值,如yyyy-MM-dd 23:59:59.997。 我们可以使用DATEADD函数,来实现
- 上一次,我们谈到在ASP中如何利用“正则表达式”对象来实现各种数据的校验,文中描述了正则表达式对象的强大功能,接下来,我们来看看有关“正则表
- select count(*) as lot from OA_sample_check where left(ecnNO, LOCATE(&
- Python是世界上最受欢迎的编码语言之一,在80年代后期首次受到ABC和Modula-3语言的影响而被概念化。从1991年的第一个版本到成
- 本文实例讲述了PHP实现数组根据某个字段进行水平合并,横向合并。分享给大家供大家参考,具体如下:PHP数组水平合并,横向合并,两条数据合并成
- 1. 事务介绍MVCC之前,先介绍下事务:事务是为了保证数据库中数据的完整性和一致性。事务的4个基本要素:原子性(Atomicity):要么
- 一、进入pycharm二、步骤1、开始点击pycharm左上角的file,找到python interpreter,点击右边的设置(长得像齿
- 简介到目前为止,我们查阅anaconda的官网可发现,由于目前Anaconda没有支持arm架构的版本,在M1芯片Mac上安装的Anacon
- 数据库发生阻塞和死锁的现象:一、数据库阻塞的现象:第一个连接占有资源没有释放,而第二个连接需要获取这个资源。如果第一个连接没有提交或者回滚,
- 1.计算变量缺失率df=pd.read_csv('titanic_train.csv')def missing_cal(df
- 更改mysql密码-- 查询用户权限show grants for 'root'@'%';update my
- 本文实例讲述了Python Flask框架模板操作。分享给大家供大家参考,具体如下:模板在前面的示例中,视图函数的主要作用是生成请求的响应,
- 问题创建一个二叉树二叉树有限多个节点的集合,这个集合可能是:空集由一个根节点,和两棵互不相交的,分别称作左子树和右子树的二叉树组成创建二叉树