命令行进度条实现

原创 2017年06月19日 20:40:21

对于很多包管理工具而言,拥有一个进度条基本上来说是必备的,可以轻松的让用户知道当前程序的进度。
VSCode命令行进度条美化版
命令行下其实也可以活得很精彩。


今天来学一下如何制作一个命令行下的进度条工具。回想之前用Python写过的getpass2,用了标准输出来实现的。和这次的进度条需求相比,感觉应该是一回事。应该就是清空上次的打印内容,然后write本行数据。

单行输出

果不其然,在网上大致搜了一下,发现很多都是使用类似的思路。那既然如此,就没必要重复造轮子了。干脆用人家的好了。

single-line-log

关于这个模块的使用,可以通过npm进行安装,也可以下载源代码,放到本地使用。其核心代码超少,我就直接贴出代码好了。

/**
 * 单行内容输出效果。
 */
const MOVE_LEFT = new Buffer('1b5b3130303044', 'hex').toString();
const MOVE_UP = new Buffer('1b5b3141', 'hex').toString();
const CLEAR_LINE = new Buffer('1b5b304b', 'hex').toString();

/**
 * 借助一个第三方的计算字符串长度的模块。
 */
const stringwidth = require('string-width');

module.exports = function(stream) {
    var write = stream.write;
    var str;

    stream.write = function(data) {
        if(str && data!== str) str = null;
        return write.apply(this, arguments);
    };

    if(stream === process.stderr || stream === process.stdout) {
        process.on('exit', ()=>{
            if(str!==null) stream.write('');
        });
    }

    var prevLineCount = 0;
    var log = function(){
        str = '';
        var nextstr = Array.prototype.join.call(arguments, ' ');

        // 清屏
        for(var i =0; i < prevLineCount; i++) {
            str += MOVE_LEFT + CLEAR_LINE + (i < prevLineCount-1?MOVE_UP:'');
        }

        // 更新实际内容
        str += nextstr;
        stream.write(str);

        // 下行要删除多少行内容
        var prevLines = nextstr.split('\n');
        prevLineCount = 0;
        for(var i = 0; i < prevLines.length; i++) {
            prevLineCount += Math.ceil(stringwidth(prevLines[i]) / stream.columns) || 1;
        }
    };

    log.clear = function() {
        stream.write('');
    };

    return log;
};

/**
 * 对外提供接口。
 */
module.exports.stdout = module.exports(process.stdout);
module.exports.stderr = module.exports(process.stderr);

是的,就只有这么几行的内容。阅读代码就不难发现,就是我上面说的那个思路。

测试输出

接下来简单的进行测试一下。因为对于小文件来说,的一下就完事了,所以干脆找个大文件,比如一个电影来进行测试。

var log = require('./singleline').stdout;
var fs = require('fs');
var strformat = require('str-format');
var read = 0;
var filepath = "E:\\Video\\电影\\大内密探零零发.mkv";
var size = fs.statSync(filepath).size;

var rs = fs.createReadStream(filepath);
rs.on('data', function(data){
    read += data.length;
    var percentage = Math.floor(100*read/size);
    // log("Writing to super large file\n["+percentage+'%]', read, 'bytes readed.')
    log(strformat.format('Writing to super large file.\n[ {}% ] bytes readed.', [percentage]))
});

里面用到了我之前写的一个Python风格的字符串格式化模块。有需要的可以使用

npm install str-format

来进行安装和使用。

下面来看下运行的效果。
单行输出测试,大电影形式

其实这样就实现了一个简单的进度条了。但是为了使其更加通用,接下来对其进行了一个封装。


progressbar

虽然说是进行了封装, 其实重要的还只是percentage那部分的内容了。

封装代码

/**
 * 进度条实现。
 */
const log = require('./singleline').stdout;
const strformat = require('str-format').format;

/**
 * 封装一个进度条工具。
 */
function ProgressBar(description, bar_length) {
    this.description = description || "PROGRESS";
    this.length = bar_length.length || 28;

    // 刷新进度条图案,文字的方法
    this.render = function(opts) {
        var percentage = (opts.completed/opts.total).toFixed(4);
        var cell_num = Math.floor(percentage * this.length);
        // 拼接黑色条
        var cell = '';
        for(var i = 0; i < cell_num; i++) {
            cell += '█';
        }
        // 拼接灰色条
        var empty = '';
        for(var i = 0; i < this.length - cell_num; i++) {
            empty += '░';
        }
        // 拼接最终文本
        var cmdtext = strformat("<{}:{}%> {}{}  [ {}/{} `{}`]", [this.description, (100*percentage).toFixed(2),
        cell, empty, opts.completed, opts.total, opts.status]);
        log(cmdtext);
    };
}

/**
 * 模块导出。
 */
module.exports = ProgressBar;

测试进度条效果

var ProgressBar = require('./progressbar');
var pb = new ProgressBar('下载进度', 50);
var num = 0, total = 100;
function downloading() {
    if (num < total) {
        pb.render({ completed: num, total: total, status: '下载中...' });
        num++;
        setTimeout(function () {
            downloading();
        }, 50);
    }else{
        pb.render({completed: num, total: total, status: "下载完毕."});
            process.exit(0);
    }
}

downloading()

运行效果,如下:
进度条本地测试

至此,一个还算是比较通用的进度条就算是完成了。每次需要手动更新进度的时候,只需要调用render方法即可。

美化

单纯的黑白字符,看起来挺枯燥的,下面使用一个终端彩色模块来对其进行一下美化。

美化版进度条包装

/**
 * 进度条实现。
 */
const log = require('./singleline').stdout;
const strformat = require('str-format').format;
const clicolor = require('cli-color');

/**
 * 封装一个进度条工具。
 */
function ProgressBar(description, bar_length) {
    this.description = description || "PROGRESS";
    this.length = bar_length.length || 28;

    // 刷新进度条图案,文字的方法
    this.render = function(opts) {
        var percentage = (opts.completed/opts.total).toFixed(4);
        var cell_num = Math.floor(percentage * this.length);
        // 拼接黑色条
        var cell = '';
        for(var i = 0; i < cell_num; i++) {
            cell += '█';
        }
        // 拼接灰色条
        var empty = '';
        for(var i = 0; i < this.length - cell_num; i++) {
            empty += '░';
        }

        var percent = (100*percentage).toFixed(2);
        /**
         * 使用cli-color进行包装美化。
         */
        this.description = clicolor.blue.bold(this.description);
        cell = clicolor.green.bgBlack.bold(cell);
        opts.completed = clicolor.yellow.bold(opts.completed);
        opts.total = clicolor.blue.bold(opts.total);
        opts.status = percent==100.00?clicolor.green.bold(opts.status):clicolor.red.bold(opts.status);


        // 拼接最终文本
        var cmdtext = strformat("<{}:{}%> {}{}  [ {}/{} `{}`]", [this.description, percent,
        cell, empty, opts.completed, opts.total, opts.status]);
        log(cmdtext);
    };
}

/**
 * 模块导出。
 */
module.exports = ProgressBar;

美化版进度条测试

var ProgressBar = require('./progressbar');
var pb = new ProgressBar('下载进度', 72);
var num = 0, total = 100;
function downloading() {
    if (num < total) {
        pb.render({ completed: num, total: total, status: '下载中...' });
        num++;
        setTimeout(function () {
            downloading();
        }, 20);
    }else{
        pb.render({completed: num, total: total, status: "下载完毕."});
            process.exit(0);
    }
}

downloading()

下面看下执行结果。

  • 先看下在VSCode下的执行效果。
    VSCode命令行进度条美化版

  • 然后是常规的CMD命令行下效果。
    常规CMD命令行进度条美化版


好了,大致就是这么个内容了。在Linux上还有很多更加优秀的此类实现。有机会再去借鉴借鉴好了。

版权声明:本作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可。转载时请标注http://blog.csdn.net/marksinoberg. 举报

相关文章推荐

命令行进度条实现

对于很多包管理工具而言,拥有一个进度条基本上来说是必备的,可以轻松的让用户知道当前程序的进度。命令行下其实也可以活得很精彩。今天来学一下如何制作一个命令行下的进度条工具。回想之前用Python写过的g...

Linux中模拟实现进度条

一、背景 1、进度条实现原理    进度条的实现必须了解以下几个知识点,回车换行、缓冲区    换行:换行就是光标只从上一行行尾移至下一行行尾    回车:回车就是光标从行尾移至行首  &#...

我是如何成为一名python大咖的?

人生苦短,都说必须python,那么我分享下我是如何从小白成为Python资深开发者的吧。2014年我大学刚毕业..

Linux(三):简单进度条的原理及实现

Linux:进度条的简单实现,缓冲区,进度条原理,换行和回车

C实现LINUX命令行环境下的进度条功能

虽然Linux通过命令行操作时非常方便的,但是有时候那又臭又长的脚本执行过程的各种输出也实在看着乱七八糟,因此用C语言写了一个简单的进度条,因为是根据我自己的项目写的,所以只是单纯的循环进度条,而不是...

web进度条

在处理长任务,大数据交互是,程序容易造成假死,用户也不知道程序在做什么,于是就需要一个进度条,但是网上进度条实例,效果都不佳,都不能实时更新进度条,比如伪进度条就只能是一张图片,还有的是事务处理完后,...

进度条实现

方法一:js+css http://www.w3.org/TR/html4/loose.dtd"> #box {float:left;width:200px;height:18px;bor...

进度条实现

本片文章介绍进度条shell c的实现代码Shell脚本实现#!/bin/bashi=0 str="" arr=("|" "/" "-" "\\") color=("30" &qu...

一起talk C栗子吧(第一百九十九回:C语言实例--DIY cp命令三)

各位看官们,大家好,上一回中咱们说的是DIY cp命令的例子,这一回咱们继续说该例子。闲话休提,言归正转。让我们一起talk C栗子吧!

Linux 下几个文件操作命令的代码实现,myfind find 查找命令 实现

转自http://www.ibm.com/developerworks/cn/linux/l-cn-commands/ 用 C 语言实现命令 cp、df、mkdir、rm、tac 本文...

【Linux】Linux下进度条的模拟实现

本文主要介绍了进度条的编写方法和思路
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

(最多只允许输入30个字)