Python - 命令行参数

---

要运行Python程序，我们在操作系统的命令提示符终端中执行以下命令。例如，在Windows中，在Windows命令提示符终端中输入以下命令。

命令提示符 C:\> 前面的行（或 Linux 操作系统中的 $）称为命令行。

如果程序需要接受用户的输入，则使用Python的input()函数。当从命令行执行程序时，从命令终端接受用户输入。

例子

name = input("Enter your name: ")
print ("Hello {}. How are you?".format(name))

该程序从命令提示符终端运行，如下所示 -

很多时候，您可能需要将程序要使用的数据放在命令行本身中并在程序内部使用它。在命令行中提供数据的示例可以是 Windows 或 Linux 中的任何 DOS 命令。

在 Windows 中，您可以使用以下 DOS 命令将文件 hello.py 重命名为 hi.py。

C:\Python311>ren hello.py hi.py

在 Linux 中，您可以使用 mv 命令 -

$ mv hello.py hi.py

这里 ren 或 mv 是需要旧文件名和新文件名的命令。由于它们与命令一致，因此称为命令行参数。

您可以从命令行将值传递给 Python 程序。Python 将参数收集在列表对象中。Python 的 sys 模块通过 sys.argv 变量提供对任何命令行参数的访问。sys.argv 是命令行参数列表，sys.argv[0] 是程序，即脚本名称。

hello.py 脚本在脚本运行后使用 input() 函数接受用户输入。让我们将其更改为接受来自命令行的输入。

import sys
print ('argument list', sys.argv)
name = sys.argv[1]
print ("Hello {}. How are you?".format(name))

从命令行运行程序，如下图所示 -

输出如下所示-

C:\Python311>python hello.py Rajan
argument list ['hello.py', 'Rajan']
Hello Rajan. How are you?

命令行参数始终存储在字符串变量中。要将它们用作数字，您可以适当地使用类型转换函数。

在以下示例中，输入两个数字作为命令行参数。在程序内部，我们使用 int() 函数将它们解析为整型变量。

import sys
print ('argument list', sys.argv)
first = int(sys.argv[1])
second = int(sys.argv[2])
print ("sum = {}".format(first+second))

它将产生以下输出-

C:\Python311>python hello.py 10 20
argument list ['hello.py', '10', '20']
sum = 30

Python 的标准库包含一些有用的模块来解析命令行参数和选项 -

• getopt - 用于命令行选项的 C 风格解析器。

• argparse - 命令行选项、参数和子命令的解析器。

getopt 模块

Python 提供了一个getopt模块来帮助您解析命令行选项和参数。该模块提供了两个函数和一个异常来启用命令行参数解析。

getopt.getopt 方法

该方法解析命令行选项和参数列表。以下是此方法的简单语法 -

getopt.getopt(args, options, [long_options])

这是参数的详细信息 -

• args - 这是要解析的参数列表。

• options - 这是脚本想要识别的选项字母字符串，需要参数的选项后面应该跟一个冒号（:）。

• long_options - 这是一个可选参数，如果指定，则必须是包含应该支持的长选项名称的字符串列表。需要参数的长选项后面应该跟一个等号（'='）。要仅接受长选项，选项应该是空字符串。

此方法返回一个由两个元素组成的值 - 第一个是（选项，值）对的列表，第二个是删除选项列表后留下的程序参数列表。

返回的每个选项和值对都将选项作为其第一个元素，前缀为短选项的连字符（例如“-x”）或长选项的两个连字符（例如“--long-option”）。

异常 getopt.GetoptError

当在参数列表中找到无法识别的选项或没有给出需要参数的选项时，会引发此错误。

异常的参数是一个指示错误原因的字符串。属性 msg 和 opt 给出错误消息和相关选项。

例子

假设我们想通过命令行传递两个文件名，并且我们还想提供一个选项来检查脚本的使用情况。该脚本的用法如下 -

usage: test.py -i <inputfile> -o <outputfile>

这是 test.py 的以下脚本 -

import sys, getopt
def main(argv):
   inputfile = ''
   outputfile = ''
   try:
      opts, args = getopt.getopt(argv,"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 ('test.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)
if __name__ == "__main__":
   main(sys.argv[1:])

现在，运行上面的脚本如下 -

$ test.py -h
usage: test.py -i <inputfile> -o <outputfile>
$ test.py -i BMP -o
usage: test.py -i <inputfile> -o <outputfile>
$ test.py -i inputfile -o outputfile
Input file is " inputfile
Output file is " outputfile

argparse 模块

argparse模块提供了用于编写非常易于使用的命令行界面的工具。它处理如何解析sys.argv列表中收集的参数，自动生成帮助并在给出无效选项时发出错误消息。

设计命令行界面的第一步是设置解析器对象。这是通过argparse 模块中的ArgumentParser()函数完成的。可以给该函数一个解释性字符串作为描述参数。

首先，我们的脚本将从命令行执行，不带任何参数。仍然使用解析器对象的parse_args()方法，该方法不执行任何操作，因为没有给出任何参数。

import argparse
parser=argparse.ArgumentParser(description="sample argument parser")
args=parser.parse_args()

当上面的脚本运行时 -

C:\Python311>python parser1.py
C:\Python311>python parser1.py -h
usage: parser1.py [-h]
sample argument parser
options:
   -h, --help show this help message and exit

第二个命令行用法给出了-help选项，它会生成如图所示的帮助消息。-help参数默认可用。

现在让我们定义一个参数，该参数对于脚本运行是必需的，如果没有给出脚本将抛出错误。这里我们通过 add_argument() 方法定义参数“user”。

import argparse
parser=argparse.ArgumentParser(description="sample argument parser")
parser.add_argument("user")
args=parser.parse_args()
if args.user=="Admin":
   print ("Hello Admin")
else:
   print ("Hello Guest")

该脚本的帮助现在以“用户”的形式显示一个位置参数。程序检查它的值是否为“Admin”并打印相应的消息。

C:\Python311>python parser2.py --help
usage: parser2.py [-h] user
sample argument parser
positional arguments:
   user
options:
   -h, --help show this help message and exit

使用以下命令 -

C:\Python311>python parser2.py Admin
Hello Admin

但以下用法会显示 Hello Guest 消息。

C:\Python311>python parser2.py Rajan
Hello Guest

add_argument() 方法

我们可以为 add_argument() 方法中的参数分配默认值。

import argparse
parser=argparse.ArgumentParser(description="sample argument parser")
parser.add_argument("user", nargs='?',default="Admin")
args=parser.parse_args()
if args.user=="Admin":
   print ("Hello Admin")
else:
   print ("Hello Guest")

这里 nargs 是应该使用的命令行参数的数量。'？'。如果可能的话，将从命令行使用一个参数，并将其作为单个项目生成。如果不存在命令行参数，则将生成默认值。

默认情况下，所有参数都被视为字符串。要显式提及参数类型，请在 add_argument() 方法中使用类型参数。所有 Python 数据类型都是有效的类型值。

import argparse
parser=argparse.ArgumentParser(description="add numbers")
parser.add_argument("first", type=int)
parser.add_argument("second", type=int)
args=parser.parse_args()
x=args.first
y=args.second
z=x+y
print ('addition of {} and {} = {}'.format(x,y,z))

它将产生以下输出-

C:\Python311>python parser3.py 10 20
addition of 10 and 20 = 30

在上面的例子中，参数是强制性的。要添加可选参数，请在其名称前加上双破折号 -- 前缀。在以下情况下，姓氏参数是可选的，因为它以双破折号（--surname）为前缀。

import argparse
parser=argparse.ArgumentParser()
parser.add_argument("name")
parser.add_argument("--surname")
args=parser.parse_args()
print ("My name is ", args.name, end=' ')
if args.surname:
   print (args.surname)

以单破折号为前缀的单字母参数名称充当短名称选项。

C:\Python311>python parser3.py Anup
My name is Anup
C:\Python311>python parser3.py Anup --surname Gupta
My name is Anup Gupta

如果希望参数仅从定义的列表中取值，则将其定义为选择参数。

import argparse
parser=argparse.ArgumentParser()
parser.add_argument("sub", choices=['Physics', 'Maths', 'Biology'])
args=parser.parse_args()
print ("My subject is ", args.sub)

请注意，如果参数值不在列表中，则会显示无效选择错误。

C:\Python311>python parser3.py Physics
My subject is Physics
C:\Python311>python parser3.py History
usage: parser3.py [-h] {Physics,Maths,Biology}
parser3.py: error: argument sub: invalid choice: 'History' (choose from
'Physics', 'Maths', 'Biology')