Python标准库—argparse模块
argparse
ArgumentParser 对象
class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True)
- prog - 程序的名称（默认：
sys.argv[0]） - usage - 描述程序用途的字符串（默认值：从添加到解析器的参数生成）
- description - 在参数帮助文档之前显示的文本（默认值：无）
- epilog- 在参数帮助文档之后显示的文本（默认值：无）
- parents - 一个
ArgumentParser对象的列表，它们的参数也应包含在内 - formatter_class- 用于自定义帮助文档输出格式的类
- prefix_chars- 可选参数的前缀字符集合（默认值：’-’）
- fromfile_prefix_chars - 当需要从文件中读取其他参数时，用于标识文件名的前缀字符集合（默认值：
None） - argument_default - 参数的全局默认值（默认值：
None） - conflict_handler - 解决冲突选项的策略（通常是不必要的）
- add_help- 为解析器添加一个
-h/--help选项（默认值：True） - allow_abbrev - 如果缩写是无歧义的，则允许缩写长选项 （默认值：
True）
import argparse
parser = argparse.ArgumentParser(prog="XSniff", description="Capturing Packets According to Network Protocol")
parser.add_argument("-n", type=int, metavar="count", help="positive integer|capture packet count.")
parser.add_argument("-f", type=str, metavar="protocol", help="""
string|protocol you want to filter. ip(Default)
such as ip, udp, tcp or icmp etc...""")
>>> parser.print_help()
usage: XSniff [-h] [-n count] [-f protocol]
Capturing Packets According to Network Protocol
optional arguments:
-h, --help show this help message and exit
-n count positive integer|capture packet count.
-f protocol string|protocol you want to filter. ip(Default) such as ip,
udp, tcp or icmp etc...
add_argument()
ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
定义单个的命令行参数应当如何解析：
- name or flags - 一个命名或者一个选项字符串的列表，例如
foo或-f, --foo。 - action - 当参数在命令行中出现时使用的动作基本类型。
- nargs - 命令行参数应当消耗的数目。
- const - 被一些 action 和 nargs选择所需求的常数。
- default - 当参数未在命令行中出现时使用的值。
- type- 命令行参数应当被转换成的类型。
- choices - 可用的参数的容器。
- required - 此命令行选项是否可省略 （仅选项可用）。
- help- 一个此选项作用的简单描述。
- metavar - 在使用方法消息中使用的参数值示例。
- dest - 被添加到
parse_args()所返回对象上的属性名。
argparse示例
import argparse
parser = argparse.ArgumentParser(prog="XSniff", description="Capturing Packets According to Network Protocol")
parser.add_argument("-n", type=int, metavar="count", default=None, dest="num", help="positive integer|capture packet count.")
parser.add_argument("-f", type=str, metavar="protocol", default="ip", dest="protocol", help="""
string|protocol you want to filter. ip(Default)
such as ip, udp, tcp or icmp etc...""")
args = parser.parse_args()
num = args.num
protocol = args.protocol
print("Capture {p} packets. Capture Num:{n}".format(p=protocol, n=num if num else "Inf"))
$ python XSniff.py
Capture ip packets. Capture Num:Inf
$ python XSniff.py -f tcp
Capture tcp packets. Capture Num:Inf
$ python XSniff.py -f tcp -n 10
Capture tcp packets. Capture Num:10