用 Vim 写 Python 的最佳实践

2017-01-27 07:40:23 +08:00
 simple26

先来晒个图:

对于一些 Python 的小项目,使用 vim 是一个不错的选择。下面的整理自在知乎的回答 用 Vim 写 Python 的最佳实践是什么?,比原来的回答多加了一点点内容。

下面的内容是对知乎旧有回答的一个补充,尤其有一些主要针对 vim8. 如果想要查看更多内容,可以查看知乎对于该问题的其它一些回答。

语法检查

如果用 vim8, 那么可以用异步检测的 w0rp/ale 代替 syntastic 了,再也不用羡慕 flycheck, 也不用因为语法检查而卡顿了。

关于 ale 这部分的个性化配置,其实有点 “吹毛求疵”,一般使用默认的应该就够了,不过我喜欢 fancy 的东西,就折腾了一把。涉及的东西可能比较细枝末节,可以直接看 space-vim: syntax-checking 了解一下大概的配置 。主要是针对 ale 提供的 statusline 内容进行再提取进行展示。如果没有语法错误就不显示在 statusline, 如果有 warning 或 error, 则通过不同颜色就行区分。

而关于侧边的 warning 或 error sign, 我喜欢干净一点,用前景色区分就好,下面这样有时候会像一块块的补丁贴在上面,觉得不太好看。

syntax 增强

vim 自带对于 python 的高亮有点弱,连 self 都不给我亮起来, 这一点可以通过 python-mode/python-mode 来进行增强:

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

具体可以看这里 space-vim: python layer

在 python-mode 的 syntax/python.vim 里,可以看到比 vim 自带的 syntax/python.vim 更加细致的高亮群组,应该不难看懂各项内容,照着颜色表自行修改高亮风格就可以了。这是 terminal 256 色对照表 256 Terminal colors and their 24bit equivalent (or similar), 这是 GUI 颜色对照表 Complete HTML True Color Chart

这么做的优点自然是想要什么效果完全可自定义,但是也有缺点,因为可能没办法适配所有的 vim 主题。当你切换主题时,这些针对 python 自定义的高亮也许会有些不太契合。就算是只算流行的那些 vim 主题,恐怕也有两位数了,有些是冷色调,有些是暖色调,有些以蓝色为主,有些是红色居多,应该不太容易找一些百搭的配色。不过每个人所中意的主题可能也就是那么几个,所以自行选择吧.....

其实 python-mode 有点集大成的意思,囊括了用 vim 写 python 的很多功能,有兴趣的可以尝试靠它 “一招打遍天下”。不过,目前我只是中意这一部分而已。

代码格式化

这一点可以通过 google/yapf 来完成,安装好 yapf, 像下面这样 <LocalLeader>= 就能对当前文件进行格式化:

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

自动补全

这一点因为我主要还是使用 vim , 因此用的 YouCompleteMe, 实际后端用的是已经提到的 jedi-vim. 如果不喜欢 ycmd, 使用 neovim 的可以尝试使用 deoplete.nvim .

import 整理

各种 import 是不是显得有点乱?使用 timothycrosley/isort 整理一下吧:

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

一键运行

这个可以通过 skywind3000/asyncrun.vim 来增强, 把之前的 ! 换成 AsyncRun! 就好了. 其实还是有些小小的注意点:

很多人的一键运行可能大概长这样:

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

可以直接把上面的 ! 换成 AsyncRun! 吗?答案是不可以,如果要达到之前的效果,应该要这样:

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

要用分号链接多条命令( linux )或者 & 链接多条命令( windows ),具体可以看 这里

具体的 vim 配置在这里: space-vim (觉得不错的话可以顺便到 github 点个 star 支持下哈), 启用 ycmd, syntax-checking, programming, python Layer 就能达到上面的效果了。

17609 次点击
所在节点    Vim
62 条回复
simple26
2017-01-27 18:46:55 +08:00
@has keep typing 如果没有合适的候选项 继续输入就好了
has
2017-01-27 18:51:50 +08:00
@simple26 #41 假如我要按空格呢?默认会补全当前候选项
假如我要换行呢?也是的
simple26
2017-01-27 18:56:15 +08:00
@has 那你可以看一下我的配置 具体我忘了 我的配置没有这个问题 按空格或换行 不会补全当前候选项
congeec
2017-01-27 21:16:03 +08:00
@has Ctrl-E
4ever911
2017-01-28 08:49:11 +08:00
Fisa VIM + monokai 飘过
simple26
2017-01-28 08:55:20 +08:00
@4ever911 monokai 还是我说的那个问题 像贴"补丁" 影响视觉效果(当然 你也可以理解为更 “醒目”)
simple26
2017-01-28 09:27:42 +08:00
@4ever911 看了一下 感觉 Fisa 的作者应该有段时间没有更新了( Plug 'klen/python-mode' -> Plug 'python-mode/python-mode' )我对 python 的设置有更多内容 是他的超集 看了一圈没有学到什么新内容~
junnplus
2017-01-29 15:35:41 +08:00
试用下 ale 插件,发现会有点问题?异步检测不错,但是在 save 的时候还会进行检测,而且表现和异步检测不一致?我配置了 python flack8_args 的 ignore 参数,在 save 的时候还会提醒
simple26
2017-01-29 15:41:18 +08:00
@junnplus

你可以具体描述一下你的疑惑 我之前对 ale 也有一些误解

python flack8_args 的 ignore 这个参数在哪里?是 ale 提供的?我没有用过...
junnplus
2017-01-29 15:51:33 +08:00
@simple26 需求是:对某些 pep8 规范进行忽略,比如取消对超多 80 个字符的提醒(E501),
在 syntastic 中的设置是这样的`let g:syntastic_python_flake8_args = '--ignore=E501'`
我看了 ale 需要这样 let g:ale_python_flake8_args 可生效,但是生效是在异步检测, save 之后还会提醒
simple26
2017-01-29 16:00:53 +08:00
@junnplus 那么这个时候或许你该到 ale 提个 issue 问一下~ 如果真的是 ale 的问题 相信他会解决的
Gem
2017-01-29 21:45:25 +08:00
有没有配套的 iTerm2 theme?
simple26
2017-01-29 22:38:20 +08:00
@Gem https://github.com/nashamri/spacemacs-theme/issues/29 应该是有的 你可以看一下 我懒得去看了~
simple26
2017-01-30 13:03:19 +08:00
@clavichord93 https://alexpearce.me/2014/05/italics-in-iterm2-vim-tmux/ 这个点或许可以可以让你试一下 iTerm2 我也刚发现 感觉还不错
clavichord93
2017-01-30 15:02:39 +08:00
@simple26 试了一下,感觉 ctrl+d 已经足够让我换到 iterm2 了…
lzhCoooder
2017-01-30 23:01:04 +08:00
mark 一记,非常棒
xuboying
2017-01-31 01:18:47 +08:00
@junnplus 直接写 dot flake8 的配置文件
NoAnyLove
2017-01-31 06:19:53 +08:00
直接晒我的配置文件吧。主要是针对 Python 的配置,本来还要支持 C 的,不过没时间弄完。 youcompleteme 的参数提示功能一直没有合并进主 repo 中。。。。。

基本上就是:

- 用 vim-plug 管理插件
- 代码自动补完用 jedi-vim + ultisnips + youcompleteme 。 jedi-vim 好用比 ycm 的 jedi 后端好用,用 youcompleteme 可以把 jedi-vim 和 ultisnips 的候选一起显示。
- 语法检查什么的也交给 youcompleteme 了
- vim-autoformat 调用 yapf 进行代码格式化
- nerdcommenter 注释功能
- python-mode 一些细节化的支持。不过它自带的 rope 和语法检查什么的都关闭了
- ctrlp.vim 好打开文件
- etc.

最后: C 的重构确实是个大问题啊
NoAnyLove
2017-01-31 06:22:34 +08:00
Betsy
2017-02-06 21:56:32 +08:00
我特别喜欢楼主配色中,侧边的 warning 或 error 标识,这部分能写在 vimrc 文件中吗?可以告诉我该怎么实现吗?

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://tanronggui.xyz/t/337102

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX