快捷導(dǎo)航

詳解python的argpare和click模塊小結(jié)

更新時間：2019年03月31日 16:53:12 作者：bainianminguo

這篇文章主要介紹了詳解python的argpare和click模塊小結(jié)，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

一、argparse模塊

1、模塊說明

# argparse是python的標(biāo)準(zhǔn)庫中用來解析命令行參數(shù)的模塊，用來替代已經(jīng)過時的optparse模塊，argparse能夠根據(jù)程序中的定義的sys.argv中解析出這些參數(shù)，

# 并自動生成幫助和使用信息

2、模塊常用的參數(shù)

# 參數(shù)說明：
# name/flag:參數(shù)的名字
# action:遇到參數(shù)的動作，默認值是store
# nargs:參數(shù)的個數(shù)，可以是具體的數(shù)字，或者是+或者是*,*表示0個或者多個參數(shù)，+號表示1個或者多個參數(shù)
# default:不指定參數(shù)時的默認值
# type:# 參數(shù)的類型
# choice:參數(shù)允許的值
# required:可選參數(shù)是否可以省略
# help:參數(shù)的幫助信息
# dest:解析后參數(shù)的名稱

3、使用方法

import argparse
def _argparse():
 parseobj = argparse.ArgumentParser(description="This is script help")
 # 參數(shù)說明：
 # name/flag:參數(shù)的名字
 # action:遇到參數(shù)的動作，默認值是store
 # nargs:參數(shù)的個數(shù)，可以是具體的數(shù)字，或者是+或者是*,*表示0個或者多個參數(shù)，+號表示1個或者多個參數(shù)
 # default:不指定參數(shù)時的默認值
 # type:# 參數(shù)的類型
 # choice:參數(shù)允許的值
 # required:可選參數(shù)是否可以省略
 # help:參數(shù)的幫助信息
 # dest:解析后參數(shù)的名稱
 parseobj.add_argument("--host",action='store',dest='host',required=True,default="127",help="This is a host ip address",type=int)

 parseobj.add_argument("--P",'--passwd',action='store', dest='pwd', required=True, default="admin123.",help="This is a host password", type=str)
 parseobj.add_argument("--V", '--version', action='version', version="%(prog)s 0.1")
 return parseobj.parse_args()
if __name__ == '__main__':
 res = _argparse()
 print(res.pwd)
 print(res.host)

4、最后我們測試一下這個模塊

a、測試 -h選項，這里-h和--help的效果是一樣的

b、測試--V選項和--version選項

c、測試一下輸入的正確的參數(shù)

二、click模塊

1、模塊介紹

click模塊的作者就是Flask的作者,(Armin Ronacher)開發(fā)的一個第三方的模塊，用于快速創(chuàng)建命令行。他的作用用python標(biāo)準(zhǔn)庫中的argparse相同，但是

使用更加簡單，click相對于標(biāo)準(zhǔn)庫的argparse，就好比requests庫相當(dāng)于標(biāo)準(zhǔn)庫的urllib庫，click是一個第三的庫，因此在使用之前需要安裝

2、模塊安裝

E:\python3\Scripts>pip3.6.exe install click

3、使用步驟

a、使用@click.command()裝飾一個函數(shù)，使之成為命令行的接口

b、使用@click.option()等裝飾函數(shù)，為其添加命令行選項等

c、先看一個官方的例子

import click

 

# click模塊的作者就是Flask的作者,(Armin Ronacher)開發(fā)的一個第三方的模塊，用于快速創(chuàng)建命令行。他的作用用python標(biāo)準(zhǔn)庫中的argparse相同，但是

# 使用更加簡單，click相對于標(biāo)準(zhǔn)庫的argparse，就好比requests庫相當(dāng)于標(biāo)準(zhǔn)庫的urllib庫，click是一個第三的庫，因此在使用之前需要安裝

 

@click.command()

@click.option('--count',default=1,help='Number of greetings')

@click.option('--name',prompt='your name',help='The person to greet')

def hello(count,name):

 for x in range(count):

  click.echo("hello {name}".format(name = name))

 

if __name__ == '__main__':

 hello()

其他的應(yīng)該大家都可以看懂，這個prompt的作用是什么呢，實際就是如果我們沒有為name傳參數(shù)，他就會給出一個提示

下面這個例子是完整的傳參

4、常用參數(shù)

常用參數(shù)

default：設(shè)置命令行參數(shù)的默認值

help：參數(shù)說明

type：參數(shù)的類型，可以是string，int，float

prompt：當(dāng)在命令行中沒有輸入相應(yīng)的參數(shù)，會根據(jù)prompt提示用戶輸入

nargs：指定命令行參數(shù)接受的值的個數(shù)　　

a、測試一下nargs參數(shù)

@click.command()
@click.option('--post',nargs=2,help='Number of post')
def hello(post):
 print(post)

if __name__ == '__main__':
 hello()

測試結(jié)果

b、測試click.choice選項

@click.command()
@click.option('--hash',type=click.Choice(["md5","sha1"]),help='type of hash')
def hello(hash):
 print(hash)
if __name__ == '__main__':
 hello()

測試結(jié)果

c、如果使用命令行輸入密碼，則默認的情況是有很大的安全隱患的，因為輸入密碼的命令在history中，其他用戶就可以通過命令的歷史列表，拿到我們的密碼，click可以為我們解決這個問題

@click.command()
@click.option('--pwd',prompt=True,hide_input=True,help='passwd of user',confirmation_prompt=True)
def hello(pwd):
 print(pwd)
if __name__ == '__main__':
 hello()

prompt：要設(shè)置為True

hide_input：要設(shè)置為True

confirmation_prompt：會自動為我們進行密碼的二次驗證

測試結(jié)果如下

錯誤的輸入