您的位置:

命令行参数的获取和使用方式

命令行参数指的是在执行脚本程序时所附加的参数,Python提供了sys模块和argparse模块来处理命令行参数。本篇文章将介绍Python中命令行参数的获取和使用方式。

一、sys模块

sys模块是Python的内置模块之一,该模块提供了与Python解释器和它所处的环境有关的函数和变量,其中一个重要的变量是sys.argv。该变量是一个列表,包含了命令行参数以及脚本文件名称。

import sys

print("命令行参数列表:", sys.argv)
print("脚本文件名称:", sys.argv[0])
print("第一个命令行参数:", sys.argv[1])

上面的代码将会输出传入的命令行参数以及文件名,如果没有传入命令行参数,sys.argv数组将只包含脚本文件名。

二、argparse模块

argparse模块是Python自带的一个解析命令行参数的模块。通过使用argparse可以更好的处理命令行参数,包括设置参数名称、参数解释、参数类型、参数数量等。

在使用argparse模块之前,需要首先定义一个ArgumentParser对象,并可以设置一些参数,如下所示:

import argparse

parser = argparse.ArgumentParser(description='命令行参数示例')
parser.add_argument('-n', '--number', type=int, default=1, help='重复次数')
parser.add_argument('-v', '--verbose', action='store_true', help='输出详细信息')

args = parser.parse_args()

print(args.number)
print(args.verbose)

上面的代码定义了两个参数:number和verbose,其中number是一个整型参数(type=int),默认值为1(default=1),help用于指定该参数的解释。而verbose是bool类型参数,如果该参数被赋值,值为True(action='store_true'),表示需要输出详细信息。parse_args()方法用于解析命令行参数,将解析结果保存在args变量中。最后输出args的number和verbose属性的值。

三、主函数

在编写Python脚本程序时,为了能够更好的组织代码,通常会将一些程序逻辑封装到一个main函数中。利用命令行参数调用这个函数可以处理更多的情况。下面是一个简单的示例:

import argparse

def main(number, verbose):
    for i in range(number):
        if verbose:
            print("第%s次打印Hello world" % (i+1))
        else:
            print("Hello world")

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='命令行参数示例')
    parser.add_argument('-n', '--number', type=int, default=1, help='重复次数')
    parser.add_argument('-v', '--verbose', action='store_true', help='输出详细信息')
    args = parser.parse_args()

    main(args.number, args.verbose)

上面的代码定义了一个main函数,其中输出重读次数与是否输出详细信息由命令行参数控制。在main函数中使用for循环输出“Hello world”字符串。如果verbose参数为True,则在输出Hello world字符串之前先输出第几次输出。

在代码的末尾,判断脚本作为程序运行时(而不是作为导入模块运行时)才运行main函数,这是一个约定成俗的方式。

四、总结

Python提供了sys模块和argparse模块来处理命令行参数。sys.argv变量可以获取命令行参数,但对参数解析相对比较简单且不够灵活。argparse模块能够更好的解析命令行参数,并允许指定参数名称、参数解释、参数类型、参数数量等,不过需要编写一些额外的代码对命令行参数进行解析。主函数中使用命令行参数可以方便地将一些程序逻辑封装起来。