如何在 Python3 中添加带有标志的命令行参数？

Posted 2023-02-24

【中文标题】如何在 Python3 中添加带有标志的命令行参数？

【英文标题】：How to add command line arguments with flags in Python3?

【发布时间】：2012-07-21 05:22:18

【问题描述】：

我必须从命令行输入参数，即用户名、密码和数据库名称。我知道如何在不使用标志的情况下使用sys.argv 来做到这一点，如下所示：

##Test.py
hostname = str(sys.argv[1])
username = str(sys.argv[2])
password = str(sys.argv[3])

def ConnecttoDB():
    try:
        con=sql.connect(host=hostname, user= username, passwd= password)
        print ('\nConnected to Database\n')

# If we cannot connect to the database, send an error to the user and exit the program.
    except sql.Error:
        print ("Error %d: %s" % (sql.Error.args[0],sql.Error.args[1]))
        sys.exit(1)

    return con   

所以，它可以这样运行：

$test.py DATABASE USERNAME PASWORD

但问题是我必须使用“标志”。所以，脚本可以这样运行：

$test.py -db DATABSE -u USERNAME -p PASSWORD -size 20

如何使用标志从命令行获取参数？

【参考方案1】：

python 3 库包含 3 个用于解析命令行的模块，因此无需额外添加到您的设置中。

你应该使用的是argparse

import argparse
parser = argparse.ArgumentParser()

#-db DATABSE -u USERNAME -p PASSWORD -size 20
parser.add_argument("-db", "--hostname", help="Database name")
parser.add_argument("-u", "--username", help="User name")
parser.add_argument("-p", "--password", help="Password")
parser.add_argument("-size", "--size", help="Size", type=int)

args = parser.parse_args()

print( "Hostname  User  Password  size  ".format(
        args.hostname,
        args.username,
        args.password,
        args.size
        ))

【讨论】：

感谢您的回复和代码。我现在面临的问题是我的代码为上面代码中定义的变量提供错误“未定义的变量”。这是因为，之前在脚本中明确提到了它们的值，但在包含 Mark 的代码后，脚本无法识别这些值。简而言之，我如何让脚本从“argparse”模块中获取变量值。例如。脚本的早期：主机名 = 127.0.0.1，用户名 = xyz 和密码 = abc，但现在这些已被上面的代码（由马克）替换，因此脚本现在显示“未定义变量”。

【参考方案2】：

首先感谢 Mark 提供的“argparse”代码。我已经找到了从标志指定的命令行获取参数的方法。我正在粘贴下面的代码，该代码使用修改后的“标记”代码和一个小模块，该模块显示如何使用通过命令行收集的参数：

import argparse

parser = argparse.ArgumentParser()

#-db DATABASE -u USERNAME -p PASSWORD -size 20000
parser.add_argument("-host", "--hostname", dest = "hostname", default = "xyz.edu", help="Server name")
parser.add_argument("-db", "--database", dest = "db", default = "ding_dong", help="Database name")
parser.add_argument("-u", "--username",dest ="username", help="User name")
parser.add_argument("-p", "--password",dest = "password", help="Password")
parser.add_argument("-size", "--binsize",dest = "binsize", help="Size", type=int)

args = parser.parse_args()

print( "Hostname  db  User  Password  size  ".format(
        args.hostname,
        args.db,
        args.username,
        args.password,
        args.binsize
        ))
def ConnectToDB():
    print ('Trying to connect to mysql server')
    # Try to connect to the database
    try:
        con=sql.connect(host=args.hostname, user= args.username, passwd= args.password)
        print ('\nConnected to Database\n')

    # If we cannot connect to the database, send an error to the user and exit the program.
    except sql.Error:
        print ("Error %d: %s" % (sql.Error.args[0],sql.Error.args[1]))
        sys.exit(1)

    return con

我关心的一个问题是如何在代码中使用变量。为此需要做两件事

将“dest”添加到 add_argument 行，例如dest ="username" 这意味着从命令行收集的值将分配给变量 'username' 每当您使用这样的命令行从“dest”分配变量时，只需在变量 ex con=sql.connect(host=args.hostname, user= args.username, passwd= args.password) 之前添加“args”李>

【讨论】：

您接受了自己的问题解决方案，而 @Mark 确实为您提供了问题的答案。我不确定这是不是很友善...

【参考方案3】：

首先，安装 cli-args-system ：

linux: pip3 install cli-args-system
windows: pip install cli-args-system

之后：

from cli_args_system import Args

#for dont try to convert the host
args = Args(convert_numbers=False)

hostname = args.flag_str('h','hostname','host')
username = args.flag_str('u','user','username','password')
password = args.flag_str('p','password')


print(f'host: hostname')
print(f'username: username')
print(f'password: password')

尝试：

python3 teste.py -h 1234 -user foo -p bar
-> 
host: 1234
username: foo
password: bar