class ArgumentParser(_AttributeHolder, _ActionsContainer):
"""Object for parsing command line strings into Python objects. Keyword Arguments:
- prog -- The name of the program (default: sys.argv[0])
- usage -- A usage message (default: auto-generated from arguments)
- description -- A description of what the program does
- epilog -- Text following the argument descriptions
- parents -- Parsers whose arguments should be copied into this one
- formatter_class -- HelpFormatter class for printing help messages
- prefix_chars -- Characters that prefix optional arguments
- fromfile_prefix_chars -- Characters that prefix files containing
additional arguments
- argument_default -- The default value for all arguments
- conflict_handler -- String indicating how to handle conflicts
- add_help -- Add a -h/-help option
"""

取自argparse-1.4.0

1、prog 程序名(默认是sys.argv[0])

import argparse
parser = argparse.ArgumentParser()
arg = parser.parse_args()

运行结果:

argparse-learn]# python argparse-3.py -h
usage: argparse-3.py [-h] optional arguments:
-h, --help show this help message and exit

显示程序名为:argparse-3.py

可通过设置prog改变结果

import argparse
parser = argparse.ArgumentParser(prog="learn_argparse_3")
arg = parser.parse_args()

运行结果:

argparse-learn]# python argparse-3.py -h
usage: learn_argparse_3 [-h] optional arguments:
-h, --help show this help message and exit

可见程序名已经修改为learn_argparse_3

2、usage 程序的使用用例,默认情况下回自动生成

import argparse
parser = argparse.ArgumentParser(prog="learn_argparse_3",usage="[-h] [--help] [...] [what you want???]")
arg = parser.parse_args()

运行结果:

argparse-learn]# python argparse-3.py -h
usage: [-h] [--help] [...] [what you want???] optional arguments:
-h, --help show this help message and exit

这里可见learn_argparse_3没有打印,故在自定义usage是要注意。

可用:

import argparse
parser = argparse.ArgumentParser(prog="learn_argparse_3",usage="%(prog)s [-h] [--help] [...] [what you want???]")
parser.add_argument('bar', nargs='+', help='bar help')
arg = parser.parse_args()

运行结果:

argparse-learn]# python argparse-3.py -h
usage: learn_argparse_3 [-h] [--help] [...] [what you want???] positional arguments:
bar bar help optional arguments:
-h, --help show this help message and exit

3、description help参数之前显示的信息

import argparse
parser = argparse.ArgumentParser(prog="learn_argparse_3",
usage="%(prog)s [-h] [--help] [...] [what you want???]",
description="A learn program")
arg = parser.parse_args()

运行结果:

argparse-learn]# python argparse-3.py -h
usage: learn_argparse_3 [-h] [--help] [...] [what you want???] A learn program optional arguments:
-h, --help show this help message and exit

description经常会被调用用了简单的描述这个程序的用途,默认在信息的前后会有换行

4、epilog 收场白,可在最后加入你想展示的信息

import argparse
parser = argparse.ArgumentParser(prog="learn_argparse_3",
usage="%(prog)s [-h] [--help] [...] [what you want???]",
description="A learn program",
epilog="All for one, one for all")
arg = parser.parse_args()

结果:

argparse-learn]# python argparse-3.py -h
usage: learn_argparse_3 [-h] [--help] [...] [what you want???] A learn program optional arguments:
-h, --help show this help message and exit All for one, one for all

5、parents 有时候多个解析器共享一个参数,你可以将这个参数出递给parent

import argparse
parent_parser = argparse.ArgumentParser(add_help=False)
parent_parser.add_argument("--parent", type=int) parser = argparse.ArgumentParser(prog="learn_argparse_3",
usage="%(prog)s [-h] [--help] [...] [what you want???]",
description="A learn program",
epilog="All for one, one for all",
parents=[parent_parser])
arg = parser.parse_args()

运行结果:

argparse-learn]# python argparse-3.py -h
usage: learn_argparse_3 [-h] [--help] [...] [what you want???] A learn program optional arguments:
-h, --help show this help message and exit
--parent PARENT All for one, one for all

可见--parent 共享了

6、formatter_class 打印信息格式设定

    - HelpFormatter, RawDescriptionHelpFormatter, RawTextHelpFormatter,
ArgumentDefaultsHelpFormatter -- Formatter classes which
may be passed as the formatter_class= argument to the
ArgumentParser constructor. HelpFormatter is the default,
RawDescriptionHelpFormatter and RawTextHelpFormatter tell the parser
not to change the formatting for help text, and
ArgumentDefaultsHelpFormatter adds information about argument defaults
to the help.

摘自argparse-1.4.0

可见formatter_class有4个参数:HelpFormatter,RawDescriptionHelpFormatter,RawTextHelpFormatter,ArgumentDefaultsHelpFormatter

  • HelpFormatter 是默认参数
import argparse
parent_parser = argparse.ArgumentParser(add_help=False)
parent_parser.add_argument("--parent", type=int) parser = argparse.ArgumentParser(prog="learn_argparse_3",
usage="%(prog)s [-h] [--help] [...] [what you want???]",
description='''
other men live ti eat, while i eat to live -- socrates
love rules his kingdom without a sword -- herbert''',
epilog='''
All for one, one for all -- dumas
we soon believe what we desire -- chaucer
the darkest hour is that before the dawn -- fuller''',
parents=[parent_parser],
formatter_class=argparse.HelpFormatter)
arg = parser.parse_args()

运行结果:

argparse-learn]# python argparse-3.py -h
usage: learn_argparse_3 [-h] [--help] [...] [what you want???] other men live ti eat, while i eat to live -- socrates love rules his kingdom
without a sword -- herbert optional arguments:
-h, --help show this help message and exit
--parent PARENT All for one, one for all -- dumas we soon believe what we desire -- chaucer
the darkest hour is that before the dawn -- fuller

可见HelpFormatter粗暴的去除了所有的'\s' '\n'

  • RawDescriptionHelpFormatter,description和epilog不做修改原样输出
import argparse
parent_parser = argparse.ArgumentParser(add_help=False)
parent_parser.add_argument("--parent", type=int) parser = argparse.ArgumentParser(prog="learn_argparse_3",
usage="%(prog)s [-h] [--help] [...] [what you want???]",
description='''
other men live ti eat, while i eat to live -- socrates
love rules his kingdom without a sword -- herbert''',
epilog='''
All for one, one for all -- dumas
we soon believe what we desire -- chaucer
the darkest hour is that before the dawn -- fuller''',
parents=[parent_parser],
formatter_class=argparse.RawDescriptionHelpFormatter)
arg = parser.parse_args()

运行结果:

argparse-learn]# python argparse-3.py -h
usage: learn_argparse_3 [-h] [--help] [...] [what you want???] other men live ti eat, while i eat to live -- socrates
love rules his kingdom without a sword -- herbert optional arguments:
-h, --help show this help message and exit
--parent PARENT All for one, one for all -- dumas
we soon believe what we desire -- chaucer
the darkest hour is that before the dawn -- fuller

然源码中好像在line之间加入了个indent,不明所以,有知道的小伙伴可以指导下吗?

  • RawTextHelpFormatter  会保留预定意的帮助信息中的空格
  • ArgumentDefaultsHelpFormatter会在HelpFormatter的基础上打印默认值给参数(测试发现在add_argument中无help参数也不会显示default)
import argparse
parent_parser = argparse.ArgumentParser(add_help=False)
parent_parser.add_argument("--parent", type=int,default=[1, 2, 3, 4, 5, 6]) parser = argparse.ArgumentParser(prog="learn_argparse_3",
usage="%(prog)s [-h] [--help] [...] [what you want???]",
description='''
other men live ti eat, while i eat to live -- socrates love rules his kingdom without a sword -- herbert''',
epilog='''
All for one, one for all -- dumas
we soon believe what we desire -- chaucer
the darkest hour is that before the dawn -- fuller''',
parents=[parent_parser],
formatter_class=argparse.RawDescriptionHelpFormatter)
arg = parser.parse_args()

运行结果:

argparse-learn]# python argparse-3.py -h
usage: learn_argparse_3 [-h] [--help] [...] [what you want???] other men live ti eat, while i eat to live -- socrates love rules his kingdom without a sword -- herbert optional arguments:
-h, --help show this help message and exit
--parent PARENT All for one, one for all -- dumas
we soon believe what we desire -- chaucer
the darkest hour is that before the dawn -- fuller

default值并没有打印出来

import argparse
parent_parser = argparse.ArgumentParser(add_help=False)
parent_parser.add_argument("--parent", type=int,default=[1, 2, 3, 4, 5, 6,],help='parent') parser = argparse.ArgumentParser(prog="learn_argparse_3",
usage="%(prog)s [-h] [--help] [...] [what you want???]",
description='''
other men live ti eat, while i eat to live -- socrates love rules his kingdom without a sword -- herbert''',
epilog='''
All for one, one for all -- dumas
we soon believe what we desire -- chaucer
the darkest hour is that before the dawn -- fuller''',
parents=[parent_parser],
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
arg = parser.parse_args()

运行结果:

argparse-learn]# python argparse-3.py -h
usage: learn_argparse_3 [-h] [--help] [...] [what you want???] other men live ti eat, while i eat to live -- socrates love rules his kingdom
without a sword -- herbert optional arguments:
-h, --help show this help message and exit
--parent PARENT parent (default: [1, 2, 3, 4, 5, 6]) All for one, one for all -- dumas we soon believe what we desire -- chaucer
the darkest hour is that before the dawn -- fuller

7、prefix_chars 自定义前缀,默认'-'

import argparse
parent_parser = argparse.ArgumentParser(add_help=False)
parent_parser.add_argument("--parent", type=int,default=[1, 2, 3, 4, 5, 6,],help='parent') parser = argparse.ArgumentParser(prog="learn_argparse_3",
usage="%(prog)s [-h] [--help] [...] [what you want???]",
description='''
other men live ti eat, while i eat to live -- socrates love rules his kingdom without a sword -- herbert''',
epilog='''
All for one, one for all -- dumas
we soon believe what we desire -- chaucer
the darkest hour is that before the dawn -- fuller''',
parents=[parent_parser],
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prefix_chars='=')
arg = parser.parse_args()

这是不能用“python argparse-3.py -h”,会报错

运行结果:

argparse-learn]# python argparse-3.py =h
usage: learn_argparse_3 [-h] [--help] [...] [what you want???] other men live ti eat, while i eat to live -- socrates love rules his kingdom
without a sword -- herbert optional arguments:
=h, ==help show this help message and exit
--parent PARENT parent (default: [1, 2, 3, 4, 5, 6]) All for one, one for all -- dumas we soon believe what we desire -- chaucer
the darkest hour is that before the dawn -- fuller

8、fromfile_prefix_chars 有时候将从文件中读取参数,如果设置fromfile_prefix_chars参数的话,解析器会将带有这个前缀的参数当作文件处理

import argparse
parser = argparse.ArgumentParser(fromfile_prefix_chars='@')
parser.add_argument('-f')
print parser.parse_args(['-f', 'foo', '@args.txt'])

9、argument_default 给所有没有默认值的参数设置默认值。

import argparse
parent_parser = argparse.ArgumentParser(add_help=False)
parent_parser.add_argument("--parent", type=int,default=[1, 2, 3, 4, 5, 6,],help='parent')
parser = argparse.ArgumentParser(prog="learn_argparse_3",
usage="%(prog)s [-h] [--help] [...] [what you want???]",
description='''
other men live ti eat, while i eat to live -- socrates love rules his kingdom without a sword -- herbert''',
epilog='''
All for one, one for all -- dumas
we soon believe what we desire -- chaucer
the darkest hour is that before the dawn -- fuller''',
parents=[parent_parser],
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prefix_chars='-',
fromfile_prefix_chars='$',
argument_default='The default value for all arguments')
parser.add_argument('--argument_default')
print parser.parse_args()

运行结果:

Namespace(argument_default='The default value for all arguments', parent=[1, 2, 3, 4, 5, 6])

10、conflict_handler argumentparser对象不允许传入俩个相同的参数,否则会报错,通过设置conflict_handler为resolve,可以用新的参数覆盖旧的同名参数

import argparse
parser = argparse.ArgumentParser(prog="learn_argparse_4",
conflict_handler='resolve')
parser.add_argument('-b','--boy',help='boy')
parser.add_argument('--boy',help='girl')
parser.print_help()

运行结果:

argparse-learn]# python argparse-4.py
usage: learn_argparse_4 [-h] [-b BOY] [--boy BOY] optional arguments:
-h, --help show this help message and exit
-b BOY boy
--boy BOY girl

11、add_help默认情况下ArgumentParser对象对自动添加-h/--help选项,可设置add_help=False取消

import argparse
parser = argparse.ArgumentParser(prog="learn_argparse_4",
add_help=False)
parser.add_argument('boy',help='good boy help')
parser.print_help()

运行结果:

argparse-learn]# python argparse-4.py
usage: learn_argparse_4 boy positional arguments:
boy good boy help

python argparse(参数解析)模块学习(一)的更多相关文章

  1. python argparse(参数解析模块)

    这是一个参数解析,可以用它快捷的为你的程序生成参数相关功能 import argparse(导入程序参数模块) # 创建argparse对象,并将产品简要说明加入show = '程序说明' ===&g ...

  2. python之参数解析模块argparse

    2.7之后python不再对optparse模块进行扩展,python标准库推荐使用argparse模块对命令行进行解析. 简单入门 先来看个例子: argparse_test.py: import ...

  3. python命令行参数解析模块argparse和docopt

    http://blog.csdn.net/pipisorry/article/details/53046471 还有其他两个模块实现这一功能,getopt(等同于C语言中的getopt())和弃用的o ...

  4. python命令行解析模块--argparse

    python命令行解析模块--argparse 目录 简介 详解ArgumentParser方法 详解add_argument方法 参考文档: https://www.jianshu.com/p/aa ...

  5. $命令行参数解析模块argparse的用法

    argparse是python内置的命令行参数解析模块,可以用来为程序配置功能丰富的命令行参数,方便使用,本文总结一下其基本用法. 测试脚本 把以下脚本存在argtest.py文件中: # codin ...

  6. Python命令行参数解析模块getopt使用实例

    Python命令行参数解析模块getopt使用实例 这篇文章主要介绍了Python命令行参数解析模块getopt使用实例,本文讲解了使用语法格式.短选项参数实例.长选项参数实例等内容,需要的朋友可以参 ...

  7. Python 日期时间处理模块学习笔记

    来自:标点符的<Python 日期时间处理模块学习笔记> Python的时间处理模块在日常的使用中用的不是非常的多,但是使用的时候基本上都是要查资料,还是有些麻烦的,梳理下,便于以后方便的 ...

  8. Python命令行参数解析模块argparse

    当写一个Python脚本时经常会遇到不同参数不同功能的情况,如何做一个更好看的命令帮助信息以及对命令参数解析呢? 这就需要使用argparse模块 #!/usr/bin/env python # -* ...

  9. python之命令行参数解析模块argparse

    """argparse模块使得写用户友好性命令行接口很容易,程序定义所需要的参数,argparse会从ays.argv中提取出这些参数.argparse模块也能自动的产生 ...

  10. Day5 - Python基础5 常用模块学习

    Python 之路 Day5 - 常用模块学习   本节大纲: 模块介绍 time &datetime模块 random os sys shutil json & picle shel ...

随机推荐

  1. python: ImportError:DLL load failed 解决方法。

    在学习使用wordcloud 库创建词云过程中,mooc里提到可以使用另一个库函数,来创建不同形状的词云. 就是这句: ... from scipy.misc import imread mk = i ...

  2. exe4j使用说明

    1:首先下载exe4j,软件根据电脑的版本下载(32bit or 64bit,本人的电脑是64bit),我下载的是没显示电脑版本的exe4j,有本地导入的选项和联网下载的选项,安装jre后才能进入-图 ...

  3. hasura graphql-engine 集成zombodb

    zombodb 是一个很不错的pg 扩展,可以方便的把es 与pg 集成起来,使用方便 ,目前尽管有一些docker 镜像 但是版本都比较老,所以基于centos7 做了一个新的docker 镜像,同 ...

  4. Centos7.4安装配置haproxy和Keepalived

    系统版本是centos7.4的 [root@data-1-1 ~]# cat /etc/redhat-release CentOS Linux release 7.4.1708 (Core) [roo ...

  5. WebForm AnyWay

    项目地址 :  https://github.com/kelin-xycs/WebFormAnyWay WebForm AnyWay 用 WebForm 构建 简洁高效 的 Web 应用 WebFor ...

  6. 浅谈JS的数组遍历方法

    用过Underscore的朋友都知道,它对数组(集合)的遍历有着非常完善的API可以调用的,_.each()就是其中一个.下面就是一个简单的例子: var arr = [1, 2, 3, 4, 5]; ...

  7. Flutter 知识点

    Flutter:一个移动应用开发框架,它使用 Dart.C++.Skia 开发,对外提供了完全不依赖系统平台的 Widget 的能力,只通过自绘图形的方式工作,具有极其优秀的跨平台性.目前已经支持了 ...

  8. E212: Can't open file for writing Press ENTER or type command to continue

    E212: Can't open file for writing Press ENTER or type command to continue 出现这个错误的原因可能有两个: 1.当前用户的权限不 ...

  9. Unity Lighting(一)光照练习

    Unity 2018.1.2f1 原文链接:https://www.youtube.com/watch?v=VnG2gOKV9dw Unity Lighting练习最终效果 眼睛.光源与物体 光学基础 ...

  10. ubuntu server cloud img username password

    新安装了OpenStack Queens发现无镜像,蹦蹦跳跳的下载了ubuntu的镜像 网址https://cloud-images.ubuntu.com/ 最好你自己找你想要的,vmdk.ova.i ...