python 之分割参数getopt

港控/mmm° 2023-01-04 14:31 200阅读 0赞

在python中有一个库叫做getopt，专门用来处理命令行选项。首先假设一个命令为

./justForSample -c -b 5 --mm --lala /home  
      在上面的命令中sys.argv中存的分别是['./justForSample','-c','-b','5','--mm','--lala','/home'],其中把‘-c'代表不需要附加参数的短选项；'-b'代表需要附加参数的短选项，同时5就是其附加参数；'--mm'代表不需要附加参数的长选项；’--lala'代表需要附加参数的长选项，同时/home就是其附加参数。     getopt函数的格式是getopt.getopt(命令行参数，"短选项",[长选项]） 其中如果短选项需要附加参数则在短选项后面加：，如果长选项需要添加参数则在长选项后添加=。返回值有两个，一个是对应的参数选项和value元组，另一个是除去有用参数外的其他命令行输出。 上面例子对应的格式为   
       
        getopt.getopt(sys.argv[1:],'cb:',['mm','lala='])  
       第一个返回值为[('-c', ''), ('-b', '5'), ('--mm', ''), ('--lala', '/home')] ，第二个返回值为空。

1. 导入getopt, sys 模块  
2. 分析命令行参数  
3. 处理结果  
  
第一步很简单，只需要：  
import getopt, sys  
  
第二步处理方法如下（以Python 手册上的例子为例）：

Python代码 ![收藏代码][icon_star.png]

1.  **try**: 
2.   opts, args = getopt.getopt(sys.argv\[1:\], "ho:", \["help", "output="\]) 
3.  **except** getopt.GetoptError: 
4.  \# print help information and exit:

1. 处理所使用的函数叫getopt() ，因为是直接使用import 导入的getopt 模块，所以要加上限定getopt 才可以。  
2. 使用sys.argv\[1:\] 过滤掉第一个参数（它是执行脚本的名字，不应算作参数的一部分）。  
3. 使用短格式分析串"ho:" 。当一个选项只是表示开关状态时，即后面不带附加参数时，在分析串中写入选项字符。当选项后面是带一个附加参数时，在分析串中写入选项字符同时后面加一个":" 号 。所以"ho:" 就表示"h" 是一个开关选项；"o:" 则表示后面应该带一个参数。  
4. 使用长格式分析串列表：\["help", "output="\] 。长格式串也可以有开关状态，即后面不跟"=" 号。如果跟一个等号则表示后面还应有一个参数 。这个长格式表示"help" 是一个开关选项；"output=" 则表示后面应该带一个参数。  
5. 调用getopt 函数。函数返回两个列表：opts 和args 。opts 为分析出的格式信息。args 为不属于格式信息的剩余的命令行参数。opts 是一个两元组的列表。每个元素为：( 选项串, 附加参数) 。如果没有附加参数则为空串'' 。  
6. 整个过程使用异常来包含，这样当分析出错时，就可以打印出使用信息来通知用户如何使用这个程序。  
  
如上面解释的一个命令行例子为：  
'-h -o file --help --output=out file1 file2'  
  
在分析完成后，opts 应该是：  
\[('-h', ''), ('-o', 'file'), ('--help', ''), ('--output', 'out')\]  
  
而args 则为：  
\['file1', 'file2'\]  
第三步主要是对分析出的参数进行判断是否存在，然后再进一步处理。主要的处理模式为：

Python代码 ![收藏代码][icon_star.png]

1.  **for** o, a **in** opts: 
2.  **if** o **in** ("-h", "--help"): 
3.   usage() 
4.   sys.exit() 
5.  **if** o **in** ("-o", "--output"): 
6.   output = a

使用一个循环，每次从opts 中取出一个两元组，赋给两个变量。o 保存选项参数，a 为附加参数。接着对取出的选项参数进行处理。（例子也采用手册的例子）

实践篇：

Python代码 ![收藏代码][icon_star.png]

1.  \#!/usr/bin/env python
2.  
3.  **import** sys; 
4.  **import** getopt; 
5.  
6.  **def** usage(): 
7.  **print**("Usage:%s \[-a|-o|-c\] \[--help|--output\] args...." %Dsys.argv\[0\]); 
8.  
9.  
10. **if** "\_\_main\_\_" == \_\_name\_\_: 
11. \#lsArgs = \[""\];
12. 
13. **try**: 
14.  opts,args = getopt.getopt(sys.argv\[1:\], "ao:c", \["help", "output="\]); 
15. 
16. **print**("============ opts =================="); 
17. **print**(opts); 
18. 
19. **print**("============ args =================="); 
20. **print**(args); 
21. 
22. \#check all param
23. **for** opt,arg **in** opts: 
24. **if** opt **in** ("-h", "--help"): 
25.  usage(); 
26.  sys.exit(1); 
27. **elif** opt **in** ("-t", "--test"): 
28. **print**("for test option"); 
29. **else**: 
30. **print**("%s ==> %s" %(opt, arg)); 
31. 
32. **except** getopt.GetoptError: 
33. **print**("getopt error!"); 
34.  usage(); 
35.  sys.exit(1);

运行结果：

$ ./test\_getopt.py -a -oaaa -caa --output=out file1 t file2 -d  
============ opts ==================  
\[('-a', ''), ('-o', 'aaa'), ('-c', ''), ('-a', ''), ('-a', ''), ('--output', 'out')\]  
============ args ==================  
\['file1', 't', 'file2', '-d'\]  
\-a ==>  
\-o ==> aaa  
\-c ==>  
\-a ==>  
\-a ==>  
\--output ==> out

[icon_star.png]: /images/20221119/4b7f9842b881417d8a30e5a9d179cc0c.png