doctest를 사용하면 소스 코드와 문서를 한 곳에서 관리할 수 있으며, 문서화를 작성하는 동시에 테스트 코드도 작성할 수 있습니다. 이를 통해 문서화의 일관성을 유지하고, 예제 코드의 정확성을 자동으로 검증할 수 있습니다.

doctest는 다른 테스트 프레임워크와는 달리 코드와 예제를 매우 간결하게 작성할 수 있어 편리합니다. 파이썬 인터프리터에서 독스트링 내의 예제를 실행하고 오류가 발생하지 않으면 테스트 통과로 간주됩니다.

아래는 doctest를 사용하여 간단한 함수를 테스트하는 예제 코드입니다.

def add(a, b):
    """
    두 정수를 더하는 함수

    >>> add(1, 2)
    3
    >>> add(-1, 5)
    4
    >>> add(2, -3)
    -1
    """
    return a + b

if __name__ == "__main__":
    import doctest
    doctest.testmod()

위 예제 코드에서는 add 함수의 독스트링에 테스트 케이스를 작성하였습니다. doctest.testmod() 함수를 호출하면 독스트링 내의 테스트가 실행되고 결과가 출력됩니다.

doctest는 파이썬 표준 라이브러리에 기본적으로 포함되어 있으므로 별도의 설치가 필요하지 않습니다. 자세한 사용법은 파이썬 공식 문서를 참조하시기 바랍니다.