(永久免费,扫码加入)
作者:YunfengWang
https://juejin.cn/post/7242676843987124279
1. 概述
在使用Python 命令或者 Python的命令行工具的时候,一个痛点是没有补全。比如python -m后面输入包名字,就没有提示,每次想运行一个http server的时候,都需要搜索一下http服务的包名。另外,像pip,pipx等命令也没有提示,使用不太方便。
偶然看到argcomplete[1]这个库,按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开发变得舒服一些。
参考资料
[1]
argcomplete: https://github.com/kislyuk/argcomplete
最后推荐一下我们的会员群,目前有风投天使投资人,猎头HR,抖音大V,情感博主,律师,心理咨询师,医疗销售,地产,保险,钢琴老师,运营商,企业咨询,跨境电商,建筑,互联网行业的数据分析师,后端开发,python测试等行业的同学加入。
微信咨询:coder_v5 (务必备注你的来意)
性价比超高的星球
目前星球430+人,专栏的内容秘籍已经更新了41篇,每天都有星球发布自己心得。只花一份钱可以学:
Python : python 入门课程44节+Django专栏9节+趣味实战案例
chatgpt :入门,进阶,趣味办公,高级课程
AI绘画:Mj的基础,入门,进阶,小红书玩法
如果你想学Python,又想学ChatGPT,又想学AI绘画,只想花一份钱欢迎加入我们星球会员群,还能认识很多牛人!
加入就送ChatGPT独立账号
另外还送ChatGPT高级视频课程
原价99,现在免费送星球会员
微信长按试看内容
三天内不满意可直接退款!!!
推荐阅读:
入门: 最全的零基础学Python的问题 | 零基础学了8个月的Python | 实战项目 |学Python就是这条捷径
干货:爬取豆瓣短评,电影《后来的我们》 | 38年NBA最佳球员分析 | 从万众期待到口碑扑街!唐探3令人失望 | 笑看新倚天屠龙记 | 灯谜答题王 |用Python做个海量小姐姐素描图 |碟中谍这么火,我用机器学习做个迷你推荐系统电影
趣味:弹球游戏 | 九宫格 | 漂亮的花 | 两百行Python《天天酷跑》游戏!
AI: 会做诗的机器人 | 给图片上色 | 预测收入 | 碟中谍这么火,我用机器学习做个迷你推荐系统电影
小工具: Pdf转Word,轻松搞定表格和水印! | 一键把html网页保存为pdf!| 再见PDF提取收费! | 用90行代码打造最强PDF转换器,word、PPT、excel、markdown、html一键转换 | 制作一款钉钉低价机票提示器! |60行代码做了一个语音壁纸切换器天天看小姐姐!|