本文介绍了如何在 Click 命令行应用中获取未解析的命令行参数。通过 click.Context 对象的 args 属性，可以方便地访问原始命令行参数列表，无需依赖 sys.argv。这对于需要处理未知或动态参数的应用场景非常有用。
Click 是一个流行的 Python 库，用于构建美观且易于使用的命令行界面。在 Click 应用中，我们经常需要访问传递给命令的原始命令行参数，即使这些参数没有被定义为选项或参数。Click 提供了 click.Context 对象，它包含了关于当前命令执行的上下文信息，包括已解析的参数和未解析的参数。
要获取未解析的命令行参数，可以使用 click.Context 对象的 args 属性。args 属性返回一个列表，其中包含所有未被 Click 解析的命令行参数。
以下是一个示例，演示了如何使用 ctx.args 获取未解析的参数：
import click @click.group("abc") def abc(): """ABC Help""" pass @abc.command("test") @click.option("-o", "--option") @click.option("-o2", "--option2", default="two") def test(option, option2): """Get command CLI info""" ctx = click.get_current_context() print("Command name:", ctx.info_name) print("Command path:", ctx.command_path) print("Command params:", ctx.params) print("CLI args:", ' '.join(ctx.args)) if __name__ == "__main__": abc()
在这个例子中，test 命令定义了两个选项：-o 和 -o2。如果用户传递了其他参数，例如 -x 或 extra_arg，这些参数将不会被 Click 解析，而是存储在 ctx.args 中。
运行以下命令：
abc test -o 1 -x extra_arg
将输出：
Command name: test Command path: abc test Command params: {'option': '1', 'option2': 'two'} CLI args: -x extra_arg
可以看到，-x 和 extra_arg 都被存储在 ctx.args 中。
注意事项：
- ctx.args 包含的是原始的命令行参数，包括选项标志（例如 -x）和参数值（例如 extra_arg）。
- ctx.args 中的参数顺序与它们在命令行中出现的顺序相同。
- 使用 ctx.args 获取未解析的参数时，需要小心处理这些参数，确保它们不会导致安全问题或程序错误。
总结：
click.Context 对象的 args 属性提供了一种方便的方法来获取 Click 命令行应用中的未解析参数。通过使用 ctx.args，可以轻松地访问原始命令行参数列表，并根据需要进行处理。这对于需要处理未知或动态参数的应用场景非常有用。