Test your knowledge: doctest

Practise executable docstrings, testmod and testfile, output matching, expected exceptions, and unittest integration.

6 questions ~8 min Intermediate

Knowledge check

Practise executable docstrings, testmod and testfile, output matching, expected exceptions, and unittest integration.

You can retake this quiz whenever you like.

0:00

0/0

What is the primary job of `doctest`?

Run interactive examples found in docstrings or documentation and compare their output.
Which function checks examples embedded in docstrings of the current module?

`testmod()`
A prompt example evaluates a function that returns the string `"ready"`. What does the interactive display normally include?

The string representation, including quotes: `'ready'`.
You have a README-like text file containing `>>>` examples. Which API should you start with?

`doctest.testfile()`
When a doctest expects an exception, which part is important to include after the traceback header?

The exception type and the expected message/detail.
What does `doctest.DocTestSuite(module)` provide?

A unittest test suite built from doctest examples in that module.

Back to lesson Next: Testing Asynchronous Python Code with unittest

What is the primary job of `doctest`?