ó ’›V]c@s}dZddlZddlZddlmZddlmZmZddlm Z ddl m Z ddl m Z ddlmZdd lmZmZmZdd lmZd d d gZejdejƒejdejƒgZejdƒZdad„Zd„Zd„Zd„Z d„Z!d„Z"d„Z#d„Z$d„Z%eƒd„ƒZ&eƒed„ƒƒZ'dS(s¡ Docstrings are another source of information for functions and classes. :mod:`jedi.evaluate.dynamic` tries to find all executions of functions, while the docstring parsing is much easier. There are three different types of docstrings that |jedi| understands: - `Sphinx `_ - `Epydoc `_ - `Numpydoc `_ For example, the sphinx annotation ``:type foo: str`` clearly states that the type of ``foo`` is ``str``. As an addition to parameter searching, this module also provides return annotations. iÿÿÿÿN(tdedent(tparsetParserSyntaxError(tu(tdebug(t indent_block(tevaluator_method_cache(titerator_to_context_sett ContextSett NO_CONTEXTS(tLazyKnownContextss\s*:type\s+%s:\s*([^\n]+)s\s*:param\s+(\w+)\s+%s:[^\n]*s\s*@type\s+%s:\s*([^\n]+)s\s*:rtype:\s*([^\n]+)s\s*@rtype:\s*([^\n]+)s:[^`]+:`([^`]+)`cCs8ttttfƒrt‚nddlm}|atS(Niÿÿÿÿ(tNumpyDocString(t isinstancet_numpy_doc_string_cachet ImportErrort SyntaxErrortnumpydoc.docscrapeR (R ((s7lib/python2.7/site-packages/jedi/evaluate/docstrings.pyt_get_numpy_doc_string_cls2s  c Cs³tjƒAtjdƒytƒ|ƒjd}Wntk rHgSXWdQXx]|D]U\}}}||krVtjd|ƒ}|r›|jdƒ}nt t |ƒƒSqVWgS(sASearch `docstr` (in numpydoc format) for type(-s) of `param_str`.tignoret ParametersNs"([^,]+(,[^,]+)*?)(,[ ]*optional)?$i( twarningstcatch_warningst simplefilterRt _parsed_datat Exceptiontretmatchtgrouptlistt_expand_typestr(tdocstrt param_strtparamstp_nametp_typetp_descrtm((s7lib/python2.7/site-packages/jedi/evaluate/docstrings.pyt_search_param_in_numpydocstr;s     c csÈtjƒ:tjdƒytƒ|ƒ}Wntk rAdSXWdQXy"|jd}||jd7}Wntk r~dSXxB|D]:\}}}|s¤|}nxt|ƒD] }|Vq±Wq†WdS(sP Search `docstr` (in numpydoc format) for type(-s) of function returns. RNtReturnstYields(RRRRRRR(Rtdoctreturnstr_nametr_typetr_descrttype_((s7lib/python2.7/site-packages/jedi/evaluate/docstrings.pyt_search_return_in_numpydocstrNs        ccs1tjd|ƒrGx|jdƒD]}|jdƒdjƒVq"Wnætjd|ƒrn|jdƒdVn¿|jdƒr(t|ddƒjd}|jd kr-x}|jd jD]h}|jd krêd |jkrâd VqdVq¶|jdkr¶d|j j ƒkrdVqdVq¶q¶Wq-n|VdS(s@ Attempts to interpret the possible types in `type_str` s\bor\btortofis\bof\bt{tversions3.7tatomitnumbert.tfloattinttstringtbtbyteststrN( Rtsearchtsplittstript startswithRtchildrenttypetvaluet string_prefixtlower(ttype_strtttnodetleaf((s7lib/python2.7/site-packages/jedi/evaluate/docstrings.pyRgs$cCsxgtD]"}tj|tj|ƒƒ^q}x9|D]1}|j|ƒ}|r6t|jdƒƒgSq6Wt||ƒS(sä Search `docstr` for type(-s) of `param_str`. >>> _search_param_in_docstr(':type param: int', 'param') ['int'] >>> _search_param_in_docstr('@type param: int', 'param') ['int'] >>> _search_param_in_docstr( ... ':type param: :class:`threading.Thread`', 'param') ['threading.Thread'] >>> bool(_search_param_in_docstr('no document', 'param')) False >>> _search_param_in_docstr(':param int param: some description', 'param') ['int'] i(tDOCSTRING_PARAM_PATTERNSRtcompiletescapeR<t_strip_rst_roleRR%(RRtptpatternstpatternR((s7lib/python2.7/site-packages/jedi/evaluate/docstrings.pyt_search_param_in_docstrˆs, cCs*tj|ƒ}|r"|jdƒS|SdS(s  Strip off the part looks like a ReST role in `type_str`. >>> _strip_rst_role(':class:`ClassName`') # strip off :class: 'ClassName' >>> _strip_rst_role(':py:obj:`module.Object`') # works with domain 'module.Object' >>> _strip_rst_role('ClassName') # do nothing when not ReST role 'ClassName' See also: http://sphinx-doc.org/domains.html#cross-referencing-python-objects iN(tREST_ROLE_PATTERNRR(RER((s7lib/python2.7/site-packages/jedi/evaluate/docstrings.pyRL¤s c CsOttdƒƒ}|dkr"gSx(tjd|ƒD]}d||}q5Wtjd|ddƒ|jj}y(|j |j t |ƒƒdt ƒ}Wnt k r«gSXy1t|jƒƒ}|jdjdjd }Wnttfk r÷gSX|jdkr gSdd lm}||j||ƒ} | jƒ} tt| |ƒƒS(Nsí def pseudo_docstring_stuff(): ''' Create a pseudo function for docstring statements. Need this docstring so that if the below part is not valid Python this is still a function. ''' {} s((?:\w+\.)*\w+)\.s import %s sParse docstring code %stcolortBLUEterror_recoveryiÿÿÿÿiþÿÿÿtnameR3t atom_expr(tFunctionContext(RUR3RV(RRtNoneRtfindallRtdbgt evaluatortlatest_grammarRtformatRtFalseRtnextt iter_funcdefsR@tAttributeErrort IndexErrorRAtjedi.evaluate.contextRWtget_function_executionRt_execute_types_in_stmt( tmodule_contextR8tcodetelementtgrammartmoduletfuncdeftstmtRWtfunction_contexttfunc_execution_context((s7lib/python2.7/site-packages/jedi/evaluate/docstrings.pyt_evaluate_for_statement_stringºs4   (   cs,ˆj|ƒ}tj‡fd†|DƒƒS(sÒ Executing all types or general elements that we find in a statement. This doesn't include tuple, list and dict literals, because the stuff they contain is executed. (Used as type information). c3s!|]}tˆj|ƒVqdS(N(t_execute_array_valuesR[(t.0td(Rf(s7lib/python2.7/site-packages/jedi/evaluate/docstrings.pys ös(t eval_nodeRt from_sets(RfRlt definitions((Rfs7lib/python2.7/site-packages/jedi/evaluate/docstrings.pyReîs csžddlm}m}t||ƒrg}xL|jƒD]>}tj‡fd†|jƒDƒƒ}|jt |ƒƒq8W|ˆ|j |ƒhS|j ƒSdS(s— Tuples indicate that there's not just one return value, but the listed ones. `(str, int)` means that it returns a tuple with both types. iÿÿÿÿ(tSequenceLiteralContextt FakeSequencec3s|]}tˆ|ƒVqdS(N(Rp(Rqttyp(R[(s7lib/python2.7/site-packages/jedi/evaluate/docstrings.pys sN( tjedi.evaluate.context.iterableRvRwR t py__iter__RRttinfertappendR t array_typetexecute_annotation(R[tarrayRvRwtvaluest lazy_contexttobjects((R[s7lib/python2.7/site-packages/jedi/evaluate/docstrings.pyRpûs csçddlm}ddlm}‡‡fd†}|jƒ‰ˆjƒ}|jdkr]tS||jƒƒ}t ||ƒrÍt |j |ƒrÍ|j j ƒdkrÍ|j j j}|||jƒƒO}ntjd|dd ƒ|S( Niÿÿÿÿ(tInstanceArguments(tFunctionExecutionContextcs)t‡fd†t|ˆjjƒDƒƒS(Nc3s+|]!}tˆ|ƒD] }|VqqdS(N(Ro(RqRRM(Rf(s7lib/python2.7/site-packages/jedi/evaluate/docstrings.pys s(RRPRURB(t docstring(Rftparam(s7lib/python2.7/site-packages/jedi/evaluate/docstrings.pyteval_docstrings tlambdeft__init__s#Found param types for docstring: %sRRRS(tjedi.evaluate.context.instanceRƒRcR„tget_root_contexttget_parent_functionRAR t py__doc__R tvar_argsRmt py__name__tinstancet class_contextRRZ(texecution_contextR†RƒR„R‡tfuncttypesR‘((RfR†s7lib/python2.7/site-packages/jedi/evaluate/docstrings.pyt infer_params  ccsOd„}x?||jƒƒD]+}x"t|jƒ|ƒD] }|Vq8WqWdS(Ncss]x:tD]2}|j|ƒ}|rt|jdƒƒVqqWxt|ƒD] }|VqJWdS(Ni(tDOCSTRING_RETURN_PATTERNSR<RLRR.(RgRMRR-((s7lib/python2.7/site-packages/jedi/evaluate/docstrings.pytsearch_return_in_docstr,s  (RRoR‹(RmR—REt type_eval((s7lib/python2.7/site-packages/jedi/evaluate/docstrings.pytinfer_return_types)s ((t__doc__RRttextwrapRtparsoRRtjedi._compatibilityRtjediRtjedi.evaluate.utilsRtjedi.evaluate.cacheRtjedi.evaluate.base_contextRRR tjedi.evaluate.lazy_contextR RIRJtMR–RQRXR RR%R.RRPRLRoReRpR•R™(((s7lib/python2.7/site-packages/jedi/evaluate/docstrings.pyts:      !   4