yIfN dZddlmZddlZddlmZmZmZddlm Z ddl m Z m Z erddl mZdd ZddZdddZejdfddZdS)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]]ci}|D]}|j}|tkr |||d<||dxx|z cc<||d|j||dxx|jz cc<#t$rP|t|t|jt|jd||<YwxYw|S)z,Get info from a checker and handle KeyError.checkeroptionsmsgsreports)rrrr) get_checkersnamer_options_and_valuesupdaterrKeyErrorlistdict)r by_checkerrrs E/var/www/piapp/venv/lib/python3.11/site-packages/pylint/utils/docs.py_get_checkers_infosrs/,.J&&((| $ $ $ .5 4 +4 +++w/J/J/L/LL+++4 (// ===4 +++w>++++   &#G$?$?$A$ABB ..#GO44 $$ 4     % sA4B!!AC;:C;strcxtdd}|dz }|D]}|jtkr}|jrv|D]a\}}|d}n|d}|t|dz }t|tsJ|td|dz }b|S) z'Get documentation for the main checker.z"Pylint global options and switches-z/ Pylint provides global options and switches. NzGeneral optionsz options~ ) r rrrr_options_by_section capitalize isinstancerr)r resultrsectionrtitles r!_get_global_options_documentationr((s ? E EF F&&(( @ @ <, , , ,$+$?$?$A$A @ @ ?-EE&1133===E-s333!'400000_T7;;???? MT show_optionsboolc|rt|}nd}|tddz }|dz }t|}t|D])}||}|d}|d=||jdi|d|iz }*|S)z*Get documentation for individual checkers.z%Pylint checkers' options and switchesrz 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. rr*)r(r rsortedget_full_documentation)r r*r%r checker_name informationrs r_get_checkers_documentationr3<s26:: mCSIIIF  F%V,,Jz**   . i(  "0'0    (4     Mr)streamrNonecVtt||dd|dS)z+Output a full documentation in ReST format.)r*N)file)printr3)r r4r*s rprint_full_documentationr:ZsA #FFFFssKRXr))r r r r )r r r r)T)r r r*r+r r)r r r4rr*r+r r5)__doc__ __future__rsystypingrrrpylint.constantsrpylint.utils.utilsrr pylint.lint.pylinterr rr(r3stdoutr:r.r)rrCs FE"""""" ----------......========.------*(>(+zr)