V]c@sdZddlZddlZddlZddlmZddlmZddlmZddl m Z ddl m Z ddl m Z dd lmZdd lmZdd lmZdd lmZmZdd lmZddlmZdZdZdZdefdYZdefdYZ defdYZ!de!fdYZ"de"fdYZ#de!fdYZ$dZ%defd YZ&dS(!s The :mod:`jedi.api.classes` module contains the return classes of the API. These classes are the much bigger part of the whole API, because they contain the interesting information about completion and goto operations. iN(tsettings(tdebug(tunite(tmemoize_method(timports(tcompiled(t ImportName(tFunctionExecutionContext(tStubModuleContext(t convert_namestconvert_contexts(t ContextSet(t KeywordNamecCst|ddS(NtkeycSs |jp dS(Ni(ii(t start_pos(ts((s/lib/python2.7/site-packages/jedi/api/classes.pytt(tsorted(tnames((s/lib/python2.7/site-packages/jedi/api/classes.pyt_sort_names_by_start_posscCs]t|jdt}g|jD] }|^q%}gt|D]}t||^qDS(so List sub-definitions (e.g., methods in class). :type scope: Scope :rtype: list of Definition t search_global(tnextt get_filterstTruetvaluesRt Definition(t evaluatortcontexttfiltertnameRtn((s/lib/python2.7/site-packages/jedi/api/classes.pyt defined_namesscCs&g|D]}t|j|j^qS(N(RRR(tcontextstc((s/lib/python2.7/site-packages/jedi/api/classes.pyt_contexts_to_definitions(stBaseDefinitioncBseZi dd6dd6dd6dd6dd6dd6dd6d d 6d d 6d d6dd6dd6dd6Zedidd6jDZdZedZe dZ e dZ e dZ e dZ dZe dZe d Zeed!Ze d"Ze d#Zd$Zd%Zeed&Zd'Zeed(Ze ed)Zd*Zd+Zd,d,d-Zd.Zd/Z RS(0sos.patht posixpatht riscospathtntpatht os2emxpathtmacpatht genericpathtostposixtiot_iot functoolst _functoolst collectionst _collectionstsockett_sockettsqlite3t_sqlite3tbuiltinst __builtin__ccs0|]&\}}t|jd|fVqdS(t.N(ttupletsplit(t.0tktv((s/lib/python2.7/site-packages/jedi/api/classes.pys =ssargparse.ArgumentParsersargparse._ActionsContainercCs+||_||_t|jt|_dS(N(t _evaluatort_namet isinstanceR t is_keyword(tselfRR((s/lib/python2.7/site-packages/jedi/api/classes.pyt__init__As  cCs |jjS(N(R@tget_root_context(RC((s/lib/python2.7/site-packages/jedi/api/classes.pyt _get_moduleIscCs9|j}|js%|j r5|jjSdS(sBShows the file path of a module. e.g. ``/usr/lib/python2.7/os.py``N(RFtis_stubt is_compiledt py__file__tNone(RCtmodule((s/lib/python2.7/site-packages/jedi/api/classes.pyt module_pathPs cCs |jjS(s Name of variable/function/class/module. For example, for ``x = None`` it returns ``'x'``. :rtype: str or None (R@t string_name(RC((s/lib/python2.7/site-packages/jedi/api/classes.pyR[s cCs|jj}t}|dk r]|j}|dk r]|jdkr]|jr]t}q]nt|jt j sx|rx|jj D] }|j SWn|jj S(s  The type of the definition. Here is an example of the value of this attribute. Let's consider the following source. As what is in ``variable`` is unambiguous to Jedi, :meth:`jedi.Script.goto_definitions` should return a list of definition for ``sys``, ``f``, ``C`` and ``x``. >>> from jedi._compatibility import no_unicode_pprint >>> from jedi import Script >>> source = ''' ... import keyword ... ... class C: ... pass ... ... class D: ... pass ... ... x = D() ... ... def f(): ... pass ... ... for variable in [keyword, f, C, x]: ... variable''' >>> script = Script(source) >>> defs = script.goto_definitions() Before showing what is in ``defs``, let's sort it by :attr:`line` so that it is easy to relate the result to the source code. >>> defs = sorted(defs, key=lambda d: d.line) >>> no_unicode_pprint(defs) # doctest: +NORMALIZE_WHITESPACE [, , , ] Finally, here is what you can get from :attr:`type`: >>> defs = [str(d.type) for d in defs] # It's unicode and in Py2 has u before it. >>> defs[0] 'module' >>> defs[1] 'class' >>> defs[2] 'instance' >>> defs[3] 'function' Valid values for are ``module``, ``class``, ``instance``, ``function``, ``param``, ``path`` and ``keyword``. t import_fromN( R@t tree_nametFalseRJtget_definitionttypet is_definitionRRARt SubModuleNametinfertapi_type(RCROtresolvet definitionR((s/lib/python2.7/site-packages/jedi/api/classes.pyRRfs:      cCs|jjjS(s The module name. >>> from jedi import Script >>> source = 'import json' >>> script = Script(source, path='example.py') >>> d = script.goto_definitions()[0] >>> print(d.module_name) # doctest: +ELLIPSIS json (RFRRM(RC((s/lib/python2.7/site-packages/jedi/api/classes.pyt module_names cCsHt|jtr2td|jjDSt|jtjS(s!Whether this is a builtin module.css!|]}t|tjVqdS(N(RARtCompiledObject(R<R((s/lib/python2.7/site-packages/jedi/api/classes.pys s(RARFRtanytnon_stub_context_setRRZ(RC((s/lib/python2.7/site-packages/jedi/api/classes.pytin_builtin_modules cCs$|jj}|dkrdS|dS(s7The line where the definition occurs (starting with 1).iN(R@RRJ(RCR((s/lib/python2.7/site-packages/jedi/api/classes.pytlines  cCs$|jj}|dkrdS|dS(s9The column where the definition occurs (starting with 0).iN(R@RRJ(RCR((s/lib/python2.7/site-packages/jedi/api/classes.pytcolumns  cCst|jjd|d|S(sS Return a document string for this completion object. Example: >>> from jedi import Script >>> source = '''\ ... def f(a, b=1): ... "Document for function f." ... ''' >>> script = Script(source, 1, len('def f'), 'example.py') >>> doc = script.goto_definitions()[0].docstring() >>> print(doc) f(a, b=1) Document for function f. Notice that useful extra information is added to the actual docstring. For function, it is call signature. If you need actual docstring, use ``raw=True`` instead. >>> print(script.goto_definitions()[0].docstring(raw=True)) Document for function f. :param fast: Don't follow imports that are only one level deep like ``import foo``, but follow ``from foo import bar``. This makes sense for speed reasons. Completing `import a` is slow if you use the ``foo.docstring(fast=False)`` on every object, because it parses all libraries starting with ``a``. tfasttraw(t_HelpR@t docstring(RCRaR`((s/lib/python2.7/site-packages/jedi/api/classes.pyRcscCs |jjS(s$A textual description of the object.(R@RM(RC((s/lib/python2.7/site-packages/jedi/api/classes.pyt descriptionscCs{|jjsdS|jjdt}|dkr5|St|}y|j|d|d[.[...]][.]``. It is useful when you want to look up Python manual of the object at hand. Example: >>> from jedi import Script >>> source = ''' ... import os ... os.path.join''' >>> script = Script(source, 3, len('os.path.join'), 'example.py') >>> print(script.goto_definitions()[0].full_name) os.path.join Notice that it returns ``'os.path.join'`` instead of (for example) ``'posixpath.join'``. This is not correct, since the modules name would be `````. However most users find the latter more practical. tinclude_module_namesiR9N( R@tis_context_nameRJtget_qualified_namesRtlistt_mappingtKeyErrortjoin(RCR((s/lib/python2.7/site-packages/jedi/api/classes.pyt full_names    cCs#|jjstS|jjjS(N(R@RfRPRERG(RC((s/lib/python2.7/site-packages/jedi/api/classes.pyRG s cKs.tjd|j|j|SWdQXdS(Ns goto for %s(Rtincrease_indent_cmR@t_goto_assignments(RCtkwargs((s/lib/python2.7/site-packages/jedi/api/classes.pytgoto_assignments&scCs||o | st|jjs#gSt|jjd|d|}g|D]-}||jkrf|nt|j|^qKS(Nt only_stubst prefer_stubs(tAssertionErrorR@RfR tgotoRR?(RCRqRrRR((s/lib/python2.7/site-packages/jedi/api/classes.pyRn*s  cKs.tjd|j|j|SWdQXdS(Ns infer for %s(RRmR@t_infer(RCRo((s/lib/python2.7/site-packages/jedi/api/classes.pyRU8scCs|o | st|jjs#gSt|jgdt}ttjd|Dd|d|}g|D]}|j^qm}g|D]-}||jkr|nt |j |^qS(NRrcss|]}|jVqdS(N(RU(R<R((s/lib/python2.7/site-packages/jedi/api/classes.pys GsRq( RsR@RfR RR R t from_setsRRR?(RCRqRrRR!R"tresulting_namesR((s/lib/python2.7/site-packages/jedi/api/classes.pyRu<s  cCsxZ|jjD]I}x@|jD]2}g|jdtD]}t|j|^q<SWqW|jdks{|jdkrgStddS(s Deprecated! Will raise a warning soon. Use get_signatures()[...].params. Raises an ``AttributeError`` if the definition is not callable. Otherwise returns a list of `Definition` that represents the params. t resolve_starstfunctiontclasss$There are no params defined on this.N( R@RUtget_signaturestget_param_namesRRR?RRtAttributeError(RCRt signatureR((s/lib/python2.7/site-packages/jedi/api/classes.pytparamsOs 1cCsZ|jjsdS|jj}|dkr,dSt|trG|j}nt|j|j S(N( R@RfRJtparent_contextRARtfunction_contextRR?R(RCR((s/lib/python2.7/site-packages/jedi/api/classes.pytparentgs    cCs8d|jj|jrdnd|jp-|j|jfS(Ns<%s %sname=%r, description=%r>tfull_R(t __class__t__name__RlRRd(RC((s/lib/python2.7/site-packages/jedi/api/classes.pyt__repr__ss  icCsr|jj s|jrdS|jjj}|jjdd}t||d}dj||||d!S(sI Returns the line of code where this object was defined. :param before: Add n lines before the current line to the output. :param after: Add n lines after the current line to the output. :return str: Returns the line(s) of code or an empty string if it's a builtin. Rii(R@RfR]REt code_linesRtmaxRk(RCtbeforetaftertlinestindext start_index((s/lib/python2.7/site-packages/jedi/api/classes.pyt get_line_code{s cCs2g|jjjD]}t|j|^qS(N(R@RUR{t SignatureR?(RCR((s/lib/python2.7/site-packages/jedi/api/classes.pyR{scCst|jjjS(N(R#R@RUtexecute_evaluated(RC((s/lib/python2.7/site-packages/jedi/api/classes.pytexecutes(!Rt __module__Ritdicttitemst_tuple_mappingRDRRFtpropertyRLRRRRYR]R^R_RPRRcRdRlRGRpRnRURuRRRRR{R(((s/lib/python2.7/site-packages/jedi/api/classes.pyR$,sP     H !'     t CompletioncBsteZdZdZdZedZedZee dZ edZ dZ e dZRS( s `Completion` objects are returned from :meth:`api.Script.completions`. They provide additional information about a completion. cCs8tt|j||||_||_g|_dS(N(tsuperRRDt_like_name_lengtht_stackt_same_name_completions(RCRRtstacktlike_name_length((s/lib/python2.7/site-packages/jedi/api/classes.pyRDs  cCsd}tjr'|jdkr'd}n|jjdkr|jdk rg|jD]}|j^qR}d|krd|kr|d7}qn|jj}|r||j }n||S(NRRyt(tparamttrailertargumentt=( Rtadd_bracket_after_functionRRR@RVRRJt nonterminalRMR(RCt like_nametappendt stack_nodet nonterminalsR((s/lib/python2.7/site-packages/jedi/api/classes.pyt _completes  ! cCs |jtS(s Return the rest of the word, e.g. completing ``isinstance``:: isinstan# <-- Cursor is here would return the string 'ce'. It also adds additional stuff, depending on your `settings.py`. Assuming the following function definition:: def foo(param=0): pass completing ``foo(par`` would give a ``Completion`` which `complete` would be `am=` (RR(RC((s/lib/python2.7/site-packages/jedi/api/classes.pytcompletescCs |jtS(s@ Similar to :attr:`name`, but like :attr:`name` returns also the symbols, for example assuming the following function definition:: def foo(param=0): pass completing ``foo(`` would give a ``Completion`` which ``name_with_symbols`` would be "param=". (RRP(RC((s/lib/python2.7/site-packages/jedi/api/classes.pytname_with_symbolss cCs7|jdkrt}ntt|jd|d|S(NiRaR`(RRPRRRc(RCRaR`((s/lib/python2.7/site-packages/jedi/api/classes.pyRcs cCstjj|S(s/Provide a description of the completion object.(RRdt__get__(RC((s/lib/python2.7/site-packages/jedi/api/classes.pyRdscCsdt|j|jjfS(Ns<%s: %s>(RRRR@RM(RC((s/lib/python2.7/site-packages/jedi/api/classes.pyRscCs tjdtdd|jS(s Deprecated! Return the original definitions. I strongly recommend not using it for your completions, because it might slow down |jedi|. If you want to read only a few objects (<=20), it might be useful, especially to get the original docstrings. The basic problem of this function is that it follows all results. This means with 1000 completions (e.g. numpy), it's just PITA-slow. s,Deprecated since version 0.14.0. Use .infer.t stackleveli(twarningstwarntDeprecationWarningRU(RC((s/lib/python2.7/site-packages/jedi/api/classes.pytfollow_definitions (RRt__doc__RDRRRRRPRRcRdRRR(((s/lib/python2.7/site-packages/jedi/api/classes.pyRs  RcBsheZdZdZedZedZedZdZ dZ dZ dZ RS( s *Definition* objects are returned from :meth:`api.Script.goto_assignments` or :meth:`api.Script.goto_definitions`. cCstt|j||dS(N(RRRD(RCRRX((s/lib/python2.7/site-packages/jedi/api/classes.pyRDscCs|j}|jj}|dkr6|d|jjS|d ksN|d kru|dkrcd}n|d|jjS|jp|}|jdt}t j d d|}t j d d|j }|S( s A description of the :class:`.Definition` object, which is heavily used in testing. e.g. for ``isinstance`` it returns ``def isinstance``. Example: >>> from jedi._compatibility import no_unicode_pprint >>> from jedi import Script >>> source = ''' ... def f(): ... pass ... ... class C: ... pass ... ... variable = f if random.choice([0,1]) else C''' >>> script = Script(source, column=3) # line is maximum by default >>> defs = script.goto_definitions() >>> defs = sorted(defs, key=lambda d: d.line) >>> no_unicode_pprint(defs) # doctest: +NORMALIZE_WHITESPACE [, ] >>> str(defs[0].description) # strip literals in python2 'def f' >>> str(defs[1].description) 'class C' Rt RyRzRKtinstancetdeftinclude_prefixs #[^\n]+\ns\s+(RyRzRKRN( RRR@ROt to_stringRJRMRQtget_codeRPtretsubtstrip(RCttypRORXttxt((s/lib/python2.7/site-packages/jedi/api/classes.pyRds     cCs3|jrdn d|j}d|j|j|fS(s1 In addition to the definition, also return the module. .. warning:: Don't use this function yet, its behaviour may change. If you really need it, talk to me. .. todo:: Add full path. This function is should return a `module.class.function` path. Rs@%ss%s:%s%s(R]R^RYRd(RCtposition((s/lib/python2.7/site-packages/jedi/api/classes.pytdesc_with_module8s cs8jj}ttfd|DddS(sd List sub-definitions (e.g., methods in class). :rtype: list of Definition c3s!|]}tj|VqdS(N(R R?(R<td(RC(s/lib/python2.7/site-packages/jedi/api/classes.pys OsR cSs|jjpdS(Ni(ii(R@R(R((s/lib/python2.7/site-packages/jedi/api/classes.pyRPR(R@RURR(RCtdefs((RCs/lib/python2.7/site-packages/jedi/api/classes.pyR FscCs*|jjdkrtS|jjjSdS(s Returns True, if defined as a name in a statement, function or class. Returns False, if it's a reference to such a definition. N(R@RORJRRS(RC((s/lib/python2.7/site-packages/jedi/api/classes.pyRSSscCsL|jj|jjkoK|j|jkoK|j|jkoK|j|jkS(N(R@RRLRR?(RCtother((s/lib/python2.7/site-packages/jedi/api/classes.pyt__eq__]scCs|j| S(N(R(RCR((s/lib/python2.7/site-packages/jedi/api/classes.pyt__ne__cscCs%t|jj|j|j|jfS(N(thashR@RRLRR?(RC((s/lib/python2.7/site-packages/jedi/api/classes.pyt__hash__fs( RRRRDRRdRRR RSRRR(((s/lib/python2.7/site-packages/jedi/api/classes.pyRs 2  RcBs/eZdZdZedZdZRS(s `Signature` objects is the return value of `Script.function_definition`. It knows what functions you are currently in. e.g. `isinstance(` would return the `isinstance` function. without `(` it would return nothing. cCs)tt|j||j||_dS(N(RRRDRt _signature(RCRR~((s/lib/python2.7/site-packages/jedi/api/classes.pyRDpscCs2g|jjdtD]}t|j|^qS(s2 :return list of ParamDefinition: Rx(RR|RtParamDefinitionR?(RCR((s/lib/python2.7/site-packages/jedi/api/classes.pyRtscCs |jjS(N(RR(RC((s/lib/python2.7/site-packages/jedi/api/classes.pyR|s(RRRRDRRR(((s/lib/python2.7/site-packages/jedi/api/classes.pyRjs t CallSignaturecBs>eZdZdZedZedZdZRS(s `CallSignature` objects is the return value of `Script.call_signatures`. It knows what functions you are currently in. e.g. `isinstance(` would return the `isinstance` function with its params. Without `(` it would return nothing. cCs/tt|j||||_||_dS(N(RRRDt _call_detailsR(RCRR~t call_details((s/lib/python2.7/site-packages/jedi/api/classes.pyRDs cCs|jj|jjdtS(s| The Param index of the current call. Returns None if the index cannot be found in the curent call. Rx(Rtcalculate_indexRR|R(RC((s/lib/python2.7/site-packages/jedi/api/classes.pyRs cCs |jjjS(sh The line/column of the bracket that is responsible for the last function call. (Rt bracket_leafR(RC((s/lib/python2.7/site-packages/jedi/api/classes.pyt bracket_startscCs&dt|j|j|jjfS(Ns<%s: index=%r %s>(RRRRRR(RC((s/lib/python2.7/site-packages/jedi/api/classes.pyRs (RRRRDRRRR(((s/lib/python2.7/site-packages/jedi/api/classes.pyRs   RcBs2eZdZdZdZedZRS(cCst|jjS(s- :return list of Definition: (R#R@t infer_default(RC((s/lib/python2.7/site-packages/jedi/api/classes.pyRscKst|jj|S(s :return list of Definition: :param execute_annotation: If False, the values are not executed and you get classes instead of instances. (R#R@tinfer_annotation(RCRo((s/lib/python2.7/site-packages/jedi/api/classes.pyRscCs |jjS(N(R@R(RC((s/lib/python2.7/site-packages/jedi/api/classes.pyRscCs+tjdkrtdn|jjS(s Returns an enum instance. Returns the same values as the builtin :py:attr:`inspect.Parameter.kind`. No support for Python < 3.4 anymore. iis@Python 2 is end-of-life, the new feature is not available for it(ii(tsyst version_infotNotImplementedErrorR@tget_kind(RC((s/lib/python2.7/site-packages/jedi/api/classes.pytkinds (RRRRRRR(((s/lib/python2.7/site-packages/jedi/api/classes.pyRs  cCsdjd|jDS(Ns css|]}|jVqdS(N(R(R<R~((s/lib/python2.7/site-packages/jedi/api/classes.pys s(RkR{(R((s/lib/python2.7/site-packages/jedi/api/classes.pyt_format_signaturessRbcBs5eZdZdZedZeedZRS(sb Temporary implementation, will be used as `Script.help() or something in the future. cCs ||_dS(N(R@(RCRX((s/lib/python2.7/site-packages/jedi/api/classes.pyRDscCs?t|jtr|riS|jjdkr2iS|jjS(Nt statement(RAR@RRVRU(RCR`((s/lib/python2.7/site-packages/jedi/api/classes.pyt _get_contextss cCsd}x|jd|D]}|r>|dddd7}n|j}d}|jjr|sqt|}n| r|jrx<tt|hdtD]}|j}|rPqqWqn|r|r||d|7}q|||7}qW|S(sa The docstring ``__doc__`` for any object. See :attr:`doc` for example. RR`s t-itignore_compileds ( Rt py__doc__R@RfRRGR R RP(RCR`Ratfull_docRtdoctsignature_textR"((s/lib/python2.7/site-packages/jedi/api/classes.pyRcs$  "  (RRRRDRRRRc(((s/lib/python2.7/site-packages/jedi/api/classes.pyRbs  ('RRRRtjediRRtjedi.evaluate.utilsRt jedi.cacheRt jedi.evaluateRRtjedi.evaluate.importsRtjedi.evaluate.contextRtjedi.evaluate.gradual.typeshedRt jedi.evaluate.gradual.conversionR R tjedi.evaluate.base_contextR tjedi.api.keywordsR RR R#tobjectR$RRRRRRRb(((s/lib/python2.7/site-packages/jedi/api/classes.pyts6     jil&"