read open source pygments 1

pygments 簡單說是一個syntax highlighter，他支援的語言十分之多，最近會突然想閱讀他源碼，其實有部分原因是想開始練習閱讀open source，畢竟為了我另外一個project，我想，閱讀open source的能力，勢必要有所上升才行 :)

另外原因是，之前有朋友問，怎麼在blogger上面hightlight code，關於這個，我之前都是用這個，這是based on javascript的，所以必須要在blogger的後端，加入一些連結，而且每次要寫code時，都必須把code包覆在<pre brush:xx></pre>裡面，才會有效果出現，其實就以寫blog而言，真的有那麼一點不順就是了 :(

不過朋友說他做了設定後，卻沒有效果出來，好吧，我人沒在他旁邊，所以也不知道問題出在哪，所以最近在想乾脆用用pygments將code highlight後output成html格式，再將它PO在blog上面，這樣就比較簡單了 :) 於是我的閱讀之旅就這樣開始拉，雖然僅能利用假日來讀 :(

我想，首先就從package的__init__.py來開始看，應該是沒錯的，如上圖所示，它做了一些最基本的說明 “pygments 是一個用python寫的語法高亮器 bla bla bla” 以下省略 :p

這邊特別說明一下 __all__ 這個東西的效用，其實看官網的說明，就大概知道了，當你用 from pygments import *，如果你有定義 __all__ ，那它只會import 在all裡面的那些東東而已，沒定義的話，就會看你的 __init__.py 裡面有什麼就 import 啥，比如上面有import sys，那它也會跟著import sys，好啦轉回正題~

這個檔案的結構也滿簡單的，highlight這個function用到了 lex 和 format，另外當__init__.py被當成執行入口時，它會import cmdline.py，所以接下來我要去讀的package和檔案其實也滿明顯的，接下來我是選擇先閱讀cmdline.py，其實從名字一看也知道這是關於在cmd中如何進行操作的檔案，看完這檔案，應該就知道怎麼使用 pygments了，畢竟先懂得怎麼使用，然後再試著修改，我想這應該是不錯的順序吧 :p，另外也不用再去看官方docments的操作說明 :)

看吧，果然有使用方法，不過這檔案用到挺多東西的，其中它用到了兩個standard module，

getopt
textwrap

python果然真的是太方便了，光是內建就有一堆好用的東西，雖然這些自己寫一個也是OK拉:p

看了官方說明， getopt 主要是一個 sys.argv的parser， textwrap總之，方便文字格式處理的module，詳細不多說，畢竟這不是這篇文章的重點，且官方有不少說明，或者更有興趣直接看textwrap.py和getopt.py也是可以的。

看了一些code後，使用上並不難，比如想要對test.py輸出一個語法高亮格式為html的檔案，打這樣的指令就可以了

pygmentize -O full,style=emacs -o test.html test.py

基本上只要你有提供輸入輸出檔，pygments會自動判斷該檔案的語法，當然你也可以自己輸入參數去規定syntax就是了，另外關於-O 那邊的設置，可以找源碼中的formatters的html.py裡面有相關說明，不同的輸出格式，會有一些有不同的option，效果如下

a = [ x for x in range(10) ]
b = a[::2]

print(a)
print(b)

我是將輸出的html內容擷取並貼上來，而且還要做一些小處理，只是如果每次都要這樣其實也滿累的 :( 目前就先到這邊吧，下次在PO繼續閱讀的心得，並且想個解決辦法 :p