Embedded Python 之一

by thinker

關鍵字:

$Python$ 很重要的一個功能，是做為其它 application 的 script language 。透過 embed Pyton 在軟體裡，能讓使用者擴充軟體的功能，或者進行 customize 。 $Python$ 有許多版本，這裡要談的是 $C$ Pyton ，使用 $C$ 語言寫成，並提供 API ，供 $C$ 程式呼叫 $Python$ script ，或者由主程式提供 $Python$ script 呼叫 $C$ routine 的能力。

== Initialize ==
如果你打算為你的 $C$ 主程式，提供 $Python$ script 的能力。不論你是要呼叫 $Python$ script ，或者提供 $Python$ script 額外的功能。在 $C$ 的主程式裡，都必需先初始化 $Python$ engine 。
{{{#!cpp
#include <$Python$.h>

Py_Initialize();
do_something_here();
Py_Finalize();
}}}
第三行和第五行，簡單的進行初始化和收尾的動作。在初始化之後，就可以呼叫 $Python$ 進行一些工作，並提供 $Python$ 一些額外的功能。

== Run $Python$ Scripts ==
例如執行含 $Python$ script 的字串:
{{{#!cpp
PyRun_SimpleString("print 'hello world'");
}}}
或執行 "foo.py" :
{{{#!cpp
#include <$Python$.h>
#include <stdio.h>

int main() {
        FILE *fp;

Py_Initialize();
        fp = fopen("foo.py", "r");
        PyRun_SimpleFile(fp, "foo.py");
        fclose(fp);
        Py_Finalize();
}
}}}

你也可以 import 一個 module ，然後執行裡面的 function 。
{{{#!python
def hello(a, b):
    return a + b
}}}
{{{#!cpp
#include <$Python$.h>
#include <stdio.h>

int main() {
        PyObject *foo;
        PyObject *hello, *ro;
        int r;

Py_Initialize();
        foo = PyImport_ImportModule("foo");
        hello = PyObject_GetAttrString(foo, "hello");
        ro = PyObject_CallFunction(hello, "ii", 15, 20);
        r = PyInt_AsLong(ro);
        
        printf("result is %d\n", r);
        
        Py_DECREF(ro);
        Py_DECREF(hello);
        Py_DECREF(foo);
        Py_Finalize();
}
}}}
 * 第 10 行 import foo module
 * 11 行取得 foo.hello() 這個 function 的 callable object
 * 12 行呼叫該 funciton
    * "ii" 代表呼叫 function 時，要傳入兩個參數，都是 integer 型別。
    * 兩個參數分別是 15 和 20
    * function 的傳回值就是 ro ，一個 integer 的 PyObject
 * 13 行，將 ro 這個 object 的整數值讀取出來，並 assign 為 r
 * 17~19 行，將這些 PyObject 的 reference count 減一

$C$ $Python$ 的 GC 是使用 linkname:[reference count] http://docs.python.org/ext/refcounts.html  的方式，追蹤哪些 object 需要進行回收。因此， $C$ code 必需維持 reference count 的正確性，才能確保資源不會被耗盡。

== 提示 ==
 * 這裡使用到的 API ，都可以在 http://docs.python.org/api/genindex.html 查的到。
 * 執行時，請注意 PYTHONPATH
 * link 時，必需 link python  (for ex: -lpython2.4 in $FreeBSD$ or $Linux$)

最後更新時間: 2007-03-16 23:57:26 CST | 引用

查詢:

COMMENTS:

on 2009-01-09 15:51:00 CST

JJ said ..

執行時，一直說Bus error。後來才發現要用PySys_SetPath("py檔路徑"); 終於會用了，另外感謝你的分享。

on 2009-01-11 12:03:21 CST

Thinker said ..

設 PYTHONPATH 也是同樣的功能。