mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-25 12:44:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Doctest now examines all docstrings by default. Previously, it would

Browse source 
skip over functions with private names (as indicated by the underscore
naming convention).  The old default created too much of a risk that
user tests were being skipped inadvertently.  Note, this change could
break code in the unlikely case that someone had intentionally put
failing tests in the docstrings of private functions.  The breakage
is easily fixable by specifying the old behavior when calling testmod()
or Tester().  The more likely case is that the silent failure was
unintended and that the user needed to be informed so the test could be
fixed.
This commit is contained in:
Raymond Hettinger 2003-07-16 19:25:22 +00:00
parent 853276e16d
commit 71adf7e9d8
3 changed files with 44 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

13
Doc/lib/libdoctest.tex
View file

@ -190,15 +190,16 @@ attempted.
See \file{docstring.py} for all the details. They're unsurprising: the
module docstring, and all function, class and method docstrings are
searched, with the exception of docstrings attached to objects with private
names. Objects imported into the module are not searched.
searched. Optionally, the tester can be directed to exclude
docstrings attached to objects with private names.
Objects imported into the module are not searched.
In addition, if \code{M.__test__} exists and "is true", it must be a
dict, and each entry maps a (string) name to a function object, class
object, or string. Function and class object docstrings found from
\code{M.__test__} are searched even if the name is private, and
strings are searched directly as if they were docstrings. In output,
a key \code{K} in \code{M.__test__} appears with name
\code{M.__test__} are searched even if the the tester has been
directly to skip over private names in the rest of the module.
In output, a key \code{K} in \code{M.__test__} appears with name
\begin{verbatim}
<name of M>.__test__.K
@ -206,7 +207,7 @@ a key \code{K} in \code{M.__test__} appears with name
Any classes found are recursively searched similarly, to test docstrings in
their contained methods and nested classes. While private names reached
from \module{M}'s globals are skipped, all names reached from
from \module{M}'s globals can be optionally skipped, all names reached from
\code{M.__test__} are searched.
\subsection{What's the Execution Context?}