Python命令行解析模块详解


Posted in Python onFebruary 01, 2018

本文研究的主要是Python命令行解析模块的相关内容,具体如下。

Python命令行常见的解析器有两种,一是getopt模块,二是argparse模块。下面就解读下这两种解析器。

getopt模块

这个模块可以帮助脚本解析命令行参数,一般是sys.argv[1:]。它遵循着Unix的getopt()函数相同的约定(用-/--指定命令参数)。这个模块提供两个函数(getopt.getopt()/getopt.gnu_getopt())和一个参数异常(getopt.GetoptError)。

这里重点介绍getopt.getopt()这个函数。

函数原型:getopt.getopt(args, options[, long_options])

这个函数有三个参数:

  • args:脚本要解析的命令行参数;
  • options:命令行短选项,如果指定的短选项后面需要跟参数的话,要在相应短选项后面加“:”,如e:;
  • long_options:命令行长选项,这个参数是可选的。如果指定的长选项后面要跟参数的话,要在相应长选项后面加上“=”,如conding=;

当给定的命令行参数解析不了的话,就会抛出GetoptError异常。

函数的返回值包含两个元素:

  • 第一个元素是一个(option,value)元组对。Option是解析的参数,value是对应参数的值;
  • 第二个元素是脚本不需要执行的参数列表。也就是这些参数是多余的;

下面看几个Demo:

短选项:

>>> importgetopt
>>> args='-a -b -cfoo -d bar a1 a2'.split()
>>> args
['-a', '-b', '-cfoo', '-d', 'bar', 'a1','a2']
>>> optlist, args= getopt.getopt(args,'abc:d:')
>>> optlist
[('-a', ''), ('-b', ''), ('-c', 'foo'),('-d', 'bar')]
>>> args
['a1', 'a2']

长选项:

>>> s='--condition=foo --testing --output-file abc.def -x a1 a2'
>>> args= s.split()
>>> args
['--condition=foo', '--testing','--output-file', 'abc.def', '-x', 'a1', 'a2']
>>> optlist, args= getopt.getopt(args,'x', [
...   'condition=','output-file=','testing'])
>>> optlist
[('--condition', 'foo'), ('--testing', ''),('--output-file', 'abc.def'), ('-x', '')]
>>> args
['a1', 'a2']

在脚本当中经典的应用实例:

importgetopt,sys
 
defmain():
  try:
    opts, args = getopt.getopt(sys.argv[1:],"ho:v", ["help","output="])
  except getopt.GetoptErroras err:
    # print help information and exit:
    printstr(err) # will print something like "option -a not recognized"
    usage()
    sys.exit(2)
  output =None
  verbose =False
  for o, a in opts:
    if o =="-v":
      verbose =True
    elif o in ("-h","--help"):
      usage()
      sys.exit()
    elif o in ("-o","--output"):
      output = a
    else:
      assertFalse,"unhandled option"
  # ...
 
if __name__ =="__main__":
  main()

argparse模块

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

1. 创建一个解析器

使用argparse的第一步是创建一个ArgumentParser对象:

>>> parser= argparse.ArgumentParser()

ArgumentParser对象会保存把命令行解析成Python数据类型所需要的所有信息。

2. 添加参数

通过调用add_argument()方法向ArgumentParser添加程序的参数信息。通常情况下,这些信息告诉ArgumentParser如何接收命令行上的字符串并将它们转换成对象。这些信息被保存下来并在调用parse_args()时用到。例如:

>>> parser.add_argument('--name', help='username')
>>> parser.add_argument('--pass', help='password ')

接下来,调用parse_args()返回的对象将带有两个属性,name和pass。分别保存着用户名与密码。

3. 解析参数

ArgumentParser通过parse_args()方法解析参数。它将检查命令行,把每个参数转换成恰当的类型并采取恰当的动作。在大部分情况下,这意味着将从命令行中解析出来的属性建立一个简单的 Namespace对象。

>>> argments = parser.parse_args(['--name','li','--pass','si'])

在脚本中,parse_args() 调用一般不带参数,ArgumentParser 将根据sys.argv自动确定命令行参数。

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)

创建一个新的argmentParserr对象。所有的参数应该以关键字参数传递。下面有对每个参数各自详细的描述,但是简短地讲它们是:

  • prog - 程序的名字(默认:sys.argv[0])
  • useage - 描述程序用法的字符串(默认:从解析器的参数生成)
  • description - 参数帮助信息之前的文本(默认:空)
  • epilog- 参数帮助信息之后的文本(默认:空)
  • parents - ArgmentParser 对象的一个列表,这些对象的参数应该包括进去
  • ormatter_class - 定制化帮助信息的类
  • prefix_chars - 可选参数的前缀字符集(默认:‘-‘)
  • fromfile_prefix_chars - 额外的参数应该读取的文件的前缀字符集(默认:None)
  • argument_default - 参数的全局默认值(默认:None)
  • conflict_handler - 解决冲突的可选参数的策略(通常没有必要)
  • add_help - 给解析器添加-h/?help 选项(默认:True)

add_argument() 方法

ArgumentParser.add_argument(nameor 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()返回的对象要添加的属性名称。

总结

以上就是本文关于Python命令行解析模块详解的全部内容,希望对大家有所帮助。感兴趣的朋友可以继续参阅本站其他相关专题,如有不足之处,欢迎留言指出。感谢朋友们对本站的支持!

Python 相关文章推荐
python使用cStringIO实现临时内存文件访问的方法
Mar 26 Python
在Python的Django框架中编写错误提示页面
Jul 22 Python
python xlsxwriter库生成图表的应用示例
Mar 16 Python
python3+PyQt5使用数据库表视图
Apr 24 Python
Windows下python3.7安装教程
Jul 31 Python
完美解决python3.7 pip升级 拒绝访问问题
Jul 12 Python
使用 Python 处理 JSON 格式的数据
Jul 22 Python
Django使用 Bootstrap 样式修改书籍列表过程解析
Aug 09 Python
Python 实现递归法解决迷宫问题的示例代码
Jan 12 Python
Python中内建模块collections如何使用
May 27 Python
Python求区间正整数内所有素数之和的方法实例
Oct 13 Python
python爬取某网站原图作为壁纸
Jun 02 Python
python2.7到3.x迁移指南
Feb 01 #Python
Python Paramiko模块的使用实际案例
Feb 01 #Python
python中使用xlrd读excel使用xlwt写excel的实例代码
Jan 31 #Python
python使用tensorflow保存、加载和使用模型的方法
Jan 31 #Python
python通过elixir包操作mysql数据库实例代码
Jan 31 #Python
Django视图和URL配置详解
Jan 31 #Python
Python编程求质数实例代码
Jan 31 #Python
You might like
PHP逐行输出(ob_flush与flush的组合)
2012/02/04 PHP
PHP批量生成静态HTML的简单原理和方法
2014/04/20 PHP
浅析PHP编程中10个最常见的错误
2014/08/08 PHP
php+ajax实现无刷新数据分页的办法
2015/11/02 PHP
PHP字典树(Trie树)定义与实现方法示例
2017/10/09 PHP
jQuery 使用手册(六)
2009/09/23 Javascript
键盘 keycode的值 javascript时触发事件时很有用的要素
2009/11/02 Javascript
基于jquery的blockui插件显示弹出层
2011/04/14 Javascript
jquery 操作两个select实现值之间的互相传递
2014/03/07 Javascript
JavaScript实现彩虹文字效果的方法
2015/04/16 Javascript
jQuery实现时尚漂亮的弹出式对话框实例
2015/08/07 Javascript
js文本框走动跑马灯效果代码分享
2015/08/25 Javascript
javascript和jquery实现用户登录验证
2016/05/04 Javascript
require.js配合插件text.js实现最简单的单页应用程序
2016/07/12 Javascript
JS只能输入正整数的简单实例
2016/10/07 Javascript
js对象实例详解(JavaScript对象深度剖析,深度理解js对象)
2017/09/21 Javascript
详解mpvue开发微信小程序基础知识
2019/09/23 Javascript
countup.js实现数字动态叠加效果
2019/10/17 Javascript
vue setInterval 定时器失效的解决方式
2020/07/30 Javascript
详解vue实现坐标拾取器功能示例
2020/11/18 Vue.js
利用Python实现Windows定时关机功能
2017/03/21 Python
python使用Apriori算法进行关联性解析
2017/12/21 Python
python TCP Socket的粘包和分包的处理详解
2018/02/09 Python
Opencv-Python图像透视变换cv2.warpPerspective的示例
2019/04/11 Python
解决pycharm debug时界面下方不出现step等按钮及变量值的问题
2020/06/09 Python
详解KMP算法以及python如何实现
2020/09/18 Python
CSS3属性box-shadow使用详细教程
2012/01/21 HTML / CSS
Levi’s西班牙官方网站:李维斯,著名的牛仔裤品牌
2020/08/20 全球购物
什么是.net的Remoting技术
2016/07/08 面试题
机械设计专业应届生求职信
2013/11/21 职场文书
节电标语大全
2014/06/23 职场文书
护士医德医风自我评价
2014/09/15 职场文书
大学生见习报告范文
2014/11/03 职场文书
酒店员工辞职信范文
2015/02/28 职场文书
vue前端工程的搭建
2021/03/31 Vue.js
如何自己动手写SQL执行引擎
2021/06/02 MySQL