What are some examples of doctests in Python?

What are some examples of doctests in Python?

Doctests are a great way to test your code by embedding tests in the docstrings. For example:

def add(a, b):
    """
    Returns the sum of a and b.

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

How do I run doctests in my code?

You can run doctests by using the doctest module. Just add this to your script:

import doctest

doctest.testmod()

This will automatically run all the tests in your docstrings.

Can I use doctests for classes as well?

Absolutely! You can use doctests in class methods too. Here's an example:

class Calculator:
    """
    A simple calculator class.

    >>> calc = Calculator()
    >>> calc.add(2, 3)
    5
    """

    def add(self, a, b):
        return a + b