【4】进程管理-6-python命令解析工具--argparse

argparse是Python标准库中推荐使用的编写命令行程序的工具。官网介绍

一、简介

。。。

二、用法

在这篇教程中我们通过一个常见的ls命令来展示argparse的功能。

$ ls
cpython devguide prog.py pypy rm-unused-function.patch
$ ls pypy
ctypes_configure demo dotviewer include lib_pypy lib-python ...
$ ls -l
total 20
drwxr-xr-x 19 wena wena 4096 Feb 18 18:51 cpython
drwxr-xr-x 4 wena wena 4096 Feb 8 12:04 devguide
-rwxr-xr-x 1 wena wena 535 Feb 19 00:05 prog.py
drwxr-xr-x 14 wena wena 4096 Feb 7 00:59 pypy
-rw-r--r-- 1 wena wena 741 Feb 18 01:01 rm-unused-function.patch
$ ls --help
Usage: ls [OPTION]... [FILE]...
List information about the FILEs (the current directory by default).
Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.

从以上的四个命令中,我们能够了解以下几个基本概念:

  • ls命令在没有参数的情况下也是可以运行的,默认打印出当前目录下的所有内容。

  • 如果我们想让它展示更多内容,那么我们需要给它多一点参数。在这种情况下,我们想显示一个不同的目录,pypy。我们所做的就是明确了常见的定位参数(positional argument),这样命名是因为需要程序根据参数在命令行中的位置而决定做什么。这个概念与命令cp更为接近,它的用法是cp src dest,src表示的是你想要拷贝的文件,dest表示你想要将文件拷贝到哪里。

  • 现在,我想要改变程序的行为。在我们的例子中,我想显示文件的向西信息而不仅仅是文件名,参数-l 则是我们所知道的可选参数(optinal argument)

  • 最后一句是显示帮助的文档的一个片段,当你遇到你从未使用过的命令时,你可以通过它学习怎么使用。

案例:

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

运行结果:

$ python prog.py
$ python prog.py --help
usage: prog.py [-h]

optional arguments:
 -h, --help show this help message and exit
$ python prog.py --verbose
usage: prog.py [-h]
prog.py: error: unrecognized arguments: --verbose
$ python prog.py foo
usage: prog.py [-h]
prog.py: error: unrecognized arguments: foo

若不给参数而运行这个程序,将不会得到任何结果。 第二条命名显示了使用的argparse的好处,你什么也没做,却得到了一个很好的帮助信息。 我们无需人为设置–help参数,就能得到一个良好的帮助信息。但是若给其他参数(比如foo)就会产生一个错误。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print args.echo

运行结果:

$ python prog.py
usage: prog.py [-h] echo
prog.py: error: the following arguments are required: echo
$ python prog.py --help
usage: prog.py [-h] echo
positional arguments:
 echo
optional arguments:
 -h, --help show this help message and exit
$ python prog.py foo
foo

结果分析:

这次,我们增加了一个add_argument()方法,用来设置程序可接受的命令行参数。 现在要运行程序,就必须设置一个参数。 parse_args()方法实际上从我们的命令行参数中返回了一些数据,在上面的例子中是echo 这个像“魔法”一样的过程,是argparse自动完成的。 尽管自动产生的帮助信息展示地很美观,但是我们仍然无法只根据echo这个参数知道它是做什么的。所以,我们增加了一些东西,使得它变得更有用。

使用步骤:

import argparse
parser = argparse.ArgumentParser(description = '生成模拟样本')
parser.add_argument('-i','--input_file',help = '输入Panel RS ')
parser.add_argument('-o', '--output_dir',help = '输出文件' )
parser.add_argument('-s', help = '模拟样本类型,默认的是one sample report')
args = parser.parse_args()

 if args.i and args.o and args.s == "sample":
    panel_input,result_name = args.i,args.o
    generate_one_report_by_rs(panel_input,result_name)
 else:
    parser.error("缺少参数!")
方法 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)

运行结果:

$ python prog.py -h
usage: prog.py [-h] echo
positional arguments:
 echo echo the string you use here
optional arguments:
 -h, --help show this help message and exit

在此基础上,我们再多改变一点:(计算输入参数square的平方)

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number")
args = parser.parse_args()
print args.square**2

下面是运行结果:

$ python prog.py 4
Traceback (most recent call last):
 File "prog.py", line 5, in <module>
 print args.square**2
TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'

这个程序并不能正确运行,因为argparse会将输入当作字符串处理,所以我们需要设置它的类型:(type=int)

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number",
 type=int)
args = parser.parse_args()
print args.square**2

下面是运行结果:

$ python prog.py 4
16
$ python prog.py four
usage: prog.py [-h] square
prog.py: error: argument square: invalid int value: 'four'

三、我的案例(多个命令调用)

from argparse import RawTextHelpFormatter
def command():
  parser = argparse.ArgumentParser(description="引物设计、检查、存储",formatter_class=RawTextHelpFormatter)
    subparsers = parser.add_subparsers(help='请使用子命令:design,check,store')

    def design(args):
        week, month, data, time_now, year = time.ctime().split()
        this_hour, this_min, this_second = time_now.split(":")
        check_time = year + month + "_" + data + "_" + this_hour + "_" + this_min + "_" + this_second + str(
            uuid.uuid4())

        if args.input_file and args.type and args.email:
            rs_input, primer_type, config, temp_dir, your_email = args.input_file, \
                                args.type, args.config, args.output_dir, args.email
            multiple_rs = read_input_rs(rs_input)


  parser1 = subparsers.add_parser('design', help='设计SNPType、PC引物、TaqMan')
    parser1.add_argument('-i', "--input_file",
                         help="输入RS,输入形式为rs6973243,或者17:41258472 C>A")
    parser1.set_defaults(func=design)

    def check(args):
        pass

    parser2 = subparsers.add_parser('check', help='检查引物')
    parser2.add_argument('-i', "--input_file", action="store_true",
                         help="输入RS,输入形式为rs6973243,或者17:41258472 C>A")
    parser2.add_argument('-t', "--type", action="store_true",
                         help="生成引物类型,snptype/snptype_primer/snptype_probe/PC_primer/snptype_pc/taqman")
    parser2.set_defaults(func=check)

    def store(args):
        pass
    parser3 = subparsers.add_parser('store', help='存储引物')
    parser3.add_argument('-i', "--input_file", action="store_true",
                         help="输入文本一行一个RS,输入形式为rs6973243,或者17:41258472 C>A")
    parser3.add_argument('-t', "--type", action="store_true",
                         help="生成引物类型,snptype/snptype_primer/snptype_probe/PC_primer/snptype_pc/taqman")
    parser3.set_defaults(func=store)

    args = parser.parse_args()
    args.func(args)

四、讨论

3.1 help信息换行

from argparse import RawTextHelpFormatter
parser = ArgumentParser(description='test', formatter_class=RawTextHelpFormatter)
然后再help中加入\n 断行即可

参考资料:

http://blog.sina.com.cn/s/blog_62db9b190102uzl6.html

http://www.cnblogs.com/jianboqi/archive/2013/01/10/2854726.html

http://blog.itpub.net/26250550/viewspace-1281968/

https://docs.python.org/2/howto/argparse.html

http://stackoverflow.com/questions/3853722/python-argparse-how-to-insert-newline-in-the-help-text

个人公众号,比较懒,很少更新,可以在上面提问题:

更多精彩,请移步公众号阅读:

Sam avatar
About Sam
专注生物信息 专注转化医学