python命令行解析模块--argparse

Posted 2021-02-02 -零

 

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.