Python embedding 4 - PyErr_Print() 를 파일로 남기기

원문 보기

파이썬 임베딩을 하면서 가장 유용하게 사용되는 함수 중에 하나가 PyErr_Print()라고 하면, 대부분 공감 하시리라 믿습니다. PyErr_Print()를 통해 우리는 파이썬 모듈을 로드하고 실행하는 중에 발생하는 모든 에러들과 예외 들에 대해 성실하고도 친절한 답변을 받게 됩니다.

그런데 가끔은 PyErr_Print()가 보여 주는 메시지들을 보지 못하는 환경에 놓일 때가 있습니다. 예를 들자면 윈도우의 서비스 프로세스나 리눅스의 데몬 프로세스 같은 경우지요. 앞에 말한 두 종류의 프로세스들은 프로세스의 특성상 stdout 이라던지 stderr과 같은 표준 출력을 지원하지 못하도록 막아 버리는 경우가 대부분 입니다. 그리고 우리의 PyErr_Print()함수는 stderr을 통해서 메시지를 보여 주도록 되어 있는데, stderr이 막혀 있으니 어디로든지 메시지를 전달 할 수 있는 방법이 없는 것 입니다.

그럼 이런 프로세스들은 아예 볼 방법이 없는가라고 물으 실지도 모르겠습니다. 당연히 방법이 있지요. 방법이 없었으면 포스트 시작 하지도 않았습니다. 간단하고 일반적 방법으로는 stderr의 출력을 파일 출력으로 리다이렉션 하는 방법이 있습니다. 그리고 가끔은 메시지 박스등에 출력 해주기 위해서 특정 버퍼로 출력을 원하시는 분들도 있습니다.

이 포스트에서는 첫 번째 방법에 대해서만 설명할 것입니다. 두 번째 방법에 보다 더 흥미를 느끼는 분은 'how to get string printed by PyErr_Print( )?"를 추천 드립니다.

자, 이제 부터 'PyErr_Print()의 메시지를 파일로 출력 하는 방법'에 대해서 살펴 보도록 하겠습니다. 기본 개념은 간단 합니다. sys.stderr에 우리가 출력하길 원하는 파일의 파일 객체를 넣어 주기만 하면 됩니다. 그러기 위해서는 먼저 파일 객체를 만들어 주어야 하겠지요. 아래의 코드를 한번 살펴 보도록 하겠습니다 :

PyObject* objFD = PyFile_FromString("FileNameWhatYouWant.txt", "a");

파일 객체를 만들어 리턴하는 함수 입니다. 첫번째 인자는 만들고자 하는 파일의 경로를 넣어 주고, 두 번째 인자로는 파일의 오픈 모드(open mode)를 설정 합니다. 다시 말해 쓰기 위해 여는지(w), 읽기 전용(r)으로 여는지 등을 지정하는 것입니다. C의 fopen함수와 동일한 의미와 갯수의 파라메터 리스트를 가지고 있습니다.

파일 객체가 정상적으로 생성되고 나면 파일 디스크립터의 버퍼를 0으로 만들어 버립니다 :

PyFile_SetBufSize(objFD, 0);  

PyFile_SetBufSize()함수를 이용해 버퍼 사이즈를 0으로 줄여 버렸습니다. 만일 여기서 버퍼 사이즈를 줄여 주지 않는다면 어떻게 될까요? 결론 부터 말하자면 분명히 에러는 나는데 파일에는 아무 것도 안 써지고 있는 현상이 발생 합니다. 좀 더 기다리시면(약 4096 바이트 정도의 메시지를 발생 시키고 난 후) 원했던 파일에 에러 메시지 들이 잔뜩 쌓여 있는 것을 보실 수 있으실 겁니다. 왜 이럴까요? 기본적으로 파일에 접근 한다는 것은 상당히 느린 연산에 속합니다. 그래서 대부분의 아키텍쳐에서는 파일에 접근하는 횟수를 줄이기 위해서 버퍼링을 사용하게 되고, 버퍼가 가득 차던지 아니면 flush를 하기 전까지는 파일에 접근하지 않지요. 하지만 우리가 원하는 것은 에러가 발생하는 즉시즉시 파일에 기록하길 원합니다. 그렇게 하기 위해서 버퍼 사이즈를 0으로 줄여 버리는 것입니다.

그리고 파이썬 문서에 따르자면 이 함수는 setvbuf() 함수를 지원하는 시스템에서만 사용이 가능하고, 파일 객체 생성 직후 바로 호출 되어야 한다고 적혀 있습니다.

이제는 새로 만들어진 파일 객체를 stderr 대신 사용 하도록 해야 합니다 :

int ret = PySys_SetObject("stderr", objFD);

sys.stderr 파이썬 모듈에 접근하여 stderr대신 새로 만든 파일 객체를 집어 넣어버리는 것입니다. 이로써 stderr로 출력되는 모든 내용들은 objFD가 가리키는 파일로 리다이렉션 되게 되는 것이지요. 물론 stderr에 모든 출력을 하고 있는 PyErr_Print() 함수의 메시지들 역시 그 파일로 기록 되겠지요.

위의 코드를 모아서 함수를 한번 만들어 보도록  하겠습니다. 함수의 이름은 RedirectStderrToFile이라고 정해 볼까요 :

#define CHECK_PYOBJECT(pyObj) (PyErr_Occurred() || NULL == pyObj)

bool RedirctStdErrToFile(char* pFileName, char* mode) {
    PyObject* objFD = PyFile_FromString(pFileName, mode);
    if(CHECK_PYOBJECT(objFD)) {
        return false;
    }
    PyFile_SetBufSize(objFD, 0);
    int ret = PySys_SetObject("stderr", objFD);
    if(ret != 0){
        Py_XDECREF(objFD);
        return false;
    }
    Py_XDECREF(objFD);
    return true;
}

..

int main(int argc, char** argv) {
    Py_Initialize(); // 모든 파이썬 작업에 앞서서 초기화는 필수!!
    ... // 기타 다른 초기화 모듈 로드
    RedirctStdErrToFile("FileNameWhatYouWant.txt", "a"); // 리다이렉션!!

    ... // 파이썬 모듈 로딩과 실행 코드
    PyErr_Print(); // 화면이 아닌 파일로 출력!!!
    ... // etc

    Py_Finalize();
}

오늘도 이렇게 포스팅이 끝났습니다. 얼마 전에 한RSS라는 곳에서 제 블로그를 구독하고 계신 분이 네분이나 된다는 사실을 알고 조금 놀랐습니다. 반말 찍찍하던 포스트들에 존댓말을 쓰기 시작한 것도 아마 그 때 부터인 것 같습니다. 제 꿈중의 하나가 작가가 되는 것인데, 왠지 독자가 생겨서 뿌듯한 기분이군요.