tqdm-ruby 使用教程

项目介绍

tqdm-ruby 是一个 Ruby 库，用于在循环迭代时添加进度指示器。它是 Python 中优秀的 tqdm 库的移植版本。tqdm（读作 taqadum，تقدّم）在阿拉伯语中意为“进度”。通过调用 #tqdm（或 #with_progress）方法，任何可枚举对象都会返回一个增强的克隆对象，该对象在迭代过程中会显示进度条。

项目快速启动

安装

你可以通过 Rubygems 全局安装 tqdm-ruby：

$ gem install tqdm

或者将其添加到你的应用程序的 Gemfile 中：

gem 'tqdm'

然后执行：

$ bundle

使用示例

以下是一个简单的使用示例：

require 'tqdm'

(0..1000).tqdm.each do |x|
  sleep 0.01
end

默认输出会发送到 $stderr，显示如下：

50%|████████████████████████████                | 500/1000 [00:05<00:05, 99.00it/s]

应用案例和最佳实践

在 IRB 和 Pry 中使用

tqdm-ruby 同样适用于 IRB、Pry 和 iRuby 笔记本：

require 'tqdm'

(0..100).tqdm.each do |x|
  sleep 0.01
end

最佳实践

1. 简化使用：tqdm 鼓励最懒惰的使用场景，即“设置即忘”。你不需要手动更新进度条对象，它会自动处理。
2. 避免过度配置：与其他进度条库相比，tqdm 提供了最基本的功能，避免了复杂的格式化选项。

典型生态项目

相关项目

• ruby-progressbar：另一个 Ruby 进度条库，提供了更多的配置选项。
• powerbar：另一个简单的进度条库，适用于需要轻量级进度条的场景。

通过这些项目，你可以根据具体需求选择最适合的进度条库。

---

通过以上内容，你应该能够快速上手并使用 tqdm-ruby 库来为你的循环添加进度指示器。希望这篇教程对你有所帮助！