编写完美的python命令行程序，怎地不令人向往？

忘是亡心i 2022-03-22 15:14 140阅读 0赞

## 前言 ##

我们作为一个python爱好者，我们常常要编写命令行程序，因此，更容易使用的脚本可以提高生产力，特别是当多个开发人员在同一个项目上工作时。

**因此，我建议你遵循以下四条规则：**

尽可能提供默认参数值  
所有错误情况必须处理（例如，参数缺失，类型错误，找不到文件）  
所有参数和选项必须有文档  
不是立即完成的任务应当显示进度条  
举个简单的例子  
我们把这些规则应用到一个具体的例子上。这个脚本可以使用凯撒加密法加密和解密消息。

假设已经有个写好的 encrypt 函数（实现如下），我们需要创建一个简单的脚本，用来加密和解密消息。我们希望让用户通过命令行参数选择加密模式（默认）和解密模式，并选择一个秘钥（默认为 1）。  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70][]  
我们的脚本需要做的第一件事就是获取命令行参数的值。当我搜索“python command line arguments”时，出现的第一个结果是关于sys.argv的，所以我们来试试这个方法……

python caesar_script.py --key 23 --decrypt my secret message
    
    pb vhfuhw phvvdjh

['caesar_script.py', '--key', '23', '--decrypt', 'my', 'secret', 'message']

因此只需遍历该参数列表，找到’–key’（或’-k’）以得到秘钥值，找到’–decrypt’以设置解密模式（实际上只需要使用秘钥的反转作为秘钥即可）。

最后我们的脚本大致如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70 1]

## 学习从不是一个人的事，大家互相监督 ， 共同交流，需要资料的可以私信加我 ##

**这个脚本遵循了一些我们前面推荐的规则：**  
支持默认秘钥和默认模式  
基本的错误处理（没有提供输入文本的情况，以及提供了无法识别的参数的情况）  
出错时或者不带任何参数调用脚本时会显示文档：

python caesar_script_using_sys_argv.py
    
    Usage: python caesar.py [ --key <key> ] [ --encrypt|decrypt ] <text>

但是，这个凯撒加密法脚本太长了（39 行，其中甚至还没包括加密代码本身），而且很难读懂。

解析命令行参数应该还有更好的办法……

试试 argparse？

argparse 是 Python 用来解析命令行参数的标准库。

我们来看看用 argparse 怎样编写凯撒加密的脚本：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70 2][]  
这段代码也遵循了上述规则，而且与前面的手工编写的脚本相比，可以提供更准确的文档，以及更具有交互性的错误处理：

python caesar_script_using_argparse.py --encode My message
    
    usage: caesar_script_using_argparse.py [-h] [-e | -d] [-k KEY] [text [text ...]]
    
    caesar_script_using_argparse.py: error: unrecognized arguments: --encode
    
    python caesar_script_using_argparse.py --help
    
    usage: caesar_script_using_argparse.py [-h] [-e | -d] [-k KEY] [text [text ...]]

positional arguments:
    
    text
    
    optional arguments:
    
    -h, --help show this help message and exit
    
    -e, --encrypt
    
    -d, --decrypt
    
    -k KEY, --key KEY

但是，仔细看了这段代码后，我发现（虽然有点主观）函数开头的几行（从7行到13行）定义了参数，但定义方式并不太优雅：它太臃肿了，而且完全是程式化的。应该有更描述性、更简洁的方法。

click 能做得更好！  
幸运的是，有个 Python 库能提供与 argparse 同样的功能（甚至还能提供更多），它的代码风格更优雅。这个库的名字叫 click。

这里是凯撒加密脚本的第三版，使用了 click：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70 3]  
注意现在参数和选项都在修饰器里定义，定义好的参数直接作为函数参数提供。

**我来解释一下上面代码中的一些地方：**

脚本参数定义中的nargs参数指定了该参数期待的单词的数目（一个用引号括起来的字符串算一个单词）。默认值是1。这里nargs=-1允许接收任意数目的单词。  
encrypt/–decrypt这种写法可以定义完全互斥的选项（类似于argparse中的add\_mutually\_exclusive\_group函数），它将产生一个布尔型参数。  
click.echo是该库提供的一个工具函数，它的功能与print相同，但兼容-  
Python 2和Python 3，还有一些其他功能（如处理颜色等）

**加一些隐秘性**

这个脚本的参数（被加密的消息）应当是最高机密。而我们却要求用户直接在终端里输入文本，使得这些文本被记录在命令历史中，这不是很讽刺吗？

解决方法之一就是使用隐藏的提示。或者可以从输入文件中读取文本，对于较长的文本来说更实际一些。或者可以干脆让用户选择。

输出也一样：用户可以保存到文件中，也可以输出到终端。这样就得到了凯撒脚本的最后一个版本：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70 4][]  
这个版本有什么新东西吗？

首先，注意到我给每个参数选项都加了个help参数。由于脚本变得复杂了，help参数可以给脚本的行为添加一些文档。运行结果如下：  
![20190128225238987.png][]  
两个新的参数：input\_file 和 output\_file，类型均为 click.File。该库能够用正确的模式打开文件，处理可能的错误，再执行函数。例如：

python caesar_script_v2.py --decrypt --input_file wrong_file.txt
    
    Usage: caesar_script_v2.py [OPTIONS]
    
    Error: Invalid value for "--input_file": Could not open file: wrong_file.txt: No such file or directory

正像help文本中解释的那样，如果没有提供input\_file，就使用click.promp让用户直接在提示符下输入文本，在加密模式下这些文本是隐藏的。如下所示：

python caesar_script_v2.py --encrypt --key 2
    
    Enter a text: **************
    
    yyy.ukectc.eqo

## 破解密文！ ##

现在设想你是个黑客：你要解密一个用凯撒加密过的密文，但你不知道秘钥是什么。

最简单的策略就是用所有可能的秘钥调用解密函数 25 次，阅读解密结果，看看哪个是合理的。

但你很聪明，而且也很懒，所以你想让整个过程自动化。确定解密后的 25 个文本哪个最可能是原始文本的方法之一，就是统计所有这些文本中的英文单词的个数。这可以使用 PyEnchant 模块实现：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70 5][]、![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70 6][]  
貌似运行得很不错，但别忘了，好的命令行程序还有个规则需要遵守：

**4.A 不是立即完成的任务应当显示进度条。**  
示例中的文本包含104个单词，因此该脚本需要大约5秒才能解密。这很正常，因为它需要检查所有25个秘钥，每个秘钥都要检查104个单词是否出现在英文字典中。

假设你要解密的文本包括10^5个但IC，那么就要花费50秒才能输出结果，用户可能会非常着急。

因此我建议这种任务一定要显示进度条。特别是，显示进度条还非常容易实现。

下面是个显示进度条的例子：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70 7][]  
你发现区别了吗？可能不太好找，因为区别真的很小，只有四个字母：tqdm。  
tqdm 是 Python 库的名字，也是它包含的类的名字。只需用它包裹一个可迭代的东西，就能显示出进度条：

for key in tqdm(range(26)):

这样就能显示出非常漂亮的进度条。我都不敢相信这是真的。  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70 8][]  
另外，click也提供类似的显示进度条的工具（click.progress\_bar），但我觉得它的外观不太容易懂，而且要写的代码也多一些。

## 学习从来不是一个人的事，大家加互相监督，共同学习，需要资料的可以私信加我 ##

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70]: /images/20220322/4f42c6f475ac4126a3f63c9c859beb5a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70 1]: /images/20220322/80cdf671607948ca81cfb5982d2edf55.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70 2]: /images/20220322/8d1d7aadcdef44c1aca10fa9cce52ce8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70 3]: /images/20220322/a2dc54e3d06a42578384b348dcc501b4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70 4]: /images/20220322/4cf32498532e4134be25305cc1eacfba.png
[20190128225238987.png]: /images/20220322/a3383c56180045059537a3bc7bca81d0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20190128232933245.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70 6]: /images/20220322/7609071103934117b36da12d1b4b0557.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70 7]: /images/20220322/421c067e90784cdab59641ba34dbfa24.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5MzYzMDIy_size_16_color_FFFFFF_t_70 8]: /images/20220322/761d23a4ea474652b8208c503e670ad5.png