urwid，一个好用的 Python 库！

大家好，我是涛哥，本文内容来自 涛哥聊Python ，转载请标原创。

今天为大家分享一个好用的 Python 库 - urwid。

Github地址：https://github.com/urwid/urwid

---

Urwid 是一个功能强大的 Python 库，用于创建基于文本的用户界面（TUI）和终端应用程序。它提供了丰富的小部件和布局管理器，使开发者可以轻松构建具有交互性的终端界面。本文将详细介绍 Urwid 库的特性、用法，并通过丰富的示例代码展示其在实际项目中的应用。

Urwid 简介

Urwid 是一个纯 Python 实现的终端用户界面库。

Urwid主要特点：

1. 丰富的小部件： Urwid 提供了多种小部件，如按钮、文本框、列表框等，可以构建复杂的终端界面。
2. 灵活的布局管理： Urwid 支持多种布局管理器，如列布局、行布局、框架布局等，可以灵活地组织界面结构。
3. 自定义主题： 开发者可以通过自定义主题来美化界面，包括颜色、字体等方面的设置。

安装 Urwid 库

要开始使用 Urwid 库，首先需要安装它。

可以使用 pip 命令来安装：

pip install urwid

安装完成后，可以在 Python 代码中引入 Urwid 库，并开始使用其提供的功能。

import urwid

Urwid 的基本用法

通过几个示例来展示 Urwid 库的基本用法。

创建文本框

import urwid

# 创建文本框
text_box = urwid.Edit("请输入文本：")

# 创建主循环对象并运行
loop = urwid.MainLoop(text_box)
loop.run()

创建按钮

import urwid

# 创建按钮
button = urwid.Button("点击我")

# 按钮点击事件处理函数
def on_button_click(button, data=None):
    button.set_label("已点击")

urwid.connect_signal(button, "click", on_button_click)

# 创建主循环对象并运行
loop = urwid.MainLoop(button)
loop.run()

创建列表框

import urwid

# 列表框内容
content = [
    urwid.Text("Item 1"),
    urwid.Text("Item 2"),
    urwid.Text("Item 3"),
]

# 创建列表框
list_box = urwid.ListBox(urwid.SimpleListWalker(content))

# 创建主循环对象并运行
loop = urwid.MainLoop(list_box)
loop.run()

Urwid 的高级用法

除了基本的用法之外，Urwid 还提供了一些高级功能，以满足更复杂的终端界面需求。

自定义小部件

import urwid

# 自定义小部件
class CustomWidget(urwid.WidgetWrap):
    def __init__(self, text):
        widget = urwid.Text(text)
        super().__init__(widget)

# 使用自定义小部件
custom_widget = CustomWidget("这是自定义小部件")
loop = urwid.MainLoop(custom_widget)
loop.run()

自定义主题

import urwid

# 创建自定义主题
custom_palette = [
    ("body", "black", "light gray"),
    ("footer", "white", "dark red"),
]

# 创建文本框和尾部部件
text_box = urwid.Edit("请输入文本：")
footer = urwid.Text("这是底部信息")

# 创建主循环对象并运行
loop = urwid.MainLoop(urwid.Pile([text_box, footer]), palette=custom_palette)
loop.run()

实际项目中的应用

当在实际项目中使用 Urwid 库时，通常会涉及到一些更加复杂的场景和需求。

1. 命令行工具界面设计

在开发命令行工具时，通常需要设计一个用户友好的界面来交互和显示信息。Urwid 提供了丰富的小部件和布局管理器，可以轻松实现这一需求。

import urwid

# 创建命令行工具界面
def create_cli_interface():
    # 创建文本框和按钮
    text_box = urwid.Edit("请输入命令：")
    button = urwid.Button("执行")

    # 按钮点击事件处理函数
    def on_button_click(button, data=None):
        command = text_box.get_edit_text()
        # 执行命令并显示结果
        result = execute_command(command)
        result_text.set_text(result)

    urwid.connect_signal(button, "click", on_button_click)

    # 创建结果显示文本框
    result_text = urwid.Text("执行结果将显示在这里")

    # 创建界面布局
    layout = urwid.Pile([text_box, button, result_text])

    return layout

# 模拟执行命令的函数
def execute_command(command):
    # 这里模拟执行命令的过程，实际项目中需替换为真实的命令执行逻辑
    return f"执行命令：{command}"

# 创建主循环对象并运行
loop = urwid.MainLoop(create_cli_interface())
loop.run()

2. 终端监控和控制界面

对于需要监控和控制远程服务器或设备的项目，可以使用 Urwid 创建一个终端监控和控制界面，方便用户实时查看和操作。

import urwid

# 创建监控和控制界面
def create_monitoring_interface():
    # 创建监控信息显示框
    monitor_text = urwid.Text("监控信息将实时显示在这里")

    # 创建停止按钮
    stop_button = urwid.Button("停止监控")

    # 停止按钮点击事件处理函数
    def on_stop_button_click(button, data=None):
        # 停止监控逻辑
        stop_monitoring()
        monitor_text.set_text("监控已停止")

    urwid.connect_signal(stop_button, "click", on_stop_button_click)

    # 创建界面布局
    layout = urwid.Pile([monitor_text, stop_button])

    return layout

# 模拟停止监控的函数
def stop_monitoring():
    # 这里模拟停止监控的过程，实际项目中需替换为真实的停止监控逻辑
    pass

# 创建主循环对象并运行
loop = urwid.MainLoop(create_monitoring_interface())
loop.run()

3. 终端游戏界面开发

如果正在开发一个终端游戏，Urwid 提供了丰富的小部件和事件处理机制，可以实现复杂的游戏界面和交互逻辑。

import urwid

# 创建游戏界面
def create_game_interface():
    # 创建游戏地图
    map_text = urwid.Text("游戏地图将显示在这里")

    # 创建玩家信息显示框
    player_info_text = urwid.Text("玩家信息将实时显示在这里")

    # 创建界面布局
    layout = urwid.Pile([map_text, player_info_text])

    return layout

# 创建主循环对象并运行
loop = urwid.MainLoop(create_game_interface())
loop.run()

总结

Python的Urwid库是一个功能强大的终端用户界面（TUI）库，提供丰富的小部件和布局管理器，可以轻松创建交互性强的终端界面。通过Urwid库，开发者可以快速构建命令行工具界面、终端监控和控制界面以及终端游戏界面等各种应用。其灵活性和丰富的功能使得Urwid在实际项目中具有广泛的应用价值，是开发终端应用程序的理想选择。