在Ranger文件管理器中获取用户输入：自定义命令与交互式提示

本文详细介绍了在ranger文件管理器中获取用户输入的两种主要方法。首先，通过自定义命令的参数机制，利用`self.arg(n)`等方法直接获取命令调用时提供的输入。其次，针对需要交互式、运行时提示的场景，本文提供了一个基于ranger底层`curses`库实现的`user_input`函数，允许在命令执行过程中动态地向用户请求输入。文章包含详细的代码示例、使用说明及相关注意事项，旨在帮助用户高效地扩展ranger的功能。

Ranger是一款高效的终端文件管理器，以其高度的可配置性和可扩展性而闻名。用户可以通过Python语言编写自定义命令、按键绑定甚至插件来增强Ranger的功能。当需要这些自定义功能与用户进行交互，获取用户输入时，有两种主要的方式可以实现。

一、通过命令参数获取输入

Ranger的命令系统设计允许用户在调用命令时直接提供参数。这意味着，当你在Ranger的控制台中输入一个命令时，其后的内容会被解析为该命令的参数。因此，获取用户输入的直接方法就是访问这些已提供的参数。

1. 定义自定义命令

要在Ranger中定义一个自定义命令，你需要创建一个Python类，该类继承自ranger.api.commands.Command，并实现一个execute方法。这个类的名称就是你在Ranger控制台中调用命令时使用的名称。

将以下代码添加到你的~/.config/ranger/commands.py文件中：

from ranger.api.commands import Command

class myCommand(Command):
    """
    一个简单的自定义命令，用于演示如何获取命令参数。
    """
    def execute(self):
        # 通过 self.arg(1) 获取第一个参数
        # 注意：arg(0) 通常是命令本身的名称
        filename = self.arg(1)

        # 在Ranger的通知区域显示获取到的文件名
        if filename:
            self.fm.notify(f"您输入的文件名是: {filename}")
        else:
            self.fm.notify("请提供一个文件名作为参数。")

2. 访问命令参数

在execute方法中，self对象提供了多种访问命令参数的方式：

• self.arg(n): 获取第n个参数。n从1开始计数。如果参数不存在，则返回空字符串。
• self.args: 一个包含所有（由空格分隔的）参数的列表。self.args[0]是命令名称，self.args[1]是第一个参数，以此类推。
• self.line: 用户在控制台中输入的完整命令行字符串。
• self.rest(n): 从第n个参数开始，包括其后所有内容的字符串。例如，如果命令是search foo bar a b c，self.rest(2)将返回bar a b c。
• self.start(n): 第n个参数之前的所有内容。例如，如果命令是search foo bar a b c，self.start(2)将返回search foo。
• self.quantifier: 如果命令被映射到快捷键，并且用户在按下快捷键前输入了一个数字（如6x），则self.quantifier将是这个数字。

示例用法：

在Ranger中，你可以这样调用上述myCommand：

:myCommand my_document.pdf

此时，self.arg(1)将获取到my_document.pdf，Ranger会显示通知您输入的文件名是: my_document.pdf。

注意事项：

知我AI·PC客户端

离线运行 AI 大模型，构建你的私有个人知识库，对话式提取文件知识，保证个人文件数据安全

0

查看详情

这种方式的输入是在命令调用时一次性提供的，因此在execute方法内部不需要使用Python内置的input()函数来提示用户，因为Ranger已经处理了外部的输入。尝试在execute方法中使用input()通常会导致Ranger界面冻结。

二、实现交互式提示获取输入

虽然通过命令参数获取输入简单有效，但它不适用于需要多次交互或在命令执行过程中动态提示用户输入的场景。对于这种更复杂的交互式需求，我们可以利用Ranger底层使用的curses库来实现一个自定义的user_input函数。

1. 基于curses实现user_input函数

curses是一个用于创建文本用户界面（TUI）的编程库。Ranger的UI就是基于它构建的。我们可以编写一个独立的函数来模拟input()的行为，但通过curses与Ranger的终端界面进行交互。

将以下代码保存为~/.config/ranger/plugins/plugin_greeter.py文件：

from ranger.api.commands import Command
import curses

def user_input(prompt):
    """
    在Ranger文件管理器中向用户显示提示并获取输入。
    此函数使用curses库在Ranger的状态栏（底部）进行交互。

    :param str prompt: 显示给用户的提示信息。
    :return: 用户输入的字符串。
    :rtype: str
    """
    # 初始化curses窗口，以便进行屏幕操作
    window = curses.initscr()

    # 获取屏幕的最大行和列，用于定位提示信息
    rows, cols = [coord - 1 for coord in window.getmaxyx()]

    # 在Ranger的状态栏（通常是屏幕的最后一行，第0列）添加提示信息
    window.addstr(rows, 0, prompt)

    # 启用字符回显，这样用户输入时可以看到自己输入的内容
    curses.echo()

    # 在提示信息后获取用户输入。
    # getstr的参数是行、列和最大输入长度。
    user_input_bytes = window.getstr(rows, len(prompt), cols - len(prompt) - 1)

    # 禁用字符回显，恢复Ranger的默认行为
    curses.noecho()

    # 清除Ranger的状态栏，以便下次使用或恢复Ranger的正常显示
    window.addstr(rows, 0, " " * cols)

    # 结束curses窗口操作
    curses.endwin()

    # 将获取到的字节串解码为UTF-8字符串并返回
    return user_input_bytes.decode(encoding="utf-8")

class greet(Command):
    """
    一个使用自定义user_input函数进行交互式问候的命令。
    """
    def execute(self):
        greeting_template = "你好，{person}！"

        # 第一次调用user_input获取姓名
        name = user_input("请输入您的名字：")

        # 可以在同一个命令中多次调用user_input
        # 例如，这里再次调用以确认或获取更多信息
        # name = user_input("您确定是这个名字吗？请再次输入：")

        # 使用获取到的名字格式化问候语并显示通知
        self.fm.notify(greeting_template.format(person=name))

2. 使用方法和部署

1. 保存代码： 将上述代码保存为~/.config/ranger/plugins/plugin_greeter.py。Ranger会自动加载plugins目录下的Python文件作为插件。
2. 调用命令： 启动Ranger后，在控制台中输入:greet并按回车键。
3. 交互： 此时，Ranger屏幕底部将出现提示请输入您的名字：。输入你的名字并按回车键，Ranger将显示相应的问候通知。

curses函数详解：

• curses.initscr(): 初始化curses环境，返回一个窗口对象。
• window.getmaxyx(): 获取窗口的最大行数和列数。
• window.addstr(rows, 0, prompt): 在指定位置（最后一行，第0列）显示提示字符串。
• curses.echo(): 启用用户输入时的字符回显，让用户看到自己输入的内容。
• window.getstr(rows, len(prompt), cols - len(prompt) - 1): 在提示信息之后的位置获取用户输入。第一个参数是行号，第二个是列号（提示信息的末尾），第三个是最大输入长度。
• curses.noecho(): 禁用字符回显，恢复默认行为。
• window.addstr(rows, 0, " " * cols): 用空格填充最后一行，清除之前显示的提示和输入，恢复Ranger的状态栏。
• curses.endwin(): 结束curses环境。
• .decode(encoding="utf-8"): getstr返回的是字节串，需要解码为字符串。

高级交互：

除了获取字符串输入，curses还提供了window.getch()方法，可以用于捕获单个按键事件，这对于实现更复杂的自定义按键绑定或类似游戏的交互逻辑非常有用。

三、代码存放位置和调试

• 自定义命令 (Command类)： 通常存放在~/.config/ranger/commands.py文件中。
• *插件 (`plugin_.py)：** 存放在~/.config/ranger/plugins/`目录下。当你的功能比较复杂，包含多个相关命令、按键绑定或更长的代码时，建议使用插件形式。
• 调试： 在Ranger启动时使用ranger --debug命令可以开启调试模式，这对于排查自定义代码中的问题非常有帮助。同时，查阅Ranger的man手册中关于PLUGINS的部分，可以获取更详细的插件开发指南。

总结

在Ranger中获取用户输入主要有两种策略：对于简单的、一次性输入的场景，可以直接通过自定义命令的参数（self.arg(n)）来获取；而对于需要更灵活、交互式提示的场景，则可以利用curses库实现一个自定义的user_input函数。理解这两种方法及其适用场景，将极大地增强你自定义和扩展Ranger文件管理器的能力。

以上就是在Ranger文件管理器中获取用户输入：自定义命令与交互式提示的详细内容，更多请关注php中文网其它相关文章！