Urwid 开源项目教程

Urwid 开源项目教程

urwidConsole user interface library for Python (official repo)项目地址:https://gitcode.com/gh_mirrors/ur/urwid

1. 项目的目录结构及介绍

Urwid 项目的目录结构如下：

urwid/
├── CHANGES
├── COPYING
├── MANIFEST.in
├── README.rst
├── setup.cfg
├── setup.py
├── docs/
│   ├── Makefile
│   ├── conf.py
│   ├── index.rst
│   ├── ...
├── urwid/
│   ├── __init__.py
│   ├── display_common.py
│   ├── edit_canvas.py
│   ├── ...
├── examples/
│   ├── bigtext.py
│   ├── calculator.py
│   ├── ...
├── tests/
│   ├── __init__.py
│   ├── test_box_widget.py
│   ├── ...

目录介绍

• CHANGES: 项目变更记录。
• COPYING: 项目许可证文件。
• MANIFEST.in: 用于打包的清单文件。
• README.rst: 项目介绍和使用说明。
• setup.cfg: 安装配置文件。
• setup.py: 安装脚本。
• docs/: 项目文档目录，包含 Sphinx 文档配置和源文件。
• urwid/: 项目核心代码目录，包含所有模块和功能实现。
• examples/: 示例代码目录，包含多个使用 Urwid 的示例程序。
• tests/: 测试代码目录，包含单元测试和功能测试。

2. 项目的启动文件介绍

Urwid 项目的启动文件通常是 examples 目录下的示例程序。例如，examples/bigtext.py 是一个简单的启动文件，展示了如何使用 Urwid 创建一个大型文本显示。

示例启动文件

# examples/bigtext.py
import urwid

def exit_on_q(key):
    if key in ('q', 'Q'):
        raise urwid.ExitMainLoop()

txt = urwid.Text("Hello, World")
fill = urwid.Filler(txt, 'top')
loop = urwid.MainLoop(fill, unhandled_input=exit_on_q)
loop.run()

启动文件说明

• import urwid: 导入 Urwid 库。
• exit_on_q(key): 定义一个退出函数，当按下 'q' 或 'Q' 键时退出主循环。
• txt = urwid.Text("Hello, World"): 创建一个文本控件。
• fill = urwid.Filler(txt, 'top'): 将文本控件填充到窗口中。
• loop = urwid.MainLoop(fill, unhandled_input=exit_on_q): 创建主循环并运行。

3. 项目的配置文件介绍

Urwid 项目的配置文件主要是 setup.cfg 和 setup.py。

setup.cfg

setup.cfg 是一个配置文件，用于指定安装和打包的选项。

[metadata]
name = urwid
version = 2.6.14
description = A console user interface library for Python
long_description = file: README.rst
long_description_content_type = text/x-rst
author = Ian Ward
author_email = ian@excess.org
url = http://urwid.org/
license = LGPL-2.1
classifiers =
    Development Status :: 5 - Production/Stable
    Intended Audience :: Developers
    License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
    Operating System :: OS Independent
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3.7
    Programming Language :: Python :: 3.8
    Programming Language :: Python :: 3.9
    Programming Language :: Python :: 3.10
    Topic :: Software Development :: Libraries :: Python Modules
    Topic :: Terminals

[options]
packages = find:
install_requires =
    python-dateutil
    six

[options.extras_require]
curses =
    urwid[curses]
serial =
    pyserial
zmq =
    pyzmq

setup.py

setup.py 是一个 Python 脚本，用于安装和打包项目。

urwidConsole user interface library for Python (official repo)项目地址:https://gitcode.com/gh_mirrors/ur/urwid