U
e5d_� � ! @ st d Z dZdddddddd d
d d d
ddddddddddddddd d d d d d!d"g!Zd#d$lZd#d$lZd#d$lZd#d$lZd#d$lZd#d$lZd#d$l Z d#d$l
Z
d#d$l Z d#d$l Z d#d%l
mZ d#d&lmZ ed'd(�Zi Zd)d� Zed�Zed�Zed�Zed�Zed�Zed�ZeeB eB eB eB eB Zed
�Zed �Z ed �Z ed
�Z ed�Z ee B e B e B e B Z d*Z!d+Z"d,d-� Z#dsd/d0�Z$d1d2� Z%d3d4� Z&dtd6d7�Z'd8d9� Z(G d:d;� d;e�Z)dd?� Z+d@dA� Z,G dBdC� dCej-�Z.dDdE� Z/G dFd� d�Z0G dGd� d�Z1G dHd� d�Z2G dId� d�Z3G dJd� d�Z4G dKd� d�Z5G dLd� de6�Z7G dMd� de6�Z8G dNd� de4�Z9d$a:dudQd�Z;dOd$d$d$d$dOd#d$dPe2� d$f dRd�ZdUd � Z?G dVdW� dWe j@�ZAG dXdY� dYeA�ZBG dZd[� d[e jC�ZDdwd\d �ZEG d]d^� d^eA�ZFdOd$d$e2� d$fd_d`�ZGdad � ZHdbd � ZIdcd � ZJdxddd!�ZKdydedf�ZLdzdgd"�ZMG dhdi� di�ZNeNdjdkdldmdndo�ZOdpdq� ZPeQdrk�rpe
�ReP� � d$S ){a� Module doctest -- a framework for running examples in docstrings.
In simplest use, end each module M to be tested with:
def _test():
import doctest
doctest.testmod()
if __name__ == "__main__":
_test()
Then running the module as a script will cause the examples in the
docstrings to get executed and verified:
python M.py
This won't display anything unless an example fails, in which case the
failing example(s) and the cause(s) of the failure(s) are printed to stdout
(why not stderr? because stderr is a lame hack <0.2 wink>), and the final
line of output is "Test failed.".
Run it with the -v switch instead:
python M.py -v
and a detailed report of all examples tried is printed to stdout, along
with assorted summaries at the end.
You can force verbose mode by passing "verbose=True" to testmod, or prohibit
it by passing "verbose=False". In either of those cases, sys.argv is not
examined by testmod.
There are a variety of other ways to run doctests, including integration
with the unittest framework, and support for running non-Python text
files containing doctests. There are also many ways to override parts
of doctest's default behaviors. See the Library Reference Manual for
details.
zreStructuredText en�register_optionflag�DONT_ACCEPT_TRUE_FOR_1�DONT_ACCEPT_BLANKLINE�NORMALIZE_WHITESPACE�ELLIPSIS�SKIP�IGNORE_EXCEPTION_DETAIL�COMPARISON_FLAGS� REPORT_UDIFF� REPORT_CDIFF� REPORT_NDIFF�REPORT_ONLY_FIRST_FAILURE�REPORTING_FLAGS� FAIL_FAST�Example�DocTest�
DocTestParser�
DocTestFinder�
DocTestRunner�
OutputChecker�DocTestFailure�UnexpectedException� DebugRunner�testmod�testfile�run_docstring_examples� DocTestSuite� DocFileSuite�set_unittest_reportflags�script_from_examples�
testsource� debug_src�debug� N)�StringIO)�
namedtuple� TestResultszfailed attemptedc C s t �| dtt �> �S )N� )�OPTIONFLAGS_BY_NAME�
setdefault�len��name� r, � /usr/lib64/python3.8/doctest.pyr � s z z...c C s8 d}t jD ](}| �|d�}|tt |�kr
||jO }q
|S )z�
Return the compiler-flags associated with the future features that
have been imported into the given namespace (globs).
r" N)�
__future__Zall_feature_names�get�getattrZ
compiler_flag)�globs�flagsZfnameZfeaturer, r, r- �_extract_future_flags� s
r3 � c C sV t �| �r| S t| t�r,t| t� t� dg�S | dkrJtjt� |�j
d S t d��dS )a�
Return the module specified by `module`. In particular:
- If `module` is a module, then return module.
- If `module` is a string, then import and return the
module with that name.
- If `module` is None, then return the calling module.
The calling module is assumed to be the module of
the stack frame at the given depth in the call stack.
�*N�__name__z"Expected a module, string, or None) �inspect�ismodule�
isinstance�str�
__import__�globals�locals�sys�modules� _getframe� f_globals� TypeError)�moduleZdepthr, r, r- �_normalize_module� s
rD c C s dD ]}| � |d�} q| S )N)z
�
�
)�replace)�data�newliner, r, r- �_newline_convert� s rJ c
C s� |rVt |d�}t|| �} t|dd �d k rVt|jd�rV|j�| �}|�|�}t|�| fS t| |d��}|� � | fW 5 Q R � S Q R X d S )N� �
__loader__�get_data)�encoding)
rD �_module_relative_pathr0 �hasattrrL rM �decoderJ �open�read)�filename�package�module_relativerN Z
file_contents�fr, r, r- �_load_testfile� s
rX � c C s t �d|d | �S )z~
Add the given number of space characters to the beginning of
every non-blank line in `s`, and return the result.
z
(?m)^(?!$)� )�re�sub)�s�indentr, r, r- �_indent� s r_ c C s* t � }| \}}}tj||||d� |�� S )zz
Return a string containing a traceback message for the given
exc_info tuple (as returned by sys.exc_info()).
)�file)r# � traceback�print_exception�getvalue)�exc_infoZexcout�exc_typeZexc_valZexc_tbr, r, r- �_exception_traceback� s
rf c @ s e Zd Zdd� Zddd�ZdS )� _SpoofOutc C s$ t �| �}|r |�d�s |d7 }|S �NrF )r# rc �endswith)�self�resultr, r, r- rc s
z_SpoofOut.getvalueNc C s | � |� t�| � d S �N)�seekr# �truncate)rj �sizer, r, r- rn s
z_SpoofOut.truncate)N)r6 �
__module__� __qualname__rc rn r, r, r, r- rg � s rg c C s� t | kr| |kS | �t �}dt|� }}|d }|rR|�|�rNt|�}|d= ndS |d }|r�|�|�r||t|�8 }|d= ndS ||kr�dS |D ],}|�|||�}|dk r� dS |t|�7 }q�dS )z_
Essentially the only subtle case:
>>> _ellipsis_match('aa...aa', 'aaa')
False
r" F�����T)�ELLIPSIS_MARKER�splitr) �
startswithri �find)�want�gotZws�startpos�endpos�wr, r, r- �_ellipsis_match s0
r| c C s | � � } | rd| S dS dS )z)Return a commented form of the given linez# �#N)�rstrip)�liner, r, r- �
_comment_line? s r� c C sh dt | � }}| �d�}|dkr$|}| �dd|�}|dkr>|}| �dd|�}|dkr\|d }| ||� S )Nr" rF �:�.r& )r) rv �rfind)�msg�start�end�ir, r, r- �_strip_exception_detailsG s
r� c @ s2 e Zd ZdZdd� Zd dd�Zdd� Zd d
� ZdS ) �_OutputRedirectingPdbz�
A specialized version of the python debugger that redirects stdout
to a given stream when interacting with the user. Stdout is *not*
redirected when traced code is executed.
c C s( || _ d| _tjj| |dd� d| _d S )NFT)�stdout�nosigintr& )�_OutputRedirectingPdb__out�$_OutputRedirectingPdb__debugger_used�pdb�Pdb�__init__Z use_rawinput)rj �outr, r, r- r� g s z _OutputRedirectingPdb.__init__Nc C s* d| _ |d krt�� j}tj�| |� d S )NT)r� r> r@ �f_backr� r� � set_trace)rj �framer, r, r- r� o s
z _OutputRedirectingPdb.set_tracec C s | j rtj�| � d S rl )r� r� r� � set_continue�rj r, r, r- r� u s z"_OutputRedirectingPdb.set_continuec G s2 t j}| jt _ztjj| f|�� W �S |t _X d S rl )r> r� r� r� r� �trace_dispatch)rj �args� save_stdoutr, r, r- r� { s
z$_OutputRedirectingPdb.trace_dispatch)N)r6 rp rq �__doc__r� r� r� r� r, r, r, r- r� a s
r� c C s� t �| �std| ��|�d�r(td��tjj|�d�� }t | d�rXtj�| j
�d }n�| j dkr�t t
j�dkr�t
jd dkr�tj�t
jd �d }q�tj}nFt | d�r�| jD ]&}tj�||�}tj�|�r�| S q�td | j ��tj�||�S )
NzExpected a module: %r�/z1Module-relative files may not have absolute paths�__file__r" �__main__� �__path__zBCan't resolve paths relative to the module %r (it has no __file__))r7 r8 rB ru �
ValueError�os�path�joinrt rP r� r6 r) r> �argv�curdirr� �exists)rC Z test_pathZbasedirZ directory�fullpathr, r, r- rO � s(
�rO c @ s* e Zd ZdZd
dd�Zdd� Zdd � ZdS ) r an
A single doctest example, consisting of source code and expected
output. `Example` defines the following attributes:
- source: A single Python statement, always ending with a newline.
The constructor adds a newline if needed.
- want: The expected output from running the source code (either
from stdout, or a traceback in case of exception). `want` ends
with a newline unless it's empty, in which case it's an empty
string. The constructor adds a newline if needed.
- exc_msg: The exception message generated by the example, if
the example is expected to generate an exception; or `None` if
it is not expected to generate an exception. This exception
message is compared against the return value of
`traceback.format_exception_only()`. `exc_msg` ends with a
newline unless it's `None`. The constructor adds a newline
if needed.
- lineno: The line number within the DocTest string containing
this Example where the Example begins. This line number is
zero-based, with respect to the beginning of the DocTest.
- indent: The example's indentation in the DocTest string.
I.e., the number of space characters that precede the
example's first prompt.
- options: A dictionary mapping from option flags to True or
False, which is used to override default options for this
example. Any option flags not contained in this dictionary
are left at their default value (as specified by the
DocTestRunner's optionflags). By default, no options are set.
Nr" c C sv |� d�s|d7 }|r(|� d�s(|d7 }|d k rB|� d�sB|d7 }|| _|| _|| _|| _|d krfi }|| _|| _d S rh )ri �sourcerw �linenor^ �options�exc_msg)rj r� rw r� r� r^ r� r, r, r- r� � s
zExample.__init__c C s\ t | �t |�k rtS | j|jkoZ| j|jkoZ| j|jkoZ| j|jkoZ| j|jkoZ| j|jkS rl )�type�NotImplementedr� rw r� r^ r� r� �rj �otherr, r, r- �__eq__� s
�
�
�
�
�zExample.__eq__c C s t | j| j| j| j| jf�S rl )�hashr� rw r� r^ r� r� r, r, r- �__hash__� s �zExample.__hash__)Nr" r" N)r6 rp rq r� r� r� r� r, r, r, r- r � s " �
c @ s8 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd S )
r ae
A collection of doctest examples that should be run in a single
namespace. Each `DocTest` defines the following attributes:
- examples: the list of examples.
- globs: The namespace (aka globals) that the examples should
be run in.
- name: A name identifying the DocTest (typically, the name of
the object whose docstring this DocTest was extracted from).
- filename: The name of the file that this DocTest was extracted
from, or `None` if the filename is unknown.
- lineno: The line number within filename where this DocTest
begins, or `None` if the line number is unavailable. This
line number is zero-based, with respect to the beginning of
the file.
- docstring: The string that the examples were extracted from,
or `None` if the string is unavailable.
c C s, || _ || _|�� | _|| _|| _|| _dS )z�
Create a new DocTest containing the given examples. The
DocTest's globals are initialized with a copy of `globs`.
N)�examples� docstring�copyr1 r+ rT r� )rj r� r1 r+ rT r� r� r, r, r- r� s
zDocTest.__init__c C sR t | j�dkrd}n"t | j�dkr(d}ndt | j� }d| jj| j| j| j|f S )Nr" z no examplesr& z 1 examplez %d examplesz<%s %s from %s:%s (%s)>)r) r� � __class__r6 r+ rT r� )rj r� r, r, r- �__repr__ s ��zDocTest.__repr__c C s\ t | �t |�k rtS | j|jkoZ| j|jkoZ| j|jkoZ| j|jkoZ| j|jkoZ| j|jkS rl )r� r� r� r� r1 r+ rT r� r� r, r, r- r� ) s
�
�
�
�
�zDocTest.__eq__c C s t | j| j| j| jf�S rl )r� r� r+ rT r� r� r, r, r- r� 4 s zDocTest.__hash__c C s: t |t�stS | j| j| jt| �f|j|j|jt|�fk S rl )r9 r r� r+ rT r� �idr� r, r, r- �__lt__8 s
�zDocTest.__lt__N) r6 rp rq r� r� r� r� r� r� r, r, r, r- r � s c @ s� e Zd ZdZe�dejejB �Ze�dejejB ej B �Z
e�d�j Z ddd�Z
dd � Zdd
d �Zd d
� Ze�dej�Zdd� Ze�dej�Zdd� Zdd� Zdd� ZdS )r zD
A class used to parse strings containing doctest examples.
a�
# Source consists of a PS1 line followed by zero or more PS2 lines.
(?P
(?:^(?P [ ]*) >>> .*) # PS1 line
(?:\n [ ]* \.\.\. .*)*) # PS2 lines
\n?
# Want consists of any non-blank lines that do not start with PS1.
(?P (?:(?![ ]*$) # Not a blank line
(?![ ]*>>>) # Not a line starting with PS1
.+$\n? # But any other line
)*)
a�
# Grab the traceback header. Different versions of Python have
# said different things on the first traceback line.
^(?P Traceback\ \(
(?: most\ recent\ call\ last
| innermost\ last
) \) :
)
\s* $ # toss trailing whitespace on the header.
(?P .*?) # don't blink: absorb stuff until...
^ (?P \w+ .*) # a line *starts* with alphanum.
z ^[ ]*(#.*)?$�c
s |� � }| �|�� � dkr8d�� fdd�|�d�D ��}g }d\}}| j�|�D ]�}|�|||�� � � ||�d||�� �7 }| � |||�\}}} }
| �
|�s�|�t || |
|� t |�
d�� |d�� ||�d|�� |�� �7 }|�� }qP|�||d� � |S ) a=
Divide the given string into examples and intervening text,
and return them as a list of alternating Examples and strings.
Line numbers for the Examples are 0-based. The optional
argument `name` is a name identifying this string, and is only
used for error messages.
r" rF c s g | ]}|� d � �qS rl r, ��.0�l�Z
min_indentr, r- �
s z'DocTestParser.parse..�r" r" r^ )r� r^ r� N)�
expandtabs� _min_indentr� rt � _EXAMPLE_RE�finditer�appendr� �count�_parse_example�_IS_BLANK_OR_COMMENTr r) �groupr� ) rj �stringr+ �outputZcharnor� �mr� r� rw r� r, r� r- �parses s*
�
�
zDocTestParser.parsec C s t | �||�|||||�S )a"
Extract all doctest examples from the given string, and
collect them into a `DocTest` object.
`globs`, `name`, `filename`, and `lineno` are attributes for
the new `DocTest` object. See the documentation for `DocTest`
for more information.
)r � get_examples)rj r� r1 r+ rT r� r, r, r- � get_doctest� s �zDocTestParser.get_doctestc C s dd� | � ||�D �S )a�
Extract all doctest examples from the given string, and return
them as a list of `Example` objects. Line numbers are
0-based, because it's most common in doctests that nothing
interesting appears on the same line as opening triple-quote,
and so the first interesting line is called "line 1" then.
The optional argument `name` is a name identifying this
string, and is only used for error messages.
c S s g | ]}t |t�r|�qS r, )r9 r )r� �xr, r, r- r� � s
�z.DocTestParser.get_examples..)r� )rj r� r+ r, r, r- r� � s zDocTestParser.get_examplesc
s
t |�d��� |�d��d�}| �|� ||� | �|dd� d� d ||� d�� fdd �|D ��}|�d
�}|�d�}t |�dkr�t�d |d �r�|d = | �|d� ||t |� � d�� fd
d �|D ��}| j�|�}|r�|�d�}nd}| � |||�} || ||fS )a�
Given a regular expression match from `_EXAMPLE_RE` (`m`),
return a pair `(source, want)`, where `source` is the matched
example's source code (with prompts and indentation stripped);
and `want` is the example's expected output (with indentation
stripped).
`name` is the string's name, and `lineno` is the line number
where the example starts; both are used for error messages.
r^ r� rF r& NrZ r� c s g | ]}|� d d� �qS )rY Nr, )r� Zsl�r^ r, r- r� � s z0DocTestParser._parse_example..rw z *$rr c s g | ]}|� d � �qS rl r, )r� Zwlr� r, r- r� � s r� )
r) r� rt �_check_prompt_blank�
_check_prefixr� r[ �match�
_EXCEPTION_RE�
_find_options)
rj r� r+ r� � source_linesr� rw �
want_linesr� r� r, r� r- r� � s&
� z DocTestParser._parse_examplez#\s*doctest:\s*([^\n\'"]*)$c C s� i }| j �|�D ]v}|�d��dd��� }|D ]V}|d dksN|dd� tkrdtd|d ||f ��t|dd� }|d dk||< q.q|r�| �|�r�td |||f ��|S )
a
Return a dictionary containing option overrides extracted from
option directives in the given source string.
`name` is the string's name, and `lineno` is the line number
where the example starts; both are used for error messages.
r& �,rZ r" z+-Nz7line %r of the doctest for %s has an invalid option: %r�+zSline %r of the doctest for %s has an option directive on a line with no example: %r)�_OPTION_DIRECTIVE_REr� r� rG rt r' r� r� ) rj r� r+ r� r� r� Zoption_strings�option�flagr, r, r- r� � s" � ��zDocTestParser._find_optionsz
^([ ]*)(?=\S)c C s2 dd� | j �|�D �}t|�dkr*t|�S dS dS )z;Return the minimum indentation of any non-blank line in `s`c S s g | ] }t |��qS r, )r) )r� r^ r, r, r- r�
s z-DocTestParser._min_indent..r" N)�
_INDENT_RE�findallr) �min)rj r] �indentsr, r, r- r� s zDocTestParser._min_indentc C s^ t |�D ]P\}}t|�|d kr||d dkrtd|| d ||||d � |f ��qdS )a
Given the lines of a source string (including prompts and
leading indentation), check to make sure that every prompt is
followed by a space character. If any line is not followed by
a space character, then raise ValueError.
rY rK rZ z8line %r of the docstring for %s lacks blank after %s: %rr& N)� enumerater) r� )rj �linesr^ r+ r� r� r r, r, r- r� s ��z!DocTestParser._check_prompt_blankc C s> t |�D ]0\}}|r|�|�std|| d ||f ��qdS )z�
Check that every line in the given list starts with the given
prefix; if any line does not, then raise a ValueError.
zGline %r of the docstring for %s has inconsistent leading whitespace: %rr& N)r� ru r� )rj r� �prefixr+ r� r� r r, r, r- r� s
�zDocTestParser._check_prefixN)r� )r� )r6 rp rq r� r[ �compile� MULTILINE�VERBOSEr� �DOTALLr� r� r� r� r� r� r� r� r� r� r� r� r� r, r, r, r- r C s(
� �
'
3� c @ sN e Zd ZdZde� ddfdd�Zddd�Zd d
� Zd d � Zd
d� Z dd� Z
dS )r a<
A class used to extract the DocTests that are relevant to a given
object, from its docstring and the docstrings of its contained
objects. Doctests can currently be extracted from the following
object types: modules, functions, classes, methods, staticmethods,
classmethods, and properties.
FTc C s || _ || _|| _|| _dS )at
Create a new doctest finder.
The optional argument `parser` specifies a class or
function that should be used to create new DocTest objects (or
objects that implement the same interface as DocTest). The
signature for this factory function should match the signature
of the DocTest constructor.
If the optional argument `recurse` is false, then `find` will
only examine the given object, and not any contained objects.
If the optional argument `exclude_empty` is false, then `find`
will include tests for objects with empty docstrings.
N)�_parser�_verbose�_recurse�_exclude_empty)rj �verbose�parser�recurse�
exclude_emptyr, r, r- r� 7 s zDocTestFinder.__init__Nc C sN |dkr.t |dd�}|dkr.tdt|�f ��|dkrr� )r0 r� r� r7 � getmoduleZ
getsourcefilerB Zgetfile� linecache�getlines�__dict__r� �update�_find�sort) rj �objr+ rC r1 �
extraglobsr` r� �testsr, r, r- rv M sL $ �
zDocTestFinder.findc C s� |dkr dS t �|�dk r(|t �|�kS t �|�r>|j|jkS t �|�r|t|d�r\|jj}nt|d�rn|j}ndS |j |kS t �
|�r�|j |jkS t|d�r�|j |jkS t |t �r�dS t
d��dS )zY
Return true if the given object is defined in the given
module.
NT� __objclass__rp z"object must be a class or function)r7 r� �
isfunctionr� � __globals__ZismethoddescriptorrP r� rp r6 �isclassr9 �propertyr� )rj rC �objectZobj_modr, r, r- � _from_module� s(
zDocTestFinder._from_modulec
C s | j rtd| � t|�|kr"dS d|t|�< | �|||||�}|dk rR|�|� t�|�r�| jr�|j� � D ]P\} }
d|| f } t�
t� |
��s�t� |
�rl| �
||
�rl| �||
| ||||� qlt�|��rn| j�rnt|di �� � D ]�\} }
t| t��stdt| �f ��t�
|
��sJt� |
��sJt�|
��sJt|
t��sJtdt|
�f ��d|| f } | �||
| ||||� q�t� |��r| j�r|j� � D ]�\} }
t|
t��r�t|| �}
t|
t��r�t|| �j}
t�
|
��s�t� |
��s�t|
t��r�| �
||
��r�d|| f } | �||
| ||||� �q�dS ) zm
Find tests for the given object and any contained objects, and
add them to `tests`.
zFinding tests in %sNr& z%s.%s�__test__z5DocTestFinder.find: __test__ keys must be strings: %rz`DocTestFinder.find: __test__ values must be strings, functions, methods, classes, or modules: %rz%s.__test__.%s)r� �printr� � _get_testr� r7 r8 r� r� �itemsZ isroutineZunwrapr� r r� r0 r9 r: r� r� � staticmethod� classmethod�__func__r ) rj r� r� r+ rC r� r1 �seen�testZvalname�valr, r, r- r� � sn
�
� � ���� �
�
� �zDocTestFinder._findc C s� t |t�r|}nJz,|jdkr"d}n|j}t |t�s:t|�}W n ttfk
rX d}Y nX | �||�}| jrt|stdS |dkr�d}n.t|dd�p�|j}|dd� dkr�|dd� }| j �
|||||�S )zs
Return a DocTest for the given object, if it defines a docstring;
otherwise, return None.
Nr� r� ������.pycrr ) r9 r: r� rB �AttributeError� _find_linenor� r0 r6 r� r� ) rj r� r+ rC r1 r� r� r� rT r, r, r- r s,
�zDocTestFinder._get_testc C s d}t �|�rd}t �|�rb|dkr(dS t�dt|dd� �}t|�D ]\}}|�|�rF|} qbqFt �|�rr|j }t �
|�r�|j }t � |�r�|j
}t �|�r�|j}t �|�r�t|dd�d }|dk �r
|dkr�|d S t�d�}t|t|��D ]}|�|| �r�| S q�dS ) z�
Return a line number of the given object's docstring. Note:
this method assumes that the object has a docstring.
Nr" z^\s*class\s*%s\br6 �-�co_firstlinenor& z(^|.*:)\s*\w*("|\'))r7 r8 r� r[ r� r0 r� r� Zismethodr r� �__code__Z istraceback�tb_frameZisframe�f_codeZiscode�ranger) )rj r� r� r� Zpatr� r r, r, r- r 4 s>
�
zDocTestFinder._find_lineno)NNNN) r6 rp rq r� r r� rv r r� r r r, r, r, r- r . s �
f ?&c @ s� e Zd ZdZdZd dd�Zdd� Zd d
� Zd d � Zd
d� Z dd� Z
dd� Z dd� Z e
�d�Zd dd�Zd!dd�Zd"dd �Zd d � ZdS )#r a3
A class used to run DocTest test cases, and accumulate statistics.
The `run` method is used to process a single DocTest case. It
returns a tuple `(f, t)`, where `t` is the number of test cases
tried, and `f` is the number of test cases that failed.
>>> tests = DocTestFinder().find(_TestClass)
>>> runner = DocTestRunner(verbose=False)
>>> tests.sort(key = lambda test: test.name)
>>> for test in tests:
... print(test.name, '->', runner.run(test))
_TestClass -> TestResults(failed=0, attempted=2)
_TestClass.__init__ -> TestResults(failed=0, attempted=2)
_TestClass.get -> TestResults(failed=0, attempted=2)
_TestClass.square -> TestResults(failed=0, attempted=1)
The `summarize` method prints a summary of all the test cases that
have been run by the runner, and returns an aggregated `(f, t)`
tuple:
>>> runner.summarize(verbose=1)
4 items passed all tests:
2 tests in _TestClass
2 tests in _TestClass.__init__
2 tests in _TestClass.get
1 tests in _TestClass.square
7 tests in 4 items.
7 passed and 0 failed.
Test passed.
TestResults(failed=0, attempted=7)
The aggregated number of tried examples and failed examples is
also available via the `tries` and `failures` attributes:
>>> runner.tries
7
>>> runner.failures
0
The comparison between expected outputs and actual outputs is done
by an `OutputChecker`. This comparison may be customized with a
number of option flags; see the documentation for `testmod` for
more information. If the option flags are insufficient, then the
comparison may also be customized by passing a subclass of
`OutputChecker` to the constructor.
The test runner's display output can be controlled in two ways.
First, an output function (`out) can be passed to
`TestRunner.run`; this function will be called with strings that
should be displayed. It defaults to `sys.stdout.write`. If
capturing the output is not sufficient, then the display output
can be also customized by subclassing DocTestRunner, and
overriding the methods `report_start`, `report_success`,
`report_unexpected_exception`, and `report_failure`.
zF**********************************************************************Nr" c C sN |pt � | _|dkr dtjk}|| _|| _|| _d| _d| _i | _ t
� | _ dS )ac
Create a new test runner.
Optional keyword arg `checker` is the `OutputChecker` that
should be used to compare the expected outputs and actual
outputs of doctest examples.
Optional keyword arg 'verbose' prints lots of stuff if true,
only failures if false; by default, it's true iff '-v' is in
sys.argv.
Optional argument `optionflags` can be used to control how the
test runner compares expected output to actual output, and how
it displays failures. See the documentation for `testmod` for
more information.
N�-vr" ) r �_checkerr> r� r� � optionflags�original_optionflags�tries�failures�_name2ftrg �_fakeout)rj �checkerr� r r, r, r- r� � s
zDocTestRunner.__init__c C sH | j rD|jr.|dt|j� d t|j� � n|dt|j� d � dS )z�
Report that the test runner is about to process the given
example. (Only displays a message if verbose=True)
zTrying:
z Expecting:
zExpecting nothing
N)r� rw r_ r� )rj r� r �exampler, r, r- � report_start� s ���zDocTestRunner.report_startc C s | j r|d� dS )zt
Report that the given example ran successfully. (Only
displays a message if verbose=True)
zok
N)r� �rj r� r r rx r, r, r- �report_success� s z DocTestRunner.report_successc C s& || � ||�| j�||| j� � dS )z7
Report that the given example failed.
N)�_failure_headerr �output_differencer r" r, r, r- �report_failure� s �z DocTestRunner.report_failurec C s$ || � ||�d tt|�� � dS )zO
Report that the given example raised an unexpected exception.
zException raised:
N)r$ r_ rf �rj r� r r rd r, r, r- �report_unexpected_exception� s
�
�z)DocTestRunner.report_unexpected_exceptionc C s� | j g}|jrR|jd k r4|jd k r4|j|j d }nd}|�d|j||jf � n|�d|jd |jf � |�d� |j}|�t|�� d�|�S )Nr& �?zFile "%s", line %s, in %szLine %s, in %szFailed example:rF )�DIVIDERrT r� r� r+ r� r_ r� )rj r r r� r� r� r, r, r- r$ � s �
z DocTestRunner._failure_headerc C s� d }}| j }td�\}}} | jj}
t|j�D �]6\} } | j t@ oH|dk}
|| _ | jr�| j�� D ],\}}|r|| j |O _ q`| j | M _ q`| j t @ r�q.|d7 }|
s�| �
||| � d|j | f }z,t t
| j|d|d�|j� | j�� d}W n4 tk
�r � Y n t�� }| j�� Y nX | j�� }| j�d� |}|dk�r`|
| j|| j ��r�|}n|tj|dd� � d }|
�s�|t|�7 }| j dk�r�| }nB|
| j || j ��r�|}n*| j t @ �r�|
t | j �t |�| j ��r�|}||k�r�|
�sR| � ||| |� nT||k�r(|
�s | � ||| |� |d7 }n*|| k�rR|
�sH| �!||| |� |d7 }n |r.| j t"@ r. �qhq.|| _ | �#|||� t$||�S ) a�
Run the examples in `test`. Write the outcome of each example
with one of the `DocTestRunner.report_*` methods, using the
writer function `out`. `compileflags` is the set of compiler
flags that should be used to execute examples. Return a tuple
`(f, t)`, where `t` is the number of examples tried, and `f`
is the number of examples that failed. The examples are run
in the namespace `test.globs`.
r" rK r& zZsingleNr4 rr )%r r r � check_outputr� r� r r� r r r! r+ �execr� r� r1 �debuggerr� �KeyboardInterruptr> rd r rc rn rw ra �format_exception_onlyrf r� r r� r# r& r( r � _DocTestRunner__record_outcomer% )rj r � compileflagsr� r r r �SUCCESS�FAILUREZBOOMZcheck�
examplenumr �quietZ
optionflagr rT Z exceptionrx Zoutcomer� r, r, r- Z__run� s�
�
��
�
�
zDocTestRunner.__runc C sL | j �|jd�\}}|| || f| j |j< | j|7 _| j|7 _dS )z{
Record the fact that the given DocTest (`test`) generated `f`
failures out of `t` tried examples.
r� N)r r/ r+ r r )rj r rW �t�f2�t2r, r, r- Z__record_outcome| s z DocTestRunner.__record_outcomez..+)\[(?P\d+)\]>$c C sV | j �|�}|rF|�d�| jjkrF| jjt|�d�� }|jjdd�S | � ||�S d S )Nr+ r4 T��keepends)
�%_DocTestRunner__LINECACHE_FILENAME_REr� r� r r+ r� �intr� �
splitlines�save_linecache_getlines)rj rT �module_globalsr� r r, r, r- Z __patched_linecache_getlines� s
z*DocTestRunner.__patched_linecache_getlinesTc s || _ |dkrt|j�}tj�|dkrV�j� � dks@� �� dkrH�j}n� �fdd�}| jt_t� � }t
j }t ��| _
| j
�� | j
j t
_ tj| _| jt_tj}tjt_z| �|||�W �S �t_|t
_ t�|� | jt_|t_|� r�|j�� ddl}d|_X dS )aJ
Run the examples in `test`, and display the results using the
writer function `out`.
The examples are run in the namespace `test.globs`. If
`clear_globs` is true (the default), then this namespace will
be cleared after the test runs, to help with garbage
collection. If you would like to examine the namespace after
the test completes, then use `clear_globs=False`.
`compileflags` gives the set of flags that should be used by
the Python compiler when running the examples. If not
specified, then it will default to the set of future-import
flags that apply to `globs`.
The output of each example is checked using
`DocTestRunner.check_output`, and the results are formatted by
the `DocTestRunner.report_*` methods.
N�utf-8c s t | �� d�� �} ��| � d S )N�backslashreplace)r: �encode�write)r] �rN r� r, r- r� � s z DocTestRunner.run..outr" )r r3 r1 r> r� rN �lowerrC r �gettracer� r� r� r- �resetr� r� r> �*_DocTestRunner__patched_linecache_getlines� displayhook�__displayhook__�settrace�clear�builtins�_�_DocTestRunner__run) rj r r1 r� � clear_globsZ
save_traceZsave_set_traceZsave_displayhookrM r, rD r- �run� s<
zDocTestRunner.runc
C s� |dkr| j }g }g }g }d }}| j�� D ]V}|\}\} }
||
7 }|| 7 }|
dkr`|�|� q,| dkrx|�||
f� q,|�|� q,|r�|r�tt|�d� |�� |D ]} td| � q�|r�tt|�d� |�� |D ]\} } td| | f � q�|�r:t| j� tt|�d� |�� |D ] \} \} }
td| |
| f � �q|�rft|d t| j�d
� t|| d |d � |�rztd
|d� n|�r�td� t||�S )a�
Print a summary of all the test cases that have been run by
this DocTestRunner, and return a tuple `(f, t)`, where `f` is
the total number of failed examples, and `t` is the total
number of tried examples.
The optional `verbose` argument controls how detailed the
summary is. If the verbosity is not specified, then the
DocTestRunner's verbosity is used.
Nr" zitems had no tests:z zitems passed all tests:z %3d tests in %szitems had failures:z %3d of %3d in %sztests inzitems.z
passed andzfailed.z***Test Failed***z failures.z Test passed.) r� r r r� r r) r� r* r% )
rj r� ZnotestsZpassedZfailedZtotaltZtotalfr� r+ rW r6 �thingr� r, r, r- � summarize� sP
zDocTestRunner.summarizec C sR | j }|j �� D ]<\}\}}||kr@|| \}}|| }|| }||f||< qd S rl )r r )rj r� �dr+ rW r6 r7 r8 r, r, r- �merge s zDocTestRunner.merge)NNr" )N)NNT)N)r6 rp rq r� r* r� r! r# r& r( r$ rO r0 r[ r� r; rH rQ rS rU r, r, r, r- r h s 9
$
}
I
9c @ s0 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
S ) r a_
A class used to check the whether the actual output from a doctest
example matches the expected output. `OutputChecker` defines two
methods: `check_output`, which compares a given pair of outputs,
and returns true if they match; and `output_difference`, which
returns a string describing the differences between two outputs.
c C s t |�dd�d�S )z=
Convert string to hex-escaped ASCII string.
�ASCIIrA )r: rB )rj r] r, r, r- �_toAscii( s zOutputChecker._toAsciic C s� | � |�}| � |�}||kr dS |t@ sH||fdkr8dS ||fdkrHdS |t@ s�t�dt�t� d|�}t�dd|�}||kr�dS |t@ r�d�|� � �}d�|� � �}||kr�dS |t
@ r�t ||�r�dS dS ) a�
Return True iff the actual output from an example (`got`)
matches the expected output (`want`). These strings are
always considered to match if they are identical; but
depending on what option flags the test runner is using,
several non-exact match types are also possible. See the
documentation for `TestRunner` for more information about
option flags.
T)zTrue
z1
)zFalse
z0
z (?m)^%s\s*?$r� z(?m)^[^\S\n]+$rZ F) rW r r r[ r\ �escape�BLANKLINE_MARKERr r� rt r r| �rj rw rx r r, r, r- r+ . s4
�
zOutputChecker.check_outputc C s< |t tB tB @ sdS |t@ r dS |�d�dko:|�d�dkS )NFTrF r4 )r r
r r� rZ r, r, r- �_do_a_fancy_diffm s �� z OutputChecker._do_a_fancy_diffc
C s( |j }|t@ s t�dt|�}| �|||�r�|jdd�}|jdd�}|t@ rptj ||dd�}t
|�dd� }d}nZ|t @ r�tj ||dd�}t
|�dd� }d}n,|t
@ r�tjtjd �} t
| �||��}d
}n d | td �|�� S |r�|r�d
t|�t|�f S |�rdt|� S |�r dt|� S dS dS )z�
Return a string describing the differences between the
expected output for a given example (`example`) and the actual
output (`got`). `optionflags` is the set of option flags used
to compare `want` and `got`.
z(?m)^[ ]*(?=
)Tr9 r4 )�nNz#unified diff with -expected +actualz-context diff with expected followed by actual)Zcharjunkz ndiff with -expected +actualzDifferences (%s):
r� zExpected:
%sGot:
%szExpected:
%sGot nothing
zExpected nothing
Got:
%sz Expected nothing
Got nothing
)rw r r[ r\ rY r[ r= r �difflibZ unified_diff�listr
Z context_diffr ZDifferZIS_CHARACTER_JUNKZcomparer_ r� )
rj r rx r rw r� Z got_linesZdiffZkindZenginer, r, r- r% � s4 z OutputChecker.output_differenceN)r6 rp rq r� rW r+ r[ r% r, r, r, r- r s
?c @ s e Zd ZdZdd� Zdd� ZdS )r z�A DocTest example has failed in debugging mode.
The exception instance has variables:
- test: the DocTest object being run
- example: the Example object that failed
- got: the actual output
c C s || _ || _|| _d S rl )r r rx )rj r r rx r, r, r- r� � s zDocTestFailure.__init__c C s
t | j�S rl �r: r r� r, r, r- �__str__� s zDocTestFailure.__str__N�r6 rp rq r� r� r` r, r, r, r- r � s
c @ s e Zd ZdZdd� Zdd� ZdS )r z�A DocTest example has encountered an unexpected exception
The exception instance has variables:
- test: the DocTest object being run
- example: the Example object that failed
- exc_info: the exception info
c C s || _ || _|| _d S rl )r r rd )rj r r rd r, r, r- r� � s z UnexpectedException.__init__c C s
t | j�S rl r_ r� r, r, r- r` � s zUnexpectedException.__str__Nra r, r, r, r- r � s
c @ s* e Zd ZdZd
dd�Zdd� Zdd � ZdS ) r a� Run doc tests but raise an exception as soon as there is a failure.
If an unexpected exception occurs, an UnexpectedException is raised.
It contains the test, the example, and the original exception:
>>> runner = DebugRunner(verbose=False)
>>> test = DocTestParser().get_doctest('>>> raise KeyError\n42',
... {}, 'foo', 'foo.py', 0)
>>> try:
... runner.run(test)
... except UnexpectedException as f:
... failure = f
>>> failure.test is test
True
>>> failure.example.want
'42\n'
>>> exc_info = failure.exc_info
>>> raise exc_info[1] # Already has the traceback
Traceback (most recent call last):
...
KeyError
We wrap the original exception to give the calling application
access to the test and example information.
If the output doesn't match, then a DocTestFailure is raised:
>>> test = DocTestParser().get_doctest('''
... >>> x = 1
... >>> x
... 2
... ''', {}, 'foo', 'foo.py', 0)
>>> try:
... runner.run(test)
... except DocTestFailure as f:
... failure = f
DocTestFailure objects provide access to the test:
>>> failure.test is test
True
As well as to the example:
>>> failure.example.want
'2\n'
and the actual output:
>>> failure.got
'1\n'
If a failure or error occurs, the globals are left intact:
>>> del test.globs['__builtins__']
>>> test.globs
{'x': 1}
>>> test = DocTestParser().get_doctest('''
... >>> x = 2
... >>> raise KeyError
... ''', {}, 'foo', 'foo.py', 0)
>>> runner.run(test)
Traceback (most recent call last):
...
doctest.UnexpectedException:
>>> del test.globs['__builtins__']
>>> test.globs
{'x': 2}
But the globals are cleared if there is no error:
>>> test = DocTestParser().get_doctest('''
... >>> x = 2
... ''', {}, 'foo', 'foo.py', 0)
>>> runner.run(test)
TestResults(failed=0, attempted=1)
>>> test.globs
{}
NTc C s$ t �| |||d�}|r |j�� |S )NF)r rQ r1 rL )rj r r1 r� rP �rr, r, r- rQ 3 s
zDebugRunner.runc C s t |||��d S rl )r r' r, r, r- r( 9 s z'DebugRunner.report_unexpected_exceptionc C s t |||��d S rl )r r" r, r, r- r& < s zDebugRunner.report_failure)NNT)r6 rp rq r� rQ r( r& r, r, r, r- r � s Z
TFc C s� | dkrt j�d�} t�| �s,td| f ��|dkr:| j}t|d�} |rVt||d�}
n t ||d�}
| j
| |||d�D ]} |
� | � qt|r�|
� � t
dkr�|
a
n
t
�|
� t|
j|
j�S )a*
m=None, name=None, globs=None, verbose=None, report=True,
optionflags=0, extraglobs=None, raise_on_error=False,
exclude_empty=False
Test examples in docstrings in functions and classes reachable
from module m (or the current module if m is not supplied), starting
with m.__doc__.
Also test examples reachable from dict m.__test__ if it exists and is
not None. m.__test__ maps names to functions, classes and strings;
function and class docstrings are tested even if the name is private;
strings are tested directly, as if they were docstrings.
Return (#failures, #tests).
See help(doctest) for an overview.
Optional keyword arg "name" gives the name of the module; by default
use m.__name__.
Optional keyword arg "globs" gives a dict to be used as the globals
when executing examples; by default, use m.__dict__. A copy of this
dict is actually used for each docstring, so that each docstring's
examples start with a clean slate.
Optional keyword arg "extraglobs" gives a dictionary that should be
merged into the globals that are used to execute examples. By
default, no extra globals are used. This is new in 2.4.
Optional keyword arg "verbose" prints lots of stuff if true, prints
only failures if false; by default, it's true iff "-v" is in sys.argv.
Optional keyword arg "report" prints a summary at the end when true,
else prints nothing at the end. In verbose mode, the summary is
detailed, else very brief (in fact, empty if all tests passed).
Optional keyword arg "optionflags" or's together module constants,
and defaults to 0. This is new in 2.3. Possible values (see the
docs for details):
DONT_ACCEPT_TRUE_FOR_1
DONT_ACCEPT_BLANKLINE
NORMALIZE_WHITESPACE
ELLIPSIS
SKIP
IGNORE_EXCEPTION_DETAIL
REPORT_UDIFF
REPORT_CDIFF
REPORT_NDIFF
REPORT_ONLY_FIRST_FAILURE
Optional keyword arg "raise_on_error" raises an exception on the
first unexpected exception or failure. This allows failures to be
post-mortem debugged.
Advanced tomfoolery: testmod runs methods of a local instance of
class doctest.Tester, then merges the results into (or creates)
global Tester instance doctest.master. Methods of doctest.master
can be called directly too, if you want to do something unusual.
Passing report=0 to testmod is especially useful then, to delay
displaying a summary. Invoke doctest.master.summarize(verbose)
when you're done fiddling.
Nr� z testmod: module required; %r)r� �r� r �r1 r� )r> r? r/ r7 r8 rB r6 r r r rv rQ rS �masterrU r% r r ) r� r+ r1 r� �reportr r� �raise_on_errorr� �finder�runnerr r, r, r- r H s$ E
c C s� |r|st d��t| ||| p d�\} } |dkr:tj�| �}|dkrHi }n|�� }|dk rb|�|� d|krrd|d< | r�t||d�}
n t||d�}
|
� | ||| d�}|
�
|� |r�|
� � t dkr�|
a n
t �
|
� t|
j|
j�S )a
Test examples in the given file. Return (#failures, #tests).
Optional keyword arg "module_relative" specifies how filenames
should be interpreted:
- If "module_relative" is True (the default), then "filename"
specifies a module-relative path. By default, this path is
relative to the calling module's directory; but if the
"package" argument is specified, then it is relative to that
package. To ensure os-independence, "filename" should use
"/" characters to separate path segments, and should not
be an absolute path (i.e., it may not begin with "/").
- If "module_relative" is False, then "filename" specifies an
os-specific path. The path may be absolute or relative (to
the current working directory).
Optional keyword arg "name" gives the name of the test; by default
use the file's basename.
Optional keyword argument "package" is a Python package or the
name of a Python package whose directory should be used as the
base directory for a module relative filename. If no package is
specified, then the calling module's directory is used as the base
directory for module relative filenames. It is an error to
specify "package" if "module_relative" is False.
Optional keyword arg "globs" gives a dict to be used as the globals
when executing examples; by default, use {}. A copy of this dict
is actually used for each docstring, so that each docstring's
examples start with a clean slate.
Optional keyword arg "extraglobs" gives a dictionary that should be
merged into the globals that are used to execute examples. By
default, no extra globals are used.
Optional keyword arg "verbose" prints lots of stuff if true, prints
only failures if false; by default, it's true iff "-v" is in sys.argv.
Optional keyword arg "report" prints a summary at the end when true,
else prints nothing at the end. In verbose mode, the summary is
detailed, else very brief (in fact, empty if all tests passed).
Optional keyword arg "optionflags" or's together module constants,
and defaults to 0. Possible values (see the docs for details):
DONT_ACCEPT_TRUE_FOR_1
DONT_ACCEPT_BLANKLINE
NORMALIZE_WHITESPACE
ELLIPSIS
SKIP
IGNORE_EXCEPTION_DETAIL
REPORT_UDIFF
REPORT_CDIFF
REPORT_NDIFF
REPORT_ONLY_FIRST_FAILURE
Optional keyword arg "raise_on_error" raises an exception on the
first unexpected exception or failure. This allows failures to be
post-mortem debugged.
Optional keyword arg "parser" specifies a DocTestParser (or
subclass) that should be used to extract tests from the files.
Optional keyword arg "encoding" specifies an encoding that should
be used to convert the file to unicode.
Advanced tomfoolery: testmod runs methods of a local instance of
class doctest.Tester, then merges the results into (or creates)
global Tester instance doctest.master. Methods of doctest.master
can be called directly too, if you want to do something unusual.
Passing report=0 to testmod is especially useful then, to delay
displaying a summary. Invoke doctest.master.summarize(verbose)
when you're done fiddling.
�8Package may only be specified for module-relative paths.r@ Nr6 r� rc r" )r� rX r� r� �basenamer� r� r r r� rQ rS re rU r% r r )rT rV r+ rU r1 r� rf r r� rg r� rN �textri r r, r, r- r � s2 R�
�NoNamec C s@ t |dd�}t||d�}|j| ||d�D ]}|j||d� q(dS )ar
Test examples in the given object's docstring (`f`), using `globs`
as globals. Optional argument `name` is used in failure messages.
If the optional argument `verbose` is true, then generate output
even if there are no failures.
`compileflags` gives the set of flags that should be used by the
Python compiler when running the examples. If not specified, then
it will default to the set of future-import flags that apply to
`globs`.
Optional keyword arg `optionflags` specifies options for the
testing and output. See the documentation for `testmod` for more
information.
F)r� r� rc )r1 )r1 N)r r rv rQ ) rW r1 r� r+ r1 r rh ri r r, r, r- r + s c C s" | t @ | krtd| ��t}| a|S )a? Sets the unittest option flags.
The old flag is returned so that a runner could restore the old
value if it wished to:
>>> import doctest
>>> old = doctest._unittest_reportflags
>>> doctest.set_unittest_reportflags(REPORT_NDIFF |
... REPORT_ONLY_FIRST_FAILURE) == old
True
>>> doctest._unittest_reportflags == (REPORT_NDIFF |
... REPORT_ONLY_FIRST_FAILURE)
True
Only reporting flags can be set:
>>> doctest.set_unittest_reportflags(ELLIPSIS)
Traceback (most recent call last):
...
ValueError: ('Only reporting flags allowed', 8)
>>> doctest.set_unittest_reportflags(old) == (REPORT_NDIFF |
... REPORT_ONLY_FIRST_FAILURE)
True
z Only reporting flags allowed)r
r� �_unittest_reportflags)r2 �oldr, r, r- r H s
c @ sl e Zd Zddd�Zdd� Zdd� Zd d
� Zd d � Zd
d� Zdd� Z dd� Z
dd� Z dd� Z e
jZdd� ZdS )� DocTestCaser" Nc C s. t j�| � || _|| _|| _|| _|| _d S rl )�unittest�TestCaser� �_dt_optionflags� _dt_checker�_dt_test� _dt_setUp� _dt_tearDown)rj r r �setUp�tearDownr r, r, r- r� n s zDocTestCase.__init__c C s | j }| jd k r| �|� d S rl )ru rv �rj r r, r, r- rx x s
zDocTestCase.setUpc C s( | j }| jd k r| �|� |j�� d S rl )ru rw r1 rL rz r, r, r- ry ~ s
zDocTestCase.tearDownc C s~ | j }tj}t� }| j}|t@ s(|tO }t|| jdd�}z d|_ |j
||j dd�\}}W 5 |t_X |rz| � | �
|�� ���d S )NF�r r r� zF----------------------------------------------------------------------)r� rP )ru r> r� r# rs r
rn r rt r* rQ rC ZfailureException�format_failurerc )rj r ro �newr ri r r r, r, r- �runTest� s( � �zDocTestCase.runTestc C sP | j }|jd krd}n
d|j }d�|j�d�dd � �}d|j|j|||f S )Nzunknown line numberz%sr� rr z:Failed doctest test for %s
File "%s", line %s, in %s
%s)ru r� r� r+ rt rT )rj �errr r� Zlnamer, r, r- r| � s
�zDocTestCase.format_failurec C s6 | � � t| j| jdd�}|j| jdd� | �� dS )a� Run the test case without results and without catching exceptions
The unit test framework includes a debug method on test cases
and test suites to support post-mortem debugging. The test code
is run in such a way that errors are not caught. This way a
caller can catch the errors and initiate post-mortem debugging.
The DocTestCase provides a debug method that raises
UnexpectedException errors if there is an unexpected
exception:
>>> test = DocTestParser().get_doctest('>>> raise KeyError\n42',
... {}, 'foo', 'foo.py', 0)
>>> case = DocTestCase(test)
>>> try:
... case.debug()
... except UnexpectedException as f:
... failure = f
The UnexpectedException contains the test, the example, and
the original exception:
>>> failure.test is test
True
>>> failure.example.want
'42\n'
>>> exc_info = failure.exc_info
>>> raise exc_info[1] # Already has the traceback
Traceback (most recent call last):
...
KeyError
If the output doesn't match, then a DocTestFailure is raised:
>>> test = DocTestParser().get_doctest('''
... >>> x = 1
... >>> x
... 2
... ''', {}, 'foo', 'foo.py', 0)
>>> case = DocTestCase(test)
>>> try:
... case.debug()
... except DocTestFailure as f:
... failure = f
DocTestFailure objects provide access to the test:
>>> failure.test is test
True
As well as to the example:
>>> failure.example.want
'2\n'
and the actual output:
>>> failure.got
'1\n'
Fr{ )rP N)rx r rs rt rQ ru ry )rj ri r, r, r- r! � s B �zDocTestCase.debugc C s | j jS rl �ru r+ r� r, r, r- r� � s zDocTestCase.idc C sP t | �t |�k rtS | j|jkoN| j|jkoN| j|jkoN| j|jkoN| j|jkS rl )r� r� ru rs rv rw rt r� r, r, r- r� � s
�
�
�
�zDocTestCase.__eq__c C s t | j| j| j| jf�S rl )r� rs rv rw rt r� r, r, r- r� � s �zDocTestCase.__hash__c C s, | j j�d�}d|d d�|d d� �f S )Nr� z%s (%s)rr )ru r+ rt r� )rj r+ r, r, r- r� s zDocTestCase.__repr__c C s d| j j S )Nz Doctest: r� r� r, r, r- �shortDescription s z DocTestCase.shortDescription)r" NNN)r6 rp rq r� rx ry r~ r| r! r� r� r� r� r r` r� r, r, r, r- rp l s �
H
rp c @ s0 e Zd Zdd� Zdd� Zdd� Zdd� ZeZd S )
�SkipDocTestCasec C s || _ t�| d � d S rl )rC rp r� )rj rC r, r, r- r�
s zSkipDocTestCase.__init__c C s | � d� d S )Nz-DocTestSuite will not work with -O2 and above)ZskipTestr� r, r, r- rx s zSkipDocTestCase.setUpc C s d S rl r, r� r, r, r- � test_skip s zSkipDocTestCase.test_skipc C s d| j j S )NzSkipping tests from %s)rC r6 r� r, r, r- r� s z SkipDocTestCase.shortDescriptionN)r6 rp rq r� rx r� r� r` r, r, r, r- r� s
r� c @ s e Zd Zdd� ZdS )�
_DocTestSuitec C s d S rl r, )rj �indexr, r, r- �_removeTestAtIndex s z _DocTestSuite._removeTestAtIndexN)r6 rp rq r� r, r, r, r- r� s r� c K s� |dkrt � }t| �} |j| ||d�}|sNtjjdkrNt� }|�t| �� |S |� � t� }|D ]T}t
|j �dkrtq`|j s�| j
}|dd� dkr�|dd� }||_ |�t|f|�� q`|S )a
Convert doctest tests for a module to a unittest test suite.
This converts each documentation string in a module that
contains doctest tests to a unittest test case. If any of the
tests in a doc string fail, then the test case fails. An exception
is raised showing the name of the file containing the test and a
(sometimes approximate) line number.
The `module` argument provides the module to be tested. The argument
can be either a module or a module name.
If no argument is given, the calling module is used.
A number of options may be provided as keyword arguments:
setUp
A set-up function. This is called before running the
tests in each file. The setUp function will be passed a DocTest
object. The setUp function can access the test globals as the
globs attribute of the test passed.
tearDown
A tear-down function. This is called after running the
tests in each file. The tearDown function will be passed a DocTest
object. The tearDown function can access the test globals as the
globs attribute of the test passed.
globs
A dictionary containing initial global variables for the tests.
optionflags
A set of doctest option flags expressed as an integer.
Nrd r4 r" r
r rr )r rD rv r> r2 �optimizer� �addTestr� r� r) r� rT r� rp ) rC r1 r� Z test_finderr� r� �suiter rT r, r, r- r # s( % c @ s$ e Zd Zdd� Zdd� Zdd� ZdS )� DocFileCasec C s d� | jj�d��S )NrN r� )r� ru r+ rt r� r, r, r- r� e s zDocFileCase.idc C s | j jS rl )ru rT r� r, r, r- r� h s zDocFileCase.__repr__c C s d| j j| j j|f S )Nz2Failed doctest test for %s
File "%s", line 0
%s)ru r+ rT )rj r r, r, r- r| k s �zDocFileCase.format_failureN)r6 rp rq r� r� r| r, r, r, r- r� c s r� c
K sv |d kri }n|� � }|r&|s&td��t| |||p4d�\}} d|krL| |d< tj�| �}|�|||| d�} t| f|�S )Nrj r@ r� r" )r� r� rX r� r� rk r� r� )
r� rV rU r1 r� rN r� �docr+ r r, r, r- � DocFileTestp s � r� c O sD t � }|�dd�r$t|�d��|d< | D ]}|�t|f|�� q(|S )a� A unittest suite for one or more doctest files.
The path to each doctest file is given as a string; the
interpretation of that string depends on the keyword argument
"module_relative".
A number of options may be provided as keyword arguments:
module_relative
If "module_relative" is True, then the given file paths are
interpreted as os-independent module-relative paths. By
default, these paths are relative to the calling module's
directory; but if the "package" argument is specified, then
they are relative to that package. To ensure os-independence,
"filename" should use "/" characters to separate path
segments, and may not be an absolute path (i.e., it may not
begin with "/").
If "module_relative" is False, then the given file paths are
interpreted as os-specific paths. These paths may be absolute
or relative (to the current working directory).
package
A Python package or the name of a Python package whose directory
should be used as the base directory for module relative paths.
If "package" is not specified, then the calling module's
directory is used as the base directory for module relative
filenames. It is an error to specify "package" if
"module_relative" is False.
setUp
A set-up function. This is called before running the
tests in each file. The setUp function will be passed a DocTest
object. The setUp function can access the test globals as the
globs attribute of the test passed.
tearDown
A tear-down function. This is called after running the
tests in each file. The tearDown function will be passed a DocTest
object. The tearDown function can access the test globals as the
globs attribute of the test passed.
globs
A dictionary containing initial global variables for the tests.
optionflags
A set of doctest option flags expressed as an integer.
parser
A DocTestParser (or subclass) that should be used to extract
tests from the files.
encoding
An encoding that will be used to convert the files to unicode.
rV TrU )r� r/ rD r� r� )�paths�kwr� r� r, r, r- r � s 8 c C s� g }t � �| �D ]x}t|t�rh|�|jdd� � |j}|r�|�d� |dd� |�d�dd� D �7 }q|dd� |�d�dd� D �7 }q|r�|d dkr�|�� q�|r�|d dkr�|�d � q�d� |�d S )
aw Extract script from text with examples.
Converts text with examples to a Python script. Example input is
converted to regular code. Example output and all other words
are converted to comments:
>>> text = '''
... Here are examples of simple math.
...
... Python has super accurate integer addition
...
... >>> 2 + 2
... 5
...
... And very friendly error messages:
...
... >>> 1/0
... To Infinity
... And
... Beyond
...
... You can use logic if you want:
...
... >>> if 0:
... ... blah
... ... blah
... ...
...
... Ho hum
... '''
>>> print(script_from_examples(text))
# Here are examples of simple math.
#
# Python has super accurate integer addition
#
2 + 2
# Expected:
## 5
#
# And very friendly error messages:
#
1/0
# Expected:
## To Infinity
## And
## Beyond
#
# You can use logic if you want:
#
if 0:
blah
blah
#
# Ho hum
Nrr z # Expected:c S s g | ] }d | �qS )z## r, r� r, r, r- r�
s z(script_from_examples..rF c S s g | ] }t |��qS r, )r� r� r, r, r- r�
s �r} r" )
r r� r9 r r� r� rw rt �popr� )r] r� Zpiecerw r, r, r- r � s :
"�
c sJ t | �} t� �| �}� fdd�|D �}|s4t� d��|d }t|j�}|S )a Extract the test sources from a doctest docstring as a script.
Provide the module (or dotted name of the module) containing the
test to be debugged and the name (within the module) of the object
with the doc string with tests to be debugged.
c s g | ]}|j � kr|�qS r, r* )r� r6 r* r, r- r� .
s
z testsource..znot found in testsr" )rD r rv r� r r� )rC r+ r� r �testsrcr, r* r- r %
s
c C s t | �}t|||� dS )z4Debug a single doctest docstring, in argument `src`'N)r � debug_script)�src�pmr1 r� r, r, r- r 5
s c C s� ddl }|r|�� }ni }|rvzt| ||� W q� tt�� d � |jdd�}|�� |�dt�� d � Y q�X n|jdd�� d| ||� dS )z7Debug a test script. `src` is the script, as a string.r" Nr& T)r� r4 zexec(%r))
r� r� r, r r> rd r� rG Z interactionrQ )r� r� r1 r� �pr, r, r- r� :
s
r� c C s$ t | �} t| |�}t||| j� dS )z�Debug a single doctest docstring.
Provide the module (or dotted name of the module) containing the
test to be debugged and the name (within the module) of the object
with the docstring with tests to be debugged.
N)rD r r� r� )rC r+ r� r� r, r, r- r! N
s
c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �
_TestClassz�
A pointless class, for sanity-checking of docstring testing.
Methods:
square()
get()
>>> _TestClass(13).get() + _TestClass(-12).get()
1
>>> hex(_TestClass(13).square().get())
'0xa9'
c C s
|| _ dS )z�val -> _TestClass object with associated value val.
>>> t = _TestClass(123)
>>> print(t.get())
123
N�r )rj r r, r, r- r� j
s z_TestClass.__init__c C s | j d | _ | S )zosquare() -> square TestClass's associated value
>>> _TestClass(13).square().get()
169
r4 r� r� r, r, r- �squaret
s z_TestClass.squarec C s | j S )z~get() -> return TestClass's associated value.
>>> x = _TestClass(-42)
>>> print(x.get())
-42
r� r� r, r, r- r/ ~
s z_TestClass.getN)r6 rp rq r� r� r� r/ r, r, r, r- r� \
s
r� z�
Example of a string object, searched as-is.
>>> x = 1; y = 2
>>> x + y, x * y
(3, 2)
a�
In 2.2, boolean expressions displayed
0 or 1. By default, we still accept
them. This can be disabled by passing
DONT_ACCEPT_TRUE_FOR_1 to the new
optionflags argument.
>>> 4 == 4
1
>>> 4 == 4
True
>>> 4 > 4
0
>>> 4 > 4
False
z�
Blank lines can be marked with :
>>> print('foo\n\nbar\n')
foo
bar
z�
If the ellipsis flag is used, then '...' can be used to
elide substrings in the desired output:
>>> print(list(range(1000))) #doctest: +ELLIPSIS
[0, 1, 2, ..., 999]
a�
If the whitespace normalization flag is used, then
differences in whitespace are ignored.
>>> print(list(range(30))) #doctest: +NORMALIZE_WHITESPACE
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26,
27, 28, 29]
)r� r� zbool-int equivalencez blank linesZellipsiszwhitespace normalizationc C s" dd l } | jdd�}|jdddddd � |jd
d d t�� g d
d� |jddddd� |jdddd� |�� }|j}|j}d}|jD ]}|t| O }q�|j r�|t
O }|D ]v}|� d�r�t j
�|�\}}tj
�d|� t|d d� �} tj
d= t| ||d�\}
} nt|d||d�\}
} |
r� dS q�dS ) Nr" zdoctest runner)Z descriptionr z --verbose�
store_trueFz'print very verbose output for all tests)�action�default�helpz-oz--optionr� zqspecify a doctest option flag to apply to the test run; may be specified more than once to apply multiple options)r� �choicesr� r� z-fz --fail-fastzystop running tests after first failure (this is a shorthand for -o FAIL_FAST, and is in addition to any other -o options))r� r� r` r� z file containing the tests to run)�nargsr� z.py�����rc )rV r� r r& )�argparse�ArgumentParser� add_argumentr' �keys�
parse_argsr` r� r� Z fail_fastr ri r� r� rt r> �insertr; r r ) r� r� r� Z testfilesr� r� r� rT �dirnamer� r rN r, r, r- �_test�
sL �
�
��
�
r� r� )r4 )rY ) NNNNTr" NFF)Frm Nr" )NNNN)FN)FN)F)Sr� Z
__docformat__�__all__r. r] r7 r� r� r� r[ r> ra rq �ior# � collectionsr$ r% r' r r r r r r r r r r
r r r r
rY rs r3 rD rJ rX r_ rf rg r| r� r� r� r� rO r r r r r r � Exceptionr r r re r r r rn r rr rp r� Z TestSuiter� r r� r� r r r r r� r! r� r r� r6 �exitr, r, r, r- � sF '�-
���������
1%.DK l < ; n �
h �
{ �
$ !
@
�
IR
, �3-