一个漂亮的并针对 Python 的终端旋转图标模块

Python部落(python.freelycode.com)组织翻译，禁止转载，欢迎转发。

halo 受 ora 启发，是一个漂亮的并针对 Python 的终端旋转图标模块

安装

用法

另一种情况，你可以将 halo 应用在 Python 的 with 语句中：

最后一种情况，你可以将 halo 作为装饰器使用：

API

Halo([text|spinner|color|interval|stream|enabled])

具体参数意义如下：

text

类型： str

text 紧跟旋转图标后出现。

spinner

类型：str | dict

如果是 str，则需要是旋转图标的 json 文件中给定的字符串。如果是一个 dict 则需要包含 "intervel" 和 "frame" 两项，例如：

spinner 的缺省值为 dots。对于 Windows 用户，其缺省值为 line。

color

类型：str 值：grey, red, greeen, yellow, blue, magenta, cyan, white

color 缺省值为 cyan

interval

类型：float

定义了每个块之间的间隔，缺省值为旋转图标的间隔（推荐值）

stream

类型：file

输出流，缺省值为 sys.stdout

enable

类型：bool

是否显示旋转图标，缺省值为 True

方法

下面介绍可以使用的类方法：

spinner.start([text])

运行 spinner。 如果 text 没有给出来，则将其值为 spinner 的 text 属性值。返回这个实例。

spinner.stop()

停止并删除 spinner。返回这个实例。

spinner.clear()

删除 spinner，并返回这个实例。

spinner.render()

手动渲染一个新的框架，返回这个实例。

spinner.frame()

返回下一个待渲染的框架

spinner.succeed([text])

text：类型为 str

停止这个 spinner 并将其图标变为 ✔ 。 如果给出来 text 参数，则将其 spinner 的 text 属性替换为此 text，否则保持不变。返回这个实例。

spinner.fail([test])

text：类型为 str

停止这个 spinner 并将其图标变为 ✖ 。如果给出来 text 参数，则将其 spinner 的 text 属性替换为此 text，否则保持不变。返回这个实例。

spinner.warn([text])

text：类型为 str

停止这个 spinner 并将其图标变为 ⚠ 。如果给出来 text 参数，则将其 spinner 的 text 属性替换为此 text，否则保持不变。返回这个实例。

spinner.info([text])

text：类型为 str

停止这个 spinner 并将其图标变为 ℹ 。如果给出来 text 参数，则将其 spinner 的 text 属性替换为此 text，否则保持不变。返回这个实例。

spinner.stop_and_persist([options])

options：类型为 dict

停止这个 spinner，并修改其图标和 text 属性，返回这个实例。

options 参数的键值：

symbol

类型为： str

用来替换原 spinner 图标。 缺省值为 ""

text

类型为： str

用来替换原 spinner text 属性值。 缺省值为原 text 值。

spinner.text

更改 spinner 的 text。

spinner.color

更改 spinner 的 color。

spinner.spinner

更换 spinner 自身

接下来的工作：

支持 windows

喜欢这个模块吗

如果喜欢请 star 我们。也可以通过 twitter 来告诉我们。当然也可以向别人推荐我们的工作。

相关工作

• py-spinners

• py-log-symbols

• ora

英文原文：https://github.com/ManrajGrover/halo 
译者：无