B 7r\Y@sdZddlZddlmZddlmZddlmZmZddl m Z ddl m Z ddl m Z dd lmZdd lmZdd lmZmZdd lmZd dZddZGdddeZGdddeZGdddeZGdddeZGdddeZdS)z 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. N)search_ancestor)settings)ignoredunite)memoize_method)imports)compiled) ImportName)instance) ClassContextFunctionExecutionContext) KeywordNamecCst|dddS)NcSs |jpdS)N)rr) start_pos)sr/lib/python3.7/site-packages/jedi/api/classes.pysz*_sort_names_by_start_pos..)key)sorted)namesrrr_sort_names_by_start_possrcs8t|jdd}dd|D}fddt|DS)zo List sub-definitions (e.g., methods in class). :type scope: Scope :rtype: list of Definition T)Z search_globalcSsg|]}|qSrr).0namerrr !sz!defined_names..csg|]}t|qSr) Definition)rn) evaluatorrrr"s)nextZ get_filtersvaluesr)rcontextfilterrr)rr defined_namessr!c @seZdZddddddddddddd Zedd d d iDZd d ZeddZ eddZ ddZ eddZ ddZ eddZeddZd2ddZed d!Zed"d#Zd$d%Zd&d'Zeed(d)Zd*d+Zd,d-Zd3d/d0Zd1S)4BaseDefinitionzos.pathosio functoolsZsqlite3) posixpathZ riscospathZntpathZ os2emxpathZmacpath genericpathposix_io _functoolsZ_sqlite3Z __builtin__builtinsccs$|]\}}t|d|fVqdS).N)tuplesplit)rkvrrr 5szBaseDefinition.zargparse._ActionsContainerzargparse.ArgumentParsercCsD||_||_t|jt|_||_|r4d|_n |j |_dS)N) _evaluator_name isinstancer Z is_keywordget_root_context_modulein_builtin_module module_pathZ py__file__)selfrrrrr__init__9s  zBaseDefinition.__init__cCs|jjS)z Name of variable/function/class/module. For example, for ``x = None`` it returns ``'x'``. :rtype: str or None )r4 string_name)r:rrrrIs zBaseDefinition.namecCsl|jj}d}|dk r:|}|dk r:|jdkr:|r:d}t|jtjsL|rdx|jD]}|j SW|jj S)a 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 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) >>> 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' FNZ import_fromT) r4 tree_nameget_definitiontype is_definitionr5rZ SubModuleNameinferapi_type)r:r=Zresolve definitionrrrrr?Ts4zBaseDefinition.typecsfdd}tt|S)z/The path to a module/class/function definition.c 3sj}|jdkr.to_reverse)rGrE)r:rKr)r:r_paths $zBaseDefinition._pathcCs |jjjS)a' 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 )r7rr<)r:rrr module_names zBaseDefinition.module_namecCst|jtjS)z!Whether this is a builtin module.)r5r7rCompiledObject)r:rrrr8sz BaseDefinition.in_builtin_modulecCs|jj}|dkrdS|dS)z7The line where the definition occurs (starting with 1).Nr)r4r)r:rrrrlineszBaseDefinition.linecCs|jj}|dkrdS|dS)z9The column where the definition occurs (starting with 0).N)r4r)r:rrrrcolumnszBaseDefinition.columnFTcCst|jj||dS)aS 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``. )fastraw)_Helpr4 docstring)r:rSrRrrrrUszBaseDefinition.docstringcCs|jjS)z$A textual description of the object.)r4r<)r:rrr descriptionszBaseDefinition.descriptionc Cst|}|sdStt|j|d|d<WdQRXxD|jD]6\}}t|dt||krF|g|t|d}qFWd |dr|n |ddS)a Dot-separated path of this object. It is in the form of ``[.[...]][.]``. 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. Nrr-rP) rErLrKeyError_mapping_tuple_mappingitemsr.lenjoin)r:pathrreplrrr full_names  zBaseDefinition.full_namecs8jjdkrSjjjjj}fdd|DS)Ncsg|]}tj|qSr)rr3)rr)r:rrr0sz3BaseDefinition.goto_assignments..)r4r=r3ZgotorH)r:rr)r:rgoto_assignments+s zBaseDefinition.goto_assignmentscsfddjDS)Ncsg|]}tj|jqSr)rr3r)rd)r:rrr4sz4BaseDefinition._goto_definitions..)r4rA)r:r)r:r_goto_definitions2sz BaseDefinition._goto_definitionscsRfddtj}|r,t|dds4td|d}fdd|DS)z Raises an ``AttributeError``if the definition is not callable. Otherwise returns a list of `Definition` that represents the params. csg}|jdkr4t|}t|tjr|dd}nt|tjtfrt|trTd}nd}||}|sjgS|d }t t |}t|tr|dd}|St|t j rt|S|S)NfunctionrPr;__call__r)rBrEget_param_namesr5r Z BoundMethodZAbstractInstanceContextr Zget_function_slot_namesrAriterrrN)rZ param_namessearchrZinferred)rerrre=s(          z.BaseDefinition.params..get_param_namesrZ py__call__z$There are no params defined on this.csg|]}tj|qSr)rr3)rr)r:rrr\sz)BaseDefinition.params..)rEr4rAhasattrrI)r:Zfollowedrr)rer:rparams6s  zBaseDefinition.paramscCs2|jj}|dkrdSt|tr$|j}t|j|jS)N)r4rHr5r Zfunction_contextrr3r)r:rrrrparent^s  zBaseDefinition.parentcCsdt|j|jfS)Nz<%s %s>)r?__name__rV)r:rrr__repr__gszBaseDefinition.__repr__rcCsP|r dS|jj}|jjdd}t||d}d||||dS)aI 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. r&rrP)r8r4r6Z code_linesrmaxr\)r:ZbeforeZafterlinesindexZ start_indexrrr get_line_codejs  zBaseDefinition.get_line_codeN)FT)rr)rk __module__ __qualname__rXdictrZrYr;propertyrr?rLrMr8rOrQrUrVr_r`rbrrirjrlrprrrrr"%s@ B(    !  %' r"csneZdZdZfddZddZeddZedd Zdfd d Z eddZ ddZ e ddZ ZS) Completionz `Completion` objects are returned from :meth:`api.Script.completions`. They provide additional information about a completion. cs(tt|||||_||_g|_dS)N)superrur;_like_name_length_stackZ_same_name_completions)r:rrstackZlike_name_length) __class__rrr;szCompletion.__init__cCsxd}tjr|jdkrd}|jjdkrV|jdk rVdd|jD}d|krVd|krV|d 7}|jj}|rp||jd}||S) Nr&ZFunction(paramcSsg|] }|jqSr)Z nonterminal)rZ stack_noderrrrsz(Completion._complete..ZtrailerZargument=)rZadd_bracket_after_functionr?r4rBrxr<rw)r:Z like_nameappendZ nonterminalsrrrr _completes zCompletion._completecCs |dS)a 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=` T)r)r:rrrcompleteszCompletion.completecCs |dS)a@ 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=". F)r)r:rrrname_with_symbolss zCompletion.name_with_symbolsFTcs"|jdkrd}tt|j||dS)NF)rSrR)rwrvrurU)r:rSrR)rzrrrUs zCompletion.docstringcCs tj|S)z/Provide a description of the completion object.)rrV__get__)r:rrrrVszCompletion.descriptioncCsdt|j|jjfS)Nz<%s: %s>)r?rkr4r<)r:rrrrlszCompletion.__repr__csj}fdd|DS)a 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. csg|]}tj|jqSr)rr3r)rra)r:rrrsz0Completion.follow_definition..)r4rA)r:defsr)r:rfollow_definitions zCompletion.follow_definition)FT)rkrqrr__doc__r;rrtrrrUrVrlrr __classcell__rr)rzrru~s    rucsdeZdZdZfddZeddZeddZedd Z d d Z d d Z ddZ ddZ ZS)rz *Definition* objects are returned from :meth:`api.Script.goto_assignments` or :meth:`api.Script.goto_definitions`. cstt|||dS)N)rvrr;)r:rrC)rzrrr;szDefinition.__init__cCs|j}|jj}|dks|dkr:|dkr*d}|d|jjS|dkrbt|djddd}|d|S|pl|}|jdd }td d|}td d| }|S) a A description of the :class:`.Definition` object, which is heavily used in testing. e.g. for ``isinstance`` it returns ``def isinstance``. Example: >>> 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) >>> defs [, ] >>> str(defs[0].description) # strip literals in python2 'def f' >>> str(defs[1].description) 'class C' )rcclassrDr Nrcdef r|F)include_prefixZ include_comma)rz #[^\n]+\nz\s+) r?r4r=r<rget_coder>resubstrip)r:typr=coderCZtxtrrrrVs     zDefinition.descriptioncCs&|jr dnd|j}d|j|j|fS)a1 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. r&z@%sz%s:%s%s)r8rOrMrV)r:Zpositionrrrdesc_with_modules zDefinition.desc_with_modulecs,j}ttfdd|DdddS)zd List sub-definitions (e.g., methods in class). :rtype: list of Definition c3s|]}tj|VqdS)N)r!r3)rra)r:rrr24sz+Definition.defined_names..cSs |jjp dS)N)rr)r4r)rrrrr5sz*Definition.defined_names..)r)r4rArr)r:rr)r:rr!+s zDefinition.defined_namescCs |jjdkrdS|jjSdS)z Returns True, if defined as a name in a statement, function or class. Returns False, if it's a reference to such a definition. NT)r4r=r@)r:rrrr@8s zDefinition.is_definitioncCs4|jj|jjko2|j|jko2|j|jko2|j|jkS)N)r4rr9rr3)r:otherrrr__eq__Bs  zDefinition.__eq__cCs || S)N)r)r:rrrr__ne__HszDefinition.__ne__cCst|jj|j|j|jfS)N)hashr4rr9rr3)r:rrr__hash__KszDefinition.__hash__)rkrqrrrr;rtrVrrr!r@rrrrrr)rzrrs  4   rcsLeZdZdZfddZeddZeddZedd Zd d Z Z S) CallSignaturez `CallSignature` 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. cs(tt|||||_||_||_dS)N)rvrr;_index _key_name_str_bracket_start_pos)r:rZexecutable_nameZbracket_start_posroZ key_name_str)rzrrr;UszCallSignature.__init__cCs|jdk rfx&t|jD]\}}|j|jkr|SqW|jrb|jdj}|jdk rb|jjdkrb|SdS|jt |jkrx8t|jD]*\}}|jj}|dk r|jdkr|SqWdS|jS)z| The Param index of the current call. Returns None if the index cannot be found in the curent call. NrP) r enumeraterirr4r=r>Z star_countrr[)r:ir|Z param_namer=rrrro[s$    zCallSignature.indexcCs|jS)zc The indent of the bracket that is responsible for the last function call. )r)r:rrr bracket_startvszCallSignature.bracket_startcCsddd|jDS)Nz, cSsg|]}|jddqS)N)rV)rprrrrsz-CallSignature._params_str..)r\ri)r:rrr _params_str~s zCallSignature._params_strcCsdt|j|jj|j|jfS)Nz<%s: %s index=%r params=[%s]>)r?rkr4r<rr)r:rrrrls zCallSignature.__repr__) rkrqrrrr;rtrorrrlrrr)rzrrOs     rc@s.eZdZdZddZeddZd ddZd S) rTzb Temporary implementation, will be used as `Script.help() or something in the future. cCs ||_dS)N)r4)r:rCrrrr;sz_Help.__init__cCs.t|jtr|riS|jjdkr$iS|jS)NZ statement)r5r4r rBrA)r:rRrrr _get_contextss  z_Help._get_contextsTcCs&x |j|dD]}|j| dSWdS)za The docstring ``__doc__`` for any object. See :attr:`doc` for example. )rR)Zinclude_call_signaturer&)rZ py__doc__)r:rRrSrrrrrUsz_Help.docstringN)TT)rkrqrrrr;rrrUrrrrrTs rT)rrZparso.python.treerZjedirZjedi.evaluate.utilsrrZ jedi.cacherZ jedi.evaluaterrZjedi.evaluate.importsr Zjedi.evaluate.contextr r r Zjedi.api.keywordsr rr!objectr"rurrrTrrrrs(         [cn=