Python学习之--argparse 模块 +ls功能模块实现举例

Python–argparse 模块

一、简介

argparse模块可以让人轻松编写用户友好的命令行接口。程序定义它需要的参数，然后 argparse 将弄清如何从 sys.argv 解析出那些参数。 argparse模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息。

二、使用步骤

1：import argparse    # 首先导入模块
2：parser = argparse.ArgumentParser()  # 创建一个解析对象 
3：parser.add_argument()
# 然后向该对象中添加你要关注的命令行参数和选项，每一个add_argument方法对应一个你要关注的参数或选项；
4：parser.parse_args()  #最后调用parse_args()方法进行解析；

三、创建解析器对象[ArgumentParser]

# 详细参数如下:
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)

其中:

prog: 程序的名字,默认为sys.argv[0],用来在help信息中描述程序的名称.

​ 这里的sys.argv[0] 返回的值是该文件名,如test.py ,那么缺省prog = test.py

usage: 描述程序用途的字符串

description: help 信息前的文字

epilog: help 信息之后的信息

import argparse
parse = argparse.ArgumentParser(prog = 'argparseDemo',prefix_chars= '+',description='the message info before help info',
epilog="the message info after help info")
parse.print_help()

输出结果为:

usage: argparseDemo [+h]

the message info before help info

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

the message info after help info

add_help: 设为``False`时,help 信息里不显示 [-h],[–help]信息

prefix-chars: 参数前缀,默认为’-’

举例:

import argparse
parse = argparse.ArgumentParser(prog = 'argparseDemo',prefix_chars= '+',add_help= False)
parse.add_argument('+f')
parse.add_argument('++bar')
print (parse.parse_args())
parse.print_help()

输出

Namespace(bar=None, f=None)
# 下面的内容为parse.print_help()  打印出的内容,表示的是帮助内的信息,如果add_help =False ,则就不显示  +h +help 注释掉的那一行
usage: argparseDemo [+h] [+f F] [++bar BAR]

optional arguments:
  #  +h, ++help  show this help message and exit  
  +f F
  ++bar BAR

fromfile_prefix_chars：前缀字符，放在文件名之前
argument_default：参数的全局默认值。
conflict_handler：对冲突的处理方式，默认为返回错误“error”。还有“resolve”，智能解决冲突。当用户给程序添加了两个一样的命令参数时，“error”就直接报错，提醒用户。而“resolve”则会去掉第一次出现的命令参数重复的部分或者全部（可能是短命令冲突或者全都冲突）。

import argparse
parse = argparse.ArgumentParser(prog = 'argparseDemo')
parse.add_argument('-f', '--foo', help='old foo help')
parse.add_argument('--foo', help='new foo help')
parse.print_help()

输出

# 会直接报错,错误内容为:
argparse.ArgumentError: argument -f/--foo: conflicting option string(s): --foo

添加conflict_handler策略后

parse = argparse.ArgumentParser(prog = 'argparseDemo',conflict_handler = 'resolve')
>>>
usage: argparseDemo [-h] [-f FOO] [--foo FOO]

optional arguments:
  -h, --help  show this help message and exit
  -f FOO      old foo help
  --foo FOO   new foo help
# 加了之后运行变不在出现报错 

四、add_argument()方法，用来指定程序需要接受的命令参数

#add_argument 的语法为:
add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar]