이제 자세한 방법을 살펴보겠습니다.

1. doctest 모듈 임포트하기

우선 doctest 모듈을 임포트합니다:

import doctest

2. 스크립트에 예제와 결과 추가하기

스크립트 내에 사용 예제와 기대되는 결과를 추가합니다. 이때 예제와 결과는 주석이나 문자열로 작성할 수 있습니다. 아래는 예제를 추가한 간단한 예입니다:

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

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

3. doctest 실행하기

doctest를 실행하여 예제를 실행하고 결과를 검증합니다. 일반적으로는 스크립트의 실행 시점에 doctest.testmod() 함수를 사용하여 테스트합니다:

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

이렇게 하면 스크립트를 실행할 때 doctest가 자동으로 실행되고, 예제들의 결과를 확인할 수 있습니다.

실행 결과 확인하기

스크립트를 실행하면 doctest는 추가한 예제들을 실행하고 결과를 출력합니다. 만약 예제들이 기대하는 결과와 일치하지 않으면 doctest는 에러를 표시합니다.

예를 들어, 위의 예제를 실행하면 다음과 같은 결과를 확인할 수 있습니다:

**********************************************************************
File "example.py", line 4, in __main__.add_numbers
Failed example:
    add_numbers(2, 3)
Expected:
    5
Got:
    6
**********************************************************************
1 items had failures:
   1 of   2 in __main__.add_numbers
***Test Failed*** 1 failures.

위의 결과에서 Expected는 예제의 기대 결과를 나타내고, Got은 실제로 얻은 결과를 나타냅니다. 이를 통해 스크립트의 사용법을 보다 명확하게 확인할 수 있습니다.

doctest를 사용하여 파이썬 스크립트의 사용법을 제공하는 방법을 알아보았습니다. 이를 통해 사용자들이 스크립트를 쉽게 이해하고 사용할 수 있도록 도움이 되었기를 바랍니다.

참고 문서:

• Python 공식 문서 - doctest