Python解析命令行参数的三种方法详解

叶初
叶初
发布时间:2026-10-13 | 3人浏览过
原创

本文详细解析Python中处理命令行参数的三种主流方式:sys.argv、argparse模块及getopt模块。通过具体代码示例,演示了如何从简单的位置参数传递到复杂的短长选项混合使用,帮助开发者根据实际需求选择最合适的参数解析方案,提升脚本的灵活性与可维护性。

Python命令行参数解析概述

本文深入探讨Python中解析命令行参数的三种常用方法,并通过详细的示例代码展示其具体应用。这些内容对于希望优化脚本交互性或进行自动化部署的开发者具有重要的参考价值,建议结合实际场景仔细阅读。

在Python开发中,处理命令行输入主要依赖三种机制:直接使用sys.argv列表、使用功能更强大的argparse模块,以及使用历史悠久的getopt模块。

方法一:sys.argv基础用法

方法一:利用sys.argv获取参数。例如,执行命令 python test_命令行传参.py 1,2,3 1000 时,脚本将直接接收这些位置参数。


# test_命令行传参.py
import sys 
def para_input():  
  print(len(sys.argv))   # 参数序列的长度,此时所有参数存放在一个list之中
  if len(sys.argv) < 2:    
    sys.exit("python error")  
  script_name = sys.argv[0] #第一个参数指的是脚本名称
  param_first = sys.argv[1] #第二个参数,此时也是一个str列表
  param_second = sys.argv[2] #第三个参数 
   
  print(script_name)
  print(type(script_name))
  print(param_first)
  print(type(param_first))
  
  sss = param_first.split(',')
  print(type(sss))
  print(sss[0])  #传进来的都是默认str
  print(sss[1])
  print(sss[2])
  
  print(param_second)
  print(type(param_second))
  print(script_name, param_first, param_second) 
if __name__ == "__main__":
  para_input()

方法二:argparse模块解析

方法二:使用argparse模块进行解析。执行命令 python test_命令行传参.py -n Peter 或 python test_命令行传参.py -n Peter -d 20191120 时,可通过预定义的参数名获取对应值。


# test_命令行传参.py
import argparse

parser = argparse.ArgumentParser('传入参数:***.py')
parser.add_argument('-n','--name', default='Jack')
parser.add_argument('-d','--date', default='20191128')
args = parser.parse_args()
print(args)
print(type(args))
name_ = args.name
date_ = args.date

print(type(name_))
print(type(date_))
print('the people %s said that the date is %s'%(name_, date_))

方法三:getopt模块详解

方法三:使用getopt模块进行解析。执行命令 python test_命令行传参.py -f 游泳 -p 20191130,或 python test_命令行传参.py --functionname=游泳 -p 20191130,亦或 python test_命令行传参.py --functionname=游泳 --partdate=20191130 时,均可通过该模块解析短选项与长选项。

getopt函数格式与传参形式

getopt函数的基本格式为:getopt.getopt(argv, options[, long_options]),其中argv通常来自sys.argv[1:]。

该方法支持两种传参形式:短选项以单横杠('-')开头,长选项以双横杠('--')开头。

options参数指定短选项字符串。若选项字符后紧跟冒号(:),表示该选项必须携带值,例如 -f value;若无冒号,则为布尔型标志,无需传值。

long_options参数指定长选项列表。若选项字符串后包含等号(=),表示该选项必须携带值,例如 --f=value;若无等号,则为布尔型标志。

混合使用与默认值处理

在实际使用中,可以混合使用短选项和长选项。此外,若在代码中设置了默认值,用户无需传递所有参数,未提供的参数将自动使用默认值。


import getopt
import sys

def get_args_func(argv):
  functionname = '拍照' #默认值
  partdate = '20191128'
  
  try:
    opts, args = getopt.getopt(argv, "hf:p:", ["help", "functionname=", "partdate="]) 
     #表示参数选项有:-h, -f, -p, --help, --functionname, --partdate,它们相互对应;该方法的返回值有两个元素: 第一个是(opt, value)元组的列表,第二个是一般参数列表,包含那些没有 '-' 或 '--' 的参数
  except getopt.GetoptError:
    print('Error: ***.py -f <functionname> -p <partdate>')
    print('  or: ***.py --functionname=<functionname> --partdate=<partdate>')
    sys.exit(2)
  
  for opt, arg in opts:  #依次获取列表中的元组项
    if opt in ("-h", "--help"):
      print('***.py -f <functionname> -p <partdate>')
      print('or: ***.py --functionname=<functionname> --partdate=<partdate>')
      sys.exit()
    elif opt in ("-f", "--functionname"):
      functionname = arg
    elif opt in ("-p", "--partdate"):
      partdate = arg
  print('-----------------------------------------------------------------------')
  print(opts) #元组构成的列表
  print(args) #args指的是不用 '-'或 '--'传递的参数,这里没有传递,所以为空
  print('functionname为:', functionname)
  print('partdate为:', partdate)

if __name__ == '__main__':
  get_args_func(sys.argv[1:]) #因为sys.argv[0]是脚本名称

综上所述,sys.argv、argparse和getopt各有适用场景。sys.argv适合简单脚本,argparse适合复杂应用,getopt则提供了底层的灵活性。希望本文能帮助读者更好地掌握Python命令行参数处理技巧。

本站声明

本文内容仅供参考,不代表本站观点。转载或引用请注明出处。如发现内容问题,请通过联系我们页面反馈。

Python 相关产品和应用

全部下载

专题列表