VIM, ctags, Python

Posted on  Mar 17, 2016  in  Vim , Python 程式設計 - 高階  by  Amo Chen  ‐ 1 min read

如果你有以下 2 種煩惱不妨看看這篇文章:

  1. 在呼叫某個函數前,去看一下該函數的長什麼樣子,特別是自己寫的函數
  2. 希望更有效率的研究某個 Python 開放原始碼專案

本文將使用 VIM, ctags 來解決這 2 個煩惱。

什麼是 ctags ?

Ctags is a programming tool that generates an index (or tag) file of names found in source and header files of various programming languages.

以上摘自 Wikipedia

簡單來說就是 ctags 會幫你的程式碼中的關鍵字(函數名稱, 變數名稱等等)做一份索引,所以開發者可以透過這些索引迅速跳到定義該關鍵字的地方。

目前我們常用的 ctags 是 exuberant ctags ,雖然 Mac OS X 也有 ctags 可以使用,但並不是 exuberant ctags ,所以本文所用的 ctags 都是指 exuberant ctags

如何使用 ctags ?

安裝指令(Ubuntu)

$ sudo apt-get install exuberant-ctags

使用指南

  1. 建立檔案 ~/.ctags

  2. 在該檔案中加入 --python-kinds=-i ,代表不要對 python 的 import 區塊做索引,因為 import 所用到的模組或函數名稱也會影響到索引的準確度,所以要排除。

  3. 用以下指令為你的 python 專案建立一個 ctags 索引

    $ ctags -R -o ~/myctags /path/to/your/python/project
    

完成上面 3 個步驟就可以有一個 ctags 索引檔

VIM 設定

VIM 可以透過 set tags 讀取 ctags 索引檔。

set tags=/path/to/your/ctags

設定完成後,只要在感興趣的類別名稱或函數上,按下 CTRL + ] 就會跳到該類別名稱或函數所定義的地方去了。

如果要回去原本的地方則是按下 CTRL + T 就可以了。

想知道更多用法的話可以在 VIM 中輸入 :help tags

對抗久坐職業傷害

研究指出每天增加 2 小時坐著的時間,會增加大腸癌、心臟疾病、肺癌的風險,也造成肩頸、腰背疼痛等常見問題。

然而對抗這些問題,卻只需要工作時定期休息跟伸展身體即可!

你想輕鬆改變現狀嗎?試試看我們的 PomodoRoll 番茄鐘吧! PomodoRoll 番茄鐘會根據你所設定的專注時間,定期建議你 1 項辦公族適用的伸展運動,幫助你打敗久坐所帶來的傷害!

贊助我們的創作

看完這篇文章了嗎? 休息一下,喝杯咖啡吧!

如果你覺得 MyApollo 有讓你獲得實用的資訊,希望能看到更多的技術分享,邀請你贊助我們一杯咖啡,讓我們有更多的動力與精力繼續提供高品質的文章,感謝你的支持!