使用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网络爬虫采集联想词示例
Feb 11 Python
kNN算法python实现和简单数字识别的方法
Nov 18 Python
ubuntu环境下python虚拟环境的安装过程
Jan 07 Python
Python2.7 实现引入自己写的类方法
Apr 29 Python
pandas 按照特定顺序输出的实现代码
Jul 10 Python
python实现简单的文字识别
Nov 27 Python
Linux 修改Python命令的方法示例
Dec 03 Python
解决Python pandas plot输出图形中显示中文乱码问题
Dec 12 Python
python实现逐个读取txt字符并修改
Dec 24 Python
对python dataframe逻辑取值的方法详解
Jan 30 Python
Python 3.8中实现functools.cached_property功能
May 29 Python
Python TCPServer 多线程多客户端通信的实现
Dec 31 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
7个超级实用的PHP代码片段
2011/07/11 PHP
php中3des加密代码(完全与.net中的兼容)
2012/08/02 PHP
PHP调用Linux命令权限不足问题解决方法
2015/02/07 PHP
基于PHP技术开发客服工单系统
2016/01/06 PHP
Yii2.0 Basic代码中路由链接被转义的处理方法
2016/09/21 PHP
PHP正则匹配反斜杠'\'和美元'$'的方法
2017/02/08 PHP
php实现图片压缩处理
2020/09/09 PHP
脚本吧 - 幻宇工作室用到js,超强推荐base.js
2006/12/23 Javascript
Javascript操纵Cookie实现购物车程序
2007/02/15 Javascript
对YUI扩展的Gird组件 Part-2
2007/03/10 Javascript
如何调试异步加载页面里包含的js文件
2014/10/30 Javascript
js实现图片淡入淡出切换简易效果
2016/08/22 Javascript
js基于myFocus实现轮播图效果
2017/02/14 Javascript
JS库之wow.js使用方法
2017/09/14 Javascript
手淘flexible.js框架使用和源代码讲解小结
2018/10/15 Javascript
在vue里使用codemirror遇到的问题
2018/11/01 Javascript
python xml解析实例详解
2016/11/14 Python
python一键去抖音视频水印工具
2018/09/14 Python
Pytorch 扩展Tensor维度、压缩Tensor维度的方法
2020/09/09 Python
ONLY德国官方在线商店:购买时尚女装
2017/09/21 全球购物
JD Sports荷兰:英国领先的运动时尚零售商
2020/03/13 全球购物
园林施工员岗位职责
2013/12/11 职场文书
经理秘书找工作求职信
2013/12/19 职场文书
《鸿门宴》教学反思
2014/04/22 职场文书
节水标语大全
2014/06/11 职场文书
人事专员岗位说明书
2014/07/29 职场文书
小学教师自我剖析材料
2014/09/29 职场文书
三方股东合作协议书
2014/10/28 职场文书
二年级语文下册复习计划
2015/01/19 职场文书
绍兴鲁迅故居导游词
2015/02/09 职场文书
2015年小学数学教师工作总结
2015/05/20 职场文书
幼师必备:幼儿园期末教师评语50条
2019/11/01 职场文书
nginx作grpc的反向代理踩坑总结
2021/07/07 Servers
企业开发CSS命名BEM代码规范实践
2022/02/12 HTML / CSS
Hive常用日期格式转换语法
2022/06/25 数据库
Android实现图片九宫格
2022/06/28 Java/Android