Use Vim as a Python IDE

Posted 2021-11-26 maozhe

Use Vim as a Python IDE

I love vim and often use it to write Python code. Here are some useful plugins and tools for building a delightful vim python environment, escpecially for Vim8:

我喜欢vim，经常用它来编写Python代码。以下是一些有用的插件和工具，用于构建令人愉快的vim-python环境，尤其是vim8：

As you can see, tmux is also one of my favourite tools in terminal.

如您所见，tmux也是我在终端中最喜欢的工具之一。

---

Syntax Checking

If you use Vim8, w0rp/ale is a better option than syntastic, for it utilizes the async feature in Vim8, you will never get stuck due to the syntax checking. It’s similar to flycheck in emacs, which allows you to lint while you type.

如果您使用Vim8， w0rp/ale是比syntastic更好的选择，因为它利用了Vim8中的异步特性，您永远不会因为语法检查而被卡住。它类似于emacs中的flycheck，允许您在键入时进行lint。

(taken from ale)

---

Code Formatter

google/yapf can be used to format python code. Make a key mapping as bellow, then you can format your python code via <LocalLeader> =.

可以使用google/yapf格式化python代码。将键映射设置为bellow，然后可以通过‘ = ‘格式化python代码。

autocmd FileType python nnoremap <LocalLeader>= :0,$!yapf<CR>

You can also take a look at Chiel92/vim-autoformat.

---

Sort Import

timothycrosley/isort helps you sort imports alphabetically, and automatically separated into sections. For example, use <LocalLeader>i to run isort on your current python file:

timothycrosley/isort帮助您按字母顺序对导入进行排序，并自动将其分成几个部分。例如，使用‘ i ‘在当前python文件上运行isort:

autocmd FileType python nnoremap <LocalLeader>i :!isort %<CR><CR>

Or you can use its vim plugin: fisadev/vim-isort.

Update: ALE now has a command ALEFix for autofixing. Concerning code formatter and sort import, you could do that by merely configuring ALE properly. I’d love to put these in ftplugin/python.vim:

ALE现在有一个命令‘ ALEFix ‘用于自动修复。关于code formatter和sort import，您可以通过正确配置ALE来实现这一点。我想把这些放到ftplugin/python.vim:

let b:ale_linters = ['flake8']
let b:ale_fixers = [
\\   'remove_trailing_lines',
\\   'isort',
\\   'ale#fixers#generic_python#BreakUpLongLines',
\\   'yapf',
\\]

nnoremap <buffer> <silent> <LocalLeader>= :ALEFix<CR>

If you want to fix files automatically on save:

如果你想修复文件自动保存:

let g:ale_fix_on_save = 1

Now you have the support of syntax checking and autofixing with one ALE! As a matter of fact, ALE also has a plan to support auto-completion via LSP. Keep watching this amazing project if you are interested.

现在，您已经支持语法检查和自动修复与一个ALE!事实上，ALE还计划通过LSP支持自动完成。如果你感兴趣，请继续观看这个精彩的项目。

---

Auto Completion

Valloric/YouCompleteMe is a good way to provide code auto completion. It has several completion engines, aside from Python, C, C++, Rust, Go and javascript are also supported. Whereas a bunch of people also think YCM is too huge and need to be compiled, then jedi-vim is an alternative. They all use jedi as their backend.

(from jedi-vim)

What’s more, I know many people use Shougo/deoplete.nvim. Thanks to the async API, some more hopeful completion plugins are borned:

maralla/completor.vim is an code completion framework for Vim8, and support NeoVim too.

roxma/nvim-completion-manager also provides experimental support for Vim8.

roxma/nvim-completion-manager 还为Vim8提供了实验支持。

prabirshrestha/asyncomplete.vim is a fork of nvim-completion-manager in pure vim script with python dependency removed.

prabirshrestha/asyncomplete.vim是纯vim脚本中的一个nvim- completemanager分支，去掉了python依赖项。

(from NCM)

Update: Unfortunately, NCM is not maintained any more.

*更新:**不幸的是，NCM不再维护了。*

Update again: ncm2, the successor of NCM, comes out! coc.nvim is also promising.

---

Quick Run

If use Vim8, you can execute python file asynchronously by skywind3000/asyncrun.vim and output automatically the result to the quickfix window like this:

如果使用Vim8，您可以通过skywind3000/asyncrun.vim异步执行python文件，并将结果自动输出到quickfix窗口，如下所示:

" Quick run via <F5>
nnoremap <F5> :call <SID>compile_and_run()<CR>

function! s:compile_and_run()
    exec 'w'
    if &filetype == 'c'
        exec "AsyncRun! gcc % -o %<; time ./%<"
    elseif &filetype == 'cpp'
       exec "AsyncRun! g++ -std=c++11 % -o %<; time ./%<"
    elseif &filetype == 'java'
       exec "AsyncRun! javac %; time java %<"
    elseif &filetype == 'sh'
       exec "AsyncRun! time bash %"
    elseif &filetype == 'python'
       exec "AsyncRun! time python %"
    endif
endfunction

" Deprecated:
" augroup SPACEVIM_ASYNCRUN
"     autocmd!
"    " Automatically open the quickfix window
"     autocmd User AsyncRunStart call asyncrun#quickfix_toggle(15, 1)
" augroup END
"
" asyncrun now has an option for opening quickfix automatically
let g:asyncrun_open = 15

For neovim, neomake/neomake is worthy of trying. Here is the description from neomake’s README:

对于neovim， neomake/neomake值得一试。以下是neomake的自述:

It is intended to replace the built-in :make command and provides functionality similar to plugins like syntastic and dispatch.vim. It is primarily used to run code linters and compilers from within Vim, but can be used to run any program.

Another approach is to use TMUX. The idea is simple: it can split your terminal screen into two. Basically, you will have one side of your terminal using Vim and the other side will be where you run your scripts.

PS: 另一种方法是使用TMUX。这个想法很简单:它可以把你的终端屏幕一分为二。基本上，终端的一端使用Vim，另一端运行脚本。

---

Enhance the default python syntax highlighting

python-mode/python-mode provides a more precise python syntax highlighting than the defaults. For example, you can add a highlighting for pythonSelf .

python-mode/python-mode提供了比默认值更精确的python语法高亮显示。例如，您可以为“pythonSelf”添加高亮显示。

hi pythonSelf  ctermfg=68  guifg=#5f87d7 cterm=bold gui=bold

For more customized python syntax highlightings, please see space-vim-dark theme and syntax/python.vim in python-mode/python-mode . You can also put them after color command.

更多定制的python语法高亮显示，请参见space-vim-dark主题和syntax/python。vim in python-mode/python-mode。你也可以把它们放在颜色命令之后.

Actually, python-mode contains tons of stuff to develop python applications in Vim, e.g., static analysis, completion, documentation, and more. (But personally, I prefer to obtain the functionalities by some other better plugins.)

实际上，python模式包含了大量在Vim中开发python应用程序的内容，例如静态分析、完成、文档等等。(但就我个人而言，我更喜欢通过一些更好的插件来获得这些功能。)

---

Python text objects

vim-pythonsense provides text objects and motions for Python classes, methods, functions, and doc strings.

vim-pythonsense为Python类、方法、函数和doc字符串提供文本对象和运动。

---

LSP

The concept of Language Server Protocol has been around for quite a while, many languages already have a decent LSP support. So far LSP is the only way to bring in various features similar to IDE for the text editors in a standard way. To do that, you need to install the correspoding language server and a LSP client to interact with it.

*Language Server Protocol的概念已经存在很长一段时间了，许多语言已经有了不错的LSP支持。到目前为止，LSP是以标准方式为文本编辑器引入各种类似IDE的特性的惟一方法。为此，您需要安装correspoding语言服务器和一个LSP客户机来与之交互。*

Vim LSP client	Implementation	Support
LanguageClient-neovim	Rust	vim/neovim
ale	VimL	vim/neovim
vim-lsp	VimL	vim/neovim
neovim’s built-in LSP support	Lua	neovim only

LCN implements the LSP client in Rust, so it obviously has an outstanding performance compared to others written in vimscript or lua. Most LSP clients are usable now, but far from perfect:

LCN在Rust中实现了LSP客户机，因此与其他使用vimscript或lua编写的客户机相比，LCN显然具有出色的性能。大多数LSP客户端现在都是可用的，但还远远不够完美:

• simple and crude UI
• poor performance

Still a long way to go :).

---

Summary

There are also some neccessary general programming plugins, e.g.

也有一些必要的通用编程插件，例如。

• scrooloose/nerdcommenter for convenient commenter.
• Yggdroot/indentLine or nathanaelkane/vim-indent-guides for visually displaying indent levels in Vim.
• fzf and fzf.vim for fuzzy file searching, also vim-fz and fzy.
• ……

Although vim is great and many plugins are productive, IDE is still my first choice when it comes to refactoring code and debugging:). Some useful links for debugging python:

• python-debugging-tips
• my-python-ipython-vim-debugging-workflow

For detailed vim configuration, please refer to space-vim. Enable ycmd/lsp, auto-completion, syntax-checking, python, programming Layer , then you could get a nice vim environment for python like the above screenshot. Enjoy!

有关vim的详细配置，请参阅space-vim。启用ycmd/lsp、自动完成、语法检查、python、编程层，然后您就可以得到一个适合python的vim环境，就像上面的截图一样。享受吧!