doctest는 파이썬 모듈의 실행 가능성을 테스트하기 위한 간단하고 효과적인 도구입니다. 이 도구를 사용하면 모듈의 독스트링(Docstring)에 포함된 예제 코드를 자동으로 실행하고 결과를 확인할 수 있습니다. 이를 통해 모듈이 예상대로 작동하는지 확인할 수 있으며, 개발 과정에서 실행 가능성을 자동으로 검증할 수 있습니다.

doctest를 사용하여 파이썬 모듈의 실행 가능성을 테스트하는 방법은 다음과 같습니다.

1. 모듈의 독스트링에 테스트 케이스를 작성합니다. 독스트링은 모듈이나 함수의 문서화를 위해 작성되며, 작성한 예시 코드는 doctest에서 실행될 것입니다. 예를 들어, 다음과 같은 독스트링을 작성합니다.

def add(a, b):
    """
    두 개의 숫자를 더하는 함수

    >>> add(1, 2)
    3

    >>> add(10, 5)
    15
    """
    return a + b

1. 테스트를 실행합니다. 터미널에서 python -m doctest -v 모듈이름.py 명령어를 사용하여 테스트를 실행할 수 있습니다. -v 옵션은 상세한 출력을 제공합니다.

$ python -m doctest -v 모듈이름.py

1. 결과를 확인합니다. doctest는 예상 결과와 실제 결과를 비교하여 일치하지 않는 경우 오류를 표시합니다. 모든 테스트 케이스가 성공하면 아무런 결과가 출력되지 않습니다.

Trying:
    add(1, 2)
Expecting:
    3
ok
Trying:
    add(10, 5)
Expecting:
    15
ok
1 items had no tests:
    모듈이름
2 items passed all tests:
   1 tests in 모듈이름.add
   1 tests in 모듈이름
2 tests in 3 items.
2 passed and 0 failed.
Test passed.

위의 예시에서는 모든 테스트 케이스가 성공하여 “Test passed.”라고 표시됩니다.

이와 같이 doctest를 사용하여 파이썬 모듈의 실행 가능성을 테스트할 수 있습니다. doctest는 간단하고 직관적인 테스트 방법으로 개발자들 사이에서 널리 사용되고 있으며, 코드의 작동 여부를 빠르게 확인할 수 있는 장점이 있습니다.

자세한 내용은 파이썬 공식 문서의 doctest 모듈을 참조하십시오.