1. 概述
在使用Python 命令或者 Python的命令行工具的时候,一个痛点是没有补全。比如python -m后面输入包名字,就没有提示,每次想运行一个http server的时候,都需要搜索一下http服务的包名。另外,像pip,pipx等命令也没有提示,使用不太方便。
偶然看到argcomplete1这个库,按tab键就可以给Python的命令行添加自动补全,简直是使用Python的一个神器。
具体来说,argcomplete有下面的特点:
-
官方支持支持bash和zsh两种shell,对tcsh和fish有第三方贡献者提供的支持(不好意思Windows用户这里又被当做二等公民了 )
-
可以对python命令和pip命令进行补全
-
其他任何以argparse解析的第三方包的命令都可以用自动补全,添加argcomplete的几行代码就行
下面具体展开怎么对已有的工具启用自动补全,以及如何让自己的Python包支持argcomplete。
2. 对Python和pip启用自动补全
首先通过pip命令来安装argcomplete:
pip install argcomplete
然后执行下面的语句来启用对Python和pip的自动补全:
activate-global-python-argcomplete
重启Shell,试试输入pip然后按tab,发现就会列出所有的命令选项。
3. 如何对别的第三方库启用自动补全
有些库的命令行程序是已经支持argcomplete补全,只需要用下面的命令来激活:
eval "$(register-python-argcomplete <python-app-name>)"
例如 pipx 包安装后会在系统安装一个命令行程序pipx,且pipx已经支持argcomplete,我们就可以用下面的命令来激活自动补全:
eval "$(register-python-argcomplete pipx)"
激活后输入pipx in 按tab键,就可以列出pipx所有以in开头的命令,再按tab键会在各个候选命令之间切换。
⚠️注意:这个激活命令是只对哪些代码中已经支持了argcomplete语句的程序才生效,如果代码中无这些语句,那是不生效的。
4. 如何让自己的Python库支持自动补全
只需要增加下面几行代码,就能让你的库的命令行支持自动补全:
# 在ArgumentParser对象初始化前增加这两行
# PYTHON_ARGCOMPLETE_OK
import argcomplete, argparse# 原有代码
parser = argparse.ArgumentParser()
...# 在调用parse_args()函数前增加这一行
argcomplete.autocomplete(parser)# 原有代码
args = parser.parse_args()
...
然后你的包安装后,对应的命令行程序就可以用eval "$(register-python-argcomplete )"来补全了。
⚠️注意:如果程序执行到argcomplete.autocomplete() 被调用的地方耗时很久的话,用户按tab就会有明显的延迟感。所以尽量将一些比较耗时的操作放在argcomplete.autocomplete() 语句后面,比如一些import语句,常常比较耗时,可以往后放。
希望这个程序能让你的Python开发变得舒服一些。
argcomplete: https://github.com/kislyuk/argcomplete
以上就是“Python 命令补全工具 argcomplete”的全部内容,希望对你有所帮助。
关于Python技术储备
学好 Python 不论是就业还是做副业赚钱都不错,但要学会 Python 还是要有一个学习规划。最后大家分享一份全套的 Python 学习资料,给那些想学习 Python 的小伙伴们一点帮助!
一、Python所有方向的学习路线
Python所有方向的技术点做的整理,形成各个领域的知识点汇总,它的用处就在于,你可以按照上面的知识点去找对应的学习资源,保证自己学得较为全面。
二、Python必备开发工具
三、Python视频合集
观看零基础学习视频,看视频学习是最快捷也是最有效果的方式,跟着视频中老师的思路,从基础到深入,还是很容易入门的。
四、实战案例
光学理论是没用的,要学会跟着一起敲,要动手实操,才能将自己的所学运用到实际当中去,这时候可以搞点实战案例来学习。
五、Python练习题
检查学习结果。
六、面试资料
我们学习Python必然是为了找到高薪的工作,下面这些面试题是来自阿里、腾讯、字节等一线互联网大厂最新的面试资料,并且有阿里大佬给出了权威的解答,刷完这一套面试资料相信大家都能找到满意的工作。
最后祝大家天天进步!!
上面这份完整版的Python全套学习资料已经上传至CSDN官方,朋友如果需要可以直接微信扫描下方CSDN官方认证二维码免费领取【保证100%免费】。