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 将RGB图像转换为Pytho灰度图像的实例
Nov 14 Python
python文本数据相似度的度量
Mar 12 Python
python 重定向获取真实url的方法
May 11 Python
python GUI图形化编程wxpython的使用
Jul 19 Python
python之PyQt按钮右键菜单功能的实现代码
Aug 17 Python
Python的Lambda函数用法详解
Sep 03 Python
python shutil文件操作工具使用实例分析
Dec 25 Python
pycharm 中mark directory as exclude的用法详解
Feb 14 Python
Python使用requests xpath 并开启多线程爬取西刺代理ip实例
Mar 06 Python
解决django中form表单设置action后无法回到原页面的问题
Mar 13 Python
python 服务器运行代码报错ModuleNotFoundError的解决办法
Sep 16 Python
pyqt5打包成exe可执行文件的方法
May 14 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 伪静态之IIS篇
2014/06/02 PHP
浅谈php数组array_change_key_case() 函数和array_chunk()函数
2016/10/22 PHP
用javascript实现读取txt文档的脚本
2007/07/20 Javascript
深入理解JavaScript系列(13) This? Yes,this!
2012/01/18 Javascript
javascript动态加载二
2012/08/22 Javascript
javascript中加号(+)操作符的一些神奇作用
2014/06/06 Javascript
JS自动倒计时30秒后按钮才可用(两种场景)
2015/08/31 Javascript
浅谈bootstrap源码分析之tab(选项卡)
2016/06/06 Javascript
Input文本框随着输入内容多少自动延伸的实现
2017/02/15 Javascript
Vue表单验证插件Vue Validator使用方法详解
2017/04/07 Javascript
Vue-cli-webpack搭建斗鱼直播步骤详解
2017/11/17 Javascript
基于js 字符串indexof与search方法的区别(详解)
2017/12/04 Javascript
Angularjs实现控制器之间通信方式实例总结
2018/03/27 Javascript
npm 常用命令详解(小结)
2019/01/17 Javascript
Vue CLI2升级至Vue CLI3的方法步骤
2019/05/20 Javascript
vue自动化路由的实现代码
2019/09/30 Javascript
Python-基础-入门 简介
2014/08/09 Python
python实现中文输出的两种方法
2015/05/09 Python
对Python中Iterator和Iterable的区别详解
2018/10/18 Python
python写入文件自动换行问题的方法
2019/07/05 Python
python selenium爬取斗鱼所有直播房间信息过程详解
2019/08/09 Python
一文弄懂Pytorch的DataLoader, DataSet, Sampler之间的关系
2020/07/03 Python
如何解决pycharm调试报错的问题
2020/08/06 Python
Python批量修改xml的坐标值全部转为整数的实例代码
2020/11/26 Python
python 利用jieba.analyse进行 关键词提取
2020/12/17 Python
应届大学生求职信
2013/12/01 职场文书
洗煤厂厂长岗位职责
2014/01/03 职场文书
竞聘上岗演讲稿范文
2014/01/10 职场文书
优秀护士先进事迹
2014/05/08 职场文书
英语分层教学实施方案
2014/06/15 职场文书
政风行风评议个人心得体会
2014/10/29 职场文书
2015世界地球日活动总结
2015/02/09 职场文书
服务员岗位职责范本
2015/04/09 职场文书
导游带团欢迎词
2015/09/30 职场文书
springboot使用Redis作缓存使用入门教程
2021/07/25 Redis
Python使用PyYAML库读写yaml文件的方法
2022/04/06 Python