o gW@@sdZddlZddlZddlZddlmZddlmZddlm Z ddl m Z ddl m Z mZzddlZddlmZmZmZmZmZmZWn4eyxdZGd d d ZGd d d ZGd ddZGdddZGdddZ d1ddZYnwedureZeZdgddeDZddeDZdeZdZndZdgZdZGdddeZGdddeZ Gd d!d!eZ!Gd"d#d#e!Z"Gd$d%d%e!Z#Gd&d'd'eZ$e%d(Z&d)e'd*e'fd+d,Z(Gd-d.d.e Z)d/d0Z*dS)2z8Checker for spelling errors in comments and docstrings. N)Pattern)nodes)BaseTokenChecker)check_messages)IAstroidChecker ITokenChecker)Chunker EmailFilterFilter URLFilterWikiWordFilter get_tokenizerc@ eZdZdS)r N__name__ __module__ __qualname__rrV/home/ubuntu/cloudmapper/venv/lib/python3.10/site-packages/pylint/checkers/spelling.pyr 7r c@r)r Nrrrrrr :rr c@r)r Nrrrrrr =rr c@seZdZddZdS)r cCstN)NotImplementedErrorselfwordrrr_skipAsz Filter._skipN)rrrrrrrrr @s r c@r)rNrrrrrrDrrcCstSr)r )tagchunkersfiltersrrrr Gsr cCsg|]}|dqS)rr.0drrr Psr#cCs&g|]}|dd|djdqS)rz ())namer rrrr#Qs&z, nonez7 To make it work, install the 'python-enchant' package.c@eZdZdZddZdS)WordsWithDigitsFilterzSkips words with digits.cCs|D] }|r dSqdS)NTF)isdigit)rrcharrrrr]s zWordsWithDigitsFilter._skipNrrr__doc__rrrrrr)Zs r)c@r()WordsWithUnderscoreszSSkips words with underscores. They are probably function parameter names. cCsd|vS)N_rrrrrrjszWordsWithUnderscores._skipNr,rrrrr.ds r.c@s,eZdZUdZeeed<defddZdS) RegExFilterzParent class for filters using regular expressions. This filter skips any words the match the expression assigned to the class attribute ``_pattern``. _patternreturncCst|j|Sr)boolr1matchrrrrrxszRegExFilter._skipN) rrrr-rstr__annotations__r3rrrrrr0ns  r0c@eZdZdZedZdS)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+)?)Nrrrr-recompiler1rrrrr8|sr8c@r7)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}:`([^`]+)(`)?Nr9rrrrr<sr<c@s eZdZdZddZddZdS)ForwardSlashChunkerz[ This chunker allows splitting words like 'before/after' into 'before' and 'after' cCs |jstd|jvr|j}d|_d|_|dfS|jdd\}}||_d|_|r8|r8|dr8|dsFd|_d|_|d|dfS|dfS)NT/rrr$)_text StopIteration_offsetsplitisalpha)rtextpre_text post_textrrrnexts.   zForwardSlashChunker.nextcCsf d|jvr |jdfS|jdd\}}|r|s t|dr(|ds+t|d||_q)NTr>rr$r? )r@rCrDrA)rrFrGrrr_nexts  zForwardSlashChunker._nextN)rrrr-rHrJrrrrr=s r=z!(\s|^)(`{1,2})([^`]+)(\2)([^`]|$)liner2cCsdtfdd}t||S)zAlter line so code flanked in backticks is ignored. Pyenchant automatically strips backticks when parsing tokens, so this cannot be done at the individual filter level.r2cSs|d|dS)Nr$)group) match_objrrr-replace_code_but_leave_surrounding_charactersszW_strip_code_flanked_in_backticks..replace_code_but_leave_surrounding_characters)r5CODE_FLANKED_IN_BACKTICK_REGEXsub)rKrOrrr _strip_code_flanked_in_backtickssrRc @seZdZdZeefZdZddddZddd d e d e d e d fddddddfddddddfddddddfddddddfd d!ddd"dffZ d#d$Z d%d&Zd'd(Zd)d*Zed+d,ejd-d.fd/d0Zed+d,ejd-d.fd1d2Zed+d,ejd-d.fd3d4ZeZd5d6Zd.S)7SpellingCheckerz)Check spelling in comments and docstringsspelling)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 docstringinvalid-characters-in-docstringz;Used when a word in docstring cannot be checked by enchant.)C0401C0402C0403z spelling-dictrchoicez z2Spelling dictionary name. Available dictionaries: .)defaulttypemetavarchoiceshelpzspelling-ignore-wordsstringzz9List of comma separated words that should not be checked.)r]r^r_razspelling-private-dict-filezzIA path to a file that contains the private dictionary; one word per line.zspelling-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-suggestionsintNz: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 and the beginning of a comment and should not be checked.c Csd|_d|_tdur dS|jj}|sdSdd|jjdD|_|jddgdd|jj dD|_ |jj rDt j |jj |j_ |jj r\t||jj |_t|jj dd d |_nt||_|jjrjt|_t|tgtttttttgd |_d |_dS) NFcSg|]}|qSrstripr!wrrrr#.z(SpellingChecker.open..,parampylintcSrhrrirkrrrr#5rmazutf-8)encoding)rrT) initializedprivate_dict_fileenchantconfig spelling_dictspelling_ignore_wordsrC ignore_listextend"spelling_ignore_comment_directivesignore_comment_directive_listspelling_private_dict_fileospath expanduser DictWithPWLopenDictspelling_store_unknown_wordsset unknown_wordsr r=r r r r)r.r8r< tokenizer)r dict_namerrrr$sR     zSpellingChecker.opencCs|jr |jdSdSr)rtclose)rrrrr[szSpellingChecker.closec CsB|}z td|jdd}Wn ttfyd}Ynw|drLd|vrL|dd}|jD]}|d|rH|t|dd}nq3d}nd}t |}| |D]\}} | |7} | } ||j vso| |j vrpqY|d rt|d kr|d d}| d d} z|j | rWqY|j |rWqYWntjjy|jd ||fd YqYw|jjr| |jvr|j| d |j| qY|j |} | |jjd=|| d} td|d| } | r| jd d}n| |}|| 7}|r|d7}d|dt|}d| }|||d|df}|j|||d qYdS)Nz ^[^\S]\s*rr$# docstringrITF)zu'zu"zr'zr"rW)rKargs z(\W|^)(z)(\W|$)^z' or '')r:searchregs IndexErrorAttributeErrorrj startswithr|lenrRrcasefoldryrwcheckruerrorsError add_messagervrrrtwriteaddsuggestmax_spelling_suggestionsindexjoin)rmsgidrKline_num original_line initial_spaceiter_directivestarts_with_commentr word_start_atlower_cased_word suggestions line_segmentr4col indicatorall_suggestionrrrr_check_spelling_sp           zSpellingChecker._check_spellingcCs^|jsdS|D]%\}}\}}}}|tjkr,|dkr|drq|dr%q|d||qdS)Nr$z#!/z # pylint:rU)rstokenizeCOMMENTrr)rtokenstok_typetoken start_rowr/rrrprocess_tokenss  zSpellingChecker.process_tokensrVnoder2NcC|jsdS||dSrrs_check_docstringrrrrr visit_modulezSpellingChecker.visit_modulecCrrrrrrrvisit_classdefrzSpellingChecker.visit_classdefcCrrrrrrrvisit_functiondefrz!SpellingChecker.visit_functiondefcCsD|j}|sdS|jd}t|D] \}}|d|||qdS)z&check the node has any spelling errorsNr$rV)doclineno enumerate splitlinesr)rrr start_lineidxrKrrrrs z SpellingChecker._check_docstring)rrrr-rr__implements__r&msgs dict_choicesdictsinstroptionsrrrrrrModulerClassDefr FunctionDefrvisit_asyncfunctiondefrrrrrrSs     ?7K rScCs|t|dS)z-required method to auto register this checkerN)register_checkerrS)linterrrrregistersr)NNN)+r-r~r:rtypingrastroidrpylint.checkersrpylint.checkers.utilsrpylint.interfacesrrruenchant.tokenizerr r r r r ImportErrorBrokerbr list_dictsrrrrr)r.r0r8r<r=r;rPr5rRrSrrrrrsX    $      )