将vim打造为好用python IDE

2020-12-19 09:16:30 编辑 1 阅读量:2966

本篇说明如果将vim改造成适用于python的IDE，包括vim的常规配置以及一些插件，要求vim版本大于7.4， python版本大于等于2.7。最终效果可能如图：
<img alt="Vim as Python IDE" src="https://realpython.com/images/blog_images/vim/vim-ide.png">

ps：ubuntu升级vim操作如下：

```bash
sudo add-apt-repository ppa:jonathonf/vim
sudo apt-get update
sudo apt-get install vim
vim --version | grep python         # 检查vim是否支持python，如果有+python2的字样，说明支持python2，-python表示不支持
# 如果不支持python2，执行下面步骤：
sudo apt install vim-nox-py2    
sudo update-alternatives --config vim    #     重置vim符号链接，选择vim-nox-py2，然后enter
```

一、安装Vundle
  Vundle是一个插件安装、管理工具，类似于pip这种工具。安装Vundled的方法:

```bash
$ git clone https://github.com/gmarik/Vundle.vim.git ~/.vim/bundle/Vundle.vim
$ vim ~/.vimrc    # 添加如下内容

set nocompatible              " required
filetype off                  " required

" set the runtime path to include Vundle and initialize
set rtp+=~/.vim/bundle/Vundle.vim
call vundle#begin()

" alternatively, pass a path where Vundle should install plugins
"call vundle#begin('~/some/path/here')

" let Vundle manage Vundle, required
Plugin 'gmarik/Vundle.vim'

" Add all your plugins here (note older versions of Vundle used Bundle instead of Plugin)

" All of your Plugins must be added before the following line
call vundle#end()            " required
filetype plugin indent on    " required
 
```

使用方法是在~/.vimrc文件中，添加需要安装的模块

```bash
# vim ~/.vimrc
Plugin 'vim-scripts/indentpython.vim'  #添加需要安装的模块，并保存退出
# 然后，在新vim中输入
:PluginInstall      # 之后模块就会自动安装，如果成功会显示done
```

# 二、一些具体的模块
### 2.1 代码折叠（Code Folding）
  在.vimrc中添加下面的代码开启该功能：

```bash
" Enable folding
set foldmethod=indent
set foldlevel=99
# 此时配置为手动输入za来折叠（和取消折叠）。如果要用更快捷的空格键代替，可以：
" Enable folding with the spacebar
nnoremap <space> za

# 希望看到折叠代码的文档字符串？
let g:SimpylFold_docstring_preview=1 
# 第一个命令，set foldmethod=ident会根据每行的缩进开启折叠。但是这样做会出现超过你所希望的折叠数目。但是别怕，有几个扩展就是专门解决这个问题的。在这里，我们推荐SimplyFold。在.vimrc中加入下面这行代码，通过Vundle进行安装：
Plugin 'tmhedberg/SimpylFold'

# 保存且退出，然后在vim中执行命令
:PluginInstall
```

### 2.2 更好的缩进以及pep8风格

```
# 在.vimrc中添加
" For indent and PEP8
au BufNewFile,BufRead *.py
    \ set tabstop=4 |
    \ set softtabstop=4 |
    \ set shiftwidth=4 |
    \ set textwidth=79 |
    \ set expandtab |
    \ set autoindent |
    \ set fileformat=unix 
au BufNewFile,BufRead *.js, *.html, *.css
    \ set tabstop=2 |
    \ set softtabstop=2 |
    \ set shiftwidth=2
# 上面的|不可少，网上其他很多的教程都会少|，会引起一些不必要的报错，另外BadWhitespace要提前定义好，网上的也很多漏了这个
# 下面是表面不必要的空格
hi BadWhitespace guifg=gray guibg=red ctermfg=gray ctermbg=red
au BufRead,BufNewFile *.py,*.pyw,*.c,*.h match BadWhitespace /\s\+$/

# 添加自动缩进插件，ps：再次提醒，添加插件保存后，要在vim中执行:PluginInstall进行安装
Plugin 'vim-scripts/indentpython.vim'
```

### 2.3 安装YouCompleteMe
  YouCompleteMe是一个神级的代码自动补全工具，使用tab出现补全提示，安装这个插件还需要进行本地编译，具体如下

```bash
$ vim ~/.vimrc    # 在.vimrc中添加

Bundle 'Valloric/YouCompleteMe'
# 保存并退出后
$ vim
:PluginInstall
# 此时vim界面应该有显示Valloric/YouCompleteMe，成功后显示Done
```

安装后，还需要编译

```bash
# 首先安装一些依赖，centos中如下安装，其他系统安装YouCompleteMe说明
$ sudo yum install cmake
$ sudo yum groupinstall "Development Tools"

# 如果上面两个还不行，再多安装下面的
$ sudo yum install gcc-c++，clang

# 进行YCM编译
$ cd ~/.vim/bundle/YouCompleteMe
$ ./install.py --clang-completer     # --clang-completer表示支持C类语言的代码补全

# 编译成功后，在~/.vimrc添加常用配置
$ vim ~/.vimrc
let g:ycm_autoclose_preview_window_after_completion=1
let g:ycm_complete_in_comments = 1  "在注释输入中也能补全
let g:ycm_complete_in_strings = 1   "在字符串输入中也能补全
" 表示跳转到定义处
map <leader>g  :YcmCompleter GoToDefinitionElseDeclaration<CR>
" 如果要支持在virtualenv中使用，还需添加
"python with virtualenv support
py << EOF
import os
import sys
if 'VIRTUAL_ENV' in os.environ:
  project_base_dir = os.environ['VIRTUAL_ENV']
  activate_this = os.path.join(project_base_dir, 'bin/activate_this.py')
  execfile(activate_this, dict(__file__=activate_this))
EOF
```

<leader>表示vim快捷组合键的第一个键，默认是'\'，也可以自己设置，比如：

```bash
# 还是在.vimrc中
let mapleader=","
```

### 2.4 语法检查/高亮
  flake8包括三个工具：PyFlakes：静态检查Python代码逻辑错误的工具(会提示定义了变量却没有用到等)，pep8： 静态检查PEP 8编码风格的工具，Ned Batchelder’s McCabe script：静态分析Python代码复杂度的工具。

```
$ sudo python2 -m pip install flake8  # 安装flake8包
$ vim ~/.vimrc

let python_highlight_all=1
syntax on
Plugin 'scrooloose/syntastic'
Plugin 'nvie/vim-flake8'
```

### 2.5 文件浏览NERDTree,以及nerdtree-git-plugin

```
$ vim ~/.vimrc

"F2开启和关闭树"
map <F2> :NERDTreeToggle<CR>
let NERDTreeChDirMode=1
"显示书签"
let NERDTreeShowBookmarks=1
"设置忽略文件类型"
let NERDTreeIgnore=['\~$', '\.pyc$', '\.swp$']
"窗口大小"
let NERDTreeWinSize=25
" 当前无文件是，nerdtree自动退出
autocmd bufenter * if (winnr("$") == 1 && exists("b:NERDTreeType") &&b:NERDTreeType == "primary") | q | endif

" A plugin of NERDTree showing git status
let g:NERDTreeIndicatorMapCustom = {
    \ "Modified"  : "✹",
    \ "Staged"    : "✚",
    \ "Untracked" : "✭",
    \ "Renamed"   : "➜",
    \ "Unmerged"  : "═",
    \ "Deleted"   : "✖",
    \ "Dirty"     : "✗",
    \ "Clean"     : "✔︎",
    \ 'Ignored'   : '☒',
    \ "Unknown"   : "?"
    \ }
Plugin 'scrooloose/nerdtree'

" A plugin of NERDTree showing git status
Plugin 'Xuyuanp/nerdtree-git-plugin'
```

### 2.6 一键执行python
  通过quickfix实现，不需要安装插件，但python文件中不能有input(), raw_input()函数，否则执行时会卡死

```
$ vim ~/.vimrc
"按F5运行python"
map <F5> :call RunPython()<CR>
function RunPython()
  let mp = &makeprg
  let ef = &errorformat
  let exeFile = expand("%:t")
  setlocal makeprg=python\ -u
  set efm=%C\ %.%#,%A\ \ File\ \"%f\"\\,\ line\ %l%.%#,%Z%[%^\ ]%\\@=%m
  silent make %
  copen
  let &makeprg = mp
  let &errorformat = ef
endfunction
```

### 2.7 Powerline状态栏

```bash
$ vim ~/.vimrc
Plugin 'Lokaltog/powerline', {'rtp': 'powerline/bindings/vim/'}
```

### 2.8 括号补全auto-pairs，nerdcommenter多行注释
  用法是，在normal模式下按v并移动光标选择需要注释的行，再按F4就可以为所有选中的行添加注释。

```
$ vim ~/.vimrc

let mapleader=','
map <F4> <leader>ci <CR>
Plugin 'jiangmiao/auto-pairs'
Plugin 'scrooloose/nerdcommenter'
```

### 2.9 indentLine、vim-autopep8
  indentLine是一款缩进指示线，由纯字符实现，效果比较完美。由于python是靠代码缩进来判断代码块的，因此缩进指示的功能有多方便就不言而喻了。indentLine默认是关闭的，因此需要在.vimrc中配置才能看到效果。 ps:此插件有可能导致字符串错乱的问题，请勿使用
  autopep8是一款自动格式化工具，安装后在Normal模式输入:Autopep8或按F8就可以自动依照pep8的标准自动格式化代码。

ps：使用autopep8需要先安装这个包

```
$ sudo pip install autopep8
$ vim ~/.vimrc

"缩进指示线, 此插件有可能导致字符串错乱的问题，请勿使用
"let g:indentLine_char='┆'
"let g:indentLine_enabled = 1
"Plugin 'Yggdroot/indentLine'
"autopep8设置
let g:autopep8_disable_show_diff=1
Plugin 'tell-k/vim-autopep8'
```

### 2.10 全局搜索ctrlp

```
$ vim ~/.vimrc
let g:ctrlp_working_path_mode = 'ra'
set wildignore+=*/tmp/*,*/node_modules/*,*.so,*.swp,*.zip     
let g:ctrlp_custom_ignore = {'dir':  '\v[\/]\.(git|hg|svn)$', 'file': '\v\.(exe|so|dll)$'}
Plugin 'kien/ctrlp.vim'
```

### 2.11 对*.py文件自动添加头部注释
```
" 自动添加头部注释
au BufNewFile *.py call AddPythonTitle()
function AddPythonTitle()
        call append(0,"# -*- coding: utf-8 -*-")
        call append(1,"'''")
        call append(2," * Author        : caitinggui")
        call append(3," * Email         : caitinggui@qq.com")
        call append(4," * Created time  : ".strftime("%Y-%m-%d %H:%M"))
        call append(5," * Description   : ")
        call append(6,"'''")
        echohl WarningMsg | echo "Successful in adding the copyright." | echohl None
endfunction
```

### 2.12 其他一些配置，ps："在vim中表示注释

```
$ vim ~/.vimrc

set encoding=utf-8     " 设置支持utf-8格式文件
set clipboard=unnamed   "使用系统剪切板
set nu                             "使用行号
set tabstop=4    "设置table长度"
set cursorline        "突出显示当前行"
let mapleader=","   " 设置快捷键为,
```

# 三、 步骤的总结（不完整）
## 完整的代码和自动安装脚本见[个人github](https://github.com/caitinggui/vimrc)

首先，新建~/.vimrc，内容如下：

```
set encoding=utf-8           " 设置支持utf-8格式文件
set clipboard=unnamed        "使用系统剪切板
set nu                       "使用行号
set tabstop=4                "设置table长度"
let mapleader=","

set nocompatible             " required
filetype off                 " required

" set the runtime path to include Vundle and initialize
set rtp+=~/.vim/bundle/Vundle.vim
call vundle#begin()

" alternatively, pass a path where Vundle should install plugins
"call vundle#begin('~/some/path/here')

" let Vundle manage Vundle, required
Plugin 'gmarik/Vundle.vim'

" Add all your plugins here (note older versions of Vundle used Bundle instead of Plugin)

" All of your Plugins must be added before the following line
call vundle#end()            " required
filetype plugin indent on    " required

" Enable folding
set foldmethod=indent
set foldlevel=99
" Enable folding with the spacebar
nnoremap <space> za
" see docstring
let g:SimpylFold_docstring_preview=1
Plugin 'tmhedberg/SimpylFold'

" For indent and PEP8
au BufNewFile,BufRead *.py
    \ set tabstop=4 |
    \ set softtabstop=4 |
    \ set shiftwidth=4 |
    \ set textwidth=79 |
    \ set expandtab |
    \ set autoindent |
    \ set fileformat=unix
au BufNewFile,BufRead *.js, *.html, *.css
    \ set tabstop=2 |
    \ set softtabstop=2 |
    \ set shiftwidth=2
hi BadWhitespace guifg=gray guibg=red ctermfg=gray ctermbg=red
au BufRead,BufNewFile *.py,*.pyw,*.c,*.h match BadWhitespace /\s\+$/
Plugin 'vim-scripts/indentpython.vim'

" For YouCompleteMe
let g:ycm_complete_in_comments = 1  "在注释输入中也能补全
let g:ycm_complete_in_strings = 1   "在字符串输入中也能补全
let g:ycm_autoclose_preview_window_after_completion=1
" 表示跳转到定义处，如果要支持在virtualenv中使用，还需添加
map <leader>g  :YcmCompleter GoToDefinitionElseDeclaration<CR>

"python with virtualenv support
py << EOF
import os
import sys
if 'VIRTUAL_ENV' in os.environ:
  project_base_dir = os.environ['VIRTUAL_ENV']
  activate_this = os.path.join(project_base_dir, 'bin/activate_this.py')
  execfile(activate_this, dict(__file__=activate_this))
EOF
Bundle 'Valloric/YouCompleteMe'

" For syntastic 
let python_highlight_all=1
syntax on
Plugin 'scrooloose/syntastic'
Plugin 'nvie/vim-flake8'

" For NERDTree
" F2开启和关闭树
map <F2> :NERDTreeToggle<CR>
let NERDTreeChDirMode=1
let NERDTreeShowBookmarks=1
let NERDTreeIgnore=['\~$', '\.pyc$', '\.swp$']
let NERDTreeWinSize=25
autocmd VimEnter * NERDTree︎
autocmd VimEnter * wincmd w
" 当前无文件时,nerdtree自动关闭
autocmd bufenter * if (winnr("$") == 1 && exists("b:NERDTreeType") &&b:NERDTreeType == "primary") | q | endif
Plugin 'scrooloose/nerdtree'

" For run python
map <F5> :call RunPython()<CR>
function RunPython()
  let mp = &makeprg
  let ef = &errorformat
  let exeFile = expand("%:t")
  setlocal makeprg=python\ -u
  set efm=%C\ %.%#,%A\ \ File\ \"%f\"\\,\ line\ %l%.%#,%Z%[%^\ ]%\\@=%m
  silent make %
  copen
  let &makeprg = mp
  let &errorformat = ef
endfunction

" 自动补全括号等以及多行注释
let mapleader=','
" <leader>cc行前注释, <leader>cu解除注释
Plugin 'jiangmiao/auto-pairs'
Plugin 'scrooloose/nerdcommenter'

"缩进指示线, 此插件有可能导致字符串错乱的问题，请勿使用
"let g:indentLine_char='┆'
"let g:indentLine_enabled = 1
"Plugin 'Yggdroot/indentLine'
"autopep8设置"
let g:autopep8_disable_show_diff=1
let g:autopep8_max_line_length=79
Plugin 'tell-k/vim-autopep8'

" global catalog search
let g:ctrlp_working_path_mode = 'ra'
set wildignore+=*/tmp/*,*/node_modules/*,*.so,*.swp,*.zip     
let g:ctrlp_custom_ignore = {'dir':  '\v[\/]\.(git|hg|svn)$', 'file': '\v\.(exe|so|dll)$'}
Plugin 'kien/ctrlp.vim'

" 自动添加头部注释
au BufNewFile *.py call AddPythonTitle()
function AddPythonTitle()
        call append(0,"# -*- coding: utf-8 -*-")
        call append(1,"'''")
        call append(2," * Author        : caitinggui")
        call append(3," * Email         : caitinggui@qq.com")
        call append(4," * Created time  : ".strftime("%Y-%m-%d %H:%M"))
        call append(5," * Description   : ")
        call append(6,"'''")
        echohl WarningMsg | echo "Successful in adding the copyright." | echohl None
endfunction
```

然后，依次安装

```
# 安装Vundle.vim, autopep8, flake8
$ git clone https://github.com/gmarik/Vundle.vim.git ~/.vim/bundle/Vundle.vim
$ sudo pip install autopep8
$ sudo python2 -m pip install flake8  # 安装flake8包

# 安装各个插件
$ vim
:PluginInstall

# 安装YouCompleteMe
$ sudo yum install cmake  # centos的依赖环境
$ sudo yum groupinstall "Development Tools"  
$ cd ~/.vim/bundle/YouCompleteMe # 进行YCM编译
$ ./install.py --clang-completer     # --clang-completer表示支持C类语言的代码补全

# 使用说明：
F2:  nerdtree，文件目录关闭打开
F5:  运行文件
F7:  静态代码检查
<leader>cc, cu:  多行注释, 取消注释
<space>:  代码折叠
Tab:  代码补全
<leader>g:  跳转到定义处
Ctrl + o:  从定义处返回
:Autopep8:  采用pep8格式化代码
Ctrl + p:  项目文件查找
Ctrl + w + w:  切换窗格
```

# 四、 其他
### 4.1 如果要将self也高亮，需要修改syntax文件

```
$ sudo vim /usr/share/vim/vim72/syntax/python.vim
syn keyword pythonBuiltin print property range repr reversed round set self #在print这行添加self
```

### 4.2 vim替换
搜索替换":%s/要搜的东西/要换成的东西/g"
移到一个单词上按#的话可以跳转到这个文档里下一个一样的单词

### 4.3 临时使用sudo权限保存文件：

```vim
# 首先:w执行写文件操作，写的位置是哪里呢？这里调用了sudo命令，使得我们有root权限；将文件写入到tee来处理，tee是什么？它复制标准输入到标准输出（例如到文件），tee的后缀参数为文件名。而%在Vim中的意思是当前文件名。
:w !sudo tee %
```

### 4.4 编译YouCompleteMe出现PYTHON_INCLUDE_DIR2异常
```
-- Could NOT find PythonLibs (missing:  PYTHON_INCLUDE_DIRS) (found version "2.7.6")
CMake Error: The following variables are used in this project, but they are set to NOTFOUND.
Please set them or make sure they are set and tested correctly in the CMake files:
PYTHON_INCLUDE_DIR2 (ADVANCED)
   used as include directory in directory /home/hadoop/.vim/bundle/YouCompleteMe/third_party/ycmd/third_party/cregex
```
解决方法：
```
$ sudo apt-get install python-dev python3-dev python2.7-dev  # 一般都能解决
// 如果不能解决就手动修改Makefile文件
$ vim /home/hadoop/.vim/bundle/YouCompleteMe/third_party/ycmd/third_party/cregex/CMakeLists.txt
include_directories( SYSTEM
                     /usr/include/python2.7 )    # 这行被替换了

add_library( ${PROJECT_NAME} SHARED
             ${REGEX_SOURCES} )

target_link_libraries( ${PROJECT_NAME}
                       /usr/include/python2.7 )  # 这行被替换了

```

参考文档：
- [caitinggui/vimrc](caitinggui/vimrc)
- [flake8官网](http://flake8.readthedocs.io/en/latest/)
- [nerdtree使用参考](http://www.jianshu.com/p/eXMxGx)
- [nerdtree-git官网](https://github.com/Xuyuanp/nerdtree-git-plugin)
- https://realpython.com/blog/python/vim-and-python-a-match-made-in-heaven/
- http://www.jianshu.com/p/f0513d18742a
- http://codingpy.com/article/vim-and-python-match-in-heaven/
- [在vim下按F4自动添加作者信息，文件创作时间等](http://blog.csdn.net/euxnijuoh/article/details/52115910)
- [python头部注释 vim添加头部注释](https://www.cnblogs.com/juandx/p/5626710.html)

将vim打造为好用python IDE

附件: