为python脚本创建帮助选项

时间:2018-11-02 14:02:18

标签: python

我用python编写了一个脚本,该脚本带有一些命令行参数。现在,我想使脚本易于使用。所以我想为我的脚本创建一个帮助菜单。要运行脚本的命令行是-

python newcode.py textfile.txt 18ww24 PO .43

现在我想要这样的东西-

python newcode.py -h

它应该显示用于脚本的命令行选项的完整信息

我已经阅读了一篇文章,该文章正在单独开发脚本以寻求帮助。我想知道我们可以在主脚本本身中提供帮助选项吗?

  

编辑   我已经尝试使用下面给出的代码,但是它不起作用`

import argparse
parser = argparse.ArgumentParser(description='Meaning for each of the Command line arguments')
parser.add_argument('strings', metavar='textfile.txt', type=str, 
               help='log.util file path generated from patch build')
parser.add_argument('strings', metavar='work_week', type=str,
               help='an integer for the accumulator')
parser.add_argument('strings', metavar='PIF', type=str,
               help='an integer for the accumulator')
parser.add_argument('strings', metavar='Milestone', type=str,
               help='an integer for the accumulator')
parser.add_argument('strings',metavar='patch_revid',type=str,
 help='patch_revid')

args = parser.parse_args()

现在,当此脚本在单独的文件中单独运行时,请说出test.py,然后将选项传递为-python test.py -h正在提供有关命令行参数的完整信息,如下所示-

usage: help.py [-h] textfile.txt work_week PIF Milestone patch_revid
Meaning for each of the Command line arguments
positional arguments:
textfile.txt  log.util file path generated from patch build
work_week     an integer for the accumulator
PIF           an integer for the accumulator
Milestone     an integer for the accumulator
patch_revid   patch_revid for patch released

optional arguments:
-h, --help    show this help message and exit

但是当在主脚本中包含相同的代码时,当所有命令行参数都给出时,如果要使用--help参数,则我希望脚本执行正常功能。

例如,我的脚本名称为ReadExcel.py,然后如果执行“ python ReadExcel.py -h” 然后应该显示帮助。

0 个答案:

没有答案