Python教程：optparse—命令行选项解析器

最新推荐文章于 2023-01-06 16:46:26 发布

转载最新推荐文章于 2023-01-06 16:46:26 发布 · 435 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：https://www.jianshu.com/u/8f2987e2f9fb

文章标签：

#python

先观察以下一段代码：

# 先导入类并实例化
from optparse import OptionParser
optParser = OptionParser()

optParser.add_option('-f','--file',action = 'store',type = "string" ,dest = 'filename')
optParser.add_option("-v","--vison", action="store_false", dest="verbose",
                     default='hello',help="make lots of noise [default]")

fakeArgs = ['-f','file.txt','-v','how are you', 'arg1', 'arg2']
option , args = optParser.parse_args()
op , ar = optParser.parse_args(fakeArgs)

print("option : ",option)
print("args : ",args)
print("op : ",op)
print("ar : ",ar)

输出：

option :  {'filename': None, 'verbose': 'hello'}
args :  []
op :  {'filename': 'file.txt', 'verbose': False}
ar :  ['how are you', 'arg1', 'arg2']
# optParser.parse_args() 剖析并返回一个字典和列表，
# 字典中的关键字是我们所有的add_option()函数中的dest参数值，
# 而对应的value值，是add_option()函数中的default的参数或者是由用户传入optParser.parse_args()的参数

1.add_option()选项属性

action（默认值：“store”）存储方式。几个常用方式：

store 上表示命令行参数的值保存在options对象中。例如上面一段代码，如果我们对optParser.parse_args()函数传入的参数列表中带有‘-f’，那么就会将列表中‘-f’的下一个元素作为其dest的实参filename的值，他们两个参数形成一个字典中的一个元素{filename：file_txt}。相反当我们的参数列表中没有‘-f’这个元素时，那么filename的值就会为空。
store_false fakeArgs 中存在’-v’verbose将会返回False，而不是‘how are you’，也就是说verbose的值与’-v’的后一位无关，只与‘-v’存在不存在有关。
store_ture 这与action="store_false"类似，只有其中有参数’-v’存在，则verbose的值为True,如果’-v’不存在，那么verbose的值为None。

type（默认值：“string”）参数类型（例如"string"或"int"）。

dest（默认值：从选项字符串派生）存储的变量。

default 默认值。如果在命令行上未看到该选项，则default的值为用于该选项的默认值。

help 打印用法消息。包括所有选项和它们的文档。

帮助选项：

parser = OptionParser()
parser.add_option("-v", "--verbose",
                  action="store_true", dest="verbose", default=True,
                  help="make lots of noise [default]")
parser.add_option("-q", "--quiet",
                  action="store_false", dest="verbose",
                  help="be vewwy quiet (I'm hunting wabbits)")
parser.add_option("-f", "--filename",
                  metavar="FILE", help="write output to FILE")
parser.add_option("-m", "--mode",
                  default="intermediate",
                  help="interaction mode: novice, intermediate, "
                       "or expert [default: %default]")

如果在命令行中optparse遇到-h或–help在命令行中遇到，或者只是调用parser.print_help()，它将在标准输出中显示以下内容：

Options:
  -h, --help            show this help message and exit
  -v, --verbose         make lots of noise [default]
  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
  -f FILE, --filename=FILE
                        write output to FILE
  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or
                        expert [default: intermediate]

（如果帮助输出由帮助选项触发，则optparse在打印帮助文本后退出。）

2.pycharm终端运行实例

'''
遇到问题没人解答？小编创建了一个Python学习交流QQ群：778463939
寻找有志同道合的小伙伴，互帮互助,群里还有不错的视频学习教程和PDF电子书！
'''
import optparse

class FTPclient(object):
    """FTP客户端"""
    def __init__(self):
        parser = optparse.OptionParser()
        parser.add_option('-s', '--server', dest='server', help='ftp server ip_addr')
        parser.add_option('-P', '--port', type='int', help='ftp server port')
        parser.add_option('-u', '--username', dest='username', help='username info')
        parser.add_option('-p', '--password', dest='password', help='password info')
        self.options, self.args = parser.parse_args()
        print(self.options, self.args)

if __name__ == '__main__':
    client = FTPclient()