首页 > 编程语言 > 详细

20151130 python的argparse模块

时间:2015-12-01 14:52:20      阅读:337      评论:0      收藏:0      [点我收藏+]

一、简介:

argparse是python用于解析命令行参数和选项的标准模块,用于代替已经过时的optparse模块。argparse模块的作用是用于解析命令行参数,例如python parseTest.py input.txt output.txt --user=name --port=8080。

二、使用步骤:

1:import argparse

2:parser = argparse.ArgumentParser()

3:parser.add_argument()

4:parser.parse_args()

解释:首先导入该模块;然后创建一个解析对象;然后向该对象中添加你要关注的命令行参数和选项,每一个add_argument方法对应一个你要关注的参数或选项;最后调用parse_args()方法进行解析;解析成功之后即可使用,下面简单说明一下步骤2和3。

? ?

三、方法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)

这些参数都有默认值,当调用parser.print_help()或者运行程序时由于参数不正确(此时python解释器其实也是调用了pring_help()方法)时,会打印这些描述信息,一般只需要传递description参数,如上。

四、方法add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

其中:

name or flags:命令行参数名或者选项,如上面的address或者-p,--port.其中命令行参数如果没给定,且没有设置defualt,则出错。但是如果是选项的话,则设置为None

nargs:命令行参数的个数,一般使用通配符表示,其中,‘?‘表示只用一个,‘*‘表示0到多个,‘+‘表示至少一个

default:默认值

type:参数的类型,默认是字符串string类型,还有float、int等类型

help:和ArgumentParser方法中的参数作用相似,出现的场合也一致

  1. #?-*-?coding:?utf-8?-*-??
  2. ?? ?
  3. import?argparse??
  4. ?? ?
  5. args?=?"-f?hello.txt?-n?1?2?3?-x?100?-y?b?-z?a?-q?hello?@args.txt?i_am_bar?-h".split()???
  6. #?使用@args.txt要求fromfile_prefix_chars="@"??
  7. #?args.txt文件中应该一行一个参数,想改变行为参考convert_arg_line_to_args()??
  8. ?? ?
  9. ?? ?
  10. #?ArgumentParser参数的简单说明??
  11. ##?description?-?命令行帮助的开始文字,大部分情况下,我们只会用到这个参数??
  12. #?epilog?-?命令行帮助的结尾文字??
  13. #?prog?-?(default:?sys.argv[0])程序的名字,一般不需要修改,另外,如果你需要在help中使用到程序的名字,可以使用%(prog)s??
  14. #?prefix_chars?-?命令的前缀,默认是-,例如-f/--file。有些程序可能希望支持/f这样的选项,可以使用prefix_chars="/"??
  15. #?fromfile_prefix_chars?-?(default:?None)如果你希望命令行参数可以从文件中读取,就可能用到。例如,如果fromfile_prefix_chars=‘@‘,命令行参数中有一个为"@args.txt"args.txt的内容会作为命令行参数??
  16. #?add_help?-?是否增加-h/-help选项?(default:?True),一般help信息都是必须的,所以不用设置啦。??
  17. ##??parents?-?类型是list,如果这个parser的一些选项跟其他某些parser的选项一样,可以用parents来实现继承,例如parents=[parent_parser]??
  18. ##?formatter_class?-?自定义帮助信息的格式(descriptionepilog)。默认情况下会将长的帮助信息进行<自动换行和消除多个连续空白>??
  19. #三个允许的值:??
  20. #?class?argparse.RawDescriptionHelpFormatter?直接输出descriptionepilog的原始形式(不进行自动换行和消除空白的操作)??
  21. #?class?argparse.RawTextHelpFormatter?直接输出descriptionepilog以及add_argument中的help字符串的原始形式(不进行自动换行和消除空白的操作)??
  22. ##?class?argparse.ArgumentDefaultsHelpFormatter?在每个选项的帮助信息后面输出他们对应的缺省值,如果有设置的话。这个最常用吧!??
  23. #?argument_default?-?(default:?None)设置一个全局的选项的缺省值,一般每个选项单独设置,所以这个参数用得少,不细说??
  24. #?usage?-?(default:?generated)如果你需要修改usage的信息(usage:?PROG?[-h]?[--foo?[FOO]]?bar?[bar?...]),那么可以修改这个,一般不要修改。??
  25. #?conflict_handler?-?不建议使用。这个在极端情况下才会用到,主要是定义两个add_argument中添加的选项的名字发生冲突时怎么处理,默认处理是抛出异常。??
  26. #注释一行有##表示这几个参数比较常用??
  27. parser?=?argparse.ArgumentParser(description="This?is?a?description?of?%(prog)s",?epilog="This?is?a?epilog?of?%(prog)s",?prefix_chars="-+",?fromfile_prefix_chars="@",?formatter_class=argparse.ArgumentDefaultsHelpFormatter)??
  28. ?? ?
  29. #?ArgumentParser.add_argument(name?or?flags...[,?action][,?nargs][,?const][,?default][,?type][,?choices][,?required][,?help][,?metavar][,?dest])??
  30. #?add_argument的参数是比较复杂的。。。??
  31. ?? ?
  32. #?name?or?flags?-?指定参数的形式,想写几个写几个,不过我们一般就写两个,一个短参数,一个长参数,看下面的例子"-f",?"--file"??
  33. #?可选的选项,位置不固定,想怎么写就怎么写,默认是可选的??
  34. parser.add_argument("-f",?"--file",?help="test?test?test")??
  35. #?位置固定的选项,例如"prog?i_am_bar",这样子的话,i_am_bar就是bar选项的值啦,默认是必须有的??
  36. parser.add_argument("bar",?help="test?test?test")??
  37. ?? ?
  38. #?nargs?-?指定这个参数后面的value有多少个,例如,我们希望使用-n?1?2?3?4,来设置n的值为[1,?2,?3,?4]??
  39. parser.add_argument("-n",?"--num",?nargs="+",?type=int)??
  40. #?这里nargs="+"表示,如果你指定了-n选项,那么-n后面至少要跟一个参数,+表示至少一个,?表示一个或0,*0个或多个,??
  41. ?? ?
  42. #?default?-?如果命令行没有出现这个选项,那么使用default指定的默认值??
  43. parser.add_argument("+g",?"++gold",?help="test?test?test",?default="test_gold")#需要prefix_chars包含"+"??
  44. ?? ?
  45. #?type?-?如果希望传进来的参数是指定的类型(例如?float,?int?or?file等可以从字符串转化过来的类型),可以使用??
  46. parser.add_argument("-x",?type=int)??
  47. ?? ?
  48. #?choices?-?设置参数值的范围,如果choices中的类型不是字符串,记得指定type??
  49. parser.add_argument("-y",?choices=[‘a‘,?‘b‘,?‘d‘])??
  50. ?? ?
  51. #?required?-?通常-f这样的选项是可选的,但是如果required=True那么就是必须的了??
  52. parser.add_argument("-z",?choices=[‘a‘,?‘b‘,?‘d‘],?required=True)??
  53. ?? ?
  54. #?metavar?-?参数的名字,在显示?帮助信息时才用到.??
  55. parser.add_argument("-o",?metavar="OOOOOO")??
  56. ?? ?
  57. #?help?-?设置这个选项的帮助信息??
  58. #?dest?-?设置这个选项的值就是解析出来后放到哪个属性中??
  59. parser.add_argument("-q",?dest="world")???
  60. ?? ?
  61. args?=?parser.parse_args(args)?#?如果你没有args参数,那么就使用sys.argv,也就是命令行参数啦。有这个参数,就方便我们调试啊??
  62. #?args.world就是-q的值啦??
  63. ?? ?
  64. #?action?-?The?basic?type?of?action?to?be?taken?when?this?argument?is?encountered?at?the?command?line.??
  65. #?const?-?A?constant?value?required?by?some?action?and?nargs?selections.??
  66. #?这两个自己看帮助文档啦,比较复杂??
  67. #?http://docs.python.org/library/argparse.html??
  68. ?? ?
  69. print?args??

?

这个复杂的代码,最后输出的帮助信息是(只要命令行有-h选项就会输出帮助信息并退出哦)

  1. ??? ?
  2. usage:?argparse_sample.py?[-h]?[-f?FILE]?[-n?NUM?[NUM?...]]?[+g?GOLD]?[-x?X]??
  3. ??????????????????????????[-y?{a,b,d}]?-z?{a,b,d}?[-o?OOOOOO]?[-q?WORLD]??
  4. ??????????????????????????bar??
  5. ??? ?
  6. This?is?a?description?of?argparse_sample.py??
  7. ??? ?
  8. positional?arguments:??
  9. ??bar???????????????????test?test?test??
  10. ??? ?
  11. optional?arguments:??
  12. ??-h,?--help????????????show?this?help?message?and?exit??
  13. ??-f?FILE,?--file?FILE??test?test?test?(default:?None)??
  14. ??-n?NUM?[NUM?...],?--num?NUM?[NUM?...]??
  15. ??+g?GOLD,?++gold?GOLD??test?test?test?(default:?test_gold)??
  16. ??-x?X??
  17. ??-y?{a,b,d}??
  18. ??-z?{a,b,d}??
  19. ??-o?OOOOOO??
  20. ??-q?WORLD??
  21. ??? ?
  22. This?is?a?epilog?of?argparse_sample.py??

20151130 python的argparse模块

原文:http://www.cnblogs.com/listenriffle/p/5009944.html

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!