python之argparse模块_argparse 参数缩写-程序员宅基地

技术标签: python  class  

argparse 模块使编写用户友好的命令行界面变得更容易.程序只需定义好它要求的参数,然后argparse将负责如何从sys.argv中解析出这些参数。argparse模块还会自动生成帮助和使用信息并且当用户赋给程序非法的参数时产生错误信息。

1.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:程序的名字
  • usage:默认情况下,ArgumentParser依据它包含的参数计算出帮助信息
  • description:这个参数给出程序做什么以及如何工作的简短描述
  • epilog:显示额外的关于程序的描述
  • parents:有时候,几个解析器会共享一个共同的参数集。可以使用一个带有所有共享参数的解析器传递给ArgumentParser的parents=参数,而不用重复定义这些参数
  • formatter_class:ArgumentParser对象允许通过指定一个格式化类来定制帮助信息的格式(argparse.RawDescriptionHelpFormatter、argparse.RawTextHelpFormatter、argparse.ArgumentDefaultsHelpFormatter、argparse.MetavarTypeHelpFormatter)
  • prefix_chars:修改前缀符
  • fromfile_prefix_chars:以任意一个给定字符开始的参数将被当做文件,并且将被这些文件包含的参数替换
  • argument_default:指定一个解析器范围的参数默认值
  • allow_abbrev:允许使用缩写(默认)
  • conflict_handler:关于设置同一个选项具有两个动作
  • add_help

2.ArgumentParser对象add_argument()方法

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

参数

  • name or flags:传递给add_argument() 的第一个参数因此必须是一个标记序列或者一个简单的参数名字
  • action:指出应该如何处理命令行参数(支持的操作:’store’ ,’store_const’,’store_true’,’store_false’,’append’,’append_const’,’count’,’help’,’version’)
  • nargs:将一个动作与不同数目的命令行参数关联在一起(支持的值:N,’?’,’*’,’+’)
  • const:用于保存常量值,它们不是从命令行读入但是是ArgumentParser 的动作所要求的
  • default:其默认值为None,指出如果命令行参数没有出现时它们应该是什么值
  • type:允许任意必要的类型检查并作类型转换
  • choices:某些命令行参数应该从一个受限的集合中选择
  • required:如果要使得选项是必需的,可以指定True作为required=关键字参数的值给add_argument()
  • help:包含参数简短描述的字符串
  • metavar:默认情况下,对于位置参数直接使用dest的值,对于可选参数则将dest的值变为大写。注意metavar只会改变显示出来的名字parse_args() 对象中属性的名字仍然由dest的值决定。
  • dest:对于位置参数的动作,dest 通常作为第一个参数提供给add_argument(),对于可选参数的动作,dest的动作通常从选项字符串推导出来,如:ArgumentParser生成的dest的值是将第一个长的选项字符串前面的–字符串去掉。如果没有提供长选项字符串,dest的获得则是将第一个短选项字符串前面的-字符去掉。任何内部的-将被转换为字符以确保字符串是合法的属性名字。(即对于可选参数,先找长的选项字符串,再找短选项字符串,并且内部的-会被转换为字符。)

Action类
class argparse.Action(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

3.ArgumentParser对象parse_args()方法

将参数字符串转换成对象并设置成命名空间的属性。返回构成的命名空间。
之前对add_argument() 的调用完全决定了创建什么对象以及如何设置。

选项值语法,parse_args()方法支持几种指定一个选项的值的方法:

  • 最简单的方法是,将选项和它的值以两个分开的参数传递
  • 对于长选项(名字长度超过一个字符的选项),选项和它的值还可以用一个单一的命令行参数传递,并用=分隔它们
  • 对于短选项(长度只有一个字符的选项),选项及其值可以连在一起
  • 几个短选项可以连在一起仅使用一个-前缀,只要只有最后一个选项要求有值或者都不要有值

无效参数
在解析命令行的同时,parse_args()会检查各种错误,包括有歧义的选项、不合法的类型、不合法的选项、错误的位置参数个数等等。当它遇到此类错误时,会退出并跟随用法信息一起打印出错误。

参数包含“ - ”
parse_args()方法每当用户犯了明确的错误时会努力给出错误信息,但是有些情况天生就有歧义。例如,命令行参数-1既可以是想指明一个选项也可以是想提供一个位置参数。这里parse_args()会非常小心:位置参数只有在它们看上去像负数且解析器中没有选项看上去是负数时才可以以-开始。
如果你有必须以- 开始的位置参数且不是负数,你可以插入伪参数’–’告诉parse_args()其后的所有内容都为位置参数。

参数缩写(前缀匹配)

参数不来自sys.argv
有时候可能需要ArgumentParser解析的参数不是来自sys.argv。这可以通过传递一个字符串列表给parse_args()来完成

4.class argparse.Namespace

parse_args() 默认使用的简单的类,用于创建一个保存属性的对象并返回该对象。
有时可能需要让ArgumentParser分配属性给一个已经存在的对象而不是一个新的Namespace对象。这可以通过指定namespace=关键字参数达到。

其它实用工具
ArgumentParser.add_subparsers([title][, description][, prog][, parser_class][, action][, option_string][, dest][, help][, metavar])
class argparse.FileType(mode=’r’, bufsize=-1, encoding=None, errors=None)
ArgumentParser.add_argument_group(title=None, description=None)
ArgumentParser.add_mutually_exclusive_group(required=False)ArgumentParser.set_defaults(**kwargs)
打印帮助

  • ArgumentParser.print_usage(file=None)
  • ArgumentParser.print_help(file=None)
  • ArgumentParser.format_usage()
  • ArgumentParser.format_help()

ArgumentParser.parse_known_args(args=None, namespace=None)
ArgumentParser.convert_arg_line_to_args(arg_line)
ArgumentParser.exit(status=0, message=None)
ArgumentParser.error(message)

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/qq_14898613/article/details/54136223

智能推荐

响应式web设计体会_响应式web心得感悟-程序员宅基地

文章浏览阅读2.5k次。响应式web设计这里要推荐一本书《响应式Web设计:HTML5和CSS3实战》,书里对响应式web设计有比较详细的说明。响应式web设计的目的:可以使web页面能自动的对设备尺寸进行适配。响应式web设计的主要方法:使用css的media来查询当前设备的状态,主要的是显示尺寸,然后对不同的尺寸的设备编写不同的css使得web在不同尺寸的情况下显示不同的页面布局,文字大小,图片尺寸等。在_响应式web心得感悟

pandas读取文件-程序员宅基地

文章浏览阅读1.8w次,点赞15次,收藏106次。读取文件一、pandas读取文件用法1、pandas读取xlsx、xls文件import pandas as pddata=pd.read_excel('path',sheetname='sheet1',header=0,names=['第一列','第二列','第三列'])path:要读取的文件的绝对路径sheetname:指定读取excel中的哪一个工作表,默认sheetname=0,即默认读取excel中的第一个工作表若sheetname = ‘sheet1’,即读取excel中_pandas读取文件

增程汽车 插电式串联混动汽车Matlab Simulink软件模型,动力性、经济性仿真计算_matlab仿真混合动力汽车simulink模型基于动态规划算-程序员宅基地

文章浏览阅读1k次。1.本模型基于Matlab Simulink搭建,包含:电池、电机、发动机、整车纵向动力学、控制策略、驾驶员等模块。增程汽车 插电式串联混动汽车Matlab Simulink软件模型,动力性、经济性仿真计算。2.模型搭建时参考了部分mathwork官方模型,但比官方模型更容易理解。增程器控制策略采用跟随负载功率的控制,可以使SOC保持在设定目标附近。3.模型所有模块完全开放,无任何封装,更方便后期升级与改制。同时输入数据采用m脚本文件编辑,更容易管理。4.模型可用于课题研究、项目开发参考。_matlab仿真混合动力汽车simulink模型基于动态规划算

tslib移植实践-程序员宅基地

文章浏览阅读371次。移植准备开发环境PC系统:ubuntu-16.04-desktop-amd64.iso交叉编译器:arm-Linux-gcc 4.4.3硬件平台:mini2440开发板文件系统镜像制作工具mkyaffs2image-128M镜像下载工具MiniToolstslib源码下载https://github.com/libts/tslib/releases 下载 tslib-1.0...._tslib移植

MinGW_mingw seup-程序员宅基地

文章浏览阅读1.1k次。MinGWMingW(Minimalist GNU on Windows)是一个Linux/Windows下的可以把软件源码中Unix-like OS API调用通过头文件翻译替换成相应的Windows API调用的编译环境,从而把Linux上的软件在不修改源码的情况下编译为可直接在Win下的可执行文件.MinGW提供了一个完整的开源编程工具集,该工具集适用于MS-Windows应用程序的开发,并且不依赖于任何第三方C-Runtime DLLMinGW包括:GNU编译器集合(GCC),包括C,_mingw seup

【算法训练-动态规划 三】【双序列DP问题】最长重复子数组、最长公共子串、最长公共子序列、编辑距离_最长重复子数组和最长公共子序列 dp数组定义-程序员宅基地

文章浏览阅读683次。对于本题而言,可以定义dp[i][j]表示和的最长公共子序列。表示的是 text1 的 第 0 个元素到第 i - 1 个元素,两端都包含) 之所以dp[i][j]的定义不是text1[0:i]和text[0:j],是为了方便当 i = 0 或者 j = 0 的时候,dp[i][j]表示空字符串和另外一个字符串的匹配,这样dp[i][j]可以初始化为空字符串对于本题而言,可以定义dp[i][j]表示和的最长公共子序列。表示的是 text1 的 第 0 个元素到第 i - 1 个元素,两端都包含) 之所以。_最长重复子数组和最长公共子序列 dp数组定义

随便推点

expat win10+vs2015编译_vc expat-程序员宅基地

文章浏览阅读1.1k次。Expat是一个用C语言开发的、用来解析XML文档的开发库,它最初是开源的、Mozilla 项目下的一个XML解析器。1.下载expat安装文件 百度云盘:http://pan.baidu.com/s/1hsMdEhm 密码:pg1e2.安装expat-win32bin-2.2.0.exe 安装目录随自己设置,最好不要在C盘,因为C盘有权限问题。3.在安装目录找到V..._vc expat

android系统签名后找不到类,Android系统签名简介-程序员宅基地

文章浏览阅读192次。apk的签名,简单说开发者可以通过签名 对应用进行标识和更新。包名在一个设备上是唯一的,这样可以避免被相同包名应用随意覆盖安装。这是一个非常重要的安全功能。系统中的签名文件,也是对系统中应用进行签名,编译应用是可以指定签名类型。下面介绍的是Android系统中的签名相关内容。Android系统中的主要签名文件media.pk8,media.x509.pem;platform.pk8,platfor..._找不到/build/target/product/security

【IDEA 教程系列第 18 篇】idea 快速从光标处选中内容到行首或行尾_idea 选中到行尾-程序员宅基地

文章浏览阅读5.4k次,点赞7次,收藏7次。idea 快速从光标处选中内容到行首或行尾_idea 选中到行尾

二叉树的创建,递归和非递归遍历_二叉树的创建,递归和非递归遍历-程序员宅基地

文章浏览阅读375次。递归的实现很简单,我就不介绍了;下面我就说说非递归遍历1. 先序非递归遍历 根据前序遍历访问的顺序,优先访问根结点,然后再分别访问左孩子和右孩子。即对于任一结点,其可看做是根结点,因此可以直接访问,访问完之后,若其左孩子不为空,按相同规则访问它的左子树;当访问其左子树时,再访问它的右子树。因此其处理过程如下: 对于任一结点P: 1)访问结点P,_二叉树的创建,递归和非递归遍历

Java Web文件管理课程设计 网站地址_java 设计网页文件夹-程序员宅基地

文章浏览阅读518次。体验网站地址:http://jw.chenr.cn/github地址:https://github.com/CCZX/Java-Web_java 设计网页文件夹

GP232RNL兼容替代FT232RL/FT232RNL USB转UART桥接控制器芯片低成本方案_ft232rnl与ft232rl区别-程序员宅基地

文章浏览阅读1k次,点赞19次,收藏19次。GP232RNL是一款高度集成的USB到UART桥接控制器,提供了一种简单的解决方案,可以使用最少的元器件和PCB空间,将RS232接口转换为USB接口。GP232RNL 包括-一个USB 2. 0全速功能控制器、USB收发器、振荡器、EEPROM和带有完整的调制解调器控制信号的异步串行数据总线(UART), 集成在SS0P28封装中,不需要其他外部USB元件。●集成1024位EEPROM,用于存储供应商ID、产品ID、序列号、电源描述符、版本号、产品描述字符串和CBUSI/O配置;_ft232rnl与ft232rl区别

推荐文章

热门文章

相关标签