10.6.?處理命令行參數 · Dive Into Python

# 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` 將是空字符串。 |