--- a/RefactoringRope/CodeAssistServer.py Sat Jun 25 18:06:56 2022 +0200
+++ b/RefactoringRope/CodeAssistServer.py Wed Sep 21 15:30:34 2022 +0200
@@ -12,9 +12,7 @@
import sys
import uuid
-from PyQt6.QtCore import (
- pyqtSlot, QCoreApplication, QTimer
-)
+from PyQt6.QtCore import pyqtSlot, QCoreApplication, QTimer
from EricWidgets.EricApplication import ericApp
from EricWidgets import EricMessageBox
@@ -31,8 +29,9 @@
"""
Class implementing the autocompletion interface to rope.
"""
+
IdProject = "Project"
-
+
PictureIDs = {
"class": "?{0}".format(Editor.ClassID),
"_class": "?{0}".format(Editor.ClassProtectedID),
@@ -48,34 +47,33 @@
"__module": "?{0}".format(Editor.ModuleID),
"None": "",
}
-
+
def __init__(self, plugin, parent=None):
"""
Constructor
-
+
@param plugin reference to the plugin object
@type RefactoringRopePlugin
@param parent parent
@type QObject
"""
- super().__init__(
- "CodeAssistServer", multiplex=True, parent=parent)
-
+ super().__init__("CodeAssistServer", multiplex=True, parent=parent)
+
self.__plugin = plugin
self.__ui = parent
self.__vm = ericApp().getObject("ViewManager")
self.__e5project = ericApp().getObject("Project")
-
+
self.__editorLanguageMapping = {}
self.__clientConfigs = {}
self.__editors = {}
-
+
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,
@@ -83,10 +81,9 @@
"DocumentationResult": self.__processDocumentationResult,
"GotoDefinitionResult": self.__gotoDefinitionResult,
"GotoReferencesResult": self.__processGotoReferencesResult,
-
"ClientException": self.__processClientException,
}
-
+
self.__typeMapping = {
"staticmethod": self.tr("static method"),
"classmethod": self.tr("class method"),
@@ -98,13 +95,13 @@
"object": self.tr("object"),
"<unknown>": self.tr("not known"),
}
-
+
# temporary store for editor references indexed by Uuid
self.__editors = {}
-
+
# Python 3
self.__ensureActive("Python3")
-
+
def __updateEditorLanguageMapping(self):
"""
Private method to update the editor language to connection mapping.
@@ -112,73 +109,75 @@
self.__editorLanguageMapping = {}
for name in self.connectionNames():
if name == "Python3":
- self.__editorLanguageMapping.update({
- "Python3": "Python3",
- "MicroPython": "Python3",
- "Pygments|Python": "Python3",
- "Pygments|Python 2.x": "Python3",
- "Cython": "Python3",
- })
-
+ self.__editorLanguageMapping.update(
+ {
+ "Python3": "Python3",
+ "MicroPython": "Python3",
+ "Pygments|Python": "Python3",
+ "Pygments|Python 2.x": "Python3",
+ "Cython": "Python3",
+ }
+ )
+
def isSupportedLanguage(self, language):
"""
Public method to check, if the given language is supported.
-
+
@param language editor programming language to check
@type str
@return flag indicating the support status
@rtype bool
"""
return language in self.__editorLanguageMapping
-
+
def __idString(self, editor):
"""
Private method to determine the ID string for the back-end.
-
+
@param editor reference to the editor to determine the ID string for
@type Editor
@return ID string
@rtype str
"""
idString = ""
-
+
language = editor.getLanguage()
if (
- self.__e5project.isOpen() and
- self.__e5project.getProjectLanguage() == language
+ self.__e5project.isOpen()
+ and self.__e5project.getProjectLanguage() == language
):
filename = editor.getFileName()
if self.__e5project.isProjectSource(filename):
idString = CodeAssistServer.IdProject
-
+
if not idString and language in self.__editorLanguageMapping:
idString = self.__editorLanguageMapping[language]
-
+
return idString
-
+
def __getConfigs(self):
"""
Private method to get the configurations of all connected clients.
"""
for idString in self.connectionNames():
self.sendJson("getConfig", {}, idString=idString)
-
+
def __setConfig(self, params):
"""
Private method to set the rope client configuration data.
-
+
@param params dictionary containing the configuration data
@type dict
"""
idString = params["Id"]
ropeFolder = params["RopeFolderName"]
-
+
self.__clientConfigs[idString] = ropeFolder
-
+
def __ropeConfigFile(self, idString):
"""
Private method to get the name of the rope configuration file.
-
+
@param idString id for which to get the configuration file
@type str
@return name of the rope configuration file
@@ -192,20 +191,20 @@
if not os.path.exists(configfile):
configfile = None
return configfile
-
+
def __configChanged(self, idString):
"""
Private slot called, when the rope config file has changed.
-
+
@param idString id for which to get the configuration file
@type str
"""
self.sendJson("configChanged", {}, idString=idString)
-
+
def editConfig(self, idString):
"""
Public slot to open the rope configuration file in an editor.
-
+
@param idString id for which to get the configuration file
@type str
"""
@@ -213,23 +212,25 @@
if configfile:
if os.path.exists(configfile):
from QScintilla.MiniEditor import MiniEditor
+
editor = MiniEditor(configfile)
editor.show()
- editor.editorSaved.connect(
- lambda: self.__configChanged(idString))
+ editor.editorSaved.connect(lambda: self.__configChanged(idString))
self.__editors[idString] = editor
return
else:
EricMessageBox.critical(
self.__ui,
self.tr("Configure Rope"),
- self.tr("""The Rope configuration file '{0}' does"""
- """ not exist.""").format(configfile))
-
+ self.tr(
+ """The Rope configuration file '{0}' does""" """ not exist."""
+ ).format(configfile),
+ )
+
def requestCompletions(self, editor, context, acText):
"""
Public method to request a list of possible completions.
-
+
@param editor reference to the editor object, that called this method
@type Editor
@param context flag indicating to autocomplete a context
@@ -239,52 +240,54 @@
"""
if not self.__plugin.getPreferences("CodeAssistEnabled"):
return
-
+
idString = self.__idString(editor)
if not idString:
return
-
+
filename = editor.getFileName()
line, index = editor.getCursorPosition()
source = editor.text()
offset = len("".join(source.splitlines(True)[:line])) + index
maxfixes = self.__plugin.getPreferences("MaxFixes")
-
+
self.__ensureActive(idString)
- self.sendJson("getCompletions", {
- "FileName": filename,
- "Source": source,
- "Offset": offset,
- "MaxFixes": maxfixes,
- "CompletionText": acText,
- "SysPath": sys.path,
- }, idString=idString)
-
+ self.sendJson(
+ "getCompletions",
+ {
+ "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.
-
+
@param result dictionary containing the result sent by the client
@type dict
"""
names = []
for completion in result["Completions"]:
- name = completion['Name']
-
- name += CodeAssistServer.PictureIDs.get(
- completion['CompletionType'], '')
+ name = completion["Name"]
+
+ name += CodeAssistServer.PictureIDs.get(completion["CompletionType"], "")
names.append(name)
-
+
if "Error" not in result:
editor = self.__vm.getOpenEditor(result["FileName"])
if editor is not None:
- editor.completionsListReady(names,
- result["CompletionText"])
-
+ editor.completionsListReady(names, result["CompletionText"])
+
def getCallTips(self, editor, pos, commas):
"""
Public method to calculate calltips.
-
+
@param editor reference to the editor object, that called this method
@type Editor
@param pos position in the text for the calltip
@@ -296,42 +299,46 @@
"""
if not self.__plugin.getPreferences("CodeAssistCalltipsEnabled"):
return []
-
+
# reset the calltips buffer
self.__calltips = None
-
+
idString = self.__idString(editor)
if not idString:
return []
-
+
filename = editor.getFileName()
source = editor.text()
line, index = editor.lineIndexFromPosition(pos)
offset = len("".join(source.splitlines(True)[:line])) + index
maxfixes = self.__plugin.getPreferences("CalltipsMaxFixes")
-
+
self.__ensureActive(idString)
- self.sendJson("getCallTips", {
- "FileName": filename,
- "Source": source,
- "Offset": offset,
- "MaxFixes": maxfixes,
- "SysPath": sys.path,
- }, idString=idString)
-
+ 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)
- timer.start(5000) # 5s timeout
+ timer.start(5000) # 5s timeout
while self.__calltips is None and timer.isActive():
QCoreApplication.processEvents()
-
+
return [] if self.__calltips is None else self.__calltips
-
+
def __processCallTipsResult(self, result):
"""
Private method to process the calltips sent by the client.
-
+
@param result dictionary containing the result sent by the client
@type dict
"""
@@ -339,11 +346,11 @@
self.__calltips = []
else:
self.__calltips = result["CallTips"]
-
+
def reportChanged(self, filename, oldSource):
"""
Public slot to report some changed sources.
-
+
@param filename file name of the changed source
@type str
@param oldSource source code before the change
@@ -354,65 +361,70 @@
idString = self.__idString(editor)
if idString:
self.__ensureActive(idString)
- self.sendJson("reportChanged", {
- "FileName": filename,
- "OldSource": oldSource,
- }, idString=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 Editor
"""
if self.__documentationViewer is None:
return
-
+
idString = self.__idString(editor)
-
+
if not idString:
language = editor.getLanguage()
- warning = self.tr(
- "Language <b>{0}</b> is not supported."
- ).format(language)
- self.__documentationViewer.documentationReady(
- warning, isWarning=True)
+ warning = self.tr("Language <b>{0}</b> is not supported.").format(language)
+ self.__documentationViewer.documentationReady(warning, isWarning=True)
return
-
+
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)
-
+ 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 with keys 'name', 'argspec', 'note', 'docstring', 'typ'
"""
if self.__documentationViewer is None:
return
-
+
docu = None
-
+
if "Error" not in result:
documentationDict = result["DocumentationDict"]
if documentationDict:
@@ -422,66 +434,70 @@
"Present in <i>{0}</i> module"
).format(documentationDict["module"])
del documentationDict["module"]
-
+
if "typ" in documentationDict:
if documentationDict["typ"] not in self.__typeMapping:
del documentationDict["typ"]
else:
documentationDict["typ"] = self.__typeMapping[
- documentationDict["typ"]]
-
+ documentationDict["typ"]
+ ]
+
if "note" not in documentationDict:
documentationDict["note"] = ""
-
+
docu = documentationDict
-
+
if docu is None:
msg = self.tr("No documentation available.")
- self.__documentationViewer.documentationReady(
- msg, isDocWarning=True)
+ self.__documentationViewer.documentationReady(msg, isDocWarning=True)
else:
self.__documentationViewer.documentationReady(docu)
-
+
def gotoDefinition(self, editor):
"""
Public slot to find the definition for the word at the cursor position
and go to it.
-
+
Note: This is executed upon a mouse click sequence.
-
+
@param editor reference to the calling editor
@type Editor
"""
if not self.__plugin.getPreferences("MouseClickEnabled"):
return
-
+
idString = self.__idString(editor)
if not idString:
return
-
+
filename = editor.getFileName()
source = editor.text()
line, index = editor.getCursorPosition()
offset = len("".join(source.splitlines(True)[:line])) + index
-
+
self.__ensureActive(idString)
-
+
euuid = str(uuid.uuid4())
self.__editors[euuid] = editor
-
- self.sendJson("gotoDefinition", {
- "FileName": filename,
- "Offset": offset,
- "Source": source,
- "SysPath": sys.path,
- "Uuid": euuid,
- }, idString=idString)
-
+
+ self.sendJson(
+ "gotoDefinition",
+ {
+ "FileName": filename,
+ "Offset": offset,
+ "Source": source,
+ "SysPath": sys.path,
+ "Uuid": euuid,
+ },
+ idString=idString,
+ )
+
def __gotoDefinitionResult(self, result):
"""
Private method to handle the "Goto Definition" result sent by
the client.
-
+
@param result dictionary containing the result data
@type dict
"""
@@ -494,11 +510,11 @@
editor = self.__editors[euuid]
except KeyError:
editor = None
-
+
if (
- editor is not None and
- editor.getFileName() == location["ModulePath"] and
- editor.getCursorPosition()[0] + 1 == location["Line"]
+ editor is not None
+ and editor.getFileName() == location["ModulePath"]
+ and editor.getCursorPosition()[0] + 1 == location["Line"]
):
# this was a click onto the definition line
# -> get references
@@ -506,39 +522,41 @@
filename = editor.getFileName()
source = editor.text()
line, index = editor.getCursorPosition()
- offset = (
- len("".join(source.splitlines(True)[:line])) +
- index
+ offset = len("".join(source.splitlines(True)[:line])) + index
+ self.sendJson(
+ "gotoReferences",
+ {
+ "FileName": filename,
+ "Offset": offset,
+ "Line": line + 1,
+ "SysPath": sys.path,
+ "Uuid": euuid,
+ },
+ idString=idString,
)
- self.sendJson("gotoReferences", {
- "FileName": filename,
- "Offset": offset,
- "Line": line + 1,
- "SysPath": sys.path,
- "Uuid": euuid,
- }, idString=idString)
return
-
- self.__vm.openSourceFile(location["ModulePath"],
- location["Line"],
- addNext=True)
+
+ self.__vm.openSourceFile(
+ location["ModulePath"], location["Line"], addNext=True
+ )
else:
ericApp().getObject("UserInterface").statusBar().showMessage(
- self.tr('Code Assist: No definition found'), 5000)
-
+ self.tr("Code Assist: No definition found"), 5000
+ )
+
with contextlib.suppress(KeyError):
del self.__editors[euuid]
-
+
def __processGotoReferencesResult(self, result):
"""
Private method callback for the goto references result.
-
+
@param result dictionary containing the result data
@type dict
"""
with contextlib.suppress(ImportError):
from QScintilla.Editor import ReferenceItem
-
+
if "Error" not in result:
# ignore errors silently
references = result["GotoReferencesList"]
@@ -555,62 +573,68 @@
codeLine=ref["Code"],
line=ref["Line"],
column=0,
- ) for ref in references
+ )
+ for ref in references
]
editor.gotoReferenceHandler(referenceItemsList)
-
+
with contextlib.suppress(KeyError):
del self.__editors[euuid]
-
+
#######################################################################
## Methods below handle the network connection
#######################################################################
-
+
def handleCall(self, method, params):
"""
Public method to handle a method call from the client.
-
+
@param method requested method name
@type str
@param params dictionary with method specific parameters
@type dict
"""
self.__methodMapping[method](params)
-
+
def __processClientException(self, params):
"""
Private method to handle exceptions of the refactoring client.
-
+
@param params dictionary containing the exception data
@type dict
"""
if params["ExceptionType"] == "ProtocolError":
self.__ui.appendToStderr(
- self.tr("The data received from the code assist"
- " server could not be decoded. Please report"
- " this issue with the received data to the"
- " eric bugs email address.\n"
- "Error: {0}\n"
- "Data:\n{1}\n").format(
- params["ExceptionValue"],
- params["ProtocolData"]))
+ self.tr(
+ "The data received from the code assist"
+ " server could not be decoded. Please report"
+ " this issue with the received data to the"
+ " eric bugs email address.\n"
+ "Error: {0}\n"
+ "Data:\n{1}\n"
+ ).format(params["ExceptionValue"], params["ProtocolData"])
+ )
else:
self.__ui.appendToStderr(
- self.tr("An exception happened in the code assist"
- " client. Please report it to the eric bugs"
- " email address.\n"
- "Exception: {0}\n"
- "Value: {1}\n"
- "Traceback: {2}\n").format(
+ self.tr(
+ "An exception happened in the code assist"
+ " client. Please report it to the eric bugs"
+ " email address.\n"
+ "Exception: {0}\n"
+ "Value: {1}\n"
+ "Traceback: {2}\n"
+ ).format(
params["ExceptionType"],
params["ExceptionValue"],
- params["Traceback"]))
-
+ params["Traceback"],
+ )
+ )
+
def __startCodeAssistClient(self, interpreter, idString, clientEnv):
"""
Private method to start the code assist client with the given
interpreter.
-
+
@param interpreter interpreter to be used for the code assist client
@type str
@param idString id of the client to be started
@@ -622,46 +646,54 @@
@rtype bool
"""
ok = False
-
+
if interpreter:
if idString == CodeAssistServer.IdProject:
configDir = self.__e5project.getProjectPath()
else:
- configDir = os.path.join(Globals.getConfigDir(), "rope",
- idString)
+ configDir = os.path.join(Globals.getConfigDir(), "rope", idString)
if not os.path.exists(configDir):
os.makedirs(configDir)
-
- client = os.path.join(os.path.dirname(__file__),
- "CodeAssistClient.py")
+
+ client = os.path.join(os.path.dirname(__file__), "CodeAssistClient.py")
ok, exitCode = self.startClient(
- interpreter, client,
+ interpreter,
+ client,
clientArgs=[configDir, Globals.getPythonLibraryDirectory()],
- idString=idString, environment=clientEnv)
+ idString=idString,
+ environment=clientEnv,
+ )
if not ok:
if exitCode == 42:
- self.__ui.appendToStderr("CodeAssistServer: " + self.tr(
- "The rope refactoring library is not installed.\n"
- ))
+ self.__ui.appendToStderr(
+ "CodeAssistServer: "
+ + self.tr("The rope refactoring library is not installed.\n")
+ )
else:
- self.__ui.appendToStderr("CodeAssistServer: " + self.tr(
- "'{0}' is not supported because the configured"
- " interpreter could not be started.\n"
- ).format(idString))
+ self.__ui.appendToStderr(
+ "CodeAssistServer: "
+ + self.tr(
+ "'{0}' is not supported because the configured"
+ " interpreter could not be started.\n"
+ ).format(idString)
+ )
else:
- self.__ui.appendToStderr("CodeAssistServer: " + self.tr(
- "'{0}' is not supported because no suitable interpreter is"
- " configured.\n"
- ).format(idString))
-
+ self.__ui.appendToStderr(
+ "CodeAssistServer: "
+ + self.tr(
+ "'{0}' is not supported because no suitable interpreter is"
+ " configured.\n"
+ ).format(idString)
+ )
+
return ok
-
+
def __ensureActive(self, idString):
"""
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
@@ -684,30 +716,29 @@
if not venvName:
venvName, _ = venvManager.getDefaultEnvironment()
if venvName:
- interpreter = venvManager.getVirtualenvInterpreter(
- venvName)
-
+ interpreter = venvManager.getVirtualenvInterpreter(venvName)
+
execPath = venvManager.getVirtualenvExecPath(venvName)
-
+
# build a suitable environment
if execPath:
if "PATH" in clientEnv:
clientEnv["PATH"] = os.pathsep.join(
- [execPath, clientEnv["PATH"]])
+ [execPath, clientEnv["PATH"]]
+ )
else:
clientEnv["PATH"] = execPath
if interpreter:
- ok = self.__startCodeAssistClient(
- interpreter, idString, clientEnv)
+ ok = self.__startCodeAssistClient(interpreter, idString, clientEnv)
else:
ok = False
return ok
-
+
def __interpreterForProject(self):
"""
Private method to determine the interpreter for the current project and
the environment to run it.
-
+
@return tuple containing the interpreter of the current project and the
environment variables
@rtype tuple of (str, dict)
@@ -717,10 +748,10 @@
clientEnv = os.environ.copy()
if "PATH" in clientEnv:
clientEnv["PATH"] = self.__ui.getOriginalPathString()
-
+
if projectLanguage.startswith("Python"):
venvManager = ericApp().getObject("VirtualEnvManager")
-
+
# get virtual environment from project first
venvName = self.__e5project.getDebugProperty("VIRTUALENV")
if not venvName:
@@ -732,32 +763,31 @@
else:
venvName = ""
if venvName:
- interpreter = venvManager.getVirtualenvInterpreter(
- venvName
- )
+ interpreter = venvManager.getVirtualenvInterpreter(venvName)
execPath = venvManager.getVirtualenvExecPath(venvName)
-
+
# build a suitable environment
if execPath:
if "PATH" in clientEnv:
clientEnv["PATH"] = os.pathsep.join(
- [execPath, clientEnv["PATH"]])
+ [execPath, clientEnv["PATH"]]
+ )
else:
clientEnv["PATH"] = execPath
-
+
return interpreter, clientEnv
-
+
@pyqtSlot()
def handleNewConnection(self):
"""
Public slot for new incoming connections from a client.
"""
super().handleNewConnection()
-
+
self.__updateEditorLanguageMapping()
-
+
self.__getConfigs()
-
+
def activate(self):
"""
Public method to activate the code assist server.
@@ -765,11 +795,14 @@
self.__documentationViewer = self.__ui.documentationViewer()
if self.__documentationViewer is not None:
self.__documentationViewer.registerProvider(
- "rope", self.tr("Rope"), self.requestCodeDocumentation,
- self.isSupportedLanguage)
-
+ "rope",
+ self.tr("Rope"),
+ self.requestCodeDocumentation,
+ self.isSupportedLanguage,
+ )
+
self.__e5project.projectClosed.connect(self.__projectClosed)
-
+
def deactivate(self):
"""
Public method to deactivate the code assist server.
@@ -779,15 +812,15 @@
"""
if self.__documentationViewer is not None:
self.__documentationViewer.unregisterProvider("rope")
-
+
for idString in self.connectionNames():
self.sendJson("closeProject", {}, flush=True, idString=idString)
-
+
with contextlib.suppress(TypeError):
self.__e5project.projectClosed.disconnect(self.__projectClosed)
-
+
self.stopAllClients()
-
+
@pyqtSlot()
def __projectClosed(self):
"""
