study.py内容如下
#!/usr/bin/env python
# -*- coding:utf-8 -*-
__author__ = 'shouke'
import argparse
def argparseFunc():
'''
基于argparse子產品實作指令參數解析功能
執行示例:
python study.py -i 172.19.7.236 -p 8080 -a -r
python study.py --ip 172.19.7.236 --port 7077 --auth -w -v True
'''
parser = argparse.ArgumentParser(description="study.py usage help document")
# 添加不帶預設值的可解析參數
parser.add_argument("-i", "--ip", help="ip addr") #注意: -h、--help為内置參數,不可用
parser.add_argument("-p", "--port",help="host port")
# 添加帶預設值的可解析參數(# action = store_true 表示是如果使用了這個參數,則值參數值設定為True # 更多action配置可參考源碼
# 需要注意的是,不能為帶預設值參數指定參數值,會報錯,該參數值會被當作不識别的參數
parser.add_argument("-a", "--auth", help="if auth need", action="store_true")
# 添加互斥參數(比如 例中的-r和-w 同時隻能用一個)
exclusive_group = parser.add_mutually_exclusive_group()
exclusive_group.add_argument("-r","--read", help="read enabled" , action="store_true")
exclusive_group.add_argument("-w","--write", help="write enabled", action="store_true")
# 添加參數時不設定設定參數說明
parser.add_argument('-v') # show verbose
# 添加參數時不設定參數全名
parser.add_argument('-V', help="version")
ARGS = parser.parse_args() # 擷取指令行參數
print('ARGS:', ARGS)
# 擷取某個參數值
if ARGS.ip: # 注意,這裡的參數名,必須使用參數全稱
print("host addr is: %s" % ARGS.ip)
if ARGS.port:
print("host port is: : %s" % ARGS.port)
if ARGS.auth:
print("auth need: : %s" % ARGS.auth)
if ARGS.read:
print("read enabled: %s" % ARGS.read)
if ARGS.write:
print("write enabled: %s" % ARGS.write)
argparseFunc()
運作測試
python study.py -i 172.19.7.236 -p 8080 -a -r
python study.py --ip 172.19.7.236 --port 7077 --auth -w -v True
結果如下

python study.py -i127.0.0.1 # 注意,參數和參數值之間可以沒有空格
結果如下
python study.py -notExists 1
結果如下
如上,以上代碼實作是針對單個子產品腳本,如果要在多個子產品中使用咋辦?解決方法為封裝為類,具體參見“代碼實踐2”
#代碼實踐2
argument_parser.py
#!/usr/bin/env python
# -*- coding:utf-8 -*-
'''
@Author : shouke
'''
import argparse
class ArgParser(object):
'''
參數解析器
'''
def __init__(self, none_exclusive_arguments, exclusive_arguments, description=''):
self.parser = argparse.ArgumentParser(description=description)
self.add_none_exclusive_arguments(none_exclusive_arguments)
self.add_exclusive_arguments(exclusive_arguments)
def add_none_exclusive_arguments(self, options:list):
'''
添加正常選項(非互斥選項)
:param options 格式為list類型,形如
[
'"-a", "--all", help="do not ignore entries starting with ."',
'"-b", "--block", help="scale sizes by SIZE before printing them"',
'"-C", "--color", help="colorize the output; WHEN can be 'never', 'auto'"',
'"-flag", help="make flag", action="store_true"', # action="store_true" 表示如果不設定該選項的值,則預設值為true,類似的action="store_false" 表示預設值為false
]
其中,每個list元素為argparse.ArgumentParserlei add_argument類函數實參的字元串表示,add_argument函數定義add_argument(self, *args,**kwargs)
'''
for option in options:
eval('self.parser.add_argument(%s)' % option)
def add_exclusive_arguments(self, options:list):
'''
添加互斥選項
:param options 格式為list,形如以下
[
('"-r","--read",help="Read Action",action="store_true"',
'"-w","--write",help="Write Action",action="store_true"')
]
'''
for option_tuple in options:
exptypegroup = self.parser.add_mutually_exclusive_group()
for item in option_tuple:
eval('exptypegroup.add_argument(%s)' % item)
@property
def args(self):
return self.parser.parse_args()
在xxx.py中引用(注意:為了讓參數解析器起到應起的作用,建議在腳本最上方構造參數解析器對象)
study.py内容如下
#!/usr/bin/env python
# -*- coding:utf-8 -*-
__author__ = 'shouke'
from argument_parser import ArgParser
none_exclusive_arguments = [
'"-ip", help="自動化測試服務平台位址"',
'"-projectId", help="自動化測試項目id"',
'"-runEnv", help="自動化測試項目運作環境"',
'"-logLevel", help="日志級别"',
'"-masterHost", help="master服務位址"',
'"-masterPort", help="master服務端口"'
]
exclusive_arguments = [
('"-r", "--read", help="Read Action",action="store_true"',
'"-w", "--write", help="Write Action",action="store_true"')
]
args = ArgParser(none_exclusive_arguments, exclusive_arguments).args
print(args)
print(args.ip)
print(args.read)
運作測試
python study.py -i 127.0.0.1 -r
運作結果如下
到此這篇關于Python 利用argparse子產品實作腳本指令行參數解析的文章就介紹到這了,更多相關Python 實作腳本指令行參數解析内容請搜尋我們以前的文章或繼續浏覽下面的相關文章希望大家以後多多支援我們!
本文标題: Python 利用argparse子產品實作腳本指令行參數解析
本文位址: http://www.cppcns.com/jiaoben/python/371473.html