1. sys.argv
2. argparse
3. getopt
4. click
最後
大家好，在日常編寫 Python 腳本的過程中，我們經常需要結合命令行參數傳入一些變量參數，使項目使用更加的靈活方便
本篇文章我將羅列出構建 Python 命令行參數的 4 種常見方式
它們分別是：
內置 sys.argv 模塊
內置 argparse 模塊
內置 getopt 模塊
第三方依賴庫 click
1. sys.argv構建命令行參數最簡單、常見的方式是利用內置的「 sys.argv 」模塊
它是將參數以一個有序的列表傳入，所以在使用時傳參順序必須固定
因此，這種方式適用於參數個數少且場景固定的項目中
import sysif __name__ == '__main__': # 獲取參數列表 # 注意：sys.argv[0] 代表第一個參數，即：腳本名稱「1_sys.argv.py」 # 其他參數列表 args = sys.argv[1:] # 參數個數 args_length = len(sys.argv) if sys.argv else 0 print("排除運行主文件參數，其他參數列表為:", args) print("參數總數：", args_length)# 使用# python3 1_sys.argv.py arg1 arg2# 排除運行主文件參數，其他參數列表為: [arg1, arg1]# 參數總數：3需要注意的是，在腳本中通過「 sys.argv 」獲取的參數列表中，第一個參數代表腳本主文件名稱
2. argparse內置的 argparse 模塊可以非常輕松地編寫出友好的命令行參數腳本，並且它能自動生成幫助使用手冊，在用戶給程序傳入無效參數時能拋出清晰的錯誤信息
官方文檔
使用它構建命令行參數包含 3 個步驟：
構建參數解析對象添加參數添加參數解析參數
1.構建命令行參數解析對象
import argparse...# 構建一個命令行參數解析對象parser = argparse.ArgumentParser(description='命令行參數')...2.添加命令行參數
需要指出的是，--arg1 用於指定參數名稱，-a1 代表 dest 目標變量值（簡寫）
...# 設置3個參數# 參數1：arg1，整型，非必須傳入參數# 參數2：arg2，字符串，非必須傳入參數，包含默認值「xag」# 參數3：arg3，字符串類型，必須傳入的參數parser.add_argument('--arg1', '-a1', type=int, help='參數1，非必須參數')parser.add_argument('--arg2', '-a2', type=str, help='參數2，非必須參數,包含默認值', default='xag')parser.add_argument('--arg3', '-a3', type=str, help='參數3，必須參數', required=True)...3.解析出參數值
...# 解析參數,獲取所有的命令行參數（Namespace），然後轉為字典args = vars(parser.parse_args())# 獲取所有參數print("所有命令行參數為:")for key in args: print(f"命令行參數名:{key}，參數值:{args[key]}")...使用的時候，我們就可以通過「 -h / --help 」命令參數查看幫助文檔
# 查看命令行參數幫助文檔python3 2_argparse.py --help# 或python3 2_argparse.py -h上面添加的 3 個參數，參數 arg1、arg2 非必須傳值，arg3 必須傳值，另外參數 arg2 指定了默認值
# 參數arg3必須，參數arg1和參數arg2非必須，其中參數arg2設置了默認值# 傳入參數arg3# python3 2_argparse.py --arg3 123# python3 2_argparse.py -a3 123 [email protected] args % python3 2_argparse.py -a3 123 所有命令行參數為:命令行參數名:arg1，參數值:None命令行參數名:arg2，參數值:xag命令行參數名:arg3，參數值:123# 傳入參數arg1、[email protected] args % python3 2_argparse.py -a1 111 -a3 123 所有命令行參數為:命令行參數名:arg1，參數值:111命令行參數名:arg2，參數值:xag命令行參數名:arg3，參數值:123# 傳入參數arg1、arg2、[email protected] args % python3 2_argparse.py -a1 111 -a2 222 -a3 123所有命令行參數為:命令行參數名:arg1，參數值:111命令行參數名:arg2，參數值:222命令行參數名:arg3，參數值:1233. getoptgetopt 是 Python 中一個內置標准模塊，可以結合 sys.argv 模塊，直接解析腳本運行時參數
使用格式：getopt(args,shortopts,longopts = [])
其中
args
參數列表，可以通過 sys.argv 獲取，可以參考上面
shortopts 短參數組成的字符串
定義短參數，如果參數有值，需要在短參數後追加一個「 : 」符號
傳參使用方式：-n 23
longopts 長參數列表
定義長參數列表時，如果某個參數有值，需要在短參數後追加一個「 = 」符號
傳參使用方式：–port 8080
這裡以傳入數據庫連接參數為例（參數包含 ip、用戶名、密碼、數據庫名稱）進行講解
from getopt import getoptimport sys# 獲取參數# sys.argv[1:]：獲取除腳本文件名外的所有命令行參數# opts：存有所有選項及其輸入值的元組列表# args：去除有用的輸入以後剩余的部分opts, args = getopt(sys.argv[1:], 'i:u:p:d:', ['ip=', 'user=', 'pwd=', 'db='])# 獲取參數值# 短參數# python3 4_getopt.py -i 127.0.0.1 -u root -p 123456 -d mysqldb# 長參數# python3 4_getopt.py --ip 127.0.0.1 -u root -p 123456 -d mysqldbip_pre = [item[1] for item in opts if item[0] in ('-i', '--ip')]ip = ip_pre[0] if len(ip_pre) > 0 else Noneprint("參數ip：", ip)user_pre = [item[1] for item in opts if item[0] in ('-u', '--user')]user = user_pre[0] if len(user_pre) > 0 else Noneprint("參數user：", user)pwd_pre = [item[1] for item in opts if item[0] in ('-p', '--pwd')]pwd = pwd_pre[0] if len(pwd_pre) > 0 else Noneprint("參數pwd：", pwd)db_pre = [item[1] for item in opts if item[0] in ('-d', '--db')]db = db_pre[0] if len(db_pre) > 0 else Noneprint("參數db：", db)在運行腳本時，我們可以利用「 短參數 」或「 長參數 」形式進行傳遞
# 測試# 短參數python3 4_getopt.py -i 127.0.0.1 -u root -p 123456 -d mysqldb# 長參數python3 4_getopt.py --ip 127.0.0.1 --user root --pwd 123456 --db mysqldb4. clickclick 作為第三方依賴庫，它為命令行工具封裝了大量的方法，可以非常方便實現命令行參數
項目地址
首先，我們需要安裝依賴庫 click
import click# 安裝依賴# pip3 install -U [email protected]()@click.option('--arg1', default='111', help='參數arg1，默認值為「111」')@click.option('--arg2', type=int, help='參數arg2')@click.option('--arg3', type=str, help='參數arg3')def start(arg1, arg2, arg3): """ 基於參數arg1、參數arg2、參數arg3運行項目 :param arg1: :param arg2: :param arg3: :return: """ print("參數arg1值為:", arg1) print("參數arg2值為:", arg2) print("參數arg3值為:", arg3)if __name__ == '__main__': start()然後，在主運行函數上通過裝飾器配置參數即可
比如，上面就定義了 3 個命令行參數 arg1、arg2、arg3，並設置了參數的類型及默認值
最後，在運行腳本時只需要按參數設定傳遞對應的值即可
# 不包含參數[email protected] args % python3 3_click.py 參數arg1值為: 111參數arg2值為: None參數arg3值為: None# 包含參數[email protected] args % python3 3_click.py --arg1 test1參數arg1值為: test1參數arg2值為: None參數arg3值為: None# 包含參數arg1、arg2# 注意：arg2的參數類型為整形，傳入的參數必須能轉為整形，否則會報錯[email protected] args % python3 3_click.py --arg1 test1 --arg2 222 參數arg1值為: test1參數arg2值為: 222參數arg3值為: None# 包含參數arg1、arg2、[email protected] args % python3 3_click.py --arg1 test1 --arg2 222 --arg3 test3參數arg1值為: test1參數arg2值為: 222參數arg3值為: test3最後上面通過實例講解了實現 Python 命令行參數常見的 4 種方式
對於一些簡單自用且不那麼正規的場景，個人覺得可以考慮用 sys.argv 模塊快速構建命令行參數；而對一些參數多、面向用戶的正式生產環境，建議利用 argparse 模塊或 click 依賴來創建命令行參數
到此這篇關於Python命令行參數化的四種方式詳解的文章就介紹到這了,更多相關Python命令行參數化內容請搜索軟件開發網以前的文章或繼續浏覽下面的相關文章希望大家以後多多支持軟件開發網！
