파이썬 내장 속성 __doc__의 역할과 docstring 조회 방법

파이썬에서 모든 함수는 __doc__이라는 내장 속성을 기본적으로 가지고 있습니다. 이 속성은 함수 소스 코드 안에 정의된 docstring(문서화 문자열)을 그대로 반환합니다.

__doc__ 속성이란?

__doc__은 함수, 클래스, 모듈 등에 작성된 설명 문자열을 저장하는 특수 속성입니다. 개발자가 코드에 남긴 문서화 주석을 프로그램 실행 중에 손쉽게 조회할 수 있어, 코드의 이해도와 유지보수성을 높이는 데 유용합니다.

사용 예제

아래 예제는 함수 내부에 docstring을 정의하고, __doc__ 속성으로 이를 출력하는 방법을 보여줍니다.

def foo():
    """ This is an example of how a doc_string looks like.
        This string gives useful information about the function being defined.
    """
    pass

print(foo.__doc__)

출력 결과

위 코드를 실행하면 함수에 정의된 docstring이 다음과 같이 출력됩니다.

This is an example of how a doc_string looks like.
        This string gives useful information about the function being defined.

알아두면 좋은 점

파이썬 3에서는 print가 함수이므로 반드시 print(foo.__doc__)처럼 괄호를 함께 사용해야 합니다. 또한 help(foo) 함수를 호출하면 __doc__ 내용을 포함한 더 자세한 정보를 확인할 수 있습니다. docstring은 함수 정의 바로 아래 첫 줄에 삼중 따옴표(""")로 작성하는 것이 표준이며, 팀 단위 개발이나 오픈소스 프로젝트에서 코드 문서화를 위해 널리 활용됩니다.