C++ of the Day #9 - Boost.Python 사용하기 #1

Python은 가장 인기있는 interpret 언어중의 하나입니다. Python의 장점 중 하나는 C/C++ 모듈과 쉽게 연동할 수 있다는 점입니다. 물론 손으로 일일히 wrapper를 만드는 것은 손이 많이 가고 에러를 만들수 있는 작업이나 SWIG등과 같은 도구를 사용하면 쉽게 python 모듈을 만들 수 있습니다.

Boost.Python은 이런 SWIG와 같이 python 모듈을 쉽게 만들 수 있도록 도와주는 라이브러리로 순수 C++만을 사용한다는 점이 SWIG와 다른 점입니다. 그리고 개인적으로는 Boost 라이브러리에 포함되어 있는 것들이 왠지 좀 더 믿음직스러워서... :-)

이번 글에서는 Boost.Python 문서에 나와 있는 예제를 가지고 간단하게 python 모듈을 만드는 방법에 대해서 알아보겠습니다.

Requirements

1. 리눅스
   이 글에서는 리눅스 환경에서의 사용 방법을 설명한다.
2. Boost.Python 라이브러리 (1.33.1)
   Boost 라이브러리를 다운로드받아 아래와 유사한 명령으로 라이브러리를 빌드한다.
bjam -sTOOLS=gcc -with-python install

   bjam의 --prefix 옵션으로 라이브러리가 설치될 위치를 변경할 수 있다.
3. Python 라이브러리 (2.4.3)
   Python을 다운로드 받아 빌드하여 설치한다.
   위의 경우와 유사하게 configure의 --prefix 옵션으로 설치될 위치를 변경할 수 있다.

Write C++ Code

다음과 같이 코드를 작성한다.

// greet.cpp
#include <stdexcept>

char const* greet(unsigned x)
{
  static char const* const msgs[] = { "hello", "Boost.Python", "world!" };
  if (x > 2) 
    throw std::range_error("greet: index out of range");
  return msgs[x];
}

#include <boost python.hpp>
using namespace boost::python;
BOOST_PYTHON_MODULE(hello)
{
  def("greet", greet, "return one of 3 parts of a greeting");
}

일반적으로는 greet 함수 아래쪽의 wrapper와 같은 코드는 다른 파일에 작성하는 것이 보통이나 여기서는 편의를 위해 한 파일에 작성하였다.

Make Module

여기서는 python에서 제공하는 distutils를 사용하는 방법을 설명한다.

1. 먼저 아래와 같이 setup.py를 작성한다.
   

   from distutils.core import setup, Extension
   
   module1 = Extension('hello',
       include_dirs = ['<your path="">/include/boost-1_33_1'],
       libraries = ['boost_python'],
       library_dirs = ['<your path="">/lib'],
       sources = ['greet.cpp'])
   
   setup (name = 'hello',
   version = '1.0',
   description = 'This is a demo package',
   ext_modules = [module1])
   

2. 다음과 같이 setup.py를 실행시킨다.
   

   python setup.py build
   

3. ./build/lib.linux-i686-2.2 와 같은 디렉토리에 만들어진 hello.so 파일을 적당한 디렉토리에 복사한다.

Use Module

이제 hello 모듈을 일반 python 모듈과 같은 방법으로 사용할 수 있다.

>>> import hello
>>> for x in range(3):
...     print hello.greet(x)
... 
hello
Boost.Python
world!
>>> hello.greet(4)
Traceback (most recent call last):
File "<stdin>", line 1, in ?
RuntimeError: greet: index out of range

위의 예제에서 보듯이 C++에서 작성한 예외도 그대로 python 모듈에 적용되는 것을 알 수 있다.

Conclusion

이번에는 간단한 예제 코드를 가지고 Boost.Python의 사용 방법을 알아 보았습니다. 성능이 필요한 core 모듈은 C++로 작성하고 대부분의 glue 코드나 UI 코드는 python으로 작성하는 방법은 개발의 속도를 매우 높여줄 수 있을 것입니다.
저도 아직 이런 식으로 프로젝트를 해본적은 없지만 예전에 특정 라이브러리를 위한 python 모듈을 일일히 손으로 만들어본 적이 있었는데 이 라이브러리를 그때 알았더라면 하는 생각이 드네요. ;-)