Best practices for writing Python in Vim

Let’s post a picture first:

For some small Python projects, using vim is a good choice. The content of this article is compiled from my answers on Zhihu. What is the best practice for writing Python in Vim? , the following content is a supplement to Zhihu’s old answers, especially some that are mainly focused on vim8. If you want more content, you can check out some of Zhihu’s answers to this question.

Syntax check

If you use vim8, you can use asynchronous detection w0rp/ale instead of syntastic. You no longer need to envy flycheck, nor do you need to get stuck due to syntax checking.

Regarding the personalized configuration of this part of ale, it is actually a bit "picky". Generally, using the default one should be enough, but I like fancy things, so I gave it a try. The things involved may be quite detailed. You can directly look at space-vim: syntax-checking to understand the general configuration. Mainly for re-extracting and displaying the statusline content provided by ale. If there is no syntax error, it will not be displayed in the statusline. If there is a warning or error, it can be distinguished by different colors.

As for the warning or error sign on the side, I like it to be cleaner and just use the foreground color to distinguish it. The following sometimes looks like patches on it. , I don’t think it looks good.

syntax enhancement

vim’s built-in highlighting for python is a bit weak, even self is not highlighted for me Up, this can be enhanced through python-mode/python-mode:

    hi pythonSelf            ctermfg=174 guifg=#6094DB cterm=bold gui=bold

For details, please see here space-vim: python layer

In syntax/python.vim of python-mode Here, you can see a more detailed highlight group than the syntax/python.vim that comes with vim. It should not be difficult to understand each content. Just modify the highlight style according to the color table. This is the terminal 256 color comparison chart 256 Terminal colors and their 24bit equivalent (or similar), this is the GUI color comparison chart Complete HTML True Color Chart.

The advantage of this is that the effect you want is completely customizable, but it also has disadvantages, because it may not be able to adapt to all vim themes. When you switch themes, these python-customized highlights may not fit a little bit. Even if we only count the popular vim themes, there are probably double digits. Some are cool tones, some are warm tones, some are mainly blue, and some are mostly red. It should not be easy to find some versatile colors. However, there may only be a few themes that everyone likes, so choose by yourself...

In fact, python-mode is a bit of a masterpiece, including many functions of using vim to write python, if you are interested You can try to rely on it to "conquer the world with one move." However, for now I only like this part.

Code formatting

This can be done through google/yapf. After installing yapf, you can format the current file as follows<LocalLeader>= Change:

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

Auto-completion

This is because I mainly use vim, so I use YouCompleteMe. The actual backend uses the already mentioned jedi-vim. If you don’t like ycmd , If you use neovim, you can try deoplete.nvim.

Import sorting

Does the various imports seem a bit messy? Use timothycrosley/isort to sort it out:

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

One-click operation

This can be enhanced through skywind3000/asyncrun.vim, replace the previous ! with AsyncRun! will be fine. In fact, there are still some small points to note:

Many people’s one-click run may look like this:

...
exec "!g++ % -o %<"
exec "!time ./%<"
...

You can directly replace the above ! should be replaced by AsyncRun!? The answer is no. If you want to achieve the previous effect, it should be like this:

exec "AsyncRun! g++ -stdc++11 % -o %<; time ./%<"

Use semicolons to link multiple commands (linux) or & to link multiple commands (windows). You can see here for details.

The specific and complete vim configuration is here: >>> space-vim (If you think the writing is good, you can go to github and give it a star.