B °L'W¶hã@s~ddlZddlZddlZddlZddlZddlmZddlmZddlm Z ddlm Z ddlm Z ddlm Z ddlm Z dd lmZdd lmZdd lmZdd lmZd2dd„Zdd„Zd3dd„Zd4dd„Zd5dd„Zdd„Zdd„ZGdd„deƒZeZGd d!„d!eƒZd6d"d#„Zd$d%„Z d&d'„Z!Gd(d)„d)eƒZ"Gd*d+„d+eƒZ#Gd,d-„d-eƒZ$Gd.d/„d/eƒZ%Gd0d1„d1eƒZ&dS)7éN)Úbuiltins)Ú exceptions)Úlibutils)Úpynames)Ú pynamesdef)Ú pyobjects)Ú pyobjectsdef)Úpyscopes)Úworder)Ú fixsyntax)Ú functionutilséTcCs2|dk rtjdtddt||||||d}|ƒS)aoReturn python code completions as a list of `CodeAssistProposal`\s `resource` is a `rope.base.resources.Resource` object. If provided, relative imports are handled. `maxfixes` is the maximum number of errors to fix if the code has errors in it. If `later_locals` is `False` names defined in this scope and after this line is ignored. Nz'Codeassist no longer supports templatesé)Ú stacklevel)ÚresourceÚmaxfixesÚ later_locals)ÚwarningsÚwarnÚDeprecationWarningÚ_PythonCodeAssist)ÚprojectÚ source_codeÚoffsetrZ templatesrrZassist©rú6lib/python3.7/site-packages/rope/contrib/codeassist.pyÚ code_assists  rcCs t |d¡}| |¡\}}}|S)aNReturn the offset in which the completion should be inserted Usually code assist proposals should be inserted like:: completion = proposal.name result = (source_code[:starting_offset] + completion + source_code[offset:]) Where starting_offset is the offset returned by this function. T)r ÚWorderÚget_splitted_primary_before)rrÚ word_finderÚ expressionÚstartingÚstarting_offsetrrrr"+s r"cCs:t ||||¡}| |¡}|dkr&dS| ¡}tƒ |¡S)z Get the pydocN)r Ú FixSyntaxÚ pyname_atÚ get_objectÚPyDocExtractorÚget_doc)rrrrrÚfixerÚpynameÚpyobjectrrrr'=s  r'Fc Cs>t ||||¡}| |¡}|dkr&dS| ¡} tƒ | ||¡S)ayGet the calltip of a function The format of the returned string is ``module_name.holding_scope_names.function_name(arguments)``. For classes `__init__()` and for normal objects `__call__()` function is used. Note that the offset is on the function itself *not* after the its open parenthesis. (Actually it used to be the other way but it was easily confused when string literals were involved. So I decided it is better for it not to try to be too clever when it cannot be clever enough). You can use a simple search like:: offset = source_code.rindex('(', 0, offset) - 1 to handle simple situations. If `ignore_unknown` is `True`, `None` is returned for functions without source-code like builtins and extensions. If `remove_self` is `True`, the first parameter whose name is self will be removed for methods. N)r r#r$r%r&Ú get_calltip) rrrrrÚignore_unknownÚ remove_selfr(r)r*rrrr+Gs  r+c CsJt ||||¡}| |¡}|dk rF| ¡\}}|dk rF| ¡ ¡|fSdS)aSReturn the definition location of the python name at `offset` Return a (`rope.base.resources.Resource`, lineno) tuple. If no `resource` is given and the definition is inside the same module, the first element of the returned tuple would be `None`. If the location cannot be determined ``(None, None)`` is returned. N)NN)r r#r$Úget_definition_locationÚ get_moduleÚ get_resource) rrrrrr(r)ÚmoduleÚlinenorrrr.hs   r.cOs(ddl}tjdtdd|jjj||ŽS)Nrz4Use `rope.contrib.findit.find_occurrences()` insteadr)r)Zrope.contrib.finditrrrZcontribZfinditÚfind_occurrences)ÚargsÚkwdsÚroperrrr3{s r3c Csô| |¡}tjj ||¡}| ¡\}}|s.dS| ¡ |¡}g}t|t j ƒrdt   |  ¡|¡dfg}n"t|t jƒr†t   |  ¡|¡dfg}xL|jrÒt|tjƒr d} nt|tjƒr²d} nd} | |j ¡| f¡|j}qˆW| |  ¡jdf¡| ¡|S)a…Get the canonical path to an object. Given the offset of the object, this returns a list of (name, name_type) tuples representing the canonical path to the object. For example, the 'x' in the following code: class Foo(object): def bar(self): class Qux(object): def mux(self, x): pass we will return: [('Foo', 'CLASS'), ('bar', 'FUNCTION'), ('Qux', 'CLASS'), ('mux', 'FUNCTION'), ('x', 'PARAMETER')] `resource` is a `rope.base.resources.Resource` object. `offset` is the offset of the pyname you want the path to. NZ PARAMETERZVARIABLEZFUNCTIONZCLASSZMODULE)Ú get_pymoduler6ÚbaseÚevaluateZ eval_locationr.Ú get_scopeÚget_inner_scope_for_lineÚ isinstancerZ ParameterNamer Z get_name_atr0Z AssignedNameÚparentr Z FunctionScopeZ ClassScopeÚappendr*Úget_nameZ real_pathÚreverse) rrrZpymodr)Zdefmodr2ÚscopeÚnamesZ scope_typerrrÚget_canonical_path‚s0        rCc@s^eZdZdZddd„Zdd„Zdd„Zed d „ƒZed d „ƒZ d d„Z dd„Z edd„ƒZ dS)ÚCompletionProposalaA completion proposal The `scope` instance variable shows where proposed name came from and can be 'global', 'local', 'builtin', 'attribute', 'keyword', 'imported', 'parameter_keyword'. The `type` instance variable shows the approximate type of the proposed object and can be 'instance', 'class', 'function', 'module', and `None`. All possible relations between proposal's `scope` and `type` are shown in the table below (different scopes in rows and types in columns): | instance | class | function | module | None local | + | + | + | + | global | + | + | + | + | builtin | + | + | + | | attribute | + | + | + | + | imported | + | + | + | + | keyword | | | | | + parameter_keyword | | | | | + NcCs||_||_| |¡|_dS)N)Únamer)Ú _get_scoperA)ÚselfrErAr)rrrÚ__init__ÕszCompletionProposal.__init__cCsd|j|j|jfS)Nz %s (%s, %s))rErAÚtype)rGrrrÚ__str__ÚszCompletionProposal.__str__cCst|ƒS)N)Ústr)rGrrrÚ__repr__ÝszCompletionProposal.__repr__cCsF|j}t|tjƒr| ¡}t|tjƒrB| ¡}t|tjƒrB|  ¡SdS)ztThe names of the parameters the function takes. Returns None if this completion is not a function. N) r)r<rÚ ImportedNameZ_get_imported_pynameÚ DefinedNamer%rÚAbstractFunctionÚget_param_names)rGr)r*rrrÚ parametersàs   zCompletionProposal.parameterscCs¬|j}t|tjƒrX| ¡}t|tjƒr*dSt|tjƒr:dSt|tjƒsRt|tjƒr¨dSnPt|tj ƒrhdSt|tj ƒs€t|tj ƒr¨| ¡}t|t j ƒr˜dSt|t jƒr¨dSdS)NÚfunctionÚclassÚinstancer1)r)r<rÚ BuiltinNamer%ZBuiltinFunctionZ BuiltinClassZ BuiltinObjectrÚImportedModulerMrNrrOÚ AbstractClass)rGr)r*rrrrIîs(          zCompletionProposal.typecCs6t|jtjƒrdSt|jtjƒs.t|jtjƒr2dS|S)NÚbuiltinÚimported)r<r)rrUrrVrM)rGrArrrrFs zCompletionProposal._get_scopecCs0|js dS|j ¡}t|dƒs"dS|j ¡ ¡S)zYGet the proposed object's docstring. Returns None if it can not be get. Nr')r)r%Úhasattrr')rGr*rrrr' s   zCompletionProposal.get_doccCst d¡|jS)NzAthe proposal's `kind` property is deprecated, use `scope` instead)rrrA)rGrrrÚkinds zCompletionProposal.kind)N) Ú__name__Ú __module__Ú __qualname__Ú__doc__rHrJrLÚpropertyrQrIrFr'r[rrrrrD¼s    rDcs(eZdZdZ‡fdd„Zdd„Z‡ZS)ÚNamedParamProposalzÊA parameter keyword completion proposal Holds reference to ``_function`` -- the function which parameter ``name`` belongs to. This allows to determine default value for this parameter. cs*||_d|}tt|ƒ |d¡||_dS)Nz%s=Úparameter_keyword)ÚargnameÚsuperrarHÚ _function)rGrErR)Ú __class__rrrH+szNamedParamProposal.__init__cCs4tj |j¡}x |jD]\}}|j|kr|SqWdS)zƒGet a string representation of a param's default value. Returns None if there is no default value for this param. N)r ÚDefinitionInfoÚreadreZargs_with_defaultsrc)rGZdefinfoÚargÚdefaultrrrÚ get_default1s  zNamedParamProposal.get_default)r\r]r^r_rHrkÚ __classcell__rr)rfrra$s racCst|||ƒ}| ¡S)aºSort a list of proposals Return a sorted list of the given `CodeAssistProposal`\s. `scopepref` can be a list of proposal scopes. Defaults to ``['parameter_keyword', 'local', 'global', 'imported', 'attribute', 'builtin', 'keyword']``. `typepref` can be a list of proposal types. Defaults to ``['class', 'function', 'instance', 'module', None]``. (`None` stands for completions with no type like keywords.) )Ú_ProposalSorterÚget_sorted_proposal_list)Ú proposalsÚ scopeprefÚtypeprefZsorterrrrÚsorted_proposals=s rrcCs0t |d¡}| |¡\}}}|r,|d|S|S)z!Return the expression to completeTÚ.)r rr)rrrr r!r"rrrÚstarting_expressionNs   rtcCstjdtddiS)Nz"default_templates() is deprecated.r)r)rrrrrrrÚdefault_templatesXs ruc@sneZdZddd„ZejZdd„Zdd „Zd d „Z d d „Z ddd„Z dd„Z dd„Z dd„Zdd„Zdd„ZdS)rNr TcCsH||_||_||_||_||_t |d¡|_|j |¡\|_ |_ |_ dS)NT) rÚcoderrrr rrrr r!r)rGrrrrrrrrrrH`sz_PythonCodeAssist.__init__cCs>|d}x,|dkr4|| ¡s*||dkr4|d8}q W|dS)Nr rÚ_)Úisalnum)rGrrZcurrent_offsetrrrÚ_find_starting_offsetms   z'_PythonCodeAssist._find_starting_offsetcCs2g}x(|jD]}| |¡r | t|dƒ¡q W|S)NÚkeyword)ÚkeywordsÚ startswithr>rD)rGr!ÚresultÚkwrrrÚ_matching_keywordsts   z$_PythonCodeAssist._matching_keywordscCsV|jt|jƒkrgSt| ¡ ¡ƒ}|j ¡dkrR|j ¡dkrR|  |  |j¡¡|S)NÚ) rÚlenrvÚlistÚ_code_completionsÚvaluesr Ústripr!Úextendr)rGZ completionsrrrÚ__call__{s z_PythonCodeAssist.__call__c Cszi}tjj ||j¡}|dk rv| ¡}d}t|tjtj fƒr@d}x4|  ¡  ¡D]$\}}|  |j ¡rNt|||ƒ||<qNW|S)NÚ attributerY)r6r8r9Úeval_strr r%r<rZPyModuleZ PyPackageZget_attributesÚitemsr|r!rD) rGÚ module_scopeZ holding_scoper}Z found_pynameÚelementÚ compl_scoperEr)rrrÚ_dotted_completionsƒs   z%_PythonCodeAssist._dotted_completionscCs˜|jdk r| |j|¡|dkr*| ¡}n| ¡}x`| ¡D]T\}}| |j¡rsz+_ProposalSorter.__init__..)rorpÚdictÚ enumerateÚtyperank)rGZcode_assist_proposalsrprqrrrrHýs z_ProposalSorter.__init__csvi}x"ˆjD]}| |jg¡ |¡q Wg}xDˆjD]:}| |g¡}‡fdd„|Dƒ}|jˆjd| |¡q4W|S)z%Return a list of `CodeAssistProposal`csg|]}|jˆjkr|‘qSr)rIr§)r¢Úproposal)rGrrú sz<_ProposalSorter.get_sorted_proposal_list..)Úkey) roÚ setdefaultrAr>rpÚgetÚsortÚ _proposal_keyr†)rGror¨r}rAZscope_proposalsr)rGrrns   z(_ProposalSorter.get_sorted_proposal_listcCs&dd„}|j |jd¡||jƒ|jfS)NcSstdd„|DƒƒS)Ncss|]}|dkrdVqdS)rwr Nr)r¢Úcrrrr¤szJ_ProposalSorter._proposal_key.._underline_count..)Úsum)rErrrÚ_underline_countsz7_ProposalSorter._proposal_key.._underline_countéd)r§r¬rIrE)rGZ proposal1r±rrrr®sz_ProposalSorter._proposal_key)NN)r\r]r^r_rHrnr®rrrrrmús rmcsteZdZdd„Zddd„Z‡fdd„Zdd „Zd d „Zd d „Zdd„Z ddd„Z ddd„Z dd„Z ddd„Z ‡ZS)r&cCsJt|tjƒr| |¡St|tjƒr,| |¡St|tjƒrF| | ¡¡SdS)N) r<rrOÚ_get_function_docstringrWÚ_get_class_docstringÚAbstractModuleÚ_trim_docstringr')rGr*rrrr'%s     zPyDocExtractor.get_docFcCs¤y4t|tjƒr|d ¡}t|tjƒs2|d ¡}Wntjk rJdSX|r`t|tjƒs`dSt|tjƒr |j|dd}|rœ|  |¡rœ|  dd¡  dd¡S|SdS) NrHr‡T)Ú add_modulez(self)z()z(self, ú() r<rrWr%rOrZAttributeNotFoundErrorÚ PyFunctionÚ_get_function_signatureÚ _is_methodÚreplace)rGr*r,r-r}rrrr+.s    zPyDocExtractor.get_calltipcsv| | ¡d¡}‡fdd„| ¡Dƒ}d| ¡d |¡f|}d|krr|d ¡}t|tjƒrr|d|  |¡7}|S)Nrcsg|] }| ¡‘qSr)r?)r¢rd)rfrrr©@sz7PyDocExtractor._get_class_docstring..zclass %s(%s): z, rHz ) r¶r'Úget_superclassesr?Újoinr%r<rrOÚ_get_single_function_docstring)rGÚpyclassÚcontentsZsupersÚdocZinit)rfrrr´>s  z#PyDocExtractor._get_class_docstringcs@|g}ˆ |¡r(| ˆ |j| ¡¡¡d ‡fdd„|Dƒ¡S)Nz csg|]}ˆ |¡‘qSr)r¿)r¢rR)rGrrr©Osz:PyDocExtractor._get_function_docstring..)r»r†Ú_get_super_methodsr=r?r¾)rGÚ pyfunctionZ functionsr)rGrr³Js    z&PyDocExtractor._get_function_docstringcCst|tjƒot|jtjƒS)N)r<rr¹r=ZPyClass)rGrÄrrrr»Rs zPyDocExtractor._is_methodcCs(| |¡}|j| ¡dd}|d|S)Nr)rŸz: )rºr¶r')rGrÄZ signatureZdocsrrrr¿Vs z-PyDocExtractor._get_single_function_docstringcCsVg}xL| ¡D]@}||kr<|| ¡}t|tjƒr<| |¡| | ||¡¡qW|S)N)r½r%r<rrOr>r†rÃ)rGrÀrEr}Z super_classrRrrrrÃ[s   z!PyDocExtractor._get_super_methodscCsR| ||¡}t|tjƒr0tj |¡}|| ¡Sd|| ¡d  |  ¡¡fSdS)Nz%s(%s)z, ) Ú _locationr<rr¹r rgrhZ to_stringr?r¾rP)rGrÄr·r—Úinforrrrºes      z&PyDocExtractor._get_function_signaturecCsŠg}|j}x2|rr?r¹ÚinsertÚ _get_modulerZ BuiltinModuler¾)rGr*r·r—r=rrrrÅns    zPyDocExtractor._locationcCs2| ¡}|dk r.| ¡}|dk r.t |¡dSdS)Nrsr€)r/r0rÚmodname)rGrÄr1rrrrrÈ|s zPyDocExtractor._get_modulercsä|sdS| ¡ ¡}tj}x6|dd…D]&}| ¡}|r(t|t|ƒt|ƒƒ}q(W|d ¡g}|tjkr–x*|dd…D]}| ||d…  ¡¡qxWx|r®|ds®|  ¡q˜Wx|rÊ|dsÊ|  d¡q²Wd  ‡fdd„|Dƒ¡S) zThe sample code from :PEP:`257`r€r Nréÿÿÿÿr˜c3s|]}dˆ|VqdS)ú Nr)r¢Úline)rŸrrr¤œsz1PyDocExtractor._trim_docstring..) Ú expandtabsÚ splitlinesÚsysÚmaxsizeÚlstripÚminrr…r>ÚrstripÚpopr¾)rGZ docstringrŸrÚindentrÌÚstrippedZtrimmedr)rŸrr¶„s"   zPyDocExtractor._trim_docstring)FF)F)F)r)r\r]r^r'r+r´r³r»r¿rÃrºrÅrÈr¶rlrr)rfrr&#s   r&cseZdZ‡fdd„Z‡ZS)ÚTemplateProposalcs,tjdtddtt|ƒ |d¡||_dS)NzTemplateProposal is deprecated.r)rÚtemplate)rrrrdr×rHrØ)rGrErØ)rfrrrH¢s zTemplateProposal.__init__)r\r]r^rHrlrr)rfrrסsr×c@s,eZdZdd„Zdd„Zdd„Zdd„Zd S) ÚTemplatecCs||_tjdtdddS)NzTemplate is deprecated.r)r)rØrrr)rGrØrrrrH«szTemplate.__init__cCsgS)Nr)rGrrrÚ variables°szTemplate.variablescCs|jS)N)rØ)rGÚmappingrrrÚ substitute³szTemplate.substitutecCs t|jƒS)N)rrØ)rGrÛrrrÚget_cursor_location¶szTemplate.get_cursor_locationN)r\r]r^rHrÚrÜrÝrrrrrÙ©srÙ)NNr T)Nr )Nr FF)Nr )NN)'rzrÏrZrope.base.codeanalyzer6Zrope.base.evaluateZ rope.baserrrrrrrr r Z rope.contribr Z rope.refactorr rr"r'r+r.r3rCÚobjectrDZCodeAssistProposalrarrrtrurrmr&r×rÙrrrrÚsH              ! :e  )~