使用click創(chuàng)建完美的Python命令行程序

　　Python程序員的主要工作是寫命令行程序，即直接在終端運行的腳本。隨著項目規(guī)模增長，我們希望創(chuàng)建有效的命令行接口，通過提供不同的參數(shù)，解決不同的問題，而不是每次都修改源代碼。Click庫是一個非常高效的命令行工具，能夠幫助我們快速創(chuàng)建完美的命令行接口，小編認為這是每個Python程序員都應該掌握的工具。

　　為了實現(xiàn)這一目標，我總結了四條原則，希望對大家有所幫助：

　　命令行參數(shù)應提供默認值

　　處理所有可能的參數(shù)錯誤，包括缺少參數(shù)，- 數(shù)據(jù)類型錯誤，無法找到文件等

　　撰寫完善的文檔，解釋參數(shù)的含義以及如何設置

　　使用進度條顯示長時間運行的任務

　　一個簡單的例子

　　讓我們將這些規(guī)則應用于一個具體的案例：一個使用Caesar cipher加密和解密消息的腳本。

　　假設我們編寫了一個encrypt函數(shù)，如下所示?，F(xiàn)在要創(chuàng)建一個的腳本來加密和解密消息。

　　腳本允許用戶選擇：模式(加密或解密)，密鑰。前者的默認值是加密，后者的默認值是1。這一切都通過命令行參數(shù)實現(xiàn)。

　　初學者方法：sys.argv

　　腳本需要先獲取命令行參數(shù)的值，讓我們先用最簡單的sys.argv實現(xiàn)。

　　sys.argv是一個列表，包含了用戶在運行腳本時輸入的所有參數(shù)(包括腳本名字本身)。

　　在終端輸入以下指令：

　　sys.argv列表包括：

　　為了獲得參數(shù)值，需要遍歷參數(shù)列表，尋找一個 '--key' (或 '-k' )來獲取密鑰值，并尋找一個 '--decrypt' 獲取模式。

　　代碼遵循我們一開始提出的原則：

　　有一個默認鍵值和一個默認模式

　　處理基本錯誤(不提供輸入文本或未知參數(shù))

　　在參數(shù)錯誤或在不帶參數(shù)的情況下調(diào)用腳本時，打印簡潔的提示信息

　　但是這個版本的腳本相當長(39行，不包括加密函數(shù))，而且代碼非常丑陋。

　　是否有更好的方法來解析命令行參數(shù)?

　　進入argparse

　　argparse是用于解析命令行參數(shù)的Python標準庫模塊。

　　修改腳本，使用argparse解析命令行參數(shù)：

　　代碼仍然遵守我們提出的原則，并且比手動解析命令行參數(shù)提供更精確的文檔和更具交互性的錯誤處理。

　　腳本的第7行到第13行代碼定義了命令行參數(shù)，但它們不是很優(yōu)雅：太冗長且程序化，我們可以用更緊湊和聲明性的方式完成。

　　使用click創(chuàng)建更好的命令行接口

　　幸運的是有一個三方庫click用于創(chuàng)建命令行接口，它不僅提供比argparse更多的功能， 而且代碼風格更漂亮。用click替換argparse，繼續(xù)優(yōu)化腳本。

　　注意，命令行參數(shù)和選項都在裝飾器中聲明， 這使得它們可以作為函數(shù)的參數(shù)直接訪問。

　　讓我們仔細分析上面的代碼：

　　nargs定義了命令行參數(shù)接收的值的數(shù)量，默認值為1，nargs=-1允許提供任意數(shù)量的單詞。

　　--encrypt/--decrypt定義互斥的選項 ，最終以布爾值傳遞給程序。

　　click.echo是click庫提供的基礎函數(shù)，功能類似于print，但提供更強大的功能，例如調(diào)整打印到控制臺的文本的顏色。

　　從本地文件讀取輸入

　　命令行參數(shù)接收的值是將被加密的最高機密消息，所以如果要求用戶直接在終端中輸入純文本，可能會引發(fā)安全顧慮。

　　一種更安全的方法是使用隱藏提示，或者從本地文件讀取文本 ，這對于長文本來說更加實用。

　　這個想法同樣適用于輸出：用戶可以將其保存到文件中，或者在終端中打印出來。讓我們繼續(xù)優(yōu)化腳本。

　　由于腳本變得更復雜，我們創(chuàng)建了參數(shù)文檔(通過定義click.option裝飾器的help參數(shù)實現(xiàn))，詳細解釋參數(shù)的功能，效果如下。微信搜索公眾號：Linux技術迷，回復：linux 領取資料 。

　　我們有兩個新的參數(shù)input_file和output_file，類型是click.File，click會用正確的模式打開文件并處理可能發(fā)生的錯誤。例如找不到文件：

　　如果未提供input_file，則我們用click.prompt，在命令行創(chuàng)建提示窗口，讓用戶直接輸入文本，該提示對于加密模式將是隱藏的。效果如下：

　　假設你是一名黑客：想要解密一個用凱撒加密過的密文，但你不知道秘鑰是什么。最簡單的策略就是用所有可能的秘鑰調(diào)用解密函數(shù) 25 次，閱讀解密結果，看看哪個是合理的。但你很聰明，而且也很懶，所以你想讓整個過程自動化。確定解密后的 25 個文本哪個最可能是原始文本的方法之一，就是統(tǒng)計所有這些文本中的英文單詞的個數(shù)。這可以使用 PyEnchant 模塊實現(xiàn)：

　　使用進度條

　　示例中的文本包含10^4個單詞，因此該腳本需要大約5秒才能解密。這很正常，因為它需要檢查所有25個秘鑰，每個秘鑰都要檢查10^4個單詞是否出現(xiàn)在英文字典中。

　　假設你要解密的文本包括10^5個單詞，那么就要花費50秒才能輸出結果，用戶可能會非常著急。因此我建議這種任務一定要顯示進度條。特別是，顯示進度條還非常容易實現(xiàn)。下面是個顯示進度條的例子：

　　這里使用了tqdm庫，tqdm.tqdm類可以將任何可迭代對象轉(zhuǎn)化為一個進度條。click也提供了類似的接口來創(chuàng)建進度條(click.progress_bar)，但我覺得它不如tqdm好用。