File: //home/arjun/projects/env/lib/python3.10/site-packages/coverage/__pycache__/control.cpython-310.pyc
o
!weO� � @ s� d Z ddlmZ ddlZddlZddlZddlZddlZddlZddl Z ddl
Z
ddl Z ddl Z ddl
Z
ddlmZ ddlmZmZmZmZmZmZmZmZmZmZmZ ddl m Z ddl m Z ddl m!Z!m"Z" dd l#m$Z$m%Z% dd
l&m'Z'm(Z( dd l)m*Z*m+Z+ dd l,m-Z-m.Z.m/Z/m0Z0m1Z1 dd
l2m3Z3 ddl4m5Z5m6Z6m7Z7m8Z8 ddl9m:Z:m;Z;m<Z<m=Z= ddl>m?Z? ddl@mAZA ddlBmCZC ddlDmEZE ddlFmGZGmHZH ddlFmIZImJZJmKZK ddlLmMZM ddlNmOZO ddlPmQZQ ddlRmSZS ddlTmUZU ddlVmWZW dd lXmYZY dd lZm[Z[m\Z\m]Z]m^Z^m_Z_m`Z`maZambZb dd lcmdZd eKe�Zejed5d%d&��ZfeId'�ZgegZhG d(d � d e\�Ziejejk�ld)d���rRdd*l,mmZmmnZn emend+d,�d-gd.�ei�Zid6d0d1�Zod7d3d4�ZpdS )8z#Core control stuff for coverage.py.� )� annotationsN)� FrameType) �cast�Any�Callable�Dict�IO�Iterable�Iterator�List�Optional�Tuple�Union)�env)�AnnotateReporter)� Collector� HAS_CTRACER)�CoverageConfig�read_coverage_config)�"should_start_context_test_function�combine_context_switchers)� CoverageData�combine_parallel_data)� DebugControl� NoDebugging� short_stack�write_formatted_info� relevant_environment_display)�disposition_debug_msg)� ConfigError�CoverageException�CoverageWarning� PluginError)� PathAliases�abs_file�relative_filename�set_relative_directory)� HtmlReporter)�InOrOut)� JsonReporter)� LcovReporter)� bool_or_none�
join_regex)� DefaultValue�ensure_dir_for_file�isolate_module)�patch_multiprocessing)� FileReporter)�Plugins)�PythonFileReporter)�SummaryReporter)�
render_report)�Analysis)�FilePath�
TConfigurable�TConfigSectionIn�TConfigValueIn�TConfigValueOut�TFileDisposition�TLineNo�TMorf)� XmlReporter�cov�Coverage�kwargsr: �return�Iterator[None]c k sB � | j }| j �� | _ z| j jdi |�� dV W || _ dS || _ w )z�Temporarily tweak the configuration of `cov`.
The arguments are applied to `cov.config` with the `from_args` method.
At the end of the with-statement, the old configuration is restored.
N� )�config�copy� from_args)r@ rB �original_configrE rE �I/home/arjun/projects/env/lib/python3.10/site-packages/coverage/control.py�override_config; s � rK �MISSINGc @ s� e Zd ZU dZg Zded< ed�dd��Zeddd ddd
ddddddd dd fd�d$d%�Z d�d&d'�Z
d�d(d)�Z d�d*d+�Z d�d1d2�Z
d�d3d4�Zd�d�d8d9�Zd�d:d;�Zd�d>d?�Zd�dBdC�Zd�dDdE�Zd�dFdG�Zd�dIdJ�Zd�dKdL�Zd�dMdN�Zejd�dPdQ��Zd�d�dTdU�Zd�dZd[�Z d�d\d]�Z d�d_d`�Z d�d�dcdd�Z d�d�dfdg�Z d�dhdi�Z!d�djdk�Z"d�d�dmdn�Z#d�dodp�Z$d�drds�Z% d�d�dwdx�Z&d�dzd{�Z'd�d|d}�Z(d�d�d��Z)d�d�d��Z*d�d�d��Z+d�d�d��Z,d�d�d�d��Z-d�d�d��Z. d�d�d�d��Z/ d�d�d�d��Z0 d�d�d�d��Z1 d�d�d�d��Z2 d�d�d�d��Z3 d�d�d�d��Z4d�d�d��Z5dS )�rA a� Programmatic access to coverage.py.
To use::
from coverage import Coverage
cov = Coverage()
cov.start()
#.. call your code ..
cov.stop()
cov.html_report(directory="covhtml")
A context manager is available to do the same thing::
cov = Coverage()
with cov.collect():
#.. call your code ..
cov.html_report(directory="covhtml")
Note: in keeping with Python custom, names starting with underscore are
not part of the public API. They might stop working at any point. Please
limit yourself to documented methods to avoid problems.
Methods can raise any of the exceptions described in :ref:`api_exceptions`.
zList[Coverage]�
_instancesrC �Optional[Coverage]c C s | j r| j d S dS )z�Get the latest started `Coverage` instance, if any.
Returns: a `Coverage` instance, or None.
.. versionadded:: 5.0
���N)rM )�clsrE rE rJ �currentm s
zCoverage.currentNFT� data_file�'Optional[Union[FilePath, DefaultValue]]� data_suffix�Optional[Union[str, bool]]� cover_pylib�Optional[bool]� auto_data�bool�timid�branch� config_file�Union[FilePath, bool]�source�Optional[Iterable[str]]� source_pkgs�omit�#Optional[Union[str, Iterable[str]]]�include�debug� concurrency�check_preimported�context�
Optional[str]�messages�Nonec C s` t � | _|du | _t|t�rd}|durt�|�}d| _| | _| _ || _
d| _ d| _ || _
g | _|| _g | _t� | _d| _t� | _d| _d| _t| _d | _| _i | _ d| _ d| _ d| _ d| _ d| _!t|t"�smt�|�}t#di d|�d| j$�d|�d|�d|�d |�d
t%|��d |�d | �d
|
�d| �d| �d|
�d| �d|
�d|��| _t&j's�t(� dS dS )a�
Many of these arguments duplicate and override values that can be
provided in a configuration file. Parameters that are missing here
will use values from the config file.
`data_file` is the base name of the data file to use. The config value
defaults to ".coverage". None can be provided to prevent writing a data
file. `data_suffix` is appended (with a dot) to `data_file` to create
the final file name. If `data_suffix` is simply True, then a suffix is
created with the machine and process identity included.
`cover_pylib` is a boolean determining whether Python code installed
with the Python interpreter is measured. This includes the Python
standard library and any packages installed with the interpreter.
If `auto_data` is true, then any existing data file will be read when
coverage measurement starts, and data will be saved automatically when
measurement stops.
If `timid` is true, then a slower and simpler trace function will be
used. This is important for some environments where manipulation of
tracing functions breaks the faster trace function.
If `branch` is true, then branch coverage will be measured in addition
to the usual statement coverage.
`config_file` determines what configuration file to read:
* If it is ".coveragerc", it is interpreted as if it were True,
for backward compatibility.
* If it is a string, it is the name of the file to read. If the
file can't be read, it is an error.
* If it is True, then a few standard files names are tried
(".coveragerc", "setup.cfg", "tox.ini"). It is not an error for
these files to not be found.
* If it is False, then no configuration file is read.
`source` is a list of file paths or package names. Only code located
in the trees indicated by the file paths or package names will be
measured.
`source_pkgs` is a list of package names. It works the same as
`source`, but can be used to name packages where the name can also be
interpreted as a file path.
`include` and `omit` are lists of file name patterns. Files that match
`include` will be measured, files that match `omit` will not. Each
will also accept a single string argument.
`debug` is a list of strings indicating what debugging information is
desired.
`concurrency` is a string indicating the concurrency library being used
in the measured code. Without this, coverage.py will get incorrect
results if these libraries are in use. Valid strings are "greenlet",
"eventlet", "gevent", "multiprocessing", or "thread" (the default).
This can also be a list of these strings.
If `check_preimported` is true, then when coverage is started, the
already-imported files will be checked to see if they should be
measured by coverage. Importing measured files before coverage is
started can mean that code is missed.
`context` is a string to use as the :ref:`static context
<static_contexts>` label for collected data.
If `messages` is true, some messages will be printed to stdout
indicating what is happening.
.. versionadded:: 4.0
The `concurrency` parameter.
.. versionadded:: 4.2
The `concurrency` parameter can now be a list of strings.
.. versionadded:: 5.0
The `check_preimported` and `context` parameters.
.. versionadded:: 5.3
The `source_pkgs` parameter.
.. versionadded:: 6.0
The `messages` parameter.
NTFr\ �warnrR rV rZ r[ �parallelr^ r` �run_omit� run_includerd � report_omit�report_includere rg rE ))r rF �_no_disk�
isinstancer- �os�fspath� _debug_file�
_auto_load�
_auto_save�_data_suffix_specified�
_warn_no_data�_warn_unimported_source�_warn_preimported_source�_no_warn_slugs� _messages� _warningsr �_debug�_inoroutr2 �_plugins�_data�
_collectorr$ � _file_mapper� _data_suffix� _run_suffix� _exclude_re� _old_sigterm�_inited�_inited_for_start�_started�_should_write_debugrY r �_warnr+ r �METACOV� _prevent_sub_process_measurement)�selfrR rT rV rX rZ r[ r\ r^ r` ra rc rd re rf rg ri rE rE rJ �__init__{ s� m
�������� �
� � �
����
�zCoverage.__init__c C s� | j rdS d| _ t| jj| j| jj�| _d| jjpdv r d| j_i | _ t
� | jj r-t | _
t�| jj| j| j�| _| jjD ]}|�| | jgtt�� �d � q=dS )z�Set all the initial state.
This is called by the public methods to initialize state. This lets us
construct a :class:`Coverage` object, then tweak its state before this
function is called.
NT�multiprocessingrE � )r� r rF rd ru �
debug_filer re rl r� r& �relative_filesr% r� r2 � load_plugins�pluginsr� � configurers� configure�int�time�r� �pluginrE rE rJ �_init6 s "�zCoverage._initc C sH | j r
d| _ | �� | jjr | jjtdd�v r"td| jj� ���dS dS )z,Stuff to do after everything is initialized.F� )�limitzCrashing because called by N)r� �_write_startup_debugrF �_crashr � RuntimeError�r� rE rE rJ �
_post_init] s �zCoverage._post_initc C s� d}| j �� �X | j �d�r | j�� }t| j jd|� d}| j �d�rFt| j jd| �� � | jD ]}d|j }|�� }t| j j||� q0d}| j �d�rXt| j jdt
�� � d}W d � n1 sbw Y |rst| j jdd � dS dS )
z*Write out debug info at startup if needed.FrF T�syszsys: �pybehaveN�endrE ) r �without_callers�shouldrF �
debug_infor �write�sys_infor� �_coverage_plugin_namer )r� � wrote_any� config_infor� �header�inforE rE rJ r� h s*
� ��z Coverage._write_startup_debug�filename�str�framer r< c C s< | j dusJ �| j �||�}| j�d�r | j�t|�� |S )z�Decide whether to trace execution in `filename`.
Calls `_should_trace_internal`, and returns the FileDisposition.
N�trace)r� � should_tracer r� r� r )r� r� r� �disprE rE rJ �
_should_trace� s
zCoverage._should_tracec C sZ | j dusJ �| j �||�}| j�d�r*|s d|��}nd|�d|� �}| j�|� | S )z�Check a file name against the include/omit/etc, rules, verbosely.
Returns a boolean: True if the file should be traced, False if not.
Nr� z
Including zNot including z: )r� �check_include_omit_etcr r� r� )r� r� r� �reason�msgrE rE rJ �_check_include_omit_etc� s z Coverage._check_include_omit_etcr� �slug�oncec C s� | j s
t| jj�| _ || j v rdS | j�|� |r!|� d|� d�}| j�d�r1dt� � � d|� �}t
j |t dd� |rI|dusAJ �| j �|� dS dS ) z�Use `msg` as a warning.
For warning suppression, use `slug` as the shorthand.
If `once` is true, only show this warning once (determined by the
slug.)
Nz (�)�pid�[z] r� )�category�
stacklevel)
r| �listrF �disable_warningsr~ �appendr r� rs �getpid�warningsrk r! )r� r� r� r� rE rE rJ r� � s
�zCoverage._warnc C s | j r t|� dS dS )z4Write a message to the user, if configured to do so.N)r} �print)r� r� rE rE rJ �_message� s �zCoverage._message� option_name�Optional[TConfigValueOut]c C s | j �|�S )a Get an option from the configuration.
`option_name` is a colon-separated string indicating the section and
option name. For example, the ``branch`` option in the ``[run]``
section of the config file would be indicated with `"run:branch"`.
Returns the value of the option. The type depends on the option
selected.
As a special case, an `option_name` of ``"paths"`` will return an
dictionary with the entire ``[paths]`` section value.
.. versionadded:: 4.0
)rF �
get_option)r� r� rE rE rJ r� � s zCoverage.get_option�value�'Union[TConfigValueIn, TConfigSectionIn]c C s | j �||� dS )ah Set an option in the configuration.
`option_name` is a colon-separated string indicating the section and
option name. For example, the ``branch`` option in the ``[run]``
section of the config file would be indicated with ``"run:branch"``.
`value` is the new value for the option. This should be an
appropriate Python value. For example, use True for booleans, not the
string ``"True"``.
As an example, calling:
.. code-block:: python
cov.set_option("run:branch", True)
has the same effect as this configuration file:
.. code-block:: ini
[run]
branch = True
As a special case, an `option_name` of ``"paths"`` will replace the
entire ``[paths]`` section. The value should be a dictionary.
.. versionadded:: 4.0
N)rF �
set_option)r� r� r� rE rE rJ r� � s zCoverage.set_optionc C sr | � � | jdur| j�� | jjotj�| jj� }|s#| j dd� | �
� |s7| j dus0J �| j � � dS dS )z;Load previously-collected coverage data from the data file.N��suffix)
r� r� �resetrF rl rs �path�existsrR �
_init_datar� r� �read)r� � should_skiprE rE rJ �load� s
�z
Coverage.loadc
C s | j jpg }d|v r| j jdu rtd��t| j jd� | j j}|r%|dkr(g }n|dkr0tg}ntd|����|�dd � | jj D �� t
|�}t | j | j
|| j| j j| j j| j|d
�| _| j}|rit|t�shd }n| j jr~|du rtd }n t|t�s}t|�}nd}| �|� | jdus�J �| j�| j| j j� | jj r�| jj s�| �d � d
� dd � | jj D ��| j� � �� | jj D ]}d|_!q�t"| j | j| j#�$d�r�| j#nd| j j%d�| _&| j| j&_'| jj(| j&_)d | _*t+�,| j-� | j j.�rt/�0� t/�1� k}|�r t2j3�s t4�4t4j5| j6�| _7dS dS dS dS )zInitialization for start()r� Nz-multiprocessing requires a configuration file)�rcfile�none�
test_functionz*Don't understand dynamic_context setting: c s � � | ]}|j V qd S �N)�dynamic_context��.0r� rE rE rJ � <genexpr>
s �
�z+Coverage._init_for_start.<locals>.<genexpr>)r� �
check_include�should_start_context� file_mapperrZ r[ rk re Tz1Plugin file tracers ({}) aren't supported with {}z, c s r� r� )r� r� rE rE rJ r� 4 s
� �
�Fr� )rF rk rd �include_namespace_packages)8rF re r\ r r0 r� r �extendr� �context_switchersr r r� r� r� rZ r[ r� r� rx rr r� rl rY r� r� �use_datarg � file_tracers�supports_plugins�format�join� tracer_name�_coverage_enabledr( r r� r� r� r� �file_disposition_class�
disp_classr� �atexit�register�_atexit�sigterm� threading�current_thread� main_threadr �WINDOWS�signal�SIGTERM� _on_sigtermr� )r� re �dyconr� r� r� r� �is_mainrE rE rJ �_init_for_start� s�
��
�
�
��� �
��zCoverage._init_for_startr� c C s< | j du r t| jj� t| jj|| j| j| jd�| _ dS dS )z,Create a data file if we don't have one yet.N)�basenamer� rk rd �no_disk)r� r. rF rR r r� r rq )r� r� rE rE rJ r� W s
��zCoverage._init_datac C s� | � � | jsd| _| �� | �� | jdusJ �| jdus J �| j�� | jr-| j�� | j r4| �
� | j� � d| _ | j
�| � dS )a� Start measuring code coverage.
Coverage measurement is only collected in functions called after
:meth:`start` is invoked. Statements in the same scope as
:meth:`start` won't be measured.
Once you invoke :meth:`start`, you must also call :meth:`stop`
eventually, or your process might not shut down cleanly.
The :meth:`collect` method is a context manager to handle both
starting and stopping collection.
TN)r� r� r r� r� r� �warn_conflicting_settingsr{ �warn_already_imported_filesrv r� �startr� rM r� r� rE rE rJ r f s
zCoverage.startc C sF | j r| j d | u r| j �� | jr | jdusJ �| j�� d| _dS )z Stop measuring code coverage.rO NF)rM �popr� r� �stopr� rE rE rJ r � s
z
Coverage.stoprD c c s* � | � � z
dV W | �� dS | �� w )ziA context manager to start/stop coverage measurement collection.
.. versionadded:: 7.3
N)r r r� rE rE rJ �collect� s
�zCoverage.collectr� �eventc C sX | j �d�r| j �|� dt�� � d| ��� | jr | �� | js$|dkr*| �� dS dS )z Clean up on process shutdown.�processz: pid: z , instance: r� N) r r� r� rs r� r� r rw �save)r� r rE rE rJ r� � s �zCoverage._atexit�
signum_unusedr� � frame_unused�Optional[FrameType]c C s0 | � d� t�tj| j� t�t�� tj� dS )z A handler for signal.SIGTERM.r� N)r� r� r� r� rs �killr� )r� r r
rE rE rJ r� � s
zCoverage._on_sigtermc C s` | � � | �� | jdur| j�� | jdd� | jdus J �| jj| jjd� d| _d| _ dS )z�Erase previously collected coverage data.
This removes the in-memory data collected in this session as well as
discarding the data file.
Nr� )rl F)
r� r� r� r� r� r� �eraserF rl r� r� rE rE rJ r � s
zCoverage.erase� new_contextc C sD | j std��| jdusJ �| jjr| jdddd� | j�|� dS )a� Switch to a new dynamic context.
`new_context` is a string to use as the :ref:`dynamic context
<dynamic_contexts>` label for collected data. If a :ref:`static
context <static_contexts>` is in use, the static and dynamic context
labels will be joined together with a pipe character.
Coverage collection must be started already.
.. versionadded:: 5.0
z.Cannot switch context, coverage is not startedNz Conflicting dynamic contextszdynamic-conflictT)r� r� )r� r r� r� r� �switch_context)r� r rE rE rJ r � s
zCoverage.switch_context�exclude�whichc C s& | � � t| j|d g � | �� dS )zClear the exclude list.�_listN)r� �setattrrF �_exclude_regex_stale�r� r rE rE rJ �
clear_exclude� s zCoverage.clear_exclude�regexc C s. | � � t| j|d �}|�|� | �� dS )a| Exclude source lines from execution consideration.
A number of lists of regular expressions are maintained. Each list
selects lines that are treated differently during reporting.
`which` determines which list is modified. The "exclude" list selects
lines that are not considered executable at all. The "partial" list
indicates lines with branches that are not taken.
`regex` is a regular expression. The regex is added to the specified
list. If any of the regexes in the list is found in a line, the line
is marked for special treatment during reporting.
r N)r� �getattrrF r� r )r� r r � excl_listrE rE rJ r � s
zCoverage.excludec C s | j �� dS )z=Drop all the compiled exclusion regexes, a list was modified.N)r� �clearr� rE rE rJ r � s z Coverage._exclude_regex_stalec C s2 || j vrt| j|d �}t|�| j |< | j | S )z3Return a regex string for the given exclusion list.r )r� r rF r, )r� r r rE rE rJ �_exclude_regex� s
zCoverage._exclude_regex� List[str]c C s" | � � ttt t| j|d ��S )z�Return a list of excluded regex strings.
`which` indicates which list is desired. See :meth:`exclude` for the
lists that are available, and their meaning.
r )r� r r r� r rF r rE rE rJ �get_exclude_list s zCoverage.get_exclude_listc C s | � � }|�� dS )z2Save the collected coverage data to the data file.N)�get_datar� )r� �datarE rE rJ r
s z
Coverage.saver# c C s` t | j�d�r | jjnd| jjd�}| jj�� D ]}|d }|dd� D ]}|�||� q$q|S )z,Create a PathAliases from our configuration.�pathmapN)�debugfn�relativer � ) r# r r� r� rF r� �paths�values�add)r� �aliasesr' �result�patternrE rE rJ �
_make_aliases s ��zCoverage._make_aliases�
data_paths�strict�keepc C sR | � � | jdd� | �� | �� | jdusJ �t| j| �� |||| jd� dS )a� Combine together a number of similarly-named coverage data files.
All coverage data files whose name starts with `data_file` (from the
coverage() constructor) will be read, and combined together into the
current measurements.
`data_paths` is a list of files or directories from which data should
be combined. If no list is passed, then the data files from the
directory indicated by the current data file (probably the current
directory) will be combined.
If `strict` is true, then it is an error to attempt to combine when
there are no data files to combine.
If `keep` is true, then original input data files won't be deleted.
.. versionadded:: 4.0
The `data_paths` parameter.
.. versionadded:: 4.3
The `strict` parameter.
.. versionadded: 5.5
The `keep` parameter.
Nr� )r* r. r/ r0 �message)r� r� r� r! r� r r- r� )r� r. r/ r0 rE rE rJ �combine s
�zCoverage.combiner c C sj | � � | jdd� | �� | jdur+| jD ] }|js!| j�|� q| j�� r+| �� | j dus2J �| j S )z�Get the collected data.
Also warn about various problems collecting data.
Returns a :class:`coverage.CoverageData`, the collected coverage data.
.. versionadded:: 4.0
Nr� )
r� r� r� r� r� r� �plugin_was_disabled�
flush_data�_post_save_workr� r� rE rE rJ r! I s
�
zCoverage.get_datac C s� | j dusJ �| jdusJ �| jr| j�� | j s#| jr#| jddd� t�t�}| j� � D ]\}}| �
|�}|| � |� q-|� � D ] \}}| j �
||� qBdS )z�After saving data, look for warnings, post-work, etc.
Warn about things that should have happened but didn't.
Look for un-executed files.
NzNo data was collected.zno-data-collected)r� )r� r� rz �warn_unimported_sourcery r� � collections� defaultdictr� � find_possibly_unexecuted_filesr� r� �items� touch_files)r� �
file_paths� file_path� plugin_namer' rE rE rJ r5 b s
�zCoverage._post_save_work�morfr> �-Tuple[str, List[TLineNo], List[TLineNo], str]c C s | � |�\}}}}}||||fS )z:Like `analysis2` but doesn't return excluded line numbers.)� analysis2)r� r? �f�s�_�m�mfrE rE rJ �analysis s zCoverage.analysis�<Tuple[str, List[TLineNo], List[TLineNo], List[TLineNo], str]c C s0 | � |�}|jt|j�t|j�t|j�|�� fS )aG Analyze a module.
`morf` is a module or a file name. It will be analyzed to determine
its coverage statistics. The return value is a 5-tuple:
* The file name for the module.
* A list of line numbers of executable statements.
* A list of line numbers of excluded statements.
* A list of line numbers of statements not run (missing from
execution).
* A readable formatted string of the missing line numbers.
The analysis uses the source file itself and the current measured
coverage data.
)�_analyzer� �sorted�
statements�excluded�missing�missing_formatted)r� r? rG rE rE rJ rA � s
�zCoverage.analysis2�it�Union[FileReporter, TMorf]r6 c C sF | � � | �� | �� }t|t�r|}n| �|�}t|| jj|| j �S )zTAnalyze a single morf or code unit.
Returns an `Analysis` object.
)
r� r� r! rr r1 �_get_file_reporterr6 rF � precisionr� )r� rO r" �frrE rE rJ rI � s
zCoverage._analyzer1 c C s� | j dusJ �d}d}t|t�r7| �|�}| j �|�}|r7| j�|�}|r7|�|�}|du r7td� |j
|���|dkr@t || �}t|t �sGJ �|S )z-Get a FileReporter for a module or file name.N�pythonz5Plugin {!r} did not provide a file reporter for {!r}.)
r� rr r� r� � file_tracerr� �get�
file_reporterr" r� r� r3 r1 )r� r? r� rW � mapped_morfr> rE rE rJ rQ � s(
��
zCoverage._get_file_reporter�morfs�Optional[Iterable[TMorf]]�List[FileReporter]c sH � j dusJ �|s� j �� }t|tttf�s|g}� fdd�|D �}|S )a� Get a list of FileReporters for a list of modules or file names.
For each module or file name in `morfs`, find a FileReporter. Return
the list of FileReporters.
If `morfs` is a single module or file name, this returns a list of one
FileReporter. If `morfs` is empty or None, then the list of all files
measured is used to find the FileReporters.
Nc s g | ]}� � |��qS rE )rQ )r� r? r� rE rJ �
<listcomp>� s z0Coverage._get_file_reporters.<locals>.<listcomp>)r� �measured_filesrr r� �tuple�set)r� rY �file_reportersrE r� rJ �_get_file_reporters� s
z Coverage._get_file_reportersc C sF | j jr!t| j| jdd�}| jdur |j| j| �� d� || _dS dS )zARe-map data before reporting, to get implicit "combine" behavior.T)rk rd r N)r* )rF r' r r� r r� �updater- )r� � mapped_datarE rE rJ �_prepare_data_for_reporting� s
�z$Coverage._prepare_data_for_reporting� show_missing�
ignore_errors�file�Optional[IO[str]]� Optional[Union[str, List[str]]]� skip_covered�contexts�Optional[List[str]]�
skip_emptyrR �
Optional[int]�sort�
output_format�floatc
C s` | � � t| ||||||| |
| | d� � t| �}
|
j||d�W d � S 1 s)w Y dS )a Write a textual summary report to `file`.
Each module in `morfs` is listed, with counts of statements, executed
statements, missing statements, and a list of lines missed.
If `show_missing` is true, then details of which lines or branches are
missing will be included in the report. If `ignore_errors` is true,
then a failure while reporting a single file will not stop the entire
report.
`file` is a file-like object, suitable for writing.
`output_format` determines the format, either "text" (the default),
"markdown", or "total".
`include` is a list of file name patterns. Files that match will be
included in the report. Files matching `omit` will not be included in
the report.
If `skip_covered` is true, don't report on files with 100% coverage.
If `skip_empty` is true, don't report on empty files (those that have
no statements).
`contexts` is a list of regular expression strings. Only data from
:ref:`dynamic contexts <dynamic_contexts>` that match one of those
expressions (using :func:`re.search <python:re.search>`) will be
included in the report.
`precision` is the number of digits to display after the decimal
point for percentages.
All of the arguments default to the settings read from the
:ref:`configuration file <config>`.
Returns a float, the total percentage covered.
.. versionadded:: 4.0
The `skip_covered` parameter.
.. versionadded:: 5.0
The `contexts` and `skip_empty` parameters.
.. versionadded:: 5.2
The `precision` parameter.
.. versionadded:: 7.0
The `format` parameter.
)
rf ro rp re rj �report_contextsrm rR ro r� )�outfileN)rd rK r4 �report)r� rY re rf rg ra rc rj rk rm rR ro rp �reporterrE rE rJ rt � s" A�
$�zCoverage.report� directoryc C sf t d� t d� | �� t| ||||d�� t| �}|j||d� W d � dS 1 s,w Y dS )aD Annotate a list of modules.
.. note::
This method has been obsoleted by more modern reporting tools,
including the :meth:`html_report` method. It will be removed in a
future version.
Each module in `morfs` is annotated. The source is written to a new
file, named with a ",cover" suffix, with each line prefixed with a
marker to indicate the coverage of the line. Covered lines have ">",
excluded lines have "-", and missing lines have "!".
See :meth:`report` for other arguments.
z9The annotate command will be removed in a future version.z7Get in touch if you still use it: ned@nedbatchelder.com)rf ro rp rr )rv N)r� rd rK r rt )r� rY rv rf ra rc rk ru rE rE rJ �annotate> s �"�zCoverage.annotate� extra_css�title�
show_contextsc
C sb | � � t| |||||||| |
| | d� � t| �}
|
�|�}|W d � S 1 s*w Y dS )aE Generate an HTML report.
The HTML is written to `directory`. The file "index.html" is the
overview starting point, with links to more detailed pages for
individual modules.
`extra_css` is a path to a file of other CSS to apply on the page.
It will be copied into the HTML directory.
`title` is a text string (not HTML) to use as the title of the HTML
report.
See :meth:`report` for other arguments.
Returns a float, the total percentage covered.
.. note::
The HTML report files are generated incrementally based on the
source files and coverage results. If you modify the report files,
the changes will not be considered. You should be careful about
changing the files in the report folder.
) rf ro rp �html_dirrx �
html_title�html_skip_coveredrz rr �html_skip_emptyrR N)rd rK r' rt )r� rY rv rf ra rc rx ry rj rz rk rm rR ru �retrE rE rJ � html_reporte s& '�
$�zCoverage.html_reportrs c C sZ | � � t| ||||||d�� t| jjt| �|| j�W d � S 1 s&w Y dS )ab Generate an XML report of coverage results.
The report is compatible with Cobertura reports.
Each module in `morfs` is included in the report. `outfile` is the
path to write the file to, "-" will write to stdout.
See :meth:`report` for other arguments.
Returns a float, the total percentage covered.
)rf ro rp �
xml_outputrr rm N)rd rK r5 rF r� r? r� )r� rY rs rf ra rc rk rm rE rE rJ �
xml_report� s � $�zCoverage.xml_report� pretty_printc
C s\ | � � t| |||||||d�� t| jjt| �|| j�W d � S 1 s'w Y dS )a� Generate a JSON report of coverage results.
Each module in `morfs` is included in the report. `outfile` is the
path to write the file to, "-" will write to stdout.
`pretty_print` is a boolean, whether to pretty-print the JSON output or not.
See :meth:`report` for other arguments.
Returns a float, the total percentage covered.
.. versionadded:: 5.0
)rf ro rp � json_outputrr �json_pretty_print�json_show_contextsN)rd rK r5 rF r� r) r� ) r� rY rs rf ra rc rk r� rz rE rE rJ � json_report� s �
$�zCoverage.json_reportc C sX | � � t| |||||d�� t| jjt| �|| j�W d � S 1 s%w Y dS )a Generate an LCOV report of coverage results.
Each module in `morfs` is included in the report. `outfile` is the
path to write the file to, "-" will write to stdout.
See :meth:`report` for other arguments.
.. versionadded:: 6.3
)rf ro rp � lcov_outputrr N)rd rK r5 rF r� r* r� )r� rY rs rf ra rc rk rE rE rJ � lcov_report� s �$�zCoverage.lcov_report�Iterable[Tuple[str, Any]]c C s� ddl }| �� | �� d)dd�}d |jfd
|jfd | jdur$| j�� nd fd
tr+dndfd|| jj �fd|| jj
�fd|| jj �fd| j j
fd| j jfd| j jfd| j jr\t| j j�nd fd| jduri| j�� nd fdtj�dd�fdt�� fd t�� fd tjfd t�� fd t�� fd t � � fd!t � � fd"tj fd#d$d%� t t j!�D �fd&d'�"t#td(d g��fg}| j$dur�|�%| j$�&� � |�%t'�&� � |S )*zAReturn a list of (key, value) pairs showing internal information.r Nr� � List[Any]rC r c S s0 g }| D ]}|j }|js|d7 }|�|� q|S )z7Make an entry for the sys_info from a list of plug-ins.z (disabled))r� r� r� )r� �entriesr� �entryrE rE rJ � plugin_info s z&Coverage.sys_info.<locals>.plugin_info�coverage_version�coverage_module�tracerz-none-�CTracer� available� unavailablezplugins.file_tracerszplugins.configurerszplugins.context_switchers�configs_attempted� configs_readr\ �config_contentsrR rT �
� �platform�implementation�
executable� def_encoding� fs_encodingr� �cwdr� � environmentc S s g | ] \}}|� d |� ��qS )z = rE )r� �k�vrE rE rJ r\ . s z%Coverage.sys_info.<locals>.<listcomp>� command_line� �argv)r� r� rC r )(�coverager� r� � __version__�__file__r� r� r r� r� r� r� rF �attempted_config_files�config_files_readr\ �_config_contents�reprr� �
data_filenamer� �version�replacer� �python_implementationr� �getdefaultencoding�getfilesystemencodingrs r� �getcwdr� r �environr� r r� r� r� r )r� �covmodr� r� rE rE rJ r� sD
�
�
zCoverage.sys_info�rC rN )"rR rS rT rU rV rW rX rY rZ rW r[ rW r\ r] r^ r_ r` r_ ra rb rc rb rd r_ re rb rf rY rg rh ri rY rC rj �rC rj )r� r� r� r rC r< )r� r� r� r rC rY )NF)r� r� r� rh r� rY rC rj )r� r� rC rj )r� r� rC r� )r� r� r� r� rC rj )r� rU rC rj )rC rD )r� )r r� rC rj )r r� r
r rC rj )r r� rC rj )r )r r� rC rj )r r� r r� rC rj )r r� rC r� )r r� rC r )rC r# )NFF)r. r_ r/ rY r0 rY rC rj )rC r )r? r> rC r@ )r? r> rC rH )rO rP rC r6 )r? r> rC r1 r� )rY rZ rC r[ ) NNNNNNNNNNNN)rY rZ re rW rf rW rg rh ra ri rc ri rj rW rk rl rm rW rR rn ro rh rp rh rC rq )NNNNNN)rY rZ rv rh rf rW ra ri rc ri rk rl rC rj )rY rZ rv rh rf rW ra ri rc ri rx rh ry rh rj rW rz rW rk rl rm rW rR rn rC rq )NNNNNNN)rY rZ rs rh rf rW ra ri rc ri rk rl rm rW rC rq )NNNNNNNN)rY rZ rs rh rf rW ra ri rc ri rk rl r� rW rz rW rC rq )rY rZ rs rh rf rW ra ri rc ri rk rl rC rq )rC r� )6�__name__�
__module__� __qualname__�__doc__rM �__annotations__� classmethodrQ �DEFAULT_DATAFILEr� r� r� r� r� r� r� r� r� r� r� r r� r r �
contextlib�contextmanagerr r� r� r r r r r r r r r- r2 r! r5 rG rA rI rQ ra rd rt rw r� r� r� r� r� rE rE rE rJ rA N s�
�
<
'
[
&
�
.
�T �) �< �$ �( � �COVERAGE_DEBUG_CALLS)�decorate_methods�
show_callsT)� show_argsr! )�butnotrN c C sV t j�d�} | s
dS ttd�rdS t| d�}|t_d|_d|_d|_ d|_
|� � |S )a� Call this at Python start-up to perhaps measure coverage.
If the environment variable COVERAGE_PROCESS_START is defined, coverage
measurement is started. The value of the variable is the config file
to use.
There are two ways to configure your Python installation to invoke this
function when Python starts:
#. Create or append to sitecustomize.py to add these lines::
import coverage
coverage.process_startup()
#. Create a .pth file in your Python installation containing::
import coverage; coverage.process_startup()
Returns the :class:`Coverage` instance that was started, or None if it was
not started by this call.
�COVERAGE_PROCESS_STARTNr� )r\ FT) rs r� rV �hasattr�process_startuprA r� ry rz r{ rw r )�cpsr@ rE rE rJ r� E s
r� rj c C s" t tdd�} | durd| _dS dS )z7Stop any subprocess auto-measurement from writing data.r� NF)r r� rw )�auto_created_coveragerE rE rJ r� z s
�r� )r@ rA rB r: rC rD r� r� )qr� �
__future__r r� r7 r� rs �os.pathr� r� r� r� r� r� �typesr �typingr r r r r r r
r r r
r r� r �coverage.annotater �coverage.collectorr r �coverage.configr r �coverage.contextr r �
coverage.datar r �coverage.debugr r r r r �coverage.dispositionr �coverage.exceptionsr r r! r" �coverage.filesr# r$ r% r& �
coverage.htmlr' �coverage.inoroutr( �coverage.jsonreportr) �coverage.lcovreportr* �
coverage.miscr+ r, r- r. r/ �coverage.multiprocr0 �coverage.pluginr1 �coverage.plugin_supportr2 �coverage.pythonr3 �coverage.reportr4 �coverage.report_corer5 �coverage.resultsr6 �coverage.typesr7 r8 r9 r: r; r< r= r> �coverage.xmlreportr? r� rK r� �_DEFAULT_DATAFILErA r� r� rV r� r� r� r� rE rE rE rJ �<module> s� 4 ( w��
5