Your IP : 216.73.216.213

Current Path : /opt/alt/python37/lib64/python3.7/Doc/tools/extensions/__pycache__/
Upload File :
Current File : //opt/alt/python37/lib64/python3.7/Doc/tools/extensions/__pycache__/suspicious.cpython-37.opt-1.pyc

B

� f�%�@s�dZddlZddlZddlZddlZddlmZddlmZddl	Z
e�dejej
B�jZejdkZGdd�d�ZGd	d
�d
ej�ZGdd�de�Zd
d�Zdd�ZGdd�dej�ZdS)a�
Try to detect suspicious constructs, resembling markup
that has leaked into the final output.

Suspicious lines are reported in a comma-separated-file,
``suspicious.csv``, located in the output directory.

The file is utf-8 encoded, and each line contains four fields:

 * document name (normalized)
 * line number in the source document
 * problematic text
 * complete line showing the problematic text in context

It is common to find many false positives. To avoid reporting them
again and again, they may be added to the ``ignored.csv`` file
(located in the configuration directory). The file has the same
format as ``suspicious.csv`` with a few differences:

  - each line defines a rule; if the rule matches, the issue
    is ignored.
  - line number may be empty (that is, nothing between the
    commas: ",,"). In this case, line numbers are ignored (the
    rule matches anywhere in the file).
  - the last field does not have to be a complete line; some
    surrounding text (never more than a line) is enough for
    context.

Rules are processed sequentially. A rule matches when:

 * document names are the same
 * problematic texts are the same
 * line numbers are close to each other (5 lines up or down)
 * the rule text is completely contained into the source line

The simplest way to create the ignored.csv file is by copying
undesired entries from suspicious.csv (possibly trimming the last
field.)

Copyright 2009 Gabriel A. Genellina

�N)�nodes)�Builderz�
    ::(?=[^=])|            # two :: (but NOT ::=)
    :[a-zA-Z][a-zA-Z0-9]+| # :foo
    `|                     # ` (seldom used by itself)
    (?<!\.)\.\.[ \t]*\w+:  # .. foo: (but NOT ... else:)
    )�rc@seZdZdd�Zdd�ZdS)�RulecCs"||_||_||_||_d|_dS)zA rule for ignoring issuesFN)�docname�lineno�issue�line�used)�selfrrrr	�r�D/opt/alt/python37/lib64/python3.7/Doc/tools/extensions/suspicious.py�__init__@s
z
Rule.__init__cCs
d�|�S)Nz{0.docname},,{0.issue},{0.line})�format)rrrr
�__repr__Jsz
Rule.__repr__N)�__name__�
__module__�__qualname__rrrrrr
r?s
rc@seZdZdZdZdS)�dialectz+Our dialect: uses only linefeed as newline.�
N)rrr�__doc__Zlineterminatorrrrr
rOsrc@s|eZdZdZdZejj�d�Z	dd�Z
dd�Zddd	�Zd
d�Z
dd
�Zdd�Zdd�Zdd�Zdd�Zdd�Zdd�ZdS)�CheckSuspiciousMarkupBuilderzK
    Checks for possibly invalid markup that may leak into the output.
    Z
suspiciouscCsDtj�|jd�|_t|jd���|�tj�tj�t	�dd��dS)Nzsuspicious.csv�wz..zsusp-ignored.csv)
�os�path�joinZoutdir�
log_file_name�open�close�
load_rules�dirname�__file__)rrrr
�init[sz!CheckSuspiciousMarkupBuilder.initcCs|jjS)N)�envZ
found_docs)rrrr
�get_outdated_docscsz.CheckSuspiciousMarkupBuilder.get_outdated_docsNcCsdS)N�r)rr�typrrr
�get_target_urifsz+CheckSuspiciousMarkupBuilder.get_target_uricCsdS)Nr)rZdocnamesrrr
�prepare_writingisz,CheckSuspiciousMarkupBuilder.prepare_writingcCs$d|_||_t||�}|�|�dS)NF)�	any_issuer�SuspiciousVisitor�walk)rrZdoctreeZvisitorrrr
�	write_docls
z&CheckSuspiciousMarkupBuilder.write_docc	CsHdd�|jD�}|rD|j�dt|�t|j�d�dd�|D��f�dS)NcSsg|]}|js|�qSr)r
)�.0�rulerrr
�
<listcomp>tsz7CheckSuspiciousMarkupBuilder.finish.<locals>.<listcomp>zFound %s/%s unused rules: %sr%css|]}t|�VqdS)N)�repr)r-r.rrr
�	<genexpr>ysz6CheckSuspiciousMarkupBuilder.finish.<locals>.<genexpr>)�rules�logger�warning�lenr)rZunused_rulesrrr
�finishssz#CheckSuspiciousMarkupBuilder.finishcCs |�|||�s|�|||�dS)N)�
is_ignored�report_issue)rr	rrrrr
�check_issue~sz(CheckSuspiciousMarkupBuilder.check_issuecCsd|j}xX|jD]N}|j|krq|j|kr*q|j|kr6q|jdk	rTt|j|�dkrTqd|_dSWdS)z/Determine whether this issue should be ignored.N�TF)rr2rr	r�absr
)rr	rrrr.rrr
r7�s



z'CheckSuspiciousMarkupBuilder.is_ignoredc
Cs�d|_|�|||�tr4|j�d|j|||f�nB|j�d|j�t��d�||�t��d�|�	��t��d�f�d|j
_dS)NTz[%s:%d] "%s" found in "%-.120s"�replace�)r)�write_log_entry�py3r3r4r�encode�sys�getdefaultencoding�stripZappZ
statuscode)r�textrrrrr
r8�sz)CheckSuspiciousMarkupBuilder.report_issuecCs�tr>t|jd�}t�|t�}|�|j|||��g�|�	�nJt|jd�}t�|t�}|�|j�
d�||�
d�|���
d�g�|�	�dS)N�aZabzutf-8)r?rr�csv�writerrZwriterowrrCrr@)rrrrD�frGrrr
r>�s
z,CheckSuspiciousMarkupBuilder.write_log_entrycCs|jjddd�g|_}ytr,t|d�}n
t|d�}Wntk
rLdSXx�tt�|��D]�\}}t	|�dkr�t
d||d|f��|\}}}}	|r�t|�}nd}ts�|�d	�}|�d	�}|	�d	�}	t
||||	�}
|�|
�q^W|��|j�d
t	|j��dS)z�Load database of previously ignored issues.

        A csv file, with exactly the same format as suspicious.csv
        Fields: document name (normalized), line number, issue, surrounding text
        zloading ignore rules... r=)Znonl�r�rbN�zwrong format in %s, line %d: %szutf-8zdone, %d rules loaded)r3�infor2r?r�IOError�	enumeraterF�readerr5�
ValueError�int�decoder�appendr)r�filenamer2rH�i�rowrrrrDr.rrr
r�s0




z'CheckSuspiciousMarkupBuilder.load_rules)N)rrrr�name�sphinx�utilZloggingZ	getLoggerr3r"r$r'r(r,r6r9r7r8r>rrrrr
rTs
rcCs&d}x|dkr |r |j}|j}qW|S)z*Obtain line number information for a node.N)�parentr	)�noderrrr
�
get_lineno�s

r\cCs:|�dd|�d}|�d|�}|dkr.t|�}|||�S)a text may be a multiline string; extract
    only the line containing the given character index.

    >>> extract_line("abc
defgh
i", 6)
    >>> 'defgh'
    >>> for i in (0, 2, 3, 4, 10):
    ...   print extract_line("abc
defgh
i", i)
    abc
    abc
    abc
    defgh
    defgh
    i
    rrr=)�rfind�findr5)rD�index�p�qrrr
�extract_line�s
rbc@s4eZdZdZdd�Zdd�ZeZdd�Zdd	�Zd
S)r*rcCstj�||�||_dS)N)r�GenericNodeVisitorr�builder)rZdocumentrdrrr
r�szSuspiciousVisitor.__init__cCs�t|tjtjf�r�|��}tt|�p&d|j�|_}t�}xPt	|�D]D}|�
�}t||���}||f|krD|j
�|||�|�||f�qDWdS)Nr)�
isinstancerZTextZimageZastext�maxr\�
lastlineno�set�
detect_all�grouprb�startrdr9�add)rr[rDr�seen�matchrr	rrr
�
default_visit�szSuspiciousVisitor.default_visitcCs
d|_dS)Nr)rg)rr[rrr
�visit_documentsz SuspiciousVisitor.visit_documentcCs
tj�dS)N)rZSkipNode)rr[rrr
�
visit_commentszSuspiciousVisitor.visit_commentN)	rrrrgrroZ
unknown_visitrprqrrrr
r*�s
r*)rr�rerFrAZdocutilsrZsphinx.buildersrZsphinx.utilrX�compile�UNICODE�VERBOSE�finditerri�version_infor?rZexcelrrr\rbrcr*rrrr
�<module>*s"