如何在使用 Vim 時訪問/查看 Python 幫助

我是一名新的 Vim 編輯器用戶。我用它編寫 Python 代碼。有沒有辦法在 vim 中查看 Python 文檔而無需訪問互聯網？假設我的游標在 Python 的 print 關鍵字下，然後按下 F1，我想查看關鍵字 print 的幫助。如何在 vim 中顯示 python help() ？如何在不離開 vim 的情況下調用 pydoc3/pydoc 尋求幫助？

pydoc 或 pydoc3 命令可以根據 Python 關鍵字、主題、函數、模塊或包的名稱顯示文本文檔，或在模塊內或包中的模塊對類或函數的引用。你可以從 Vim 中調用 pydoc。讓我們看看如何在 Vim 編輯器中使用 pydoc 訪問 Python 文檔。

使用 pydoc 訪問 python 幫助

語法是：

pydoc keyword
pydoc3 keyword
pydoc len
pydoc print

編輯你的 ~/.vimrc：

$ vim ~/.vimrc

為 pydoc3 添加以下配置（python v3.x 文檔）。在正常模式下創建 H 鍵的映射：

nnoremap <buffer> H :<C-u>execute "!pydoc3 " . expand("<cword>")<CR>

保存並關閉文件。打開 Vim 編輯器：

$ vim file.py

寫一些代碼：

#!/usr/bin/python3
x=5
y=10
z=x+y
print(z)
print("Hello world")

將游標置於 Python 關鍵字 print 的下方，然後按下 Shift，然後按 H。你將看到下面的輸出：

按 H 查看 Python 關鍵字 print 的幫助

如何在使用 Vim 時查看 python 幫助

jedi-vim 是一個綁定自動補全庫 Jed 的 Vim 插件。它可以做很多事情，包括當你按下 Shift 後跟 K （即按大寫 K） 就顯示關鍵字的幫助。

如何在 Linux 或類 Unix 系統上安裝 jedi-vim

使用 pathogen、vim-plug 或 Vundle 安裝 jedi-vim。我使用的是 vim-plug。在 ~/.vimrc 中添加以下行：

Plug 'davidhalter/jedi-vim'

保存並關閉文件。啟動 Vim 並輸入：

PlugInstall

在 Arch Linux 上，你還可以使用 pacman 命令從官方倉庫中的 vim-jedi 安裝 jedi-vim：

$ sudo pacman -S vim-jedi

它也可以在 Debian（比如 8）和 Ubuntu（ 比如 14.04）上使用 [apt-get command](https://www.cyberciti.biz/faq/ubuntu-lts-debian-linux-apt-command-examples/ "See Linux/Unix apt command examples for more info")/[apt-get command](https://www.cyberciti.biz/tips/linux-debian-package-management-cheat-sheet.html "See Linux/Unix apt-get command examples for more info") 安裝 vim-python-jedi：

$ sudo apt install vim-python-jedi

在 Fedora Linux 上，它可以用 dnf 安裝 vim-jedi：

$ sudo dnf install vim-jedi

Jedi 默認是自動初始化的。所以你不需要進一步的配置。要查看 Documentation/Pydoc，請按 K。它將彈出幫助窗口：

關於作者

作者是 nixCraft 的創建者，也是經驗豐富的系統管理員和 Linux 操作系統/Unix shell 腳本的培訓師。他曾與全球客戶以及 IT、教育、國防和太空研究以及非營利部門等多個行業合作。在 Twitter、Facebook、Google + 上關注他。

via: https://www.cyberciti.biz/faq/how-to-access-view-python-help-when-using-vim/

作者：Vivek Gite 譯者：geekpi 校對：wxy

本文由 LCTT 原創編譯，Linux中國 榮譽推出

本文轉載來自 Linux 中國: https://github.com/Linux-CN/archive