# 10.6. 处理命令行参数 Python 完全支持创建在命令行运行的程序，也支持通过命令行参数和短长样式来指定各种选项。这些并非是 XML 特定的，但是这样的脚本可以充分使用命令行处理，看来是时候提一下它了。 如果不理解命令行参数如何暴露给你的 Python 程序，讨论命令行处理是很困难的，所以让我们先写个简单点的程序来看一下。 ## 例 10.20. `sys.argv` 介绍 如果您还没有下载本书附带的样例程序, 可以 [下载本程序和其他样例程序](http://www.woodpecker.org.cn/diveintopython/download/diveintopython-exampleszh-cn-5.4b.zip "Download example scripts")。 ``` #argecho.py import sys for arg in sys.argv: print arg ``` | | | | --- | --- | | \[1\] | 每个传递给程序的命令行参数都在 `sys.argv` 中，而它仅仅是一个列表。这里我们在独立行中打印出每个参数。 | ## 例 10.21. `sys.argv` 的内容 ``` [you@localhost py]$ python argecho.py argecho.py [you@localhost py]$ python argecho.py abc def argecho.py abc def [you@localhost py]$ python argecho.py --help argecho.py --help [you@localhost py]$ python argecho.py -m kant.xml argecho.py -m kant.xml ``` | | | | --- | --- | | \[1\] | 关于 `sys.argv` 需要了解的第一件事情就是：它包含了你正在调用的脚本的名称。你后面会实际使用这个知识，在[第 16 章 _函数编程_](../functional_programming/index.html "第 16 章 函数编程")中。现在不用担心。 | | \[2\] | 命令行参数通过空格进行分隔。在 `sys.argv` 列表中，每个参数都是一个独立的元素。 | | \[3\] | 命令行标志，像 `--help`，在 `sys.argv` 列表中还保存了它们自己的元素。 | | \[4\] | 为了让事情更有趣，有些命令行标志本身就接收参数。比如，这里有一个标记 (`-m`) 接收一个参数 (`kant.xml`)。标记自身和标记参数只是 `sys.argv` 列表中的一串元素。并没有试图将元素与其它元素进行关联；所有你得到的是一个列表。 | 所以正如你所看到的，你确实拥有了命令行传入的所有信息，但是接下来要实际使用它似乎不那么容易。对于只是接收单个参数或者没有标记的简单程序，你可以简单地使用 `sys.argv[1]` 来访问参数。这没有什么羞耻的；我一直都是这样做的。对更复杂的程序，你需要 `getopt` 模块。 ## 例 10.22. `getopt` 介绍 ``` def main(argv): grammar = "kant.xml" try: opts, args = getopt.getopt(argv, "hg:d", ["help", "grammar="]) except getopt.GetoptError: usage() sys.exit(2) ... if __name__ == "__main__": main(sys.argv[1:]) ``` | | | | --- | --- | | \[1\] | 首先，看一下例子的最后并注意你正在调用 `main` 函数，参数是 `sys.argv[1:]`。记住，`sys.argv[0]` 是你正在运行脚本的名称；在处理命令行时，你不用关心它，所以你可以砍掉它并传入列表的剩余部分。 | | \[2\] | 这里就是所有有趣处理发生的地方。`getopt` 模块的 `getopt` 函数接受三个参数：参数列表 (你从 `sys.argv[1:]` 得到的)、一个包含了程序所有可能接收到的单字符命令行标志，和一个等价于单字符的长命令行标志的列表。第一次看的时候，这有点混乱，下面有更多的细节解释。 | | \[3\] | 在解析这些命令行标志时，如果有任何事情错了，`getopt` 会抛出异常，你可以捕获它。你可以告诉 `getopt` 你明白的所有标志，那么这也意味着终端用户可以传入一些你不理解的命令行标志。 | | \[4\] | 和 UNIX 世界中的标准实践一样，如果脚本被传入了不能理解的标志，你要打印出正确用法的一个概要并友好地退出。注意，在这里我没有写出 `usage` 函数。你还是要在某个地方写一个，使它打印出合适的概要；它不是自动的。 | 那么你传给 `getopt` 函数的参数是什么呢？好的，第一个只不过是一个命令行标志和参数的原始列表 (不包括第一个元素――脚本名称，你在调用 `main` 函数之前就已经将它砍掉了)。第二个是脚本接收的短命令行标志的一个列表。 ## `"hg:d"` `-h` 打印用法概要 `-g ...` 使用给定的语法文件或 URL `-d` 在解析时显示调试信息 第一个标志和第三个标志是简单的独立标志；你选择是否指定它们，它们做某些事情 (打印帮助) 或者改变状态 (打开调试)。但是，第二个标志 (`-g`) _必须_ 跟随一个参数――进行读取的语法文件的名称。实际上，它可以是一个文件名或者一个 web 地址，这时还不知道 (后面会确定)，但是你要知道必须要_有些东西_。所以，你可以通过在 `getopt` 函数的第二个参数的 `g` 后面放一个冒号，来向 `getopt` 说明这一点。 更复杂的是，这个脚本既接收短标志 (像 `-h`)，也接受长标志 (像 `--help`)，并且你要它们做相同的事。这就是 `getopt` 第三个参数存在的原因：它是指定长标志的一个列表，其中的长标志是和第二个参数中指定的短标志相对应的。 ## `["help", "grammar="]` `--help` 打印用法概要 `--grammar ...` 使用给定的语法文件或 URL 这里有三点要注意： 1. 所有命令行中的长标志以两个短划线开始，但是在调用 `getopt` 时，你不用包含这两个短划线。它们是能够被理解的。 2. `--grammar` 标志的后面必须跟着另一个参数，就像 `-g` 标志一样。通过等于号标识出来：`"grammar="`。 3. 长标志列表比短标志列表更短一些，因为 `-d` 标志没有相应的长标志。这很好；只有 `-d` 才会打开调试。但是短标志和长标志的顺序必须是相同的，你应该先指定有长标志的短标志，然后才是剩下的短标志。 被搞昏没？让我们看一下真实的代码，看看它在上下文中是否起作用。 ## 例 10.23. 在 `kgp.py` 中处理命令行参数 ``` def main(argv): grammar = "kant.xml" try: opts, args = getopt.getopt(argv, "hg:d", ["help", "grammar="]) except getopt.GetoptError: usage() sys.exit(2) for opt, arg in opts: if opt in ("-h", "--help"): usage() sys.exit() elif opt == '-d': global _debug _debug = 1 elif opt in ("-g", "--grammar"): grammar = arg source = "".join(args) k = KantGenerator(grammar, source) print k.output() ``` | | | | --- | --- | | \[1\] | `grammar` 变量会跟踪你正在使用的语法文件。如果你没有在命令行指定它 (使用 `-g` 或者 `--grammar` 标志定义它)，在这里你将初始化它。 | | \[2\] | 你从 `getopt` 取回的 `opts` 变量是一个由元组 (`flag` 和 `argument`) 组成的列表。如果标志没有带任何参数，那么 `arg` 只是 `None`。这使得遍历标志更容易了。 | | \[3\] | `getopt` 验证命令行标志是否可接受，但是它不会在短标志和长标志之间做任何转换。如果你指定 `-h` 标志，`opt` 将会包含 `"-h"`；如果你指定 `--help` 标志，`opt` 将会包含`"--help"` 标志。所以你需要检查它们两个。 | | \[4\] | 别忘了，`-d` 标志没有相应的长标志，所以你只需要检查短形式。如果你找到了它，你就可以设置一个全局变量来指示后面要打印出调试信息。(我习惯在脚本的开发过程中使用它。什么，你以为所有这些程序都是一次成功的？) | | \[5\] | 如果你找到了一个语法文件，跟在 `-g` 或者 `--grammar` 标志后面，那你就要把跟在后面的参数 (`arg`) 保存到变量`grammar` 中，覆盖掉在 `main` 函数你初始化的默认值。 | | \[6\] | 就是这样。你已经遍历并处理了所有的命令行标志。这意味着所有剩下的东西都必须是命令行参数。它们由 `getopt` 函数的 `args` 变量返回。在这个例子中，你把它们当作了解析器源材料。如果没有指定命令行参数，`args` 将是一个空列表，而 `source` 将是空字符串。 |