o 2gA@sUdZddlmZddlZddlZddlZddlZddlZddlm Z m Z m Z m Z m Z mZmZddlmZddlZeeefZded<edZd ed <ed Zd ed <dHddZGdddZGddde ZdZd ed<dZd ed<dZ d ed<dZ!d ed<dZ"d ed <d!Z#d ed"<d#Z$d ed$<Gd%d&d&Z%dId+d,Z&dJd.d/Z'dKd0d1Z(dLd2d3Z)dMd6d7Z*dNd;d<Z+dOd?d@Z,dPdDdEZ-dQdFdGZ.dS)RzParsing/inferring signatures from documentation. This module provides several functions to generate better stubs using docstrings and Sphinx docs (.rst files). ) annotationsN)AnyFinalMutableMappingMutableSequence NamedTupleSequenceTuple) TypeAlias _TypeAliasSigz4^[a-zA-Z_][\w\[\], .\"\']*(\.[a-zA-Z_][\w\[\], ]*)*$r_TYPE_REz\**[A-Za-z_][A-Za-z0-9_]*$ _ARG_NAME_REsstrreturnboolcCs.|dvrdSd|vrd|vrdSt|duS)zCTry to determine whether a string might be a valid type annotation.)TrueFalseretvalF,[N)r match)rrD/home/garg/my-data/venv/lib/python3.10/site-packages/mypy/stubdoc.py is_valid_types rc@sNeZdZdZ dddddddZdddZdddZdddZdddZdS) ArgSigz%Signature info for a single argument.NFz...)default default_valuenamertype str | NonerrrrNonecCs||_||_||_||_dSN)rr rr)selfrr rrrrr__init__'s zArgSig.__init__cCs|jdo |jd S)N***r startswithr$rrr is_star_arg5szArgSig.is_star_argcCs |jdS)Nr'r(r*rrr is_star_kwarg8s zArgSig.is_star_kwargcCs dt|jt|jt|jS)Nz$ArgSig(name={}, type={}, default={}))formatreprrr rr*rrr__repr__;szArgSig.__repr__otherrcCs>t|tr|j|jko|j|jko|j|jko|j|jkSdS)NF) isinstancerrr rr)r$r0rrr__eq__@s     z ArgSig.__eq__r#) rrr r!rrrrrr"rr)rr)r0rrr) __name__ __module__ __qualname____doc__r%r+r,r/r2rrrrr$s   rc@sXeZdZUded<ded<ded<dd d Zdd d Zdd dZ    ddddZdS) FunctionSigrr list[ArgSig]argsr!ret_typerrcCs2t|jdo|jdo|jo|jdjdvS)N__rr$cls)rrr)endswithr:r*rrris_special_methodPs  zFunctionSig.is_special_methodcCsb|jr|jdjdvr|jdd}n|j}t|dko0tdd|Do0|do0|dS)z=Return if this signature has catchall args: (*args, **kwargs)rr=Ncss|]}|jdvVqdS))Nobjectr typing.AnyN)r ).0arrr `z0FunctionSig.has_catchall_args..)r:rlenallr+r,)r$r:rrrhas_catchall_argsXs   zFunctionSig.has_catchall_argscCs|o|jdvS)zKReturn if this signature is the catchall identity: (*args, **kwargs) -> Any)NrrD)rKr;r*rrris_catchall_signatureesz!FunctionSig.is_catchall_signatureFNindentis_asyncany_val docstringcCsg}|jD]L}|j}|tjvrd|}|jdur*|dur*|jdvr*|jds*|}n|j}|rA|d|7}|jr@|d|j7}n |jrL|d|j7}||qd} |j rZ|j n|} | durdd| } |rhd nd} d j || |jd || d } |rd |dt j |} nd} | | S)N_r=r&z: z = =rMz -> zasync z({indent}{prefix}def {name}({args}){ret}:, )rNprefixrr:ret z z ...)r:rkeywordkwlistr r)rrappendr;r-joinmypyutilquote_docstring)r$rNrOrPrQr:argarg_defarg_typeretfieldr;rUsigsuffixrrr format_sigis@         zFunctionSig.format_sigr3)rMFNN) rNrrOrrPr!rQr!rr)r4r5r6__annotations__r@rKrLrerrrrr8Ks    r8rA STATE_INITrBSTATE_FUNCTION_NAMESTATE_ARGUMENT_LISTSTATE_ARGUMENT_TYPESTATE_ARGUMENT_DEFAULTSTATE_RETURN_VALUESTATE_OPEN_BRACKETc@s8eZdZdZdddZdd d Zdd d ZdddZdS)DocStringParserz+Parse function signatures in documentation. function_namerrr"cCsB||_tg|_d|_d|_d|_d|_d|_d|_g|_ g|_ dS)NrMrF) rtrgstate accumulatorraarg_name arg_defaultr;foundr: signatures)r$rtrrrr%s zDocStringParser.__init__tokentokenize.TokenInfocCs|jtjkr|j|jkr|jdtkr|jtd S|jtj kr@|jdkr@|jdtkr@|j d|_ d|_ |jt d S|jdtkrN|j d S|jtj krp|jdvrp|jdtkrp|j |j7_ |jtd S|jtj kr|jdvr|jdtkr|j |j7_ |j d S|jtj kr|jdkr|jdt kr|j |_d|_ |jtd S|jtj kr|jdkr|jdt tfvr|jdtkr|j |_|j n|j |_d|_ |jtd S|jtj kr|jd vr|jdt ttfvr|jdtkr|j |_|j n9|jdtkr"|j |_|j n'|jdt krI|j |_|jd kr<|j dksIt|jsI|d S|jd krT|j |jr|jrrt|jsr|jt|jd t|jd n|jt|j|jt|jd d|_d |_d |_d|_ d S|jtj kr|jd kr|jdtkrd|_ |jtd S|jtjtjfvr|jdttfvr|jdtkrt|j s|d S|j |_d|_ |j |j r|j t!|j|j|jdd|_ g|_d|_d S|j |j7_ d S)z)Process next token from the token stream.(rMT)rr~{)])}:rS)rrrN)rr rz->)rr:r;Fr)"r tokenizeNAMEstringrtrurgrZrhOPpoprvryrjrrrwrlrarnrxstriprrresetrr:rrrpNEWLINE ENDMARKERr;rzr8)r$r{rrr add_tokens                     *   zDocStringParser.add_tokencCstg|_g|_d|_d|_dS)NFrM)rgrur:ryrvr*rrrr8s zDocStringParser.resetlist[FunctionSig]cs.ddddfd d t|jfd d d S)z:Return sorted copy of the list of signatures found so far.rr signaturer8rrcstfdd|jDS)Nc3s|]}|jkVqdSr#r)rExrrrrGBrHzBDocStringParser.get_signatures..has_arg..)anyr:)rrrrrhas_argAsz/DocStringParser.get_signatures..has_argcsd|o d|S)Nz*argsz**kwargsr)r)rrr args_kwargsDsz3DocStringParser.get_signatures..args_kwargscs|rdSdS)NrArr)r)rrrHsz0DocStringParser.get_signatures..)keyN)rrrr8rr)rr8rr)sortedrzr*r)rrrget_signatures>s zDocStringParser.get_signaturesN)rtrrr")r{r|rr")rr")rr)r4r5r6r7r%rrrrrrrrss   rsdocstrr!rlist[FunctionSig] | Nonec st|tr|s dSt|}ttj1ztt| dj }|D]}| |q#Wnt y<YWddSwWdn1sGwY| }d ddfd d |DS) a=Convert function signature to list of FunctionSig Look for function signatures of function in docstring. Signature is a string of the format () -> or perhaps without the return type. Returns empty list, when no signature is found, one signature in typical case, multiple signatures, if docstring specifies multiple signatures for overload functions. Return None if the docstring is empty. Arguments: * docstr: docstring * name: name of function for which signatures are to be found Nzutf-8rcr8rrcSst|jtdd|jDkS)z1return true if function argument names are uniquecSsh|]}|jqSrrrEr_rrr jszCinfer_sig_from_docstring..is_unique_args..)rIr:)rcrrris_unique_argshsz0infer_sig_from_docstring..is_unique_argscsg|]}|r|qSrr)rErcrrr msz,infer_sig_from_docstring..)rcr8rr)r1rrs contextlibsuppressr TokenErrorioBytesIOencodereadlinerIndentationErrorr)rrrutokensr{sigsrrrinfer_sig_from_docstringKs$   rr9cCs td|d}|r|djSgS)zXConvert signature in form of "(self: TestClass, arg0: str='ada')" to List[TypedArgList].stubr)rr:)rrVrrr!infer_arg_sig_from_anon_docstringps rcCst||}|r |djSdS)zWConvert signature in form of "func(self: TestClass, arg0) -> int" to their return type.rN)rr;)rrrVrrr!infer_ret_type_sig_from_docstringxs  rcCs"dd|D}td|dS)zSConvert signature in form of "(self: TestClass, arg0) -> int" to their return type.cSs&g|]}|drd|qS)r~r)rr))rElinerrrrs&z:infer_ret_type_sig_from_anon_docstring..rMr) splitlinesrr[)rlinesrrr&infer_ret_type_sig_from_anon_docstringsrrc'tuple[str, list[str], list[str]] | Nonec Cs td|}|s dS|d}|dd}|d}|s$|ggfSdd|d D}g}g}d }|t|krf||d sGd ||vrHn|||d |d7}||d d r`n|t|ks:|t|kr||}|d }|d d }|||d7}|t|ksl|||fS)zSplit function signature into its name, positional an optional arguments. The expected format is "func_name(arg, opt_arg=False)". Return the name of function and lists of positional and optional argument names. z([.a-zA-Z0-9_]+)\(([^)]*)\)NrA.r}rBcSsg|]}|qSr)rrrrrrsz#parse_signature..rrrrSz[]) rergroupsplitrrIr)rZrstripr?) rcmr arg_stringr: positionaloptionalir_rrrparse_signatures8         rr Sequence[str]rcCs`g}|||D]}|dr||q ||dq dd|d}|dd}|S)zNBuild function signature from lists of positional and optional argument names.r&z=...r~rTrz(self)rM)extendr)rZr[replace)rrr:r_rcrrrbuild_signatures    rrtuple[list[Sig], list[Sig]]c Csg}g}|D]>}|}td|}|rD|dd}t|}|rD|\}}} |ddkr:||t|| fq||t|| fqt|t|fS)ztParse all signatures in a given reST document. Return lists of found signatures for functions and classes. z,\.\. *(function|method|class) *:: *[a-zA-Z_]z::rAclass) rrrrrrrZrr) rr class_sigsrrrcparsedrfixedrrrrparse_all_signaturess  rr Sequence[Sig] list[Sig]cCsdi}|D] \}}||g|qg}|D]\}}tt|dkr-|||dfqt|S)z-Remove names with duplicate found signatures.rAr) setdefaultrZitemsrIsetr)rsig_maprrcresult name_sigsrrrfind_unique_signaturess rcCs*|sdSd}t||}|r|dSdS)agCheck for Google/Numpy style docstring type annotation for a property. The docstring has the format ": ". In the type string, we allow the following characters: * dot: because sometimes classes are annotated using full path * brackets: to allow type hints like List[int] * comma/space: things like Tuple[int, int] Nz^([a-zA-Z0-9_, \.\[\]]*): rA)rrr)rtest_strrrrrinfer_prop_type_from_docstrings   r)rrrr)rr!rrrr)rrrr9)rrrrrr!)rrrr!)rcrrr)rrrrrr)rrrr)rrrr)rr!rr!)/r7 __future__rrrrXrrtypingrrrrrrr typing_extensionsr r mypy.utilr\rr rfcompiler rrrr8rgrhrjrlrnrprrrsrrrrrrrrrrrrrsD $   ' P       ( %    %