ƺ>X d Z ddlmZ ddlZddlZddlZddlmZ ddlmZ ddl m
Z
ddl m Z ddl
mZmZmZ ej d k rdd
lmZ ndd
lmZ ej d ZddZ G d de ZdS )z)Docstring checker from the basic checker. ) annotationsN)nodes)
interfaces)utils)
_BasicChecker)is_overload_stubis_property_deleteris_property_setter) )Literalz^_node1nodes.Module | nodes.ClassDef | nodes.FunctionDefreturn
str | Nonec | d }n# t $ r Y d S w xY wt j | }|sd S t |t j sd S t
|j S )N__doc__)KeyErrorr
safe_infer
isinstancer Conststrvalue)r docstrings x/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib/python3.11/site-packages/pylint/checkers/base/docstring_checker.py_infer_dunder_doc_attributer ! s| O tt ++I t i - - t y s
c > e Zd Zdddddgifddddd gifd
d d dd gifd
dddd gifdZdeddddfddddddffZd/d Z ej dd d0d Z ej d d d1d" Z
ej dd d2d$ Z e Z d%e
j fd3d-Zd.S )4DocStringCheckerzEmpty %s docstringempty-docstringz^Used when a module, function, class or method has an empty docstring (it would be too easy ;). old_names)W0132zold-empty-docstringzMissing module docstringmissing-module-docstringzNUsed when a module has no docstring. Empty modules do not require a docstring.)C0111zmissing-docstringzMissing class docstringmissing-class-docstringzNUsed when a class has no docstring. Even an empty class must have a docstring.z$Missing function or method docstringmissing-function-docstringzoUsed when a function or method has no docstring. Some special methods like __init__ do not require a docstring.)C0112C0114C0115C0116zno-docstring-rgxregexpzzcRegular expression which should only match function or class names that do not require a docstring.)defaulttypemetavarhelpzdocstring-min-lengthintzz[Minimum line length for functions/classes that require docstrings, shorter ones are exempt.r Nonec B | j j d S )N)linterstatsreset_undocumented)selfs r openzDocStringChecker.openl s ,,..... r nodes.Modulec 2 | d| d S )Nmodule)_check_docstringr6 r s r visit_modulez DocStringChecker.visit_moduleo s h-----r8 nodes.ClassDefc | j j j |j | d| d S d S )Nclass)r3 configno_docstring_rgxmatchnamer< r= s r visit_classdefz DocStringChecker.visit_classdefs sE ; . 4 4TY ? ? G ! !'4 0 0 0 0 0 H Gr8 nodes.FunctionDefc | j j j |j | rdnd}t
| s t | st | rd S t |j
d t j
rd}t j |j
d r t j n t j }|j
d D ]M}| dk r|j |v r)t ||j t j rd} nN| ||| | d S t |j
d t j r| || d S d S d S )NmethodfunctionT)futureFzbuiltins.object)report_missing
confidence)r3 rB rC rD rE is_methodr
r r r parentframer ClassDefr has_known_basesr INFERENCEINFERENCE_FAILURE ancestorsqname FunctionDefr< Module)r6 r ftype
overriddenrM ancestors r visit_functiondefz"DocStringChecker.visit_functiondefx s ; . 4 4TY ? ? G $ 0 0@HHjE"4((
&t,,
$D))
$+++4+88%.II
"
,T[->->d->-K-KLL6J((#5 !% 1 1 1 > > H H J J H ~~''+<<< yH,, +U->2 2, &*
%%4J: & DK - -T - : :ELII
%%eT22222? H Gr8 T node_type0Literal['class', 'function', 'method', 'module']r rL boolrM interfaces.Confidencec V |j r |j j nd}|t | }||sdS t j | |j z
}|dk r|sdS | j j j }|dk r|dk r||k rdS |dk r | j j j
dxx dz
cc< n | j j j
|xx dz
cc< |j rt |j d t j rt |j d j t j rrt j |j d j j }t |t$ j r/t |j t$ j r|j j dv rdS |dk rd } n |dk rd
} nd } | | || dS | sa|dk r | j j j
dxx dz
cc< n | j j j
|xx dz
cc< | d
||f| dS dS )z,Check if the node has a non-empty docstring.Nr; r/ rA klass r > r bytesunicoder" r$ r% )r rM r )r argsrM )doc_noder r r get_node_last_linenolinenor3 rB docstring_min_lengthr4 undocumentedbodyr r ExprCallr funcastroid BoundMethodboundInstancerE add_messagestrip)
r6 r] r rL rM r lines max_linesro messages
r r< z!DocStringChecker._check_docstring s ,0=BDM''d 3D99I !
.t44t{BEH$$U$ *?IH$$R EI999
ty|UZ88
ty| 15:>>
' ! (:(?@@ dG$788 ZJ 0> > z*EEE H$$4g%%36 W4J G G G G G "" G## !.w7771<7777 !.y999Q>999 !I rF r\ visit_asyncfunctiondefr HIGHr< r8 r r r 2 s
!
2
;< =
' &
8
9: ;
& %
9
9: ;
3 (
9: ;
- DB
. %
# "D
G4/ / / / &U%&@BSTT. . . UT. &U%&?ARSS1 1 1 TS1 &U%&BDUVV WV D / $,6O 8 8 8 8 8 8 8r8 r )r r r r )r
__future__r resysrp r pylintr pylint.checkersr "pylint.checkers.base.basic_checkerr pylint.checkers.utilsr r r
version_infotypingr
typing_extensionscompiler} r r r r8 r r sQ
0 / " " " " " "
! ! ! ! ! ! < < < < < < v )))))) !bj&& "c c c c c} c c c c cr8