3
T'íc»6 ã @ s d Z ddlZddlZddlZddlZddlmZ ddlmZ ddl m
Z
m Z m Z m
Z
mZmZmZ ddlZddlmZ ddlmZ ddlmZ dd lmZ dd
lmZ dd l m Z ej e Z de
e!e!dd
ddZ"e!e!e
e dddZ#G dd deZ$ee e!e f dddZ%dS )zCheck Python modules and C API for coverage.
Mostly written by Josip Dzolonga for the Google Highly Open Participation
contest.
é N)Ú
import_module)Úpath)ÚIOÚAnyÚDictÚListÚPatternÚSetÚTuple)ÚSphinx)ÚBuilder)Ú__)Úlogging)Úred)Ú safe_getattrú-)ÚfÚtextÚcharÚreturnc C s( | j |d | j |t| d d S )NÚ
)ÚwriteÚlen)r r r © r ú5/tmp/pip-build-gk9425m9/sphinx/sphinx/ext/coverage.pyÚ write_header s r )ÚnameÚexpsr c C sR g }xH|D ]@}y|j tj| W q
tk
rH tjtd|| Y q
X q
W |S )Nzinvalid regex %r in %s)ÚappendÚreÚcompileÚ ExceptionÚloggerÚwarningr
)r r ÚlstÚexpr r r Úcompile_regex_list s
r& c @ s¨ e Zd ZdZdZedej d ZddddZ e
dd d
Z e dd d d
Z
ddddZddddZe
edddZddddZddddZddddZdS )ÚCoverageBuilderz:
Evaluates coverage of code in the documentation.
ZcoveragezNTesting of coverage in the sources finished, look at the results in %(outdir)sz python.txt.N)r c C s g | _ x0| jjD ]$}tj| j|}| j jtj| qW g | _xX| jj j
D ]H\}}y| jj |t j
|f W qL tk
r tjtd| Y qLX qLW i | _x(| jjj
D ]\}}td|| j|< q¬W td| jj| _td| jj| _td| jj| _td| jj| _ d S )Nz&invalid regex %r in coverage_c_regexesÚcoverage_ignore_c_itemsÚcoverage_ignore_modulesÚcoverage_ignore_classesÚcoverage_ignore_functionsÚcoverage_ignore_pyobjects) Ú
c_sourcefilesÚconfigÚcoverage_c_pathr ÚjoinÚsrcdirÚextendÚglobÚ c_regexesÚcoverage_c_regexesÚitemsr r r r! r" r# r
Ú c_ignorexpsr( r& r) Ú
mod_ignorexpsr* Ú
cls_ignorexpsr+ Ú
fun_ignorexpsr, Ú py_ignorexps)ÚselfÚpatternr r% r r r r Úinit2 s, zCoverageBuilder.initc C s dS )Nzcoverage overviewr )r< r r r Úget_outdated_docsL s z!CoverageBuilder.get_outdated_docs)Úignoredr c G s0 i | _ | j | j i | _| j | j d S )N)Úpy_undocÚbuild_py_coverageÚwrite_py_coverageÚc_undocÚbuild_c_coverageÚwrite_c_coverage)r< r@ r r r r O s zCoverageBuilder.writec
C sÄ | j jd d }x®| jD ]¤}t }t|~}xv|D ]n}xh| jD ]^\}}|j|}|r>|j d } | |kr>x0| jj |g D ]}
|
j| rxP qxW |j
|| f q>q>W q2W W d Q R X |r|| j |< qW d S )NÚcÚobjectsr ) ÚenvÚ
domaindatar- ÚsetÚopenr4 ÚmatchÚgroupsr7 ÚgetÚaddrD ) r< Z c_objectsÚfilenameÚundocr ÚlineÚkeyÚregexrM r r% r r r rE X s"
z CoverageBuilder.build_c_coveragec C sú t j| jd}t|dØ}| jjr.t|dd |jd x²| jj D ]¤\}}t|| xt
|D ]z\}}|jd||f | jj r`| j j
s| j jr¨tjtd||| q`tjtdd d
d |d | td
| q`W |jd qDW W d Q R X d S )Nzc.txtÚwzUndocumented C API elementsú=r z * %-50s [%9s]
z&undocumented c api: %s [%s] in file %szundocumented zc z
api z%-30sz [%9s]z - in file )r r0 ÚoutdirrL r. Úcoverage_write_headliner r rD r6 ÚsortedÚcoverage_show_missing_itemsÚappÚquietÚwarningiserrorr" r# r
Úinfor )r< Ú output_fileÚoprQ rR Útypr r r r rF m s
2z CoverageBuilder.write_c_coverage)Ú full_namer c C s" x | j D ]}|j|rdS qW dS )NTF)r; Úsearch)r< rc r% r r r Ú ignore_pyobj s
z CoverageBuilder.ignore_pyobjc C s° | j jd d }| j jd d }| jj}x|D ]v}d}x | jD ]}|j|rBd}P qBW |s0| j|rjq0y t|}W nD tk
rº } z(t j
t d|| d|i| j |< w0W Y d d }~X nX g } i }
xÐt
j|D ]À\} } | d d krêqÒt| d
söqÒ| j|krqÒd || f }
| j|
r qÒt
j| rr|
|krx:| jD ]}|j| r<P q<W |rf| j rfqÒ| j| qÒt
j| rÒx| jD ]}|j| rP qW |
|krÄ|rº| j rºqÒg |
| < qÒg }x¾t| D ]²}|| jkræqÒyt| |}W n tk
r wÒY nX t
j|p$t
j|s,qÒ|d d kr>qÒ|rR|j rRqÒd |
|f }| j|rnqÒ||krÒ|j| qÒW |rÒ||
| < qÒW | |
d | j |< q0W d S )
NÚpyrH ÚmodulesFTz#module %s could not be imported: %sÚerrorr Ú_Ú
__module__z%s.%s)ÚfuncsÚclasses) rI rJ r. Ú coverage_skip_undoc_in_sourcer8 rM re r Ú ImportErrorr" r# r
rA ÚinspectÚ
getmembersÚhasattrrj Ú
isfunctionr: Ú__doc__r Úisclassr9 ÚdirÚ__dict__r ÚAttributeErrorÚismethod)r< rH rg Z
skip_undocÚmod_nameÚignorer% ÚmodÚerrrk rl r Úobjrc ÚattrsÚ attr_nameÚattrZfull_attr_namer r r rB s
z!CoverageBuilder.build_py_coveragec C sÜ t j| jd}g }t|d´}| jjr4t|dd t| jj }xd|D ]Z}| j| }d|krv|j
||d f qJ|d r|d rqJt|| |d rL|j d |j d d
|d D | jj
rB| jjsÞ| jjrxb|d D ]}tjtd || qèW n>x<|d D ]0}tjtd d
d d| td | qW |j d |d rJ|j d x:t|d j D ]$\}} | sî|j d| | jj
r| jjs®| jjrÂtjtd|| n*tjtd d
d d| td | n¨|j d| |j dd
| D | jj
rr| jjs.| jjrTxf| D ]}
tjtd |||
q4W nBx@| D ]8}
tjtd d
d d|d |
td | qZW qrW |j d qJW |rÎt|d |j d d
|D W d Q R X d S ) Nz
python.txtrV zUndocumented Python objectsrW rh rl rk z Functions:
c s s | ]}d | V qdS )z * %s
Nr )Ú.0Úxr r r ú <genexpr>õ s z4CoverageBuilder.write_py_coverage.<locals>.<genexpr>z&undocumented python function: %s :: %szundocumented zpy z
function z%-30sz
- in module r z Classes:
z * %s
z#undocumented python class: %s :: %sz
class z * %s -- missing methods:
c s s | ]}d | V qdS )z - %s
Nr )r r r r r r s zundocumented python method:z %s :: %s :: %sz
method Ú.z Modules that failed to importc s s | ]}d | V qdS )z * %s -- %s
Nr )r r r r r r $ s z*undocumented python method: %s :: %s :: %s)r r0 rX rL r. rY r rZ rA Úkeysr r Ú
writelinesr[ r\ r] r^ r" r# r
r_ r r6 ) r< r` Úfailedra r
r rR ÚfuncÚ
class_nameÚmethodsÚmethr r r rC ã sn
,
(
:
z!CoverageBuilder.write_py_coveragec
C s< t j| jd}t|d}tj| j| jf| W d Q R X d S )Nz undoc.pickleÚwb)r r0 rX rL ÚpickleÚdumprA rD )r< Z
picklepathZdumpfiler r r Úfinish& s zCoverageBuilder.finish)Ú__name__rj Ú __qualname__rs r r
r ÚsepÚepilogr> Ústrr? r r rE rF Úboolre rB rC r r r r r r' * s [Cr' )r\ r c C s¢ | j t | jdg d | jdg d | jdg d | jdg d | jdg d | jdi d | jdi d | jd d
d | jd dd | jd dd tjd
d
S )Nr) Fr+ r* r, r/ r5 r( rY Trm r[ )ÚversionZparallel_read_safe)Z add_builderr' Zadd_config_valueÚsphinxZ__display_version__)r\ r r r Úsetup- s
r )r )&rs r3 ro r r Ú importlibr Úosr Útypingr r r r r r r
r Zsphinx.applicationr Zsphinx.buildersr Z
sphinx.localer
Z sphinx.utilr Zsphinx.util.consoler Zsphinx.util.inspectr Ú getLoggerr r" r r r& r' r r r r r Ú<module> s* $