Doctest Python — это среда тестирования Python, которая позволяет вам писать тесты как часть документации вашего кода. Он предоставляет возможность писать интерактивные примеры в строках документации и проверять, что они дают ожидаемый результат. Вот несколько методов, которые можно использовать с примерами кода:

Метод 1. Использование модуля doctest

import doctest
def add_numbers(a, b):
    """
    Adds two numbers together.
    >>> add_numbers(2, 3)
    5
    >>> add_numbers(10, -5)
    5
    """
    return a + b
# Run the tests
doctest.testmod()

Метод 2. Использование модуля doctestс тестовыми функциями

import doctest
def multiply_numbers(a, b):
    """
    Multiplies two numbers.
    >>> multiply_numbers(2, 3)
    6
    >>> multiply_numbers(10, -5)
    -50
    """
    return a * b
# Define a test function
def run_tests():
    doctest.testmod(verbose=True)
# Run the test function
run_tests()

Метод 3. Использование модуля doctestс тестовыми классами

import doctest
class Calculator:
    """
    A simple calculator class.
    >>> calc = Calculator()
    >>> calc.add(2, 3)
    5
    >>> calc.multiply(10, -5)
    -50
    """
    def add(self, a, b):
        """Adds two numbers."""
        return a + b
    def multiply(self, a, b):
        """Multiplies two numbers."""
        return a * b
# Run the tests
doctest.testmod()

Это всего лишь несколько примеров того, как вы можете использовать модуль doctestв Python для написания и запуска тестов. Включая тесты в документацию вашего кода, вы гарантируете, что примеры корректны и актуальны. Это может помочь улучшить качество и удобство сопровождения вашего кода.