python命令行解析模塊--argparse

目錄

簡介
詳解ArgumentParser方法
詳解add_argument方法

參考文檔：

https://www.jianshu.com/p/aac9f8079a53

https://www.2cto.com/kf/201412/363654.html

簡介

介紹:
argparse是python用於解析命令行參數和選項的標準模塊，用於代替已經過時的optparse模塊。
argparse模塊的作用是用於解析命令行參數，例如python parseTest.py input.txt output.txt --user=name --port=8080。
Argparse的作用就是為py文件封裝好可以選擇的參數，使他們更加靈活，豐富。而且argparse會自動生成幫助信息和錯誤信息。



argparse模塊一般的使用步驟:
（1）import argparse #導入模塊
（2）parser = argparse.ArgumentParser() #創建一個ArgumentParser對象。
（3）parser.add_argument()  #添加參數，通過調用add_argument()方法將命令行中的參數保存到ArgumentParser對象中。
（4）args=parser.parse_args() #調用parse_args()，獲得輸入的參數
（5）return args
（6）args = parse_args()
 首先導入該模塊；然後創建一個解析對象；然後向該對象中添加你要關註的命令行參數和選項，每一個add_argument方法對應一個你要關註的參數或選項；最後調用parse_args()方法進行解析；解析成功後需要獲取輸入的參數即
 可使用。

詳解ArgumentParser方法

ArgumentParser方法

ArgumentParser(prog=None, usage=None,description=None, epilog=None, parents=[],formatter_class=argparse.HelpFormatter, prefix_chars=‘-‘,fromfile_prefix_chars=None, argument_d
efault=None,conflict_handler=‘error‘, add_help=True)

註意：

這些參數都有默認值，當調用parser.print_help()或者運行程序時由於參數不正確(此時python解釋器其實也是調用了pring_help()方法)時，會打印這些描述信息，一般只需要傳遞description參數。

參數解讀

description：help參數之前顯示的信息，描述這個程序的功能

epilog：help參數之後顯示的信息。

add_help:給解析器添加-h/--help選項（默認為True）

argument_default:設置參數的默認值（默認為None）

parents:ArgumentParser對象組成列表，這些對象中的參數也要包含進來。

prefix_chars：可選參數之前的前綴（默認為-)

fromfile_prefix_chars:如果是從文件中讀取參數，這個文件名參數的前綴（默認為None）

formatter_class:一個自定義幫助信息格式化輸出的類

conflict_handler:通常不需要，定義了處理沖突選項的策略

prog：程序名（默認為sys.argv[0]）

usage:程序的使用用例，默認情況下會自動生成。

常用參數使用

1.description

大多數調用ArgumentParser構造函數的例子中都會使用description參數，這個參數會簡短的描述這個程序的用途。

示例程序：

import argparse

parser = argparse.ArgumentParser(description=‘FTP  Scanner‘)
print(parser.print_help())
parser.parse_args()

運行結果：

(venv) C:\Pycham>python 漏洞掃描器/測試2.py
usage: 測試2.py [-h]

FTP Scanner

optional arguments:
  -h, --help  show this help message and exit

註意：

默認情況下，這個描述信息前後都會有一個空行，如果想改變這種顯示，可以使用formatter_class參數

2.epilog

有些程序可能想在描述信息之後再繼續展示別的信息，這個時候可以使用epilog參數設置。

示例程序：

import argparse

parser = argparse.ArgumentParser(description=‘FTP  Scanner‘,epilog="支持匿名登錄掃描與暴力破解")
print(parser.print_help())
parser.parse_args()

運行結果：

(venv) C:\Pycham>python 漏洞掃描器/測試2.py
usage: 測試2.py [-h]

FTP Scanner

optional arguments:
  -h, --help  show this help message and exit

支持匿名登錄掃描與暴力破解

註意：

跟description參數一樣，這個信心前後都有一個空行，同樣可以通過formatter-class參數設置。

3.add_help

默認情況下，ArgumentParser對象對自動添加-h/--help選項，以展示幫助信息。
就是上面一直輸出的：
  -h, --help  show this help message and exit

通過設置add_help=False可以取消幫助信息的顯示

4.prefix_chars

定義optional參數的前綴,默認是‘-‘和‘--‘, 如果我們設置 prefix_char=‘-+‘, 那麽我們可以定義以‘+‘或‘++‘為前綴的optional參數.

示例程序：

parser.add_argument(‘+P‘)
parser.add_argument(‘++F‘)

5.formatter_class

我們知道默認情況下，description以及epilog信息前後都有一個空行，甚至多行信息會盡量在一行輸出。
通過指定formatter_class可以對幫助信息進行格式化輸出。
這樣的類有三個：
argparse.RawDescriptionHelpFormatter
argparse.RawTextHelpFormatter
argparse.ArgumentDefaultsHelp

RawDescriptionHelpFormatter，則description和epilog將會按原樣輸出，但是前後還會有空行。

RawTextHelpFormatter則會保留預定義的幫助信息中的空格。

ArgumentDefaultsHelpFormatter則會給所有的有默認值的參數添加默認值信息。

詳解add_argument方法

方法add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

參數解讀

nargs：命令行參數的個數，一般使用通配符表示，其中，‘?‘表示只用一個，‘*‘表示0到多個，‘+‘表示至少一個

default：默認值

type：參數的類型，默認是字符串string類型，還有float、int等類型

help：和ArgumentParser方法中的參數作用相似，出現的場合也一致

choices：用於為位置參數或可選參數設限定一個範圍，例如：choices=[‘mark‘, ‘Eric‘, ‘Jonan‘]

metavar：用於自定義幫助信息(-h得到的輸出)中的位置參數和可選參數的參數值的展示樣例.默認help輸出中的位置參數的參數值示例直接使用位置參數名稱, 可選參數的參數值樣例則是把可選參數大寫

dest：dest是一個argpars.ArgumentParser對象被解析以後, args引用參數值的變量名稱，如果你不指定也沒有關系。
默認:

• 位置參數的dest為位置參數的參數名
• 可選參數的dest為:

• 合規長參數去掉前綴‘--‘, 如: --foo的dest為foo
• 不合規長參(參數名包含‘-‘)數去掉前綴‘--‘, 並且把參數名中的‘-‘變為‘ _ ‘, 例如: --food-name的dest為food_name.
• 如果沒有長參數, 那麽短參數去掉前綴‘-‘, 如: -p的dest為p

重點參數使用

1.Name or Flags

位置參數(positional arguments)

代碼示例

parser.add_argument(‘hostname‘, help=‘server host name‘, type=str)

可選參數(optional arguments)

代碼示例

parser.add_argument(‘-p‘, ‘--port‘, help=‘the port number‘, type=int)

2.nargs

用於指定某位置參數或可選參數能接受參數值的個數.

nargs=N (N為參數個數)

nargs=‘?‘ (只接收一個參數)

args=‘*‘ (接受所有參數)

args=‘+‘ (接受所有參數,要求至少有一個參數)

3.help

對參數的一個功能描述, 當用戶使用-h時, 會顯示該描述.

官方文檔

import argparse
 
def parse_args():
    description = usage: %prog [options] poetry-file
 
This is the Slow Poetry Server, blocking edition.
Run it like this:
 
  python slowpoetry.py <path-to-poetry-file>
 
If you are in the base directory of the twisted-intro package,
you could run it like this:
 
  python blocking-server/slowpoetry.py poetry/ecstasy.txt
 
to serve up John Donne‘s Ecstasy, which I know you want to do.
 
 
    parser = argparse.ArgumentParser(description = description)
     
    help = The addresses to connect.
    parser.add_argument(‘addresses‘,nargs = ‘*‘,help = help)  #位置參數
 
    help = The filename to operate on.Default is poetry/ecstasy.txt
    parser.add_argument(‘filename‘,help=help)
 
    help = The port to listen on. Default to a random available port.
    parser.add_argument(‘-p‘,--port‘, type=int, help=help) #可選參數
 
    help = The interface to listen on. Default is localhost.
    parser.add_argument(‘--iface‘, help=help, default=‘localhost‘)
 
    help = The number of seconds between sending bytes.
    parser.add_argument(‘--delay‘, type=float, help=help, default=.7)
 
    help = The number of bytes to send at a time.
    parser.add_argument(‘--bytes‘, type=int, help=help, default=10)
 
    args = parser.parse_args();
    return args
 
if __name__ == ‘__main__‘:
    args = parse_args()
     
    for address in args.addresses:
        print ‘The address is : %s .‘ % address
     
    print ‘The filename is : %s .‘ % args.filename
    print ‘The port is : %d.‘ % args.port
    print ‘The interface is : %s.‘ % args.iface
    print ‘The number of seconds between sending bytes : %f‘% args.delay
    print ‘The number of bytes to send at a time : %d.‘ % args.bytes</path-to-poetry-file>

運行該腳本：python test.py --port 10000 --delay 1.2 127.0.0.1 172.16.55.67 poetry/ecstasy.txt
 

輸出為：

The address is : 127.0.0.1 .
The address is : 172.16.55.67 .
The filename is : poetry/ecstasy.txt .
The port is : 10000.
The interface is : localhost.
The number of seconds between sending bytes : 1.200000
The number of bytes to send at a time : 10.

python命令行解析模塊--argparse