Edit File: docs.cpython-311.pyc
� s�d � � � d Z ddlmZ ddlZddlZddlmZmZmZ ddl m Z ddl m Z m Z erddlmZ dd �Zdd�Zddd�Zej dfdd�ZdS ) z?Various helper functions to create the docs of a linter object.� )� annotationsN)� TYPE_CHECKING�Any�TextIO)�MAIN_CHECKER_NAME)�get_rst_section� get_rst_title)�PyLinter�linterr �return�dict[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 w��x|S ) z,Get info from a checker and handle KeyError.�checker�ignore��category�optionsN�msgs�reports)r r r r )� get_checkers�namer �warnings�catch_warnings�filterwarnings�DeprecationWarning�options_and_values�updater r �KeyError�list�dict)r � by_checkerr r s �b/builddir/build/BUILD/cloudlinux-venv-1.0.2/venv/lib/python3.11/site-packages/pylint/utils/docs.py�_get_checkers_infosr# s4 � �,.�J��&�&�(�(� � ���|�� �$� $� $� �.5� �4� ��+� �,�.�.� P� P� �+�H�?Q�R�R�R�R� �t�$�Y�/�/�/�7�3M�3M�3O�3O�O�/�/�/�P� P� P� P� P� P� P� P� P� P� P���� P� P� P� P� �4� ��(�/�/�� �=�=�=��4� ��+�+�+�w��>�+�+�+�+��� � � � �,�.�.� � � �+�H�?Q�R�R�R�R�#*�#'��(B�(B�(D�(D�#E�#E� $�W�\� 2� 2�#'���#8�#8� (� (�J�t�$�� � � � � � � � � � ���� � � � ��� ���� %�" �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 r�t 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� E�F� � � �F� �&�&�(�(� D� D�� �<�,� ,� ,�� � ,��(�*�*� D� D��'��;M�N�N�N�N�(/�(B�(B�(D�(D� D� D�$�G�W� �� 1���#*�#5�#5�#7�#7� A� A� A���m�E�3� 7� 7�7�F�%�g�t�4�4�4�4�4�� ��w�!?�!?� C� C� C�C�F�F�D� D� D� D� D� D� D� D� D� D� D� D���� D� D� D� D�� �Ms �BC5�5C9 �<C9 T� show_options�boolc �� � |rt | � � }nd}|t dd� � z }|dz }t | � � }t |� � D ])}|| }|d }|d= | |j di |�d|i��z }�*|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# �sorted�get_full_documentation)r r0 r, r! � checker_name� informationr s r" �_get_checkers_documentationr9 C s� � �� �2�6�:�:����� �m� C�S�I�I�I�F� � � �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� �F�F�F�s��s�K�RX�� � � � � 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" �<module>rJ s �� F� E� "� "� "� "� "� "� � � � � ���� -� -� -� -� -� -� -� -� -� -� .� .� .� .� .� .� =� =� =� =� =� =� =� =�� .�-�-�-�-�-�-�� � � �2� � � �,� � � � �> (+�z��� � � � � � r: