命令行应用程序参数风格指南

Question

在Unix平台上编写命令行应用程序的参数是否有样式指南？作为iOS世界的一员，我想到了类似于人机界面指南 (HIG)的东西。我正在使用Python编写一个脚本，其中可以接受参数。

例如：如何命名参数，在何时使用-dash或--doubleDash。

- fearmint

---

使用argparse模块进行参数解析，它易于使用并且基本上强制你拥有良好的CLI风格。http://docs.python.org/dev/library/argparse.html - wim

Answer 1

看看这个标准库模块：http://docs.python.org/library/argparse.html 它可以让你更轻松地实现命令行接口，并且使用它的样式指南将使你受益匪浅。

请注意，argparse 仅在 Python 2.7（或 3.x 系列中的 3.2）中可用。在那之前，有http://docs.python.org/library/optparse.html，它会生成类似的命令行接口，但使用起来没有那么方便。

- Ben

---

是的，但参数的语法和命名怎么办？ - fearmint

@JoePasq：我怀疑没有人正式编写命名约定，但查看GNU coreutils使用的选项会有所帮助。 - Mechanical snail

你被 argparse 的参数语法所限制。它提供了位置参数、单字母参数（如 -a -b -c，可以像 -abc 一样分组）和长参数（如 --long）。我不确定是否有针对命令行参数的命名约定，或者是否能够在更具体的层面上进行。 - Ben

嗯，不同的参数解析模块基本上定义了标准。其中一些具有遗留支持--如果需要，它们将允许您在长选项名称之前使用单破折号或加号代替破折号--但您应该让合理现代的选项解析库的默认行为指导您。 - tripleee

有一些命名约定，其中大部分可以在流行命令的手册页面中找到。一些例子是 -h 或 --help（显示命令语法概要，然后退出），-V 或 --version（显示版本号，然后退出），-v 或 --verbose（提供有关命令正在执行的额外信息），-q 或 --quiet（产生较少的输出），-d 或 --debug（在标准错误上提供调试信息），-n 或 --dry-run（提供有关命令将要执行的信息而不是实际执行它）。 - ajk

啊，这也有帮助。我并没有完全意识到使用argparse符合事实标准。谢谢。 - fearmint

Answer 2

阅读《Unix可用性艺术》http://www.catb.org/~esr/writings/taouu/taouu.html

- tripleee

Answer 3

GNU编码规范中有一节关于命令行程序的内容。

为了具有posixy的感觉，您不仅应该提供标准的命令行选项（短选项和长选项），而且如果可能的话，应遵守从标准输入（或命令行）读取并写入标准输出的要求，并仅通过选项（如-o/--output）覆盖输出。这是大多数GNU命令行工具的期望行为。

- Kerrek SB