U
e5dt @ s d Z ddgZddlZddlZddlZddlZddlZddlZddlZddl Z ddl
Z
ddl Z ddl Z ddl
mZ ddlZdZG dd dZd d
Zd d ZG d
d dZdd Zdd ZdddZdd ZG dd dZdd Ze dkre dS )a program/module to trace Python program or function execution
Sample use, command line:
trace.py -c -f counts --ignore-dir '$prefix' spam.py eggs
trace.py -t --ignore-dir '$prefix' spam.py eggs
trace.py --trackcalls spam.py eggs
Sample use, programmatically
import sys
# create a Trace object, telling it what to ignore, and whether to
# do tracing or line-counting or both.
tracer = trace.Trace(ignoredirs=[sys.base_prefix, sys.base_exec_prefix,],
trace=0, count=1)
# run the new command using the given tracer
tracer.run('main()')
# make a report, placing output in /tmp
r = tracer.results()
r.write_results(show_missing=True, coverdir="/tmp")
TraceCoverageResults N) monotonicz#pragma NO COVERc @ s e Zd ZdddZdd ZdS )_IgnoreNc C s: |s
t nt || _|s g n dd |D | _ddi| _d S )Nc S s g | ]}t j|qS )ospathnormpath.0dr r /usr/lib64/python3.8/trace.py
H s z$_Ignore.__init__..z )set_mods_dirs_ignore)selfmodulesdirsr r r
__init__F s
z_Ignore.__init__c C s || j kr| j | S || jkr,d| j |< dS | jD ]"}||d r2d| j |< dS q2|d krld| j |< dS | jD ]$}||tj rrd| j |< dS qrd| j |< dS )Nr .r )r r
startswithr r sep)r filename
modulenamemodr r r r
namesL s$
z
_Ignore.names)NN)__name__
__module__ __qualname__r r r r r r
r E s
r c C s t j| }t j|\}}|S )z-Return a plausible module name for the patch.)r r basenamesplitext)r baser extr r r
_modnamew s r& c C s t j| }d}tjD ]@}t j|}||r|t| t jkrt|t|kr|}q|rr| t|d d }n| }t j|\}}|t jd}t j r|t j d}t j
|\}}| dS )z,Return a plausible module name for the path. r Nr ) r r normcasesysr lenr
splitdrivereplacealtsepr# lstrip)r Z comparepathZlongestdirr$ Zdriver r% r r r
_fullmodname~ s
r0 c @ s: e Zd ZdddZdd Zdd Zdd
d Zdd d
ZdS )r Nc
C s || _ | j d kri | _ | j | _|| _| jd kr8i | _| j | _|| _| jd krZi | _| j | _|| _|| _| jrz@t| jd}t |\}}}W 5 Q R X |
| ||| W n@ t t
tfk
r } z td| j|f tjd W 5 d }~X Y nX d S )NrbzSkipping counts file %r: %sfile)countscopyZcounter calledfuncscallersinfileoutfileopenpickleloadupdate __class__OSErrorEOFError
ValueErrorprintr) stderr)r r4 r6 r8 r7 r9 ferrr r r
r s2
zCoverageResults.__init__c C s | do|dS )z_Return True if the filename does not refer to a file
we want to have reported.
<>)r endswith)r r r r r
is_ignored_filename s z#CoverageResults.is_ignored_filenamec C sn | j }| j}| j}|j }|j}|j}|D ] }||d|| ||< q(|D ] }d||< qJ|D ] }d||< q\dS )z.Merge in the data from another CoverageResultsr r N)r4 r6 r7 get) r otherr4 r6 r7 Z other_countsZother_calledfuncsZ
other_callerskeyr r r
r= s
zCoverageResults.updateTFc "
C s | j r@t td | j }t|D ] \}}}td|||f q"| jrt td d }} t| jD ]h\\}
} } \}
}}|
|krt td|
d |
}d} |
|
kr| |
krtd|
|
} td| | ||f qfi }| jD ].\}}||i }||< | j||f ||< qi }| D ]\}}| |r0q|drH|d d
}|d krpt j
t j
|}t
|}n$|}t j
|st | t|}|rt|}ni }t|}t j
||d }t|d }t|j\}}W 5 Q R X | |||||\} } |r| rtd
| | } | | ||f||< q|rt|rttd t|D ]&} || \} } }}td|| qL| jrz6t| jd } t | j| j | jf| d W 5 Q R X W n6 t k
r }! ztd|! t j d W 5 d }!~!X Y nX d S )af
Write the coverage results.
:param show_missing: Show lines that had no hits.
:param summary: Include coverage summary per module.
:param coverdir: If None, the results of each module are placed in its
directory, otherwise it is included in the directory
specified.
zfunctions called:z*filename: %s, modulename: %s, funcname: %szcalling relationships:r' z***z -->z %s.%s -> %s.%sz.pycNz.coverr1 d z lines cov% module (path)z%5d %3d%% %s (%s)wbr z"Can't save counts files because %sr2 )!r6 rB sortedr7 r4 rJ itemsrI rH r r dirnameabspathr& existsmakedirsr0 _find_executable_linenos linecachegetlinesjoinr: tokenizedetect_encodingreadlinewrite_results_fileintr9 r; dumpr? r) rC )"r Z show_missingsummarycoverdirZcallsr r funcnameZlastfileZ lastcfileZpfileZpmodZpfunccfileZcmodZcfuncZper_filelineno lines_hitZsumscountr/ lnotabsourceZ coverpathfpencoding_n_hitsn_linesZpercentmrD rE r r r
write_results s
z CoverageResults.write_resultsc
C s zt |d|d}W n> tk
rP } z td||f tjd W Y dS d}~X Y nX d}d} | t|dD ]r\}
} |
|kr|d ||
| d7 } |d7 }n.|
|krt| kr|d
|d7 }n
|d || d qjW 5 Q R X | |fS )
z'Return a coverage results file in path.wrj z3trace: Could not open %r for writing: %s - skippingr2 )r r Nr r z%5d: z>>>>>> z ) r: r? rB r) rC enumeratewritePRAGMA_NOCOVER
expandtabs) r r linesrg re rj r9 rE rm rl rd liner r r
r] ) s.
z"CoverageResults.write_results_file)NNNNN)TFN)N)r r r! r rI r= ro r] r r r r
r s
\c C s, i }t | D ]\}}||krd||< q|S )z:Return dict where keys are lines in the line number table.r )disZfindlinestarts)codestrslinenosrk rd r r r
_find_lines_from_codeI s
r} c C s4 t | |}| jD ] }t|r|t|| q|S )z.r c S s g | ]}t |tr|qS r )
isinstancer r
r r r
r s
r c S s g | ]}t |d r|qS ) __bases__)hasattr)r r r r r
r s
z%s.%s) f_code co_filenamer& co_namer gcZ
get_referrersr* r )
r framerz r r rb ZclsnameZfuncsZdictsclassesr r r
file_module_function_of s,
z Trace.file_module_function_ofc C s0 |dkr,| |}| |j}d| j||f< dS )zkHandler for call events.
Adds information about who called who to the self._callers dict.
callr N)r f_backr )r r whyarg this_funcZ parent_funcr r r
r
s
z Trace.globaltrace_trackcallersc C s |dkr | |}d| j|< dS )zoHandler for call events.
Adds (filename, modulename, funcname) to the self._calledfuncs dict.
r r N)r r )r r r r r r r r
r s
z Trace.globaltrace_countfuncsc C sj |dkrf|j }|jdd}|rbt|}|dk rf| j||}|sf| jrZtd||jf | j S ndS dS )zHandler for call events.
If the code block being entered is to be ignored, returns `None',
else returns self.localtrace.
r __file__Nz! --- modulename: %s, funcname: %s)
r f_globalsrJ r& r r r rB r r )r r r r rz r r Z ignore_itr r r
r ! s zTrace.globaltrace_ltc C s |dkr~|j j}|j}||f}| j|dd | j|< | jrTtdt | j dd tj
|}td||t ||f dd | j
S ) Nrx r r %.2f r
%s(%d): %sr' )r r f_linenor4 rJ r rB r r r r" rW getliner )r r r r r rd rL bnamer r r
r 8 s
z Trace.localtrace_trace_and_countc C sd |dkr^|j j}|j}| jr4tdt | j dd tj|}td||t
||f dd | j S )Nrx r r r r r' ) r r r r rB r r r r" rW r r )r r r r r rd r r r r
r G s
zTrace.localtrace_tracec C s< |dkr6|j j}|j}||f}| j|dd | j|< | jS )Nrx r r )r r r r4 rJ r )r r r r r rd rL r r r
r T s zTrace.localtrace_countc C s t | j| j| j| j| jdS )N)r8 r9 r6 r7 )r r4 r8 r9 r r )r r r r
results\ s
z
Trace.results) r r r r r r NNF)NN)r r r! r r r r __text_signature__r r r r r r r r r r r r
r s&
2
)
c s dd l } | }|jdddd |dd}|jdd d
d d |jd
dd
dd |jddd
dd |jddd
dd |d}| }|jddd
dd |jddd
d d |jd d d d |jd!d"d#d |jd$d%d
d&d |jd'd(d
d)d |jd*d+d
d,d |d-d.}|jd/d0g d1d2 |jd3d0g d4d2 |jd5d
d6d7d2 |jd8d9d:d; |jd<| jd=d; | }|jrt d>t d? fd@dAdBdC |j
D |_
fdDdC|jD |_|j r|j s|
dE t|j |j dF}||j|j|jS t|j|j|j|jgs |
dG |jrB|js8|jrB|
dH |jr\|js\|
dI |jd krr|
dJ t|j|j|j|j|j
|j|j |j |jdK }z|jrdd l }|j}| |\} }
} | j f|j t _!dL| j |
j"|
j#|
d dM} n^|jf|j t _!t$j%&|jt j%d< t'(|j}
t)|
* |jdN} W 5 Q R X |jdLd d dO} |+| | | W nP t,k
r } z t -dPt j!d |f W 5 d }~X Y n t.k
r Y nX |/ }|j0s||j|j|j d S )QNr z --versionversionz trace 2.0)actionr z Main optionsz(One of these (or --report) must be givenz-cz--count
store_truezCount the number of times each line is executed and write the counts to .cover for each module executed, in the module's directory. See also --coverdir, --file, --no-report below.)r helpz-tz--tracez3Print each line to sys.stdout before it is executedz-lz --listfuncszKeep track of which functions are executed at least once and write the results to sys.stdout after the program exits. Cannot be specified alongside --trace or --count.z-Tz --trackcallsz^Keep track of caller/called pairs and write the results to sys.stdout after the program exits.Z Modifiersz-rz--reportzGenerate a report from a counts file; does not execute any code. --file must specify the results file to read, which must have been created in a previous run with --count --file=FILEz-Rz --no-reportz^Do not generate the coverage report files. Useful if you want to accumulate over several runs.z-fz--filez+File to accumulate counts over several runs)r z-Cz
--coverdirzDirectory where the report files go. The coverage report for . will be written to file //.coverz-mz --missingz?Annotate executable lines that were not executed with ">>>>>> "z-sz --summaryz\Write a brief summary for each file to sys.stdout. Can only be used with --count or --reportz-gz--timingzQPrefix each line with the time since the program started. Only used while tracingZFiltersz Can be specified multiple timesz--ignore-moduleappendzqIgnore the given module(s) and its submodules (if it is a package). Accepts comma separated list of module names.)r defaultr z --ignore-dirzWIgnore files in the given directory (multiple directories can be joined by os.pathsep).z--moduleFzTrace a module. progname?zfile to run as main program)nargsr argumentszarguments to the programZstdlibZ
platstdlibc s4 t jt j| } | dd } t j| S )Nz$prefixz $exec_prefix)r r
expanduser
expandvarsr, r )s) _exec_prefix_prefixr r
parse_ignore_dir s z main..parse_ignore_dirc S s$ g | ] }| d D ] }| qqS ),)splitstrip)r r r r r r
r s zmain..c s& g | ] }| tjD ] } |qqS r )r r pathsep)r r r )r r r
r s z -r/--report requires -f/--file)r8 r9 zLmust specify one of --trace, --count, --report, --listfuncs, or --trackcallsz8cannot specify both --listfuncs and (--trace or --count)z3--summary can only be used with --count or --reportz3progname is missing: required with the main options)r r r r r8 r9 r r )r r __package__
__loader____spec__
__cached__r )r r r r z Cannot run file %r because: %s)1argparseArgumentParser add_argumentZadd_argument_groupZ add_mutually_exclusive_groupZ REMAINDER
parse_argsZ
ignore_dir sysconfigZget_pathZ
ignore_moduleZreportr3 errorr ro Zmissingr` ra anyr rf Z listfuncsZ
trackcallsr r r modulerunpyZ_get_module_detailsr r r) argvparentloaderr r rR io open_coder r r r? exit
SystemExitr Z no_report)r parserZgrpZ_grpZoptsr tr Z module_nameZmod_nameZmod_specrz Zglobsri rE r )r r r r
mainb s
(r r )N) __doc____all__r rW r r) r r rZ r r ry r; timer r r ru r r& r0 r r} r r rV r r r r r r r
s< 2 0
_