如何为Python命令行工具实现类分页器的交互式输出？

下面是几个直接在Python CLI中实现交互式分页的可行方式：

1. 使用标准库curses实现完整交互式分页 #

curses是Python自带的终端界面库，可完全自定义分页交互逻辑，支持上下滚动、退出等操作，和less的体验最接近。

示例代码：

import curses
from your_module import get_formatted_logs  # 替换成你获取格式化日志的函数

def main(stdscr):
    # 初始化curses
    curses.curs_set(0)  # 隐藏光标
    stdscr.clear()
    logs = get_formatted_logs()  # 获取你的格式化日志列表，每个元素是一行
    max_y, max_x = stdscr.getmaxyx()
    current_line = 0

    while True:
        stdscr.clear()
        # 计算当前页能显示的行数
        display_lines = min(max_y - 1, len(logs) - current_line)
        # 打印当前页的日志
        for i in range(display_lines):
            line = logs[current_line + i][:max_x - 1]  # 适配终端宽度
            stdscr.addstr(i, 0, line)
        # 显示分页信息
        page_info = f"Line {current_line + 1}-{current_line + display_lines}/{len(logs)} | Press q to quit, ↑/↓ to scroll"
        stdscr.addstr(max_y - 1, 0, page_info[:max_x - 1])
        stdscr.refresh()

        # 监听按键
        key = stdscr.getch()
        if key == ord('q'):
            break
        elif key == curses.KEY_DOWN and current_line + display_lines < len(logs):
            current_line += 1
        elif key == curses.KEY_UP and current_line > 0:
            current_line -= 1

if __name__ == "__main__":
    curses.wrapper(main)

这个方案可实现完整的上下滚动、分页提示、退出功能，完全在Python内部处理，无需依赖外部命令。

2. 使用click库的内置分页功能 #

如果已经在用click开发CLI工具，它内置的echo_via_pager方法可直接将内容通过系统分页器（如less、more）输出，自动处理交互，代码非常简洁。

示例代码：

import click
from your_module import get_formatted_logs

def main():
    logs = get_formatted_logs()
    log_content = "\n".join(logs)
    click.echo_via_pager(log_content)

if __name__ == "__main__":
    main()

这个方法会自动调用系统的分页程序，无需自己处理按键逻辑，体验和直接用less一致，且代码量极少。

3. 手动实现简易分页（无第三方依赖） #

如果不想用任何额外库，可以手动获取终端高度，按页输出，监听用户按键来翻页。

示例代码：

import sys
import os
from your_module import get_formatted_logs

def get_terminal_height():
    try:
        return os.get_terminal_size().lines
    except OSError:
        return 20  #  fallback值

def main():
    logs = get_formatted_logs()
    total_lines = len(logs)
    terminal_height = get_terminal_height() - 2  # 留一行显示提示
    current_page = 0
    total_pages = (total_lines + terminal_height - 1) // terminal_height

    while True:
        os.system('clear')  # 清屏，Windows用'cls'
        start = current_page * terminal_height
        end = min(start + terminal_height, total_lines)
        for line in logs[start:end]:
            print(line)
        # 显示分页提示
        print(f"\nPage {current_page + 1}/{total_pages} | Press 'n' for next, 'p' for prev, 'q' to quit")
        key = input().lower()
        if key == 'q':
            break
        elif key == 'n' and current_page < total_pages - 1:
            current_page += 1
        elif key == 'p' and current_page > 0:
            current_page -= 1

if __name__ == "__main__":
    main()

这个方案不需要任何额外依赖，实现基础的分页翻页功能，适合简单场景。

内容的提问来源于stack exchange，提问作者Harshavardhan Gowda