使用 Python 編寫 vim 插件

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 插件的說明請看官方文檔。

本文由 OSCHINA 譯自：http://brainacle.com/how-to-write-vim-plugins-with-python.html