使用Python编写类UNIX系统的命令行工具的教程

引言

您是否能编写命令行工具？也许您可以，但您能编写出真正好用的命令行工具吗？本文讨论使用 Python 来创建一个强健的命令行工具，并带有内置的帮助菜单、错误处理和选项处理。由于一些奇怪的原因，很多人并不了解 Python? 的标准库具有制作功能极其强大的 *NIX 命令行工具所需的全部工具。

可以这样说，Python 是制作 *NIX 命令行工具的最佳语言，因为它依照“batteries-included”的哲学方式工作，并且强调提供可读性高的代码。但仅作为提醒，当您发现使用 Python 创建命令行工具是一件多么简单的事情时，这些想法很危险，您的生活可能被搅得一团糟。据我所知，至今还没有发表过详细说明使用 Python 创建命令行工具的文章，因此我希望您喜欢这篇文章。
设置

Python 标准库中的 optparse 模块可完成创建命令行工具的大部分琐碎工作。optparse 包含在 Python 2.3 中，因此该模块将包括在许多 *NIX 操作系统中。如果由于某种原因，您使用的操作系统不包含所需要的模块，那么值得庆幸的是，Python 的最新版本已经过测试并编译到几乎任何 *NIX 操作系统中。Python 支持的系统包括 IBM? AIX?、HP-UX、Solaris、Free BSD、Red Hat Linux?、Ubuntu、OS X、IRIX，甚至包括几种 Nokia 手机。
创建 Hello World 命令行工具

编写优秀的命令行工具的第一步是定义要解决的问题。这对您工具的成功至关重要。这对于以尽可能简单的方法解决问题也同样重要。这里明确地采用了 KISS（Keep It Simple Stupid，保持简单）准则。只有在实现并测试了计划内功能之后才添加选项和增加其他功能。

我们首先从创建 Hello World 命令行工具开始。按照上面的建议，我们使用尽可能简单的术语来定义问题。

问题定义：我希望创建一个命令行工具，默认打印 Hello World，并提供用于打印不通人的姓名的选项。

基于上述说明，可以提供一个包含少量代码的解决方案。
Hello World 命令行接口 (CLI)

 #!/usr/bin/env python     import optparse          def main():      p = optparse.OptionParser()      p.add_option('--person', '-p', default="world")      options, arguments = p.parse_args()      print 'Hello %s' % options.person          if __name__ == '__main__':      main()

如果运行此代码，预期的输出如下：

Hello world

但是，我们通过少量代码所能做到的远不止于此。我们可以获得自动生成的帮助菜单：

python hello_cli.py --help       Usage: hello_cli.py [options]          Options:     -h, --help      show this help message and exit     -p PERSON, --person=PERSON

从帮助菜单中可以了解到，我们可以使用两种方法来更改 Hello World 的输出：