给你的命令行工具加上一个高逼格的banner

追马

发布于 2020-07-06 16:53:47

1.9K0

发布于 2020-07-06 16:53:47

文章被收录于专栏：一日一工具一日一工具

看不懂man page, 小工具来帮你

你在看别人开源的命令行工具的时候，在支持-h或者-v的时候是不是经常看到下面这样的格式输出，你一定是好奇的，这是如何实现的，那今天就带你一块了解下这块的实现。

比如下面这种

再比如下面这种

或者是下面这种

亦或者是下面这种

不得不提的figlet

什么是figlet

figlet是一个可以生成ASCII Art字体工具，在编写一些CLI工具的时候可以作为banner，支持很多字形，对于终端展示十分炫(zhuang)酷(bi)。

安装

其实figlet支持的安装方式很多很多，比如pip, npm, brew等安装方式，今天我们主要来讲解下pip的安装方式，原因是因为安装完不单单可以作为命令行工具使用，还可以在你的Python程序里导入使用。

pip安装

pip install pyfiglet

brew安装

brew install figlet

npm安装

npm install figlet

命令行使用

> pyfiglet -f Banner3 z h u i m a
########    ##     ##    ##     ##    ####    ##     ##       ###
     ##     ##     ##    ##     ##     ##     ###   ###      ## ##
    ##      ##     ##    ##     ##     ##     #### ####     ##   ##
   ##       #########    ##     ##     ##     ## ### ##    ##     ##
  ##        ##     ##    ##     ##     ##     ##     ##    #########
 ##         ##     ##    ##     ##     ##     ##     ##    ##     ##
########    ##     ##     #######     ####    ##     ##    ##     ##


>

程序里使用

代码程序

# -*- coding: utf-8 -*-
# __Author__ = "zhuima"


from __future__ import absolute_import, unicode_literals

from pyfiglet import figlet_format
import six

try:
    import colorama

    colorama.init()
except ImportError:
    colorama = None

try:
    from termcolor import colored
except ImportError:
    colored = None


def log(string, color, font="Banner3", figlet=False):
    if colored:
        if not figlet:
            six.print_(colored(string, color))
        else:
            six.print_(colored(figlet_format(string, font=font), color))
    else:
        six.print_(string)


log("\nZ H U I M A", color="blue", figlet=True)

效果展示


> python test-figlet.py
########    ##     ##    ##     ##    ####    ##     ##       ###
     ##     ##     ##    ##     ##     ##     ###   ###      ## ##
    ##      ##     ##    ##     ##     ##     #### ####     ##   ##
   ##       #########    ##     ##     ##     ## ### ##    ##     ##
  ##        ##     ##    ##     ##     ##     ##     ##    #########
 ##         ##     ##    ##     ##     ##     ##     ##    ##     ##
########    ##     ##     #######     ####    ##     ##    ##     ##

>