Rtf3dZddlZddlZddlZddlZddlZddlZ ddlZddl m Z ddl m Z mZmZddlmZddlmZmZdd lmZGd d ej,ZGd d ej0Zddej4defdZdej4deddfdZddee edfdefdZ e!dk(r e"e y#e$rddl ZYwxYw)z.Run numpydoc validation on contents of a file.N)Path)SequenceTupleUnion)tabulate) docscrapevalidate)find_project_rootceZdZdZdej dejdeddfdZ e dZ e defd Z e defd Ze defd Ze defd Ze defd Ze defdZe deefdZe defdZy) 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|jdxsd|_tj|jd|_t j |j|_t|j|_ ||_ t|tj|_t|tj|_y)NF)cleanT)nodeast get_docstringraw_doc clean_docr NumpyDocStringdocrresolve _source_file_name isinstanceClassDefis_classModule is_module)selfrrrs D/usr/lib/python3/dist-packages/numpydoc/hooks/validate_docstrings.py__init__zAstValidator.__init__&s& --diiuEK !// F-6-E-Edll-S)-h)?)?)A" (3<<@ )(CJJ?ctd)Nz*AstValidator does not support this method.)NotImplementedError)names r& _load_objzAstValidator._load_obj4s!"NOOr(c|jSN)rr%s r&r+zAstValidator.name8s zzr(cjt|jtjtjfSr.)r rr FunctionDefAsyncFunctionDefr/s r&is_function_or_methodz"AstValidator.is_function_or_method<s"$))coos7K7K%LMMr(c|jsytj|jD]C}t |tj st |j tjsCyy)NFT)r3riter_child_nodesrr ExprvalueYield)r%childs r&is_generator_functionz"AstValidator.is_generator_function@sS))))$))4 E%*z%++syy/Q r(cf|jry|jry|jrytd)Nfunctiontypemodulez Unknown type.)r3r"r$ ValueErrorr/s r&r=zAstValidator.typeIs-  % % == >>))r(c|jSr.)rr/s r&source_file_namezAstValidator.source_file_nameSs   r(cJ|js|jjSdS)Nr )r$rlinenor/s r&source_file_def_linez!AstValidator.source_file_def_lineWs'+~~tyy<1clsr%r )rHgetattrappendargextendtuple)r args_nodeparamsarg_typeentriesrPs r&extract_signaturez.extract_signature]s IFT @!)X6228x#7 '++&788w#6 7;;-&89MMg">s377">? @6]F&)6abz!M #?sB7 r') rRr3rr"bodyr rr1r+)r%rWrTr9s r&signature_parametersz!AstValidator.signature_parameters[sx "  % %&tyy1F  ]] 6eS__5%** :R.u5F 6 r(ct|j5}tj|j |j }ddd|S#1swYSxYwr.)openrArget_source_segmentreadr)r%filesources r& method_sourcezAstValidator.method_sourcewsK $'' ( DD++DIIKCF D  D s /AA)__name__ __module__ __qualname____doc__rASTosPathLikestrr' staticmethodr,propertyr+boolr3r:r=rAintrDrrYr`r(r&rrs.  @77 @.0kk @EH @  @PPcNtNNt*c**!#!!=c==eCj6sr(rceZdZdZdededdfdZdejdede fd Z dejddfd Z dejddfd Z y) 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. filepathconfigrNc||_||_t|jj|_g|_g|_yr.)rqrprstem module_namestackfindings)r%rprqs r&r'zDocstringVisitor.__init__s7 # % $T]] 3 8 8 "   r(rcheckc||jdvry|jdr? |jd|}tj|tj|y yy#t $rYywxYw)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 overridesF)rqresearchrrKeyError)r%rrwpatterns r& _ignore_issuezDocstringVisitor._ignore_issues}  H- - ;;{ # ++k25999Wc&7&7&=>JK   s;A"" A.-A.c Fdj|j}tj|t||j}|j j |dDcgc]/\}}|j||s|jd|d|||g1c}}ycc}}w)z Get numpydoc validation issues. Parameters ---------- node : ast.AST The node under inspection. .)rrerrors: file_lineN)joinrur rrprvrQr)r%rr+reportrw descriptions r&_get_numpydoc_issuesz%DocstringVisitor._get_numpydoc_issuessxx #"" ,   +1*: &E;))$6MM?!F;$7#894 T   s 4B c:t|tjtjtjtj fr|j jt|tjr |jn |j|jdrR>RS  JJ  $.tSZZ$@  dii   I&IIdkk)4chhtzz6JK))$/   t $  A r() rarbrcrdrhdictr'rrerkrrrrmr(r&roro~st  ! ! !  !#''#$:  T *!#''!d!r(rodir_pathrc dhtid}t|jj}|dz }|dz }d fd}|j rt |d5}t j|}|jdijd i}t|jd |d |d <|jd |d }tt|ts|n|g|d <|||jd d d n|j rtj}|j|d } t|j| d jdj!dxs|d |d < t|j| d jdj!dxs|d |d <|||j| t'j(|d |d < |d |d <|S#1swY4xYw#tj"$rYwxYw#tj"$rY}wxYw#tj$$rY~wxYw)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)ryrrzzpyproject.tomlz setup.cfgc`|r+tjdjd|DSdS)N|c3&K|] }|s| ywr.rm).0exps r& z6parse_config..compile_regex..s Cs Cs)r{compiler) expressionss r& compile_regexz#parse_config..compile_regexs3 JJtyy C CC D  r(c|D]J\}}|jds|jd\}}|s/||d|j<Ly)N override_rrz) startswithsplitupper)options config_itemsoptionr7rrwrs r&extract_check_overridesz-parse_config..extract_check_overridessU) OMFE  -!<<,5:G:NGK(7  Or(rbtoolnumpydoc_validationryrNztool:numpydoc_validation,)setr expanduserris_filer[tomllibloadgetr rhitems configparser ConfigParserr]rstripr NoOptionErrorNoSectionErrorr get_validation_checks) rr toml_pathcfg_pathr toml_filepyproject_tomlrqglobal_exclusions"numpydoc_validation_config_sectionrs @r& parse_configrss. SUDGH~((*224H++I+%H O )T " =i$\\)4N#''3778MrRF #FJJx9J$K LGH  & 9gi6H I !$!"3S9"'("GI  $GV\\^ < = =    **, H-G*  $'JJA8LVC[U3Z)x( %! %(JJA9MVC[U3Z*y) & " $&HI !66wx7HIGH&wy'9:GI N_ = =4 --   --  **   s]&B&HAH$AH=IH!$H:7I9H::I=IIIII,+I,rprqzlist[list[str]]ct|5}tj|j|}dddt t ||}|j |jS#1swYN8DKK$52 66H < T>:;< @     { s G __main__r.)#rdrrrrfr{rr ImportErrortomlipathlibrtypingrrrrrr r utilsr Validatorr NodeVisitorrorgrrrrhrlrra SystemExitrmr(r&rs4  ))"$c8%%cL`!s`!F[2;;[$[|&2;;&&9J&2E uXc]D()E SE P z TV i sB99 CC