-Ph- dZddlZddlZddlZddlZddlZ ddlZn#e$rddlZYnwxYwddl m Z ddl m Z m Z mZmZmZddlmZddlmZmZdd lmZGd d ejZGd d ejZddejdefdZdejdeddfdZddddeedee ee fdfdeeedfde fdZ!dS)z.Run numpydoc validation on contents of a file.N)Path)AnyDictListTupleUnion)tabulate) docscrapevalidate)find_project_rootc@eZdZdZdejdejdeddfdZ e dZ e defd Z e defd Ze defd Ze defd Ze defd Ze defdZe deefdZe defdZdS) AstValidatoraQ Overrides the :class:`Validator` to work entirely with the AST. Parameters ---------- ast_node : ast.AST The node under inspection. filename : os.PathLike The file where the node is defined. obj_name : str A name for the node to use in the listing of issues for the file as a whole. ast_nodefilenameobj_namereturnNc||_tj|jdpd|_tj|jd|_t j|j|_t| |_ ||_ t|tj |_t|tj|_dS)NF)cleanT)nodeast get_docstringraw_doc clean_docr NumpyDocStringdocrresolve _source_file_name isinstanceClassDefis_classModule is_module)selfrrrs b/var/www/html/test/jupyter/venv/lib/python3.11/site-packages/numpydoc/hooks/validate_docstrings.py__init__zAstValidator.__init__%s& -diuEEEK !/ FFF-6-Edl-S-S)-h)?)?)A)A" (3<@@ )(CJ??c td)Nz*AstValidator does not support this method.)NotImplementedError)names r( _load_objzAstValidator._load_obj3s!"NOOOr*c|jSN)r!r's r(r-zAstValidator.name7s zr*cXt|jtjtjfSr0)r"rr FunctionDefAsyncFunctionDefr1s r(is_function_or_methodz"AstValidator.is_function_or_method;s$)cos7K%LMMMr*c|jsdStj|jD]>}t |tjr"t |jtjrdS?dS)NFT)r5riter_child_nodesrr"ExprvalueYield)r'childs r(is_generator_functionz"AstValidator.is_generator_function?sd) 5)$)44  E%** z%+sy/Q/Q ttur*cV|jrdS|jrdS|jrdStd)Nfunctiontypemodulez Unknown type.)r5r$r& ValueErrorr1s r(r?zAstValidator.typeHs>  % : = 6 > 8)))r*c|jSr0)r r1s r(source_file_namezAstValidator.source_file_nameRs   r*c,|js |jjndS)Nr )r&rlinenor1s r(source_file_def_linez!AstValidator.source_file_def_lineVs'+~zPAstValidator.signature_parameters..extract_signature..gs">">">s37">">">r*r>clsr'r )rJgetattrappendrQextendtuple)r args_nodeparamsarg_typeentriess r(extract_signaturez.extract_signature\s IFT @ @!)X6622298x#7#7 &7'+&7&7888:8w#6#6 &87;&8&8999MM">">g">">">????6]]F "&)66abbz!Mr*r)) rXr5rr$bodyr"rr3r-)r'r]rZr;s r(signature_parametersz!AstValidator.signature_parametersZs   "  % 6&&ty11FF ] 6 6 6eS_556%* :R:R..u55F r*ct|j5}tj||j}dddn #1swxYwY|Sr0)openrCrget_source_segmentreadr)r'filesources r( method_sourcezAstValidator.method_sourcevs $' ( ( DD+DIIKKCCF D D D D D D D D D D D D D D D s-AAA)__name__ __module__ __qualname____doc__rASTosPathLikestrr) staticmethodr.propertyr-boolr5r<r?rCintrFrr_rfrPr*r(rrs   @7 @.0k @EH @  @ @ @ @PP\PcXNtNNNXNtX*c***X*!#!!!X!=c===X=eCjX6sXr*rcxeZdZdZdededdfdZdejdede fd Z dejddfd Z dejddfd Z dS) DocstringVisitora Visits nodes in the AST from a given module and reporting numpydoc issues. Parameters ---------- filepath : str The absolute or relative path to the file to inspect. config : dict Configuration options for reviewing flagged issues. filepathconfigrNcz||_||_t|jj|_g|_g|_dSr0)rvrurstem module_namestackfindings)r'rurvs r(r)zDocstringVisitor.__init__s9 # % $T] 3 3 8 "   r*rcheckc||jdvrdS|jdrN |jd|}tj|tj|dSn#t $rYnwxYwdS)aW Check whether the issue should be ignored. Parameters ---------- node : ast.AST The node under inspection. check : str The code for the check being evaluated. Return ------ bool Whether the issue should be excluded from the report. checksT overridesNF)rvresearchrrKeyError)r'rr|patterns r( _ignore_issuezDocstringVisitor._ignore_issues  H- - -4 ;{ #  +k2599Wc&7&=&=>>J4K    us:A A*)A*cdjtjtjjfddDdS)z Get numpydoc validation issues. Parameters ---------- node : ast.AST The node under inspection. .)rrcng|]1\}}|jdd||g2S): file_line)rru)rRr| descriptionr-rreportr's r(rSz9DocstringVisitor._get_numpydoc_issues..sa   &E;))$66 M99F;$7994 T   r*errorsN)joinrzr rrur{rW)r'rr-rs``@@r(_get_numpydoc_issuesz%DocstringVisitor._get_numpydoc_issuessxx ##" ,            *0*:        r*ct|tjtjtjtjfr|jt|tjr|jn|j |j dr8tj |j dd |js|||||j}dSdS)z Visit a node in the AST and report on numpydoc validation issues. Parameters ---------- node : ast.AST The node to visit. excluderN)r"rr%r#r3r4rzrVryr-rvrrrr generic_visitpop)r'r_s r(visitzDocstringVisitor.visits  3:s|S_c>RS   ! J  $.tSZ$@$@O  di     I& 0Idk)4chhtz6J6JKK 0))$///   t $ $ $   AAA ! !r*) rgrhrirjrndictr)rrkrqrrrrPr*r(rtrt}s   ! ! !  ! ! ! !#'#$:  T    *!#'!d!!!!!!r*rtdir_pathrc dhtid}t|}|dz }|dz }d fd}|rt |d5}t j|}|did i}t|d |d |d <|d |d }tt|ts|n|g|d <||| d d d n #1swxYwYnK|r6tj }||d } t|| d ddp|d |d <n#tj$rYnwxYw t|| d ddp|d |d <n#tj$rYnwxYw||| | n#tj$rYnwxYwt'j|d |d < |d |d <|S)a Parse config information from a pyproject.toml or setup.cfg file. This function looks in the provided directory path first for a pyproject.toml file. If it finds that, it won't look for a setup.cfg file. Parameters ---------- dir_path : os.PathLike An absolute or relative path to a directory containing either a pyproject.toml file specifying a [tool.numpydoc_validation] section or a setup.cfg file specifying a [tool:numpydoc_validation] section. For example, ``~/my_project``. If not provided, the hook will try to find the project root directory. Returns ------- dict Config options for the numpydoc validation hook. all)r~rrzpyproject.tomlz setup.cfgcl|r1tjdd|DndS)N|c3K|]}||V dSr0rP)rRexps r( z6parse_config..compile_regex..s' C Cs C C C C C C Cr*)rcompiler) expressionss r( compile_regexz#parse_config..compile_regexs> BJtyy C C C C CCC D D D r*c|D]Z\}}|dr@|d\}}|r&||d|<[dS)N override_rr) startswithsplitupper)options config_itemsoptionr9rr|rs r(extract_check_overridesz-parse_config..extract_check_overridess{) O OMFE  -- O!<<,,5O:G-:N:NGK(7  O Or*rbtoolnumpydoc_validationr~rNztool:numpydoc_validation,)setr expanduserris_fileratomllibloadgetr"rnitems configparser ConfigParserrcrstripr NoOptionErrorNoSectionErrorr get_validation_checks) rr toml_pathcfg_pathr toml_filepyproject_tomlrvglobal_exclusions"numpydoc_validation_config_sectionrs @r( parse_configrsy. SUUDDGH~~((**2244H++I+%H   OOOOO, )T " " =i$\)44N#''33778MrRRF #FJJx9J$K$K L LGH  & 9gi6H I I !$!"3S99)!!'(""GI  $ #GV\\^^ < < < = = = = = = = = = = = = = = =     *,, H-G*  $'JJA8LLVC[[U3ZZ)x( %%!!  -     %(JJA9MMVC[[U3ZZ*y) && ""  -     $ #&HII    *    D !6wx7HIIGH&wy'9::GI Nsi>CEE E'AG<;J<H J HJAI'&J'I96J8I99"JJ.-J.rurvzlist[list[str]]ct|5}tj||}dddn #1swxYwYt t ||}|||jS)ad Run numpydoc validation on a file. Parameters ---------- filepath : path-like The absolute or relative path to the file to inspect. config : dict Configuration options for reviewing flagged issues. Returns ------- list[list[str]] A list of [name, check, description] lists for flagged issues. N)rurv)rarparsercrtrnrr{)rurvrd module_nodedocstring_visitors r( process_filer>s h74i X66 777777777777777)#h--OOOK(((  %%s(AA A)rvignorefilesrcBt|\}}t|p|}|dxxt|pgzcc<g}|D]%}|t ||&|r0t t |gdddtjdSdS) a Run the numpydoc validation hook. Parameters ---------- files : list[str] The absolute or relative paths to the files to inspect. config : Union[dict[str, Any], None], optional Configuration options for reviewing flagged issues. ignore : Union[list[str], None], optional Checks to ignore in the results. Returns ------- int The return status: 1 if issues were found, 0 otherwise. r~)rditemr|rgrid2)headerstablefmt maxcolwidths)rdr r) rrrrWrprintr sysstderr)rrvr project_rootrconfig_optionsr{rds r(run_hookrWs.(..OL!!&"8L99N8FLb 1 11H<< T>::;;;;  @@@         q 1r*r0)"rjrrrlrrr ImportErrortomlipathlibrtypingrrrrrr rr r utilsr Validatorr NodeVisitorrtrmrrrrnrrrrPr*r(rs344  NNNN00000000000000""""""""$$$$$$ccccc8%cccL`!`!`!`!`!s`!`!`!F[[2;[$[[[[|&2;&&9J&&&&8+/%) * * * 9*  $sCx.$& '*  $s)T/ " *  * * * * * * s  ))