C++ of the Day #12 - Boost.Python 사용하기 #3

지난번 글들 ((http://ideathinking.com/blog/?p=35
http://ideathinking.com/blog/?p=38)) 에 이어 이번에는 Boost.Python에서 C++ 함수 사용시에 신경써야 할 점 몇가지를 알아보겠습니다.

Call Policies

먼저 이해를 돕기 위해 이전에 사용했던 Point 클래스에 아래의 두개의 함수를 추가합니다.

Point* clone() const {
  return new Point(x, y);
}

Point& get_this() {
  return *this;
}

clone() 함수는 자신을 그대로 복제한 새로운 객체를 리턴하는 함수이고 get_this()는 자신을 그대로 리턴합니다. 하지만 python에서는 함수가 리턴하는 것이

새로 생성된 객체인지
- 이 경우 python 런타임은 이 객체를 새로운 obejct로써 관리해야 합니다.
기존에 있던 객체인지
- 이 경우에는 기존의 객체와 이 객체를 같은 object로써 관리해야 합니다.

를 알아야 합니다.

따라서 다음과 같이 python에게 실제 리턴되는 객체의 특성을 설명해주어야 합니다.

.def("clone", &Point::clone, return_value_policy())
.def("get_this", &Point::get_this, return_value_policy())

위의 선언을 통해 clone() 함수는 새로 생성된 객체 포인터를 리턴하고 get_this() 는 기존의 객체를 리턴한다는 것을 python에 알려줄 수 있습니다.

그럼 실행해보기에 앞서 실제 객체의 lifetime이 어떻게 되는지 알아보기 위해 Point 클래스의 소멸자에 cout을 넣도록 하겠습니다.

virtual ~Point() {
  std::cout << "~Point()" << std::endl;
}

다음은 실행 결과입니다.

>>> from point import Point
>>> x = Point(1,2)
>>> y = x.clone()
>>> print x
<point.Point object at 0xf656ffcc>
>>> print y
<point.Point object at 0xf656bc34>
>>> del x
~Point()
>>> del y
~Point()
>>> x = Point(1,2)
>>> y = x.get_this()
>>> print x
<point.Point object at 0xf656ffcc>
>>> print y

>>> del x
>>> del y
~Point()

예상대로 잘 동작함을 확인할 수 있습니다. 더 자세한 내용은 Functions::Call Policies 문서를 참고하세요.

Overloading

Overloading에 대해 알아보기 위해 Point 클래스를 다음과 같이 수정하였습니다.

class Point
{
public:
  Point(int x = 0, int y = 0) : x_(x), y_(y) {
  }
  void x(int x) {
    x_ = x;
  }
  void y(int y) {
    y_ = y;
  }
  int x() const {
    return x_;
  }
  int y() const {
    return y_;
  }
  std::string to_s() const {
    std::ostringstream ss;
    ss << "(" << std::dec << x_ << ", " << y_ << ")";
    return ss.str();
  }
private:
  int x_, y_;
};

보시는 바와 같이 'x'라는 이름으로 get/set 함수를 모두 만들었습니다. 이를 python에서 이용하게 하려면 어떻게 해야 할까요? 애석하게도 이를 위해서는 다음과 같이 손으로 함수 포인터를 다른 이름으로 선언해주어야 합니다. 물론 원래 Point 클래스는 바꾸지 않는 작업입니다.

int (Point::*get_x)() const = &Point::x;
int (Point::*get_y)() const = &Point::y;
void (Point::*set_x)(int)   = &Point::x;
void (Point::*set_y)(int)   = &Point::y;

이를 이용해서 다음과 같이 python에 property를 사용할 수 있습니다.

BOOST_PYTHON_MODULE(point)
{
class_<point>("Point", init<optional<int, int> >())
.add_property("x", get_x, set_x)
.add_property("y", get_y, set_y)
.def("to_s", &Point::to_s)
;
}

사용 예제는 다음과 같습니다.

>>> from point import Point
>>> x = Point()
>>> x.x = 1
>>> x.y = 2
>>> x.x
1
>>> x.y
2
>>> x.to_s()
'(1, 2)'

Default Arguments

자. 이번엔 default arguments에 대해 알아보기 위해 Point 클래스에 다음과 같은 함수를 추가해보겠습니다.

void set(int x = 0, int y = 0) {
  x_ = x;
  y_ = y;
}

이 경우 다음과 같은 helper macro를 사용하여 쉽게 python에서 사용할 수 있습니다.

BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(Point_overloads, set, 0, 2);
...
.def("set", &Point::set, Point_overloads())
...

이 매크로에서 사용된 세번째와 네번째 인자인 0과 2는 각각 해당 함수가 받아들일 수 있는 최소와 최대 인자의 갯수입니다. set() 함수의 경우에는 두개의 인자 모두가 default 값을 가지고 있기 때문에 0 과 2 가 되죠. 생성자에서 사용되는 default arguments의 경우에는 optional이라는 문법을 사용하면 됩니다. 이에 대해선 이전 글의 생성자 사용하기부분을 참고하세요.

Conclusion

조금 까다로운 부분을 알아볼수록 사용자가 해주어야 할 작업이 많아짐을 알 수 있습니다. 하지만 그냥 Python/C API를 쓰는 것에 비하면 별것 아니기도 하거니와 pyste 프로젝트가 완성되면 이런 잡다한 작업들도 자동으로 이루어질 것으로 기대됩니다.

IdeA thinKING

Search This Blog