MC{6 d Z ddlmZ ddlZddlZddlmZmZmZ ddl m
Z
ddl m Z m
Z
erddlmZ dd ZddZdddZej dfddZdS ) z?Various helper functions to create the docs of a linter object. ) annotationsN)
TYPE_CHECKINGAnyTextIO)MAIN_CHECKER_NAME)get_rst_section
get_rst_title)PyLinterlinterr
returndict[str, dict[str, Any]]c " i }| D ]v}|j }|t k r` ||| d< t j 5 t j dt || dxx | z
cc< ddd n # 1 swxY w Y || d |j || dxx |j
z
cc< # t $ r t j 5 t j dt |t | t |j t |j
d||< ddd n # 1 swxY w Y Y rw xY wx|S ) z,Get info from a checker and handle KeyError.checkerignorecategoryoptionsNmsgsreports)r r r r ) get_checkersnamer warningscatch_warningsfilterwarningsDeprecationWarningoptions_and_valuesupdater r KeyErrorlistdict)r
by_checkerr r s c/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib/python3.11/site-packages/pylint/utils/docs.py_get_checkers_infosr# s4 ,.J&&(( | $ $ $
.5
4 + ,.. P P +H?QRRRR t$Y///73M3M3O3OO///P P P P P P P P P P P P P P P 4 (// ===4 +++w>++++
,.. +H?QRRRR#*#'(B(B(D(D#E#E $W\ 2 2#'#8#8 ( (Jt$
%" s\ C) AB C) B C)#B $AC)) F
A)E;/ F
;E? ?F
E? F
F
strc t dd }|dz
}| D ]}|j t k r|j rt j 5 t j dt | D ]a\ }}|d}n|
d}|t |d z
}t |t sJ |t d| d
z
}b ddd n # 1 swxY w Y |S ) z'Get documentation for the main checker.z"Pylint global options and switches-z/
Pylint provides global options and switches.
r r NzGeneral optionsz options~
)r r r r r r r r r options_by_section
capitalize
isinstancer r )r resultr sectionr titles r" !_get_global_options_documentationr/ - s
?
E
EF
F &&(( D D <, , , ,(**
D
D';MNNNN(/(B(B(D(D D D$GW 1#*#5#5#7#7 A A AmE3 7 77F%gt44444 w!?!? C C CCFFD
D
D
D
D
D
D
D
D
D
D
D
D
D
D
D Ms BC55C9 <C9 T show_optionsboolc |rt | }nd}|t dd z
}|dz
}t | }t | D ])}|| }|d }|d= | |j di |d|iz
}*|S )z*Get documentation for individual checkers. z%Pylint checkers' options and switchesr& z
Pylint checkers can provide three set of features:
* options that control their execution,
* messages that they can raise,
* reports that they can generate.
Below is a list of all checkers and their features.
r r0 )r/ r r# sortedget_full_documentation)r r0 r, r! checker_name informationr s r" _get_checkers_documentationr9 C s 26::
m CSIIIF
F %V,,J z**
. i( "0'0
(4
M streamr Nonec V t t | | dd | dS )z+Output a full documentation in ReST format.)r0 N)file)printr9 )r r; r0 s r" print_full_documentationrA a sA
#F FFFssKRX r: )r r
r r
)r r
r r$ )T)r r
r0 r1 r r$ )r r
r; r r0 r1 r r< )__doc__
__future__r sysr typingr r r pylint.constantsr pylint.utils.utilsr r pylint.lint.pylinterr
r# r/ r9 stdoutrA r4 r: r" rJ s
F E " " " " " "
- - - - - - - - - - . . . . . . = = = = = = = = .------ 2 , > (+z r: