Testing code examples in docstrings with pytest

Pytest tip:

You can test code examples inside your docstrings like so:

$ pytest --doctest-modules http://yourmodule.py


from typing import List

def daily_average(temperatures: List[float]) -> float:
    Get average daily temperature

    Calculate average temperature from multiple measurements

    >>> daily_average( [10.0, 12.0, 14.0])

    : param temperatures: list of temperatures
    : return: Average temperature

    return sum(temperatures) / len(temperatures)

# python -m pytest --doctest-modules temperature. py