Python 中使用 argparse 解析命令行參數(shù)
使用 argparse
模塊為應(yīng)用程序設(shè)置命令行選項(xiàng)。
有一些第三方庫用于命令行解析,但標(biāo)準(zhǔn)庫 argparse
與之相比也毫不遜色。
無需添加很多依賴,你就可以編寫帶有實(shí)用參數(shù)解析功能的漂亮命令行工具。
1、Python 中的參數(shù)解析
使用 argparse 解析命令行參數(shù)時(shí),第一步是配置一個(gè) ArgumentParser
對象。這通常在全局模塊內(nèi)完成,因?yàn)閱螁蝊配置_一個(gè)解析器沒有副作用。
import argparse PARSER = argparse.ArgumentParser()
ArgumentParser
中最重要的方法是 .add_argument()
,它有幾個(gè)變體。默認(rèn)情況下,它會添加一個(gè)參數(shù),并期望一個(gè)值。
PARSER.add_argument("--value")
查看實(shí)際效果,調(diào)用 .parse_args():
PARSER.parse_args(["--value", "some-value"]) Namespace(value='some-value')
也可以使用 = 語法:
PARSER.parse_args(["--value=some-value"]) Namespace(value='some-value')
為了縮短在命令行輸入的命令,你還可以為選項(xiàng)指定一個(gè)短“別名”:
PARSER.add_argument("--thing", "-t")
可以傳入短選項(xiàng):
PARSER.parse_args("-t some-thing".split()) Namespace(value=None, thing='some-thing')
或者長選項(xiàng):
PARSER.parse_args("--thing some-thing".split()) Namespace(value=None, thing='some-thing')
2、類型
有很多類型的參數(shù)可供你使用。除了默認(rèn)類型,最流行的兩個(gè)是布爾類型和計(jì)數(shù)器。布爾類型有一個(gè)默認(rèn)為 True 的變體和一個(gè)默認(rèn)為 False
的變體。
PARSER.add_argument("--active", action="store_true") PARSER.add_argument("--no-dry-run", action="store_false", dest="dry_run") PARSER.add_argument("--verbose", "-v", action="count")
除非顯式傳入 --active
,否則 active 就是 False。dry-run
默認(rèn)是 True,除非傳入 --no-dry-run
。無值的短選項(xiàng)可以并列。
傳遞所有參數(shù)會導(dǎo)致非默認(rèn)狀態(tài):
PARSER.parse_args("--active --no-dry-run -vvvv".split()) Namespace(value=None, thing=None, active=True, dry_run=False, verbose=4)
默認(rèn)值則比較單一:
PARSER.parse_args("".split()) Namespace(value=None, thing=None, active=False, dry_run=True, verbose=None)
3、子命令
經(jīng)典的 Unix
命令秉承了“一次只做一件事,并做到極致”,但現(xiàn)代的趨勢把“幾個(gè)密切相關(guān)的操作”放在一起。
git
、podman
和 kubectl
充分說明了這種范式的流行。
argparse 庫也可以做到:
MULTI_PARSER = argparse.ArgumentParser() subparsers = MULTI_PARSER.add_subparsers() get = subparsers.add_parser("get") get.add_argument("--name") get.set_defaults(command="get") search = subparsers.add_parser("search") search.add_argument("--query") search.set_defaults(command="search")
MULTI_PARSER.parse_args("get --name awesome-name".split())
Namespace(name='awesome-name', command='get')
MULTI_PARSER.parse_args("search --query name~awesome".split())
Namespace(query='name~awesome', command='search')`
4、程序架構(gòu)
使用 argparse 的一種方法是使用下面的結(jié)構(gòu):
## my_package/__main__.py import argparse import sys from my_package import toplevel parsed_arguments = toplevel.PARSER.parse_args(sys.argv[1:]) toplevel.main(parsed_arguments)
## my_package/toplevel.py PARSER = argparse.ArgumentParser() ## .add_argument, etc. def main(parsed_args): ... # do stuff with parsed_args
在這種情況下,使用 python -m my_package
運(yùn)行。或者,你可以在包安裝時(shí)使用 console_scprits
入口點(diǎn)。
總結(jié):
argparse
模塊是一個(gè)強(qiáng)大的命令行參數(shù)解析器,還有很多功能沒能在這里介紹。它能實(shí)現(xiàn)你想象的一切。
到此這篇關(guān)于Python 中使用 argparse 解析命令行參數(shù)的文章就介紹到這了,更多相關(guān)Python 中使用 argparse 內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Pytorch中TensorDataset與DataLoader的使用方式
這篇文章主要介紹了Pytorch中TensorDataset與DataLoader的使用方式,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-09-09django rest framework serializers序列化實(shí)例
這篇文章主要介紹了django rest framework serializers序列化實(shí)例,具有很好的參考價(jià)值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-05-05Django?+?Taro?前后端分離項(xiàng)目實(shí)現(xiàn)企業(yè)微信登錄功能
這篇文章主要介紹了Django?+?Taro?前后端分離項(xiàng)目實(shí)現(xiàn)企業(yè)微信登錄功能,本文記錄一下企業(yè)微信登錄的流程,結(jié)合示例代碼給大家分享實(shí)現(xiàn)思路,需要的朋友可以參考下2022-04-04將Python的Django框架與認(rèn)證系統(tǒng)整合的方法
這篇文章主要介紹了將Python的Django框架與認(rèn)證系統(tǒng)整合的方法,包括指定認(rèn)證后臺和編寫認(rèn)證后臺等內(nèi)容,需要的朋友可以參考下2015-07-07Python 將代碼轉(zhuǎn)換為可執(zhí)行文件脫離python環(huán)境運(yùn)行(步驟詳解)
這篇文章主要介紹了Python 將代碼轉(zhuǎn)換為可執(zhí)行文件脫離python環(huán)境運(yùn)行(步驟詳解),本文給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-01-01Python實(shí)現(xiàn)通過文件路徑獲取文件hash值的方法
這篇文章主要介紹了Python實(shí)現(xiàn)通過文件路徑獲取文件hash值的方法,結(jié)合實(shí)例形式分析了Python針對文件進(jìn)行hash運(yùn)算的實(shí)現(xiàn)方法與相關(guān)注意事項(xiàng),需要的朋友可以參考下2017-04-04