Python 中命令行选项的 C 风格解析器

pythonserver side programmingprogramming更新于 2025/8/20 19:24:17

Python 的 sys 模块通过 sys.argv 提供对任何命令行参数的访问。sys.argv 是命令行参数列表,sys.argv[0] 是程序,即。脚本名称。

将以下代码保存为 args.py

import sys
print ('argument list', sys.argv)

从命令行执行上述脚本,如下所示:

C:\python37>python args.py 11 22
argument list ['args.py', '11', '22']

getopt 模块具有解析 sys.argv 中的命令行参数的函数。它支持与 Unix getopt() 函数相同的约定(包括 ‘-‘ 和 ‘--‘ 形式参数的特殊含义)。

API 旨在让 C getopt() 函数的用户熟悉。

getopt(args, shortopts, longopts=[])

解析命令行选项和参数列表。args 是参数列表,不包括 sys.argv[0],它是正在运行的程序的前导引用。通常,这表示 sys.argv[1:]。此函数的参数如下 −

shortopts: 是脚本将识别的选项字母字符串。需要参数的选项后面跟着冒号(':';即与 Unix getopt() 使用的格式相同)。

Longopts: 如果指定,则必须是包含应支持的长选项名称的字符串列表。选项名称中不应包含前导 '--' 字符。需要参数的长选项后面应该跟一个等号('=')。

返回值由两个元素组成:第一个是(选项,值)对的列表;第二个是选项列表被剥离后剩下的程序参数列表(这是参数的尾随片段)。返回的每个选项和值对都以选项作为其第一个元素,以连字符作为短选项的前缀(例如,'-x')或以两个连字符作为长选项的前缀(例如,'--long-option'),以选项参数作为其第二个元素,如果选项没有参数,则为空字符串。选项在列表中出现的顺序与找到它们的顺序相同,因此允许多次出现。长选项和短选项可以混合使用。

当在参数列表中发现无法识别的选项或需要参数的选项没有给出参数时,会引发 GetoptError。

示例

import sys, getopt

args=sys.argv[1:]
inputfile = ''
outputfile = ''
try:
   opts, args = getopt.getopt(args,"hi:o:",["ifile=","ofile="])
except getopt.GetoptError:
   print ('test.py -i <inputfile> -o <outputfile>')
   sys.exit(2)
for opt, arg in opts:
   if opt == '-h':
      print ('args.py -i <inputfile> -o <outputfile>')
      sys.exit()
   elif opt in ("-i", "--ifile"):
      inputfile = arg
   elif opt in ("-o", "--ofile"):
      outputfile = arg
print ('Input file is "', inputfile)
print ('Output file is "', outputfile)

输出

C:\python37>python args.py -h
args.py -i <inputfile> -o <outputfile>
C:\python37>python args.py -i abc.txt -o xyz.txt
Input file is " abc.txt
Output file is " xyz.txt
C:\python37>python args.py --ifile=abc.txt --ofile=xyz.txt
Input file is " abc.txt
Output file is " xyz.txt

相关文章


有用资源