如何在 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