Python 命令行工具辅助getopt使用解析!

雷学委 2021-10-26 04:09:35
Python 工具 命令行 命令 令行

正式的Python专栏第14篇,同学站住,别错过这个从0开始的文章!

这次介绍一下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

喜欢Python的朋友,请关注学习 十年老将带你做开源项目 or Python基础专栏 or Python入门到精通大专栏

持续学习持续开发,我是雷学委!
编程很有趣,关键是把技术搞透彻讲明白。
创作不易,请关注收藏点赞,或者留下评论打打气!

版权声明
本文为[雷学委]所创,转载请带上原文链接,感谢
https://levin.blog.csdn.net/article/details/120479835

  1. Python project management and construction, these four tools are enough!
  2. IDE的使用,pycharm引入Python库
  3. In the 120 series columns, you can learn the python beautiful oup4 module, 7000 word blog + climb the ninth workshop network
  4. Django运行xadmin 报错解析 ImportError: cannot import name 'DEFAULT_FORMATS' from 'import_export.admin'
  5. Python程序大学课程写程序
  6. Programme Python Programme d'études collégiales
  7. Python程序大學課程寫程序
  8. Django runxadmin Error resolution importerror: cannot Import name 'default Formats' from 'import _ Export.admin»
  9. Python 函数式编程,看这一篇足够了!
  10. 太棒了!11个好用到起飞的「Python字典」知识点!
  11. 一道Python题目,求解答!
  12. 一道Python題目,求解答!
  13. Un problème Python, s'il vous plaît!
  14. C'est génial! 11 points de connaissance du dictionnaire Python pour le décollage!
  15. Python Functional Programming, This is enough!
  16. 在python中beta分布的问题?
  17. 一个python习题,没有什么头绪,是关于进制的转换和绘制的,想了几天了,不仅仅是2,8,16这种常见的进制转换
  18. Un exercice Python, qui n'a pas beaucoup d'idées, est sur la conversion et le rendu décimaux et a pensé pendant quelques jours, pas seulement 2, 8, 16 cette conversion décimale commune
  19. Un problème avec la distribution bêta en python?
  20. python实现简单的读取excel 内容,报错
  21. L'implémentation Python lit simplement le contenu d'Excel et signale les erreurs
  22. 用Python定义一个函数,接收n个数字,求这些参数数字的和
  23. Définissez une fonction en python, recevez n nombres et additionnez ces nombres de paramètres
  24. 上电Python写文件后,再断电后导致文件内容丢失
  25. 上電Python寫文件後,再斷電後導致文件內容丟失
  26. Une fois que Python est allumé pour écrire des fichiers, le contenu des fichiers est perdu après une panne de courant
  27. python套接字编程报错:ConnectionResetError: [WinError 10054] 远程主机强迫关闭了一个现有的连接。
  28. 【Python从入门到精通】(二)怎么运行Python呢?有哪些好的开发工具(PyCharm)
  29. 【Python从入门到精通】(二)怎么运行Python呢?有哪些好的开发工具(PyCharm)
  30. Python语法1
  31. 2018年度最受推荐的10本Python书籍(初学者必看)
  32. Les 10 livres Python les plus recommandés en 2018 (obligatoire pour les débutants)
  33. Syntaxe Python 1
  34. Python语法1
  35. 在python 运行celery时候 AttributeError: 'NoneType' object has no attribute 'Redis'错误
  36. Attributeerror: 'nonetype' Object has no attribute 'redis' Error when Celery is running in Python
  37. Syntaxe Python 1
  38. Python celery is a plug-in that focuses on distributed asynchronous task processing and task scheduling!
  39. Python celery is a plug-in that focuses on distributed asynchronous task processing and task scheduling!
  40. 在python,使用scrapy爬虫框架
  41. It's time for everyone to see your blog written in Django (including deployment tutorial video)
  42. Python扩展速记符 要求用for循环,if语句
  43. Python擴展速記符 要求用for循環,if語句
  44. Le sténographe d'extension Python nécessite une boucle pour, si instruction
  45. Python+人工智能就业班v5.0wumi
  46. python编程技术的题目,希望能得到解答
  47. Pandas determines the header row dynamically
  48. 关于#python#的问题:模拟登陆后能获取到cookie,就是cookie一天就过期
  49. pandas为dataframe添加新的数据行(rows)、在dataframe后面纵向添加一行数据(数据为列表list形式)、列有不匹配将会使用NA值进行填补
  50. pandas使用组合条件筛选、过滤数据行
  51. 热烈祝贺1024,求解Python3.10闪退问题
  52. Python基础题练习题库有没呢?
  53. python构建神经网络,正向和反向传播
  54. python爬虫输入数字翻页才成功,用变量代替不成功,为什么?
  55. 【Python 爬虫】 2、HTTP基本原理
  56. 【Python 爬虫】 1、爬虫基础概念
  57. Python中如何用find函数计数?
  58. 一文搞懂Python装饰器
  59. python数据结构之递归
  60. 关于#python#的问题:为什么这个open函数会报错