Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
7b51a55e
Commit
7b51a55e
authored
Sep 17, 2015
by
Ethan Furman
Browse files
Options
Browse Files
Download
Plain Diff
Issue24756: clarify usage of run_docstring_examples()
parents
8e3b04c7
2a5f9da5
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
23 additions
and
7 deletions
+23
-7
Doc/library/doctest.rst
Doc/library/doctest.rst
+23
-7
No files found.
Doc/library/doctest.rst
View file @
7b51a55e
...
...
@@ -914,15 +914,10 @@ and :ref:`doctest-simple-testfile`.
above, except that *globs* defaults to ``m.__dict__``.
There'
s
also
a
function
to
run
the
doctests
associated
with
a
single
object
.
This
function
is
provided
for
backward
compatibility
.
There
are
no
plans
to
deprecate
it
,
but
it
's rarely useful:
.. function:: run_docstring_examples(f, globs, verbose=False, name="NoName", compileflags=None, optionflags=0)
Test examples associated with object *f*; for example, *f* may be a
module
,
function, or
class object.
Test examples associated with object *f*; for example, *f* may be a
string
,
a module, a function, or a
class object.
A shallow copy of dictionary argument *globs* is used for the execution context.
...
...
@@ -1815,6 +1810,27 @@ several options for organizing tests:
*
Define
a
``
__test__
``
dictionary
mapping
from
regression
test
topics
to
docstrings
containing
test
cases
.
When
you
have
placed
your
tests
in
a
module
,
the
module
can
itself
be
the
test
runner
.
When
a
test
fails
,
you
can
arrange
for
your
test
runner
to
re
-
run
only
the
failing
doctest
while
you
debug
the
problem
.
Here
is
a
minimal
example
of
such
a
test
runner
::
if
__name__
==
'__main__'
:
import
doctest
flags
=
doctest
.
REPORT_NDIFF
|
doctest
.
FAIL_FAST
if
len
(
sys
.
argv
)
>
1
:
name
=
sys
.
argv
[
1
]
if
name
in
globals
():
obj
=
globals
()[
name
]
else
:
obj
=
__test__
[
name
]
doctest
.
run_docstring_examples
(
obj
,
globals
(),
name
=
name
,
optionflags
=
flags
)
else
:
fail
,
total
=
doctest
.
testmod
(
optionflags
=
flags
)
print
(
"{} failures out of {} tests"
.
format
(
fail
,
total
))
..
rubric
::
Footnotes
..
[#]
Examples
containing
both
expected
output
and
an
exception
are
not
supported
.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment