도움이 필요할 때 코드와 문서를 동기화시키는 것은 중요합니다. pytest와 pytest-doctest를 사용하면 파이썬 코드와 문서를 간단하게 동기화할 수 있습니다. 이 플러그인을 사용하면 코드 샘플을 문서화로 활용하고 테스트할 수 있습니다.

pytest-doctest 란?

pytest는 파이썬 언어로 작성된 소프트웨어의 검증을 위한 테스트 프레임워크입니다. pytest-doctest는 이러한 테스트 케이스들의 예제 코드를 문서화로 사용하고 테스트하는 데 사용됩니다.

pytest-doctest 설치

pytest-doctest를 설치하려면 다음과 같이 실행합니다:

pip install pytest-doctestplus

pytest-doctest 사용법

1. pytest가 설치된 프로젝트 디렉토리에 있는 test_*.py 파일에 테스트 코드를 작성합니다.
2. 각 테스트 함수 앞에 문서화된 예제 코드를 추가합니다.
3. 터미널에서 다음 명령어로 테스트를 실행합니다:

pytest --doctest-modules

예제

다음은 pytest와 pytest-doctest를 사용하여 간단한 덧셈 함수를 테스트하는 예제입니다.

# sample_module.py

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

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

# test_sample_module.py

from sample_module import add

def test_add():
    assert add(2, 3) == 5
    assert add(-1, 1) == 0

위의 예제에서, test_sample_module.py 파일은 sample_module에서의 예제 코드를 테스트합니다.

결론

pytest-doctest를 사용하면 코드와 문서를 쉽게 동기화하고 테스트할 수 있습니다. 이를 통해 코드 변경시 문서와 함께 테스트를 유지하는 것이 더욱 쉬워집니다.

더 많은 정보는 pytest 공식 문서에서 확인할 수 있습니다.