File: //usr/lib/python3/dist-packages/sphinx/ext/__pycache__/coverage.cpython-310.pyc
o
�$�ag7 � @ 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 e� e �Z d d
e
de!de!ddfdd�Z"de!de!de
e fdd�Z#G dd� de�Z$dede e!e f fdd�Z%dS ) a-
sphinx.ext.coverage
~~~~~~~~~~~~~~~~~~~
Check Python modules and C API for coverage. Mostly written by Josip
Dzolonga for the Google Highly Open Participation contest.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)�
import_module)�path)�IO�Any�Dict�List�Pattern�Set�Tuple)�Sphinx)�Builder)�__)�logging)�red)� safe_getattr�-�f�text�char�returnc C s( | � |d � | � |t|� d � d S )N�
)�write�len)r r r � r �5/usr/lib/python3/dist-packages/sphinx/ext/coverage.py� write_header s r �name�expsc C sJ g }|D ] }z
|� t�|�� W q ty" t�td�|| � Y qw |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 �Zddd�Z de
fd d
�Z d e ddfd d
�Z
ddd�Zddd�Zde
defdd�Zddd�Zddd�Zddd�ZdS ) �CoverageBuilderz:
Evaluates coverage of code in the documentation.
�coveragezNTesting of coverage in the sources finished, look at the results in %(outdir)sz python.txt.r Nc C s� g | _ | jjD ]}t�| j|�}| j �t�|�� qg | _| jj �
� D ]"\}}z
| j� |t �
|�f� W q# tyE t�td�|� Y q#w i | _| jj�
� D ] \}}td|�| j|< qOtd| 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 �init7 s8 � ����
�zCoverageBuilder.initc C s dS )Nzcoverage overviewr )r= r r r �get_outdated_docsQ s z!CoverageBuilder.get_outdated_docs�ignoredc G s0 i | _ | �� | �� i | _| �� | �� d S )N)�py_undoc�build_py_coverage�write_py_coverage�c_undoc�build_c_coverage�write_c_coverage)r= rA r r r r T s zCoverageBuilder.writec C s� | j jd d }| jD ]W}t� }t|��?}|D ]4}| jD ].\}}|�|�}|rJ|�� d } | |vrI| j� |g �D ] }
|
�| �rA nq8|�
|| f� q q qW d � n1 sVw Y |rb|| j |< q d S )N�c�objectsr ) �env�
domaindatar. �set�openr5 �match�groupsr8 �get�addrE ) r= � c_objects�filename�undocr �line�key�regexrN r r% r r r rF ] s0
���� �
��z CoverageBuilder.build_c_coveragec
C s t �| jd�}t|d��n}| jjrt|dd� |�d� | j� � D ]P\}}t||� t
|�D ]=\}}|�d||f � | jj rk| j j
sG| j jrRt�td�|||� q.t�td�d d
d |d | td
� | � q.|�d� q!W d � d S 1 s}w Y d S )Nzc.txt�wzUndocumented C API elements�=r z * %-50s [%9s]
z&undocumented c api: %s [%s] in file %s�undocumented zc z
api �%-30sz [%9s]z - in file )r r1 �outdirrM r/ �coverage_write_headliner r rE r7 �sorted�coverage_show_missing_items�app�quiet�warningiserrorr" r# r
�infor )r= � output_file�oprS rT �typr r r r rG r s2
����� �"�z CoverageBuilder.write_c_coverage� full_namec C s | j D ]
}|�|�r
dS qdS )NTF)r< �search)r= rg r% r r r � ignore_pyobj� s
�z CoverageBuilder.ignore_pyobjc C s^ | j jd d }| j jd d }| jj}|D �]}d}| jD ] }|�|�r)d} nq |s1| �|�r2qzt|�}W n" tyZ } zt �
t d�||� d|i| j |< W Y d }~qd }~ww g } i }
t
�|�D ]�\} } | d d kroqdt| d
�suqd| j|kr{qdd || f }
| �|
�r�qdt
�| �r�|
|vr�| jD ] }|�| �r� n q�|r�| js�qd| �| � qdt
�| ��r#| jD ] }|�| �r� nhq�|
|vr�|r�| js�qdg |
| < qdg }t| �D ]J}|| jvr�q�zt| |�}W n ty� Y q�w t
�|�s�t
�|�s�q�|d d kr�q�|�r|j�sq�d |
|f }| �|��rq�||v�r|�|� q�|�r#||
| < qd| |
d �| j |< qd S )
N�pyrI �modulesFTz#module %s could not be imported: %s�errorr �_�
__module__z%s.%s)�funcs�classes) rJ rK r/ � coverage_skip_undoc_in_sourcer9 rN ri r � ImportErrorr" r# r
rB �inspect�
getmembers�hasattrrn �
isfunctionr; �__doc__r �isclassr: �dir�__dict__r �AttributeError�ismethod)r= rI rk �
skip_undoc�mod_name�ignorer% �mod�errro rp r �objrg �attrs� attr_name�attr�full_attr_namer r r rC � s�
� ��
�
�
�
�
�
���z!CoverageBuilder.build_py_coveragec
C s� t �| jd�}g }t|d���O}| jjrt|dd� t| j� � �}|D �]}| j| }d|v r9|�
||d f� q#|d sB|d sBq#t||� |d r�|� d� |� d d
� |d D �� | jj
r�| jjsh| jjry|d D ] }t�td �||� qln |d D ]}t�td �d
d d| td� | � q}|� d� |d �r;|� d� t|d �� �D ]�\}} | s�|� d| � | jj
r�| jjs�| jjr�t�td�||� q�t�td �d
d d| td� | � q�|� d| � |� dd
� | D �� | jj
�r5| jj�s| jj�r| D ]
}
t�td�|||
� �qq�| D ] }
t�td �d
d d|d |
td� | � �qq�|� d� q#|�rVt|d� |� d d
� |D �� W d � d S W d � d S 1 �sbw Y d S ) Nz
python.txtrX zUndocumented Python objectsrY rl rp ro z Functions:
c s � � | ]}d | V qdS )� * %s
Nr ��.0�xr r r � <genexpr>� � � z4CoverageBuilder.write_py_coverage.<locals>.<genexpr>z&undocumented python function: %s :: %srZ zpy z
function r[ z
- in module r z Classes:
r� z#undocumented python class: %s :: %sz
class z * %s -- missing methods:
c s r� )z - %s
Nr r� r r r r� r� z*undocumented python method: %s :: %s :: %sz
method �.z Modules that failed to importc s r� )z * %s -- %s
Nr r� r r r r� ) r� )r r1 r\ rM r/ r] r r^ rB �keysr r �
writelinesr_ r` ra rb r" r# r
rc r r7 ) r= rd �failedre r� r rT �func�
class_name�methods�methr r r rD � s�
�� ���
�������
���
���
��
�
�<$�z!CoverageBuilder.write_py_coveragec C sR t �| jd�}t|d��}t�| j| jf|� W d � d S 1 s"w Y d S )Nz undoc.pickle�wb)r r1 r\ rM �pickle�dumprB rE )r= �
picklepath�dumpfiler r r �finish+ s "�zCoverageBuilder.finish)r N)�__name__rn � __qualname__rw r r
r �sep�epilogr? �strr@ r r rF rG �boolri rC rD r� r r r r r' / s" ��
[Cr' r` c C s� | � t� | �dg d� | �dg d� | �dg d� | �dg d� | �dg d� | �di d� | �di d� | �d d
d� | �d dd� | �d dd� tjd
d
�S )Nr* Fr, r+ r- r0 r6 r) r] Trq r_ )�version�parallel_read_safe)� add_builderr' �add_config_value�sphinx�__display_version__)r` r r r �setup2 s
r� )r )&rw r4 rs r� r � importlibr �osr �typingr r r r r r r
r� �sphinx.applicationr �sphinx.buildersr �
sphinx.localer
� sphinx.utilr �sphinx.util.consoler �sphinx.util.inspectr � getLoggerr� r" r� r r& r' r� r r r r �<module> s, $