doctest는 기본적으로 파이썬 표준 라이브러리에 포함되어 있으므로 별도로 설치할 필요가 없습니다. doctest를 사용하려면 각 함수 또는 클래스의 docstring에 예제를 작성해야합니다. 예제는 실제 코드와 예상 결과를 포함해야하며, 이러한 예제는 파이썬 인터프리터에서 실행될 수 있습니다.

예를 들어, 다음과 같은 함수가 있다고 가정해보겠습니다.

def add(a, b):
    """
    두 수를 더하는 함수입니다.

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

위의 예제에서는 함수 add의 docstring에 add 함수의 예제를 작성했습니다. 이제 doctest를 실행하면 이 예제가 실행되어 함수가 기대하는 결과를 제공하는지 확인할 수 있습니다.

doctest를 실행하려면 다음 명령을 사용하면 됩니다.

python -m doctest -v your_module.py

위 명령어는 your_module.py에 있는 모든 모듈의 doctest를 실행하고, 자세한 실행 결과를 출력합니다. 같은 디렉토리에 있는 다른 모듈의 경우, 해당 모듈 이름을 대신 사용하면 됩니다.

doctest는 예제를 사용하여 코드를 테스트하기 때문에 세부적인 로직을 검증하기에는 적합하지 않을 수 있습니다. 따라서 복잡한 테스트 케이스는 다른 테스트 도구를 사용하는 것이 좋습니다. 하지만 doctest를 함께 사용하면 예제 기반 테스트와 상세한 테스트를 통합하여 라이브러리의 품질을 개선할 수 있습니다.

더 자세한 내용은 doctest 공식 문서를 확인하시기 바랍니다.