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

Question

我必须从命令行输入参数，即用户名、密码和数据库名称。我知道如何在不使用标志的情况下做到这一点，方法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

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

Answer 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
        ))

Answer 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

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

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

Answer 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