欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

sys.argv和getopt.getopt()的用法

程序员文章站 2023-11-03 22:57:28
1.sys.argv Python中sys.argv是命令行参数从程序外部传值的的一种途径,它是一个列表,列表元素是我们想传进去的的新参数,所以可以用索引sys.argv[]来获得想要的值。因为一个写好的程序一般封装好了,直接在编辑软件里运行就行了,但是程序里面的所有参数我们必须在程序里写好。但是当 ......

Python中sys.argv是命令行参数从程序外部传值的的一种途径,它是一个列表,列表元素是我们想传进去的的新参数,所以可以用索引sys.argv[]来获得想要的值。因为一个写好的程序一般封装好了,直接在编辑软件里运行就行了,但是程序里面的所有参数我们必须在程序里写好。但是当我们想从程序外部向程序传递我们想要用的参数时,在不改动原来程序的基础上,我们可应通过命令行参数,用dos界面运行程序,然后赋参,即向程序输入新的参数,使程序运行。这里可以用到sys.argv,看个例子;

该程序名字为hello.py

a=sys.argv
print(a)
print(type(a))

因为是程序外部传参,所以用dos界面运行文件。按win+R,输入cmd,打开dos界面,首先进入自己程序所在的文件夹,我的放在

sys.argv和getopt.getopt()的用法

然后,进入文件输入:Python hello.py Hello,按回车。注意,以空格键来分隔输入值

sys.argv和getopt.getopt()的用法

可以看见运行结果,['hello.py', 'Hello']就是sys.argv的值,类型是一个list,分析一下值的组成,sys.argv[0]表示程序文件名,这是个默认值,sys.argv[1]就是我们从外部输入的命令行参数。需要从外部输入更多参数时,输入值之间用空格分隔,如下:

sys.argv和getopt.getopt()的用法

2.

Python中getopt.getopt()这个函数是为了从外部输入不同的命令行选项时,对应执行不同的功能。目前有短选项和长选项两种格式。短选项格式为"-"加上单个字母选项;长选项为"--"加上一个单词,同样也是程序外部传参。

语法:getopt.getopt(sys.argv,短选项,长选项)

返回值:函数返回两个列表:opts和args。opts为分析出的格式信息。args为不属于格式信息的剩余的命令行参数。opts是一个两元组的列表。每个元素为:(选项串,附加参数)。如果没有附加参数则为空串''。

下面摘抄自其他博客:

在dos界面中书输入的选项的写法要求
  对于短格式,"-"号后面要紧跟一个选项字母。如果还有此选项的附加参数,可以用空格分开,也可以不分开。长度任意,可以用引号。如以下是正确的:
-o
-oa
-obbbb
-o bbbb
-o "a b"
  对于长格式,"--"号后面要跟一个单词。如果还有些选项的附加参数,后面要紧跟"=",再加上参数。"="号前后不能有空格。如以下是正确的:
--help=file1
  而这些是不正确的:
-- help=file1
--help =file1
--help = file1
--help= file1

如何用getopt进行分析
  使用getopt模块分析命令行参数大体上分为三个步骤:

1.导入getopt, sys模块
2.分析命令行参数
3.处理结果

  第一步很简单,只需要:
import getopt, sys

  第二步处理方法如下(以Python手册上的例子为例):
try:
    opts, args = getopt.getopt(sys.argv[1:], "ho:", ["help", "output="])#长短选项的功能相同,可以随意选择使用
except getopt.GetoptError:
    # print help information and exit:

1. 处理所使用的函数叫getopt(),因为是直接使用import导入的getopt模块,所以要加上限定getopt才可以。
2. 使用sys.argv[1:]过滤掉第一个参数(它是执行脚本的名字,不应算作参数的一部分)。
3. 在函数里,使用短格式分析串"ho:"。当一个选项只是表示开关状态时,即后面不带附加参数时,在分析串中写入选项字符。当选项后面是带一个附加参数时,在分析串中写入选项字符同时后面加一个":"号。所以"ho:"就表示"h"是一个开关选项;"o:"则表示后面应该带一个参数。

函数中的'ho:'表示,在dos界面输入短格式选项‘-h’,并且有附加参数,短选项的附加参数写法如上要求

4. 在函数里,使用长格式,用一个列表包含几个长选项:["help", "output="]。长格式串也可以有开关状态,即后面不跟"="号。如果跟一个等号则表示后面还应有一个参数。这个长格式表示"help"是一个开关选项;"output="则表示后面应该带一个参数。

函数中的["help", "output="],表示在dos界面输入长格式串--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']

  第三步主要是对分析出的参数进行判断是否存在,然后再进一步处理。主要的处理模式为:
for o, a in opts:
    if o in ("-h", "--help"):
        usage()
        sys.exit()
    if o in ("-o", "--output"):
        output = a

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

 例子:文件名为sys_test2.py

 1 import getopt
 2 import sys
 3 
 4 opts,args = getopt.getopt(sys.argv[1:],'-h-f:-v',['help','filename=','version'])
 5 print(opts)
 6 for opt_name,opt_value in opts:
 7     if opt_name in ('-h','--help'):
 8         print("[*] Help info")
 9         sys.exit()
10     if opt_name in ('-v','--version'):
11         print("[*] Version is 0.01 ")
12         sys.exit()
13     if opt_name in ('-f','--filename'):#当外部输入'-f1'或者'--flilename=1'时,输出为:[('--filename', '3')] \n [*] Filename is  3
14         fileName = opt_value
15         print("[*] Filename is ",fileName)
16         # do something
17         sys.exit()

 结果

sys.argv和getopt.getopt()的用法

尤其要讲的是函数返回值

sys.argv和getopt.getopt()的用法

程序中opts,args = getopt.getopt(sys.argv[1:],'-h-f:-v',['help','filename=','version'])
输入的短选项-h本身就是不附带参数的,长选项--filename可以附加参数,上例中附加值为3,可见这个返回值opts=[(('-h,''),('--filename','3'))]
其实这个函数就是为了根据相应的索引传值,比如上面--filename对应传的只就是3.