这次介绍一下getopt这个库。
这个库学委在pypi-seed开源项目中使用了，本文介绍如何使用优雅的应对不同的参数，让cli命令行程序更加弹性！
python内置库getopt
getopt是一个简化命令行工具参数处理的库，可以定义短参数和长参数。这个说的比较官方。下面看看相对友好的介绍：
小白可能不太懂，它像媒人配对一样，自动的把参数进行配对。
你告诉他参数‘-a’ 后面跟一个名字，getopt可以在程序内解析出（a,名字）这样的映射
如果参数是这样:
–author=雷学委 --project=hello
getopt可以帮我们处理为:
(author, “雷学委”),（project,“hello”)
getopt的调用
#getopt.getopt传入三个参数 import getopt getopt.getopt(args, options, [long_options])
比如pypiseed生成项目，接收了3个主要参数
name： 项目名
dir： 项目路径
author： 作者名字
我们从pypiseed调用命令来看如何编写getopt。
第一种 短参数类型
短参数类型，即是使用‘-‘ 加上一个单字母。比如大家非常常见的’-h’ （查看帮助信息） 或者 ‘-v’ (查看版本信息）
我们下面来看pypiseed CLI如何使用getopt模块的。
pypiseed -p demo_project -a testuser -d /tmp
我们看到这个命令行pypiseed接受了-p , -a, -d 三个。
我们使用getopt 如何声明处理这三个参数。
#!/usr/bin/env python # -*- coding: utf-8 -*- # @Time : 2021/9/9 10:45 下午 # @Author : LeiXueWei # @CSDN/Juejin/Wechat: 雷学委 # @XueWeiTag: CodingDemo # @File : getopstest.py # @Project : hello import sys import getopt def parse_args(): project = author = dir = None print("argv:%s" % sys.argv) argv = sys.argv[1:] opts, args = getopt.getopt(argv, "p:a:d:", []) for opt, arg in opts: if opt in ['-p']: project = arg elif opt in ['-a']: author = arg elif opt in ['-d']: dir = arg print(" project:%s, author:%s, dir:%s " % (project, author, dir)) parse_args()
保存上面代码为getopstest.py，，输入三个参数并运行：
-p sample -a "雷学委" -d /tmp
这里要注意‘-’ 后面接的必须是短参数，也就是一个字母。
像‘-dir’ 这种参数会导致getopt处理解析异常！
第二种 长参数类型
使用pypiseed生成项目的长参数类型
pypiseed --project demo_project --author testuser --dir=/tmp
上面的代码不能支持长参数，这里单独做一个支持长参数的。
#!/usr/bin/env python # -*- coding: utf-8 -*- # @Time : 2021/9/9 10:45 下午 # @Author : LeiXueWei # @CSDN/Juejin/Wechat: 雷学委 # @XueWeiTag: CodingDemo # @File : getopstest.py # @Project : hello import sys import getopt def parse_long_args(): project = author = dir = None print("argv:%s" % sys.argv) argv = sys.argv[1:] opts, args = getopt.getopt(argv, "", ["project=", "author=", "dir="]) for opt, arg in opts: if opt in ['--project']: project = arg elif opt in ['--author']: author = arg elif opt in ['--dir']: dir = arg print(" project:%s, author:%s, dir:%s " % (project, author, dir)) parse_long_args()
保存上面代码为getopstest.py，输入三个参数并运行：
-p sample -a "雷学委" -d /tmp
这样就会出错：getopt.GetoptError: option -p not recognized
我们不能还是传递短参数，参数应该改为：
--project sample --author "雷学委" --dir "/tmp"
或者这样也支持
--project=sample --author="雷学委" --dir="/tmp"
第三种 长短参数合并使用
这里学委带大家回顾上面的两个代码，里面其实很像。
比较关键的区别的是对：getopt.getopt这个函数的调用。
#短参数解析调用
opts, args = getopt.getopt(argv, "p:a:d:", [])
#长参数解析调用
opts, args = getopt.getopt(argv, "", ["project=", "author=", "dir="])
先说说，getopt函数的参数，第一个是参数列表，它是从系统参数第二个开始到最后一个参数构成的列表。
然后第二个参数我们在第一段代码中看到设置的是短参数。这里定义一个字母或者多个字母即可。如果是带参数值的，后面跟上一个冒号（:， 比如a:, 表示-a '参数值‘）
然后第三个参数在第二段代码中是一个单词（可以跟上‘=’符合）的列表。带上等于符合表示，该参数后面可以跟上一个参数值。
好了，那同时处理短参数和长参数的代码就是把第二，第三的参数位置都设置对于短参数字母串和长参数的单词串。
参考下面代码：
opts, args = getopt.getopt(argv, "p:a:d:", ["project=", "author=", "dir="])
总结
本文展示了getopt模块的使用，以及实际命令行工具开发的代码剖析。
这里有个福利，现在读者可以通过pypiseed，就能够一键生成命令行工具项目了，运行下面代码即可
pip install pypi-seed && pypiseed -p demo_project -a testuser -d /tmp --cli
