使用Python编写vim插件的简单示例


Posted in Python onApril 17, 2015

 Vim 插件是一个 .vim 的脚本文件,定义了函数、映射、语法规则和命令,可用于操作窗口、缓冲以及行。一般一个插件包含了命令定义和事件钩子。当使用 Python 编写 vim 插件时,函数外面是使用 VimL 编写,尽管 VimL 学起来很快,但 Python 更加灵活,例如可以用 urllib/httplib/simplejson 来访问某些 Web 服务,这也是为什么很多需要访问 Web 服务的插件都是使用 VimL + Python 编写的原因。

在开始编写插件之前,你需要确认 Vim 支持 Python,通过以下命令来判别:
 

vim --version | grep +python

接下来我们通过一个简单的例子来学习用 Python 编写 Vim 插件,该插件用来获取 Reddit 首页信息并显示在当前缓冲区上。

首先在 Vim 新建 vimmit.vim 文件,我们首先需要判断是否支持 Python,如果不支持给出提示信息:
 

if !has('python')
  echo "Error: Required vim compiled with +python"
  finish
endif

上面这段代码就是用 VimL 编写的,它将检查 Vim 是否支持 Python。

下面是用 Python 编写的 Reddit() 主函数:

 

" Vim comments start with a double quote.
" Function definition is VimL. We can mix VimL and Python in
" function definition.
function! Reddit()
 
" We start the python code like the next line.
 
python << EOF
# the vim module contains everything we need to interface with vim from
# python. We need urllib2 for the web service consumer.
import vim, urllib2
# we need json for parsing the response
import json
 
# we define a timeout that we'll use in the API call. We don't want
# users to wait much.
TIMEOUT = 20
URL = "http://reddit.com/.json"
 
try:
  # Get the posts and parse the json response
  response = urllib2.urlopen(URL, None, TIMEOUT).read()
  json_response = json.loads(response)
 
  posts = json_response.get("data", "").get("children", "")
 
  # vim.current.buffer is the current buffer. It's list-like object.
  # each line is an item in the list. We can loop through them delete
  # them, alter them etc.
  # Here we delete all lines in the current buffer
  del vim.current.buffer[:]
 
  # Here we append some lines above. Aesthetics.
  vim.current.buffer[0] = 80*"-"
 
  for post in posts:
    # In the next few lines, we get the post details
    post_data = post.get("data", {})
    up = post_data.get("ups", 0)
    down = post_data.get("downs", 0)
    title = post_data.get("title", "NO TITLE").encode("utf-8")
    score = post_data.get("score", 0)
    permalink = post_data.get("permalink").encode("utf-8")
    url = post_data.get("url").encode("utf-8")
    comments = post_data.get("num_comments")
 
    # And here we append line by line to the buffer.
    # First the upvotes
    vim.current.buffer.append("↑ %s"%up)
    # Then the title and the url
    vim.current.buffer.append("  %s [%s]"%(title, url,))
    # Then the downvotes and number of comments
    vim.current.buffer.append("↓ %s  | comments: %s [%s]"%(down, comments, permalink,))
    # And last we append some "-" for visual appeal.
    vim.current.buffer.append(80*"-")
 
except Exception, e:
  print e
 
EOF
" Here the python code is closed. We can continue writing VimL or python again.
endfunction

使用如下命令保存文件
 

:source vimmit.vim

然后调用该插件:
 

:call Reddit()

这个命令用起来不那么方便,因此我们再定义一个命令:

command! -nargs=0 Reddit call Reddit()

我们定义了命令:Reddit来调用这个函数。-nargs 参数声明命令行中有多少个参数。

关于函数参数的问题:

问:如何访问函数中的参数?
 

function! SomeName(arg1, arg2, arg3)
  " Get the first argument by name in VimL
  let firstarg=a:arg1
 
  " Get the second argument by position in Viml
  let secondarg=a:1
 
  " Get the arguments in python
 
  python << EOF
  import vim
 
  first_argument = vim.eval("a:arg1") #or vim.eval("a:0")
  second_argument = vim.eval("a:arg2") #or vim.eval("a:1")

你可以使用 ... 来处理可变个数参数来替换特定的参数名,可通过位置或者命名参数来访问,如:(arg1, arg2, ...)

问:如何在 Python 中调用 Vim 命令?
 

vim.command("[vim-command-here]")

问:如何定义全局变量,并在 VimL 和 Python 中访问?

全局变量使用形如 g:. 的前缀,定义全局变量前应该检查该变量是否已定义:
 

if !exists("g:reddit_apicall_timeout")
  let g:reddit_apicall_timeout=40
endif

然后你通过下面代码在 Python 中访问这个变量:
 

TIMEOUT = vim.eval("g:reddit_apicall_timeout")

可通过下面的方法来对全局变量进行重新赋值:
 

let g:reddit_apicall_timeout=60

更多关于使用 Python 编写 Vim 插件的说明请看官方文档。

备注:

一旦你用过VimL,就会发现它挺简单的,你用python写的代码也可以用它来实现。详细请参考vim python模块文档,这是一份重要的参考资料。

除了上述文档,你也可以在IBM developerWorks网站找到一些有用的资料。

Python 相关文章推荐
python使用chardet判断字符串编码的方法
Mar 13 Python
用Python生成器实现微线程编程的教程
Apr 13 Python
python实现用户登录系统
May 21 Python
python学习之matplotlib绘制散点图实例
Dec 09 Python
python获取文件路径、文件名、后缀名的实例
Apr 23 Python
Python docx库用法示例分析
Feb 16 Python
Pytorch修改ResNet模型全连接层进行直接训练实例
Sep 10 Python
Django框架安装方法图文详解
Nov 04 Python
tensorflow对图像进行拼接的例子
Feb 05 Python
基于matplotlib中ion()和ioff()的使用详解
Jun 16 Python
Python基础教程之输入输出和运算符
Jul 26 Python
matplotlib画混淆矩阵与正确率曲线的实例代码
Jun 01 Python
用Python登录Gmail并发送Gmail邮件的教程
Apr 17 #Python
基于Python实现的百度贴吧网络爬虫实例
Apr 17 #Python
python中dir函数用法分析
Apr 17 #Python
python传递参数方式小结
Apr 17 #Python
使用70行Python代码实现一个递归下降解析器的教程
Apr 17 #Python
python类继承与子类实例初始化用法分析
Apr 17 #Python
python中split方法用法分析
Apr 17 #Python
You might like
php版本的cron定时任务执行器使用实例
2014/08/19 PHP
PHP-FPM 设置多pool及配置文件重写操作示例
2019/10/02 PHP
js综合应用实例简单的表格统计
2013/09/03 Javascript
JS实现从表格中动态删除指定行的方法
2015/03/31 Javascript
jQuery each函数源码分析
2016/05/25 Javascript
JS原型链怎么理解
2016/06/27 Javascript
vue2.0父子组件及非父子组件之间的通信方法
2017/01/21 Javascript
原生JavaScript实现精美的淘宝轮播图效果示例【附demo源码下载】
2017/05/27 Javascript
深入理解Vue-cli搭建项目后的目录结构探秘
2017/07/13 Javascript
使用JS动态显示文本
2017/09/09 Javascript
webpack打包js文件及部署的实现方法
2017/12/18 Javascript
Vue实现动态添加或者删除对象和对象数组的操作方法
2018/09/21 Javascript
vue使用rem实现 移动端屏幕适配
2018/09/26 Javascript
JavaScript时间与时间戳的转换操作实例分析
2018/12/07 Javascript
vue.js的vue-cli脚手架中使用百度地图API的实例
2019/01/21 Javascript
Python运行的17个时新手常见错误小结
2012/08/07 Python
python之wxPython应用实例
2014/09/28 Python
python xlsxwriter库生成图表的应用示例
2018/03/16 Python
Python正则表达式和re库知识点总结
2019/02/11 Python
对python中url参数编码与解码的实例详解
2019/07/25 Python
TensorFlow命名空间和TensorBoard图节点实例
2020/01/23 Python
HTML5 的新的表单元素(datalist/keygen/output)使用介绍
2013/07/19 HTML / CSS
团支书的期末学习总结自我评价
2013/11/01 职场文书
车辆安全检查制度
2014/01/12 职场文书
2014年大学庆元旦迎新年活动方案
2014/03/09 职场文书
小学班干部竞选演讲稿
2014/04/24 职场文书
计算机专业自荐信
2014/05/24 职场文书
企业仓管员岗位职责
2014/06/15 职场文书
工商管理本科生求职信
2014/07/13 职场文书
假释思想汇报范文
2014/10/11 职场文书
六年级学生期末评语
2014/12/26 职场文书
财务管理制度范本
2015/08/04 职场文书
字典算法实现及操作 --python(实用)
2021/03/31 Python
pycharm无法导入lxml的解决办法
2021/03/31 Python
CSS实现切角+边框+投影+内容背景色渐变效果
2021/11/01 HTML / CSS
MySQL中一条update语句是如何执行的
2022/03/16 MySQL