Python 命令补全工具 argcomplete

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语句,常常比较耗时,可以往后放。

相关推荐

  1. Python 命令工具 argcomplete

    2024-02-21 13:42:01       29 阅读
  2. kubectl 命令自动

    2024-02-21 13:42:01       33 阅读
  3. k8s自动命令

    2024-02-21 13:42:01       9 阅读
  4. Linux的命令脚本

    2024-02-21 13:42:01       7 阅读
  5. K8S kubectl 自动命令

    2024-02-21 13:42:01       36 阅读

最近更新

  1. TCP协议是安全的吗?

    2024-02-21 13:42:01       18 阅读
  2. 阿里云服务器执行yum,一直下载docker-ce-stable失败

    2024-02-21 13:42:01       19 阅读
  3. 【Python教程】压缩PDF文件大小

    2024-02-21 13:42:01       19 阅读
  4. 通过文章id递归查询所有评论(xml)

    2024-02-21 13:42:01       20 阅读

热门阅读

  1. 设计模式面试系列-02

    2024-02-21 13:42:01       32 阅读
  2. 数学物理方法笔记——Γ函数

    2024-02-21 13:42:01       66 阅读
  3. 开源大数据管理平台选型

    2024-02-21 13:42:01       24 阅读
  4. 一些用 GPT 翻译的计算机科学/人工智能 PDF 讲义

    2024-02-21 13:42:01       32 阅读
  5. 代码随想录算法训练营总结

    2024-02-21 13:42:01       29 阅读
  6. CSS中伪元素和伪类的区别和作用?

    2024-02-21 13:42:01       30 阅读
  7. GO框架基础 (三)、xorm库

    2024-02-21 13:42:01       31 阅读
  8. LeetCode刷题笔记之二叉树(二)

    2024-02-21 13:42:01       23 阅读
  9. 【Lazy ORM 高级映射】1.2.2-JDK17-SNAPSHOT

    2024-02-21 13:42:01       27 阅读
  10. OpenCart程序结构与业务逻辑

    2024-02-21 13:42:01       33 阅读
  11. 【Python】OpenCV-图像滤波

    2024-02-21 13:42:01       29 阅读
  12. *EtherCAT:网络小能手,工业界的速度之星!**

    2024-02-21 13:42:01       26 阅读
  13. list.stream().forEach()和list.forEach()的区别

    2024-02-21 13:42:01       26 阅读