W.u d Z ddlmZ ddlZddlZddlZddlmZ ddlmZm Z ddl
m Z ddl m
Z
ddlmZ ej d k rdd
lmZ ndd
lmZ erdd lmZ ddlZdd lmZmZmZmZmZm Z d
Z nX# e $ rP dZdZ G d d Z G d d Z G d d Z G d d Z G d d Z d?d@d Z Y nw xY wdAd"Z dBd%Z dCd)Z! e Z" G d* d+e Z# G d, d-e Z$ G d. d/e Z% G d0 d1e% Z& G d2 d3e% Z' G d4 d5e Z( ej) d6 Z*dDd8Z+ G d9 d:e
Z,dEd>Z-dS )Fz7Checker for spelling errors in comments and docstrings. ) annotationsN)Pattern)
TYPE_CHECKINGAny)nodes)BaseTokenChecker)only_required_for_messages) )Literal)PyLinter)Chunker EmailFilterFilter URLFilterWikiWordFilter
get_tokenizerTFc e Zd ZdS )r N__name__
__module__ __qualname__ j/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib/python3.11/site-packages/pylint/checkers/spelling.pyr r , r r c e Zd ZdS )r Nr r r r r r / r r r c e Zd ZdS )r Nr r r r r r 2 r r r c e Zd ZddZdS )r wordstrreturnboolc t N)NotImplementedErrorselfr s r _skipz Filter._skip6 s % %r Nr r! r" r# )r r r r) r r r r r 5 s( & & & & & &r r c e Zd ZdS )r Nr r r r r r 9 s r r tag
str | Nonechunkerslist[Chunker] | Nonefilterslist[Filter] | Noner" c t S r% )r )r, r. r0 s r r r < s
xxr &list[tuple[Any, enchant.ProviderDesc]]c ^ t r%t j ng S r% )PYENCHANT_AVAILABLEenchantBroker
list_dictsr r r _get_enchant_dictsr9 D s& ,? G7> & & ( ( (RGr inner_enchant_dicts list[str]c " dgd | D z S )N c g | ]
}|d S )r r .0ds r
z-_get_enchant_dict_choices..L s 555A1Q4555r r )r: s r _get_enchant_dict_choicesrC I s!
455!4555 55r pyenchant_availabler# r! c x | r%d | D }dd | }nd}|s|dz
}|dz
}d| dS ) Nc @ g | ]}|d d|d j d S )r z ( ))namer? s r rB z*_get_enchant_dict_help..T s3 LLL1!A$..!A$)...LLLr zAvailable dictionaries: z, z0No available dictionaries : You need to install z both the python package and z*the system dependency for enchant to work.zSpelling dictionary name. .)join)r: rD dict_as_str enchant_helps r _get_enchant_dict_helprN O sp ELL8KLLL J$))K2H2HJJ I " ; : :LDD 7 7 7 77r c e Zd ZdZddZdS ) WordsWithDigitsFilterzSkips words with digits.r r! r" r# c 4 t d |D S )Nc 3 > K | ]}| V d S r% )isdigit)r@ chars r z.WordsWithDigitsFilter._skip..e s* 33d4<<>>333333r )anyr' s r r) zWordsWithDigitsFilter._skipd s 33d333333r Nr* r r r __doc__r) r r r rP rP a s. ""4 4 4 4 4 4r rP c e Zd ZdZddZdS ) WordsWithUnderscoreszSSkips words with underscores.
They are probably function parameter names.
r r! r" r# c
d|v S )N_r r' s r r) zWordsWithUnderscores._skipn s d{r Nr* rW r r r rZ rZ h s2
r rZ c & e Zd ZU dZded< d
dZd S ) RegExFilterzParent class for filters using regular expressions.
This filter skips any words the match the expression
assigned to the class attribute ``_pattern``.
z Pattern[str]_patternr r! r" r# c P t | j | S r% )r# r_ matchr' s r r) zRegExFilter._skip{ s DM''--...r Nr* )r r r rX __annotations__r) r r r r^ r^ r sB / / / / / /r r^ c 2 e Zd ZdZ ej d ZdS )CamelCasedWordzFilter skipping over camelCasedWords.
This filter skips any words matching the following regular expression:
^([a-z]\w+[A-Z]+\w+)
That is, any words that are camelCasedWords.
z^([a-z]+(\d|[A-Z])(?:\w+)?)Nr r r rX recompiler_ r r r rd rd s, rz899HHHr rd c 2 e Zd ZdZ ej d ZdS )SphinxDirectiveszFilter skipping over Sphinx Directives.
This filter skips any words matching the following regular expression:
^(:([a-z]+)){1,2}:`([^`]+)(`)?
That is, for example, :class:`BaseQuery`
z ^(:([a-z]+)){1,2}:`([^`]+)(`)?Nre r r r ri ri s, rz;<.replace_code_but_leave_surrounding_characters s% q!!IOOA$6$666r )r r r" r! ) CODE_FLANKED_IN_BACKTICK_REGEXsub)r} r s r _strip_code_flanked_in_backticksr s5 7 7 7 7 * - -5t r c P e Zd ZdZdZddddZddd d
ee eee d fd dd
dddfddddddfddddddfddd d d dfd d d
dd!dffZ
d8d$Z d9d)Z d:d,Z
ed- d;d0 Z ed- dd6Zd7S )?SpellingCheckerz*Check spelling in comments and docstrings.spelling)zEWrong spelling of a word '%s' in a comment:
%s
%s
Did you mean: '%s'?wrong-spelling-in-commentz5Used when a word in comment is not spelled correctly.)zGWrong spelling of a word '%s' in a docstring:
%s
%s
Did you mean: '%s'?wrong-spelling-in-docstringz7Used when a word in docstring is not spelled correctly.)z$Invalid characters %r in a docstring invalid-characters-in-docstringz;Used when a word in docstring cannot be checked by enchant.)C0401C0402C0403z
spelling-dictr= choicez )defaulttypemetavarchoiceshelpzspelling-ignore-wordsstringzz9List of comma separated words that should not be checked.)r r r r zspelling-private-dict-filepathzzIA path to a file that contains the private dictionary; one word per line.z spelling-store-unknown-wordsnynzzTells whether to store unknown words to the private dictionary (see the --spelling-private-dict-file option) instead of raising a message.zmax-spelling-suggestions intNz:Limits count of emitted suggestions for spelling mistakes.z"spelling-ignore-comment-directivesz2fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:zList of comma separated words that should be considered directives if they appear at the beginning of a comment and should not be checked.r" Nonec d| _ t sd S | j j j }|sd S d | j j j d D | _ | j ddg d | j j j d D | _
| j j j r*t j
|| j j j | _ nt j | | _ | j j j rt! | _ t% |t& gt( t* t, t. t0 t2 t4 g | _ d| _ d S ) NFc 6 g | ]}| S r stripr@ ws r rB z(SpellingChecker.open..2 s-
AGGII
r ,parampylintc 6 g | ]}| S r r r s r rB z(SpellingChecker.open..9 s0 .
.
.
GGII.
.
.
r )r. r0 T) initializedr5 linterconfig
spelling_dictspelling_ignore_wordsrs ignore_listextend"spelling_ignore_comment_directives ignore_comment_directive_listspelling_private_dict_filer6 DictWithPWLDict spelling_store_unknown_wordsset
unknown_wordsr rk r r r rP rZ rd ri tokenizer)r( dict_names r openzSpellingChecker.open* sn " FK&4 F
#{ 1 G M Mc R R
( 3444.
.
['JPPQTUU.
.
.
*
; 8 9!(!44;-H" "D ") i!8!8D ; : 1+.55D & )* %$
r msgidr! r} line_numc ~ |} t j d| j d d }n# t t f$ r d}Y nw xY w| d rad|vr]| dd }| j D ]6}| d|z r |t | dz d } n7d}nd}t | }|
| D ]7\ }} | |z
} | }
|| j v s |
| j v r2| d r't | d
k r|d
d }|
d
d }
| j
|
r| j
| rn3# t j j $ r | d ||f Y w xY w| j j j rv|
| j vrkt/ | j j j d
d 5 } | |
d d d d n # 1 swxY w Y | j |
`| j
| } | | j j j d = || d }
t j d| d|
}|r|j d
d }n|
| }|| z
}|r|dz
}d|z dt | z z }d | }|||d| df}| ||| 9d S )Nz^\s+r rG # docstringr{ TF)zu'zu"zr'zr" r )r} argsazutf-8)encoding
z(\W|^)(z)(\W|$)^z' or '') rf searchregs
IndexErrorAttributeErrorr
startswithr lenr r casefoldr r checkr6 errorsError add_messager r r r r r writeaddsuggestmax_spelling_suggestionsindexrK )r( r r} r
original_line
initial_spaceiter_directivestarts_with_commentr
word_start_atlower_cased_wordf suggestions line_segmentra col indicatorall_suggestionr s r _check_spellingz SpellingChecker._check_spellingX s
Igt 4 4 9! >$**,,#?#? 9 B 9 B D- ] *M #}} t'''+;t?O+O+O 788
8SYY]]ABBx#3ABB#7
%++,<==
%++D11 >'
5HD7 !
{!>
B#4+=== *E!( 9 #3 7 7 7888 9 9 9 9 9 9 9 9 9 9 9 9 9 9 9 &**+;<<< # 0 8 8 > > 2 K M MN #MNN 3 ":T":":":LII 3 *Q-*CC&,,T22C}$& 1HC 3Y3T? ; !) {!;!; mY8MN8M8M8MN XD AAAAs9 B 9 Bs9 &+ A A3F*F**-GGH==I I tokenslist[tokenize.TokenInfo]c | j sd S |D ]z\ }}\ }}}}|t j k r_|dk r| d r7| d rM| d rc| d|| {d S )NrG z#!/z # pylint:z# type: r )r tokenizeCOMMENTr r )r( r tok_typetoken start_rowr\ s r process_tokensz SpellingChecker.process_tokens s F 6< T T 1He^iQ8+++ >>e&6&6u&=&=> ##K00 ##J// $$%@%SSS T Tr r node nodes.Modulec 0 | | d S r% _check_docstringr( r s r visit_modulez SpellingChecker.visit_module d#####r nodes.ClassDefc 0 | | d S r% r r s r visit_classdefz SpellingChecker.visit_classdef r r *nodes.FunctionDef | nodes.AsyncFunctionDefc 0 | | d S r% r r s r visit_functiondefz!SpellingChecker.visit_functiondef s
d#####r Jnodes.FunctionDef | nodes.AsyncFunctionDef | nodes.ClassDef | nodes.Modulec | j sdS |j sdS |j dz }t |j j D ] \ }}| d|||z dS )z*Check if the node has any spelling errors.NrG r )r doc_nodelineno enumeratevalue
splitlinesr )r( r
start_lineidxr} s r r z SpellingChecker._check_docstring s F} F[1_
"4=#6#A#A#C#CDD X XIC !>jSVFV W W W W X Xr N)r" r )r r! r} r! r r r" r )r r r" r )r r r" r )r r r" r )r r r" r )r r r" r )r r r rX rI msgsrC
enchant_dictsrN r5 optionsr r r r r r r visit_asyncfunctiondefr r r r r r s 44 D
D*
(44]CC..}>QRR
$ 4S
) +1
+ %%
' T
1O 4-
g>G@+ + + + \OB OB OB OBbT T T T& =>>$ $ $ ?>$ =>>$ $ $ ?>$ =>>$ $ $ ?>$
/X X X X X Xr r r r
r c J | t | d S r% )register_checkerr )r s r registerr
s$
OF 3 344444r )NNN)r, r- r. r/ r0 r1 r" r )r" r3 )r: r3 r" r; )r: r3 rD r# r" r! )r} r! r" r! )r r
r" r ).rX
__future__r rf sysr r typingr r astroidr pylint.checkersr pylint.checkers.utilsr version_infor typing_extensions pylint.lintr
r6 enchant.tokenizer r r r r r r5 ImportErrorr9 rC rN r rP rZ r^ rd ri rk rg r r r r
r r r r s>
> = " " " " " "
% % % % % % % % , , , , , , < < < < < <v )))))) %$$$$$$%NNN G & & & & & & & &
)-'+ )8H H H H
6 6 6 6 8 8 8 8 #"$$
4 4 4 4 4F 4 4 4 6
/
/
/
/
/&
/
/
/: : : : :[ : : : = = = = ={ = = =( ( ( ( ( ' ( ( ( V ",,P!Q!Q HX HX HX HX HX& HX HX HXV5 5 5 5 5 5s A- -ACC