Rope Refactoring: comparison RefactoringRope/CodeAssistServer.py

-:47fb0119f0be
+:874115c79ca7
 """
 from __future__ import unicode_literals
 import os
+import sys
 from PyQt5.QtCore import pyqtSlot, QCoreApplication, QTimer
 from E5Gui.E5Application import e5App
 from E5Gui import E5MessageBox
 self.__clientConfigs = {}
 self.__editors = {}
 self.__asyncCompletions = False
+self.__documentationViewer = None
 # attributes to store the resuls of the client side
 self.__completions = None
 self.__calltips = None
 self.__methodMapping = {
 "Config": self.__setConfig,
 "CompletionsResult": self.__processCompletionsResult,
 "CallTipsResult": self.__processCallTipsResult,
+"DocumentationResult": self.__processDocumentationResult,
 "ClientException": self.__processClientException,
 }
 # Python 2
 Public method to calculate the possible completions.
 Note: This is the synchronous variant for eric6 before 17.11.
 @param editor reference to the editor object, that called this method
-@type QScintilla.Editor
+@type QScintilla.Editor.Editor
 @param context flag indicating to autocomplete a context
 @type bool
 @return list of possible completions
 @rtype list of str
 """
 Note: This is part of the asynchronous variant for eric6 17.11 and
 later.
 @param editor reference to the editor object, that called this method
-@type QScintilla.Editor
+@type QScintilla.Editor.Editor
 @param context flag indicating to autocomplete a context
 @type bool
 @param acText text to be completed
 @type str
 """
 "FileName": filename,
 "Source": source,
 "Offset": offset,
 "MaxFixes": maxfixes,
 "CompletionText": acText,
+"SysPath": sys.path,
 }, idString=idString)
 def __processCompletionsResult(self, result):
 """
 Private method to process the completions sent by the client.
 def getCallTips(self, editor, pos, commas):
 """
 Public method to calculate calltips.
 @param editor reference to the editor object, that called this method
-@type QScintilla.Editor
+@type QScintilla.Editor.Editor
 @param pos position in the text for the calltip
 @type int
 @param commas minimum number of commas contained in the calltip
 @type int
 @return list of possible calltips
 self.sendJson("getCallTips", {
 "FileName": filename,
 "Source": source,
 "Offset": offset,
 "MaxFixes": maxfixes,
+"SysPath": sys.path,
 }, idString=idString)
 # emulate the synchronous behaviour
 timer = QTimer()
 timer.setSingleShot(True)
 self.__ensureActive(idString)
 self.sendJson("reportChanged", {
 "FileName": filename,
 "OldSource": oldSource,
 }, idString=idString)
+def requestCodeDocumentation(self, editor):
+"""
+Public method to request source code documentation for the given
+editor.
+@param editor reference to the editor to get source code documentation
+for
+@type QScintilla.Editor.Editor
+"""
+language = editor.getLanguage()
+if language not in self.__editorLanguageMapping:
+return
+idString = self.__editorLanguageMapping[language]
+filename = editor.getFileName()
+source = editor.text()
+line, index = editor.getCursorPosition()
+offset = len("".join(source.splitlines(True)[:line])) + index
+maxfixes = self.__plugin.getPreferences("CalltipsMaxFixes")
+offset = editor.positionBefore(offset)
+if editor.charAt(offset) == "(":
+offset = editor.positionBefore(offset)
+self.__ensureActive(idString)
+self.sendJson("getDocumentation", {
+"FileName": filename,
+"Source": source,
+"Offset": offset,
+"MaxFixes": maxfixes,
+"SysPath": sys.path,
+}, idString=idString)
+def __processDocumentationResult(self, result):
+"""
+Private method to process the documentation sent by the client.
+@param result dictionary containing the result sent by the client
+@type dict
+"""
+if "Error" not in result:
+documentationDict = result["DocumentationDict"]
+if "module" in documentationDict:
+documentationDict["note"] = \
+self.tr("Present in {0} module").format(
+documentationDict["module"])
+del documentationDict["module"]
+docu = documentationDict
+else:
+docu = None
+self.__documentationViewer.documentationReady(docu)
 #######################################################################
 ## Methods below handle the network connection
 #######################################################################
 """
 Private method to ensure, that the requested client is active.
 A non-active client will be started.
+@param idString id of the client to be checked
+@type str
 @return flag indicating an active client
 @rtype bool
 """
 ok = idString in self.connectionNames()
 if not ok:
 self.__getConfigs()
 def activate(self):
 """
 Public method to activate the code assist server.
+"""
-Note: This method provides for some growth potential.
+try:
-Currently it is empty.
+self.__documentationViewer = self.__ui.documentationViewer()
-"""
+self.__documentationViewer.registerProvider(
-pass
+"rope", self.tr("Rope"), self.requestCodeDocumentation)
+except AttributeError:
+# eric6 before 17.11 doesn't have this
+pass
 def deactivate(self):
 """
 Public method to deactivate the code assist server.
 """
 """
 Public method to shut down the code assist server.
 """
+if self.__documentationViewer is not None:
+self.__documentationViewer.unregisterProvider("rope")
 for idString in self.connectionNames():
 self.sendJson("closeProject", {}, flush=True, idString=idString)
 self.stopAllClients()
 def connectEditor(self, editor):
 """
 Public method to connect an editor.
 @param editor reference to the editor
-@type QScintilla.Editor
+@type QScintilla.Editor.Editor
 """
 if self.isSupportedLanguage(editor.getLanguage()):
 if self.__plugin.getPreferences("CodeAssistEnabled") and \
 editor.getCompletionListHook("rope") is None:
 self.__setAutoCompletionHook(editor)
 def disconnectEditor(self, editor):
 """
 Public method to disconnect an editor.
 @param editor reference to the editor
-@type QScintilla.Editor
+@type QScintilla.Editor.Editor
 """
 if editor.getCompletionListHook("rope"):
 self.__unsetAutoCompletionHook(editor)
 if editor.getCallTipHook("rope"):
 self.__unsetCalltipsHook(editor)
 def __setAutoCompletionHook(self, editor):
 """
 Private method to set the auto-completion hook.
 @param editor reference to the editor
-@type QScintilla.Editor
+@type QScintilla.Editor.Editor
 """
 try:
 editor.addCompletionListHook("rope", self.requestCompletions,
 async=True)
 self.__asyncCompletions = True
 def __unsetAutoCompletionHook(self, editor):
 """
 Private method to unset the auto-completion hook.
 @param editor reference to the editor
-@type QScintilla.Editor
+@type QScintilla.Editor.Editor
 """
 editor.removeCompletionListHook("rope")
 def __setCalltipsHook(self, editor):
 """
 Private method to set the calltip hook.
 @param editor reference to the editor
-@type QScintilla.Editor
+@type QScintilla.Editor.Editor
 """
 editor.addCallTipHook("rope", self.getCallTips)
 def __unsetCalltipsHook(self, editor):
 """
 Private method to unset the calltip hook.
 @param editor reference to the editor
-@type QScintilla.Editor
+@type QScintilla.Editor.Editor
 """
 editor.removeCallTipHook("rope")
 # TODO: add method to edit the codeassist python2 and 3 config files

Mercurial Repositories > Rope Refactoring / file comparison

comparison: RefactoringRope/CodeAssistServer.py

RefactoringRope/CodeAssistServer.py