Rope Refactoring: comparison RefactoringRope/Refactoring.py

-:ea41742015af
+:6fc202183b3b
 self.__ui = parent
 self.__e5project = e5App().getObject("Project")
 self.__projectpath = ''
 self.__projectLanguage = ""
 self.__projectopen = False
+self.__ropeConfig = {}
 self.__mainMenu = None
 self.__helpDialog = None
 self.__progressDialog = None
 """
 Private method to handle a rope error.
 @param result dictionary containing the error information
 @type dict
-"""
+@return flag indicating, that the error is to be ignored
+@rtype bool
+"""
+if "Error" not in result:
+return True
 if result["Error"] == 'ModuleSyntaxError':
 res = E5MessageBox.warning(
 self.__ui, result["Title"],
 self.tr("Rope error: {0}").format(
 result["ErrorString"]),
 if res == E5MessageBox.Open:
 e5App().getObject("ViewManager").openSourceFile(
 os.path.join(self.__e5project.getProjectPath(),
 result["ErrorFile"]),
 result["ErrorLine"])
+elif result["Error"] == "InterruptedTaskError":
+return True
 else:
 E5MessageBox.warning(
 self.__ui, result["Title"],
 self.tr("Rope error: {0}").format(
 result["ErrorString"])
 )
+return False
 def __getOffset(self, editor, line, index):
 r"""
 Private method to get the offset into the text treating CRLF as ONE
 character.
 the client.
 @param result dictionary containing the result data
 @type dict
 """
-if "Error" in result:
+if self.__handleRopeError(result):
-self.__handleRopeError(result)
-else:
 title = result["Title"]
 if result["EntriesCount"] > 0:
 from MatchesDialog import MatchesDialog
 self.dlg = MatchesDialog(self.__ui, True)
 self.dlg.show()
 for occurrence in result["Entries"]:
 self.dlg.addEntry(
-# resource, lineno, unsure
+# file name, lineno, unsure
 occurrence[0], occurrence[1], occurrence[2])
 else:
 E5MessageBox.warning(
 self.__ui, title,
 self.tr("No occurrences found."))
 aw = e5App().getObject("ViewManager").activeWindow()
 if aw is None:
 return
-title = self.tr("Find &Definition")
+title = self.tr("Find Definition")
 if not self.confirmAllBuffersSaved():
 return
 filename = aw.getFileName()
 line, index = aw.getCursorPosition()
 offset = self.__getOffset(aw, line, index)
-import rope.contrib.findit
+self.sendJson("QueryDefinition", {
-resource = rope.base.libutils.path_to_resource(
+"Title": title,
-self.__project, filename)
+"FileName": filename,
-try:
+"Offset": offset,
-location = rope.contrib.findit.find_definition(
+"Source": aw.text(),
-self.__project, aw.text(), offset, resource)
+"Subcommand": "Query",
-except Exception as err:
+})
-self.handleRopeError(err, title)
-return
-if location is not None:
-from MatchesDialog import MatchesDialog
-self.dlg = MatchesDialog(self.__ui, False)
-self.dlg.show()
-self.dlg.addEntry(location.resource, location.lineno)
-else:
-E5MessageBox.warning(
-self.__ui, title,
-self.tr("No matching definition found."))
 def gotoDefinition(self, editor):
 """
 Public slot to find the definition for the word at the cursor position
 and go to it.
 """
 filename = editor.getFileName()
 line, index = editor.getCursorPosition()
 offset = self.__getOffset(editor, line, index)
-import rope.contrib.findit
+self.sendJson("QueryDefinition", {
-resource = rope.base.libutils.path_to_resource(
+"Title": "",
-self.__project, filename)
+"FileName": filename,
-try:
+"Offset": offset,
-location = rope.contrib.findit.find_definition(
+"Source": editor.text(),
-self.__project, editor.text(), offset, resource)
+"Subcommand": "Goto",
-except Exception:
+})
-# simply ignore them
-return
+def __queryDefinitionResult(self, result):
+"""
-if location is not None:
+Private method to handle the "Query Definition" result sent by
-try:
+the client.
-e5App().getObject("ViewManager").openSourceFile(
-location.resource.real_path, location.lineno, addNext=True)
+@param result dictionary containing the result data
-except TypeError:
+@type dict
-# backward compatibility; <= 17.03
+"""
-e5App().getObject("ViewManager").openSourceFile(
+if result["Subcommand"] == "Query":
-location.resource.real_path, location.lineno, next=True)
+if self.__handleRopeError(result):
-else:
+title = result["Title"]
-e5App().getObject("UserInterface").statusBar().showMessage(
+if "Location" in result:
-self.tr('No definition found'), 5000)
+location = result["Location"]
+from MatchesDialog import MatchesDialog
+self.dlg = MatchesDialog(self.__ui, False)
+self.dlg.show()
+self.dlg.addEntry(location[0], location[1])
+# file name, lineno
+else:
+E5MessageBox.warning(
+self.__ui, title,
+self.tr("No matching definition found."))
+elif result["Subcommand"] == "Goto":
+if "Error" not in result:
+# ignore errors silently
+if "Location" in result:
+location = result["Location"]
+try:
+e5App().getObject("ViewManager").openSourceFile(
+location[0], location[1], addNext=True)
+except TypeError:
+# backward compatibility; <= 17.03
+e5App().getObject("ViewManager").openSourceFile(
+location[0], location[1], next=True)
+else:
+e5App().getObject("UserInterface").statusBar().showMessage(
+self.tr('No definition found'), 5000)
 def __queryImplementations(self):
 """
 Private slot to handle the Find Implementations action.
 """
 filename = aw.getFileName()
 line, index = aw.getCursorPosition()
 offset = self.__getOffset(aw, line, index)
-import rope.contrib.findit
+self.sendJson("QueryImplementations", {
-from ProgressHandle import ProgressHandle
+"Title": title,
-resource = rope.base.libutils.path_to_resource(
+"FileName": filename,
-self.__project, filename)
+"Offset": offset,
-handle = ProgressHandle(title, True, self.__ui)
+})
-handle.show()
-QApplication.processEvents()
+def __queryImplementationsResult(self, result):
-try:
+"""
-occurrences = rope.contrib.findit.find_implementations(
+Private method to handle the "Query Implementations" result sent by
-self.__project, resource, offset, task_handle=handle)
+the client.
-except Exception as err:
-self.handleRopeError(err, title, handle)
+@param result dictionary containing the result data
-return
+@type dict
-handle.reset()
+"""
+if self.__handleRopeError(result):
-if occurrences:
+title = result["Title"]
-from MatchesDialog import MatchesDialog
+if result["EntriesCount"] > 0:
-self.dlg = MatchesDialog(self.__ui, True)
+from MatchesDialog import MatchesDialog
-self.dlg.show()
+self.dlg = MatchesDialog(self.__ui, True)
-for occurrence in occurrences:
+self.dlg.show()
-self.dlg.addEntry(
+for occurrence in result["Entries"]:
-occurrence.resource, occurrence.lineno, occurrence.unsure)
+self.dlg.addEntry(
-else:
+# file name, lineno, unsure
-E5MessageBox.warning(
+occurrence[0], occurrence[1], occurrence[2])
-self.__ui, title, self.tr("No occurrences found."))
+else:
+E5MessageBox.warning(
+self.__ui, title, self.tr("No implementations found."))
 #####################################################
 ## Various actions
 #####################################################
 def __editConfig(self):
 """
 Private slot to open the rope configuration file in an editor.
 """
-ropedir = self.__project.ropefolder
+ropedir = self.__ropeConfig["RopeFolderName"]
 configfile = ""
-if ropedir is not None:
+if ropedir and os.path.exists(ropedir):
-configfile = os.path.join(ropedir.real_path, "config.py")
+configfile = os.path.join(ropedir, "config.py")
 if os.path.exists(configfile):
 from QScintilla.MiniEditor import MiniEditor
 self.__editor = MiniEditor(configfile)
 self.__editor.show()
 self.__editor.editorSaved.connect(self.__configChanged)
 """
 Private slot to show help about the refactorings offered by Rope.
 """
 if self.__helpDialog is None:
 from HelpDialog import HelpDialog
-if sys.version_info[0] >= 3:
-directory = 'rope_py3'
-else:
-directory = 'rope_py2'
-helpfile = os.path.join(os.path.dirname(__file__),
-directory, "rope", "docs", "overview.txt")
 self.__helpDialog = \
 HelpDialog(self.tr("Help about rope refactorings"),
-helpfile)
+self.__ropeConfig["RopeHelpFile"])
 self.__helpDialog.show()
 def __performSOA(self):
 """
 Private slot to perform SOA on all modules.
 self.__ui,
 title,
 self.tr("""This action might take some time. """
 """Do you really want to perform SOA?"""))
 if res:
-from ProgressHandle import ProgressHandle
-handle = ProgressHandle(title, True, self.__ui)
+self.sendJson("PerformSoa", {
-handle.show()
+"Title": title,
-QApplication.processEvents()
+})
-try:
-rope.base.libutils.analyze_modules(
+def __soaFinished(self, result):
-self.__project, task_handle=handle)
+"""
-handle.reset()
+Private method to handle the "Soa Finished" result sent by
-E5MessageBox.information(
+the client.
-self.__ui,
-title,
+@param result dictionary containing the result data
-self.tr("""Static object analysis (SOA) done. """
+@type dict
-"""SOA database updated."""))
+"""
-except Exception as err:
+if self.__handleRopeError(result):
-self.handleRopeError(err, title, handle)
+title = result["Title"]
+E5MessageBox.information(
+self.__ui,
+title,
+self.tr("""Static object analysis (SOA) done. """
+"""SOA database updated."""))
 ##################################################################
 ## methods below are private utility methods
 ##################################################################
 Private method to get the name of the rope configuration file.
 @return name of the rope configuration file (string)
 """
 configfile = None
-if self.__project is not None:
+if self.__ropeConfig:
-ropedir = self.__project.ropefolder
+ropedir = self.__ropeConfig["RopeFolderName"]
-if ropedir is not None:
+if ropedir:
-configfile = os.path.join(ropedir.real_path, "config.py")
+configfile = os.path.join(ropedir, "config.py")
 if not os.path.exists(configfile):
 configfile = None
 return configfile
 def __configChanged(self):
 """
 Private slot called, when the rope config file has changed.
 """
-import rope.base.project
+self.sendJson("ConfigChanged", {})
-self.__project.close()
-self.__project = rope.base.project.Project(
-self.__projectpath, fscommands=self.__fsCommands)
 def __defaultConfig(self):
 """
 Private slot to return the contents of rope's default configuration.
 @return string containing the source of rope's default
 configuration (string)
 """
-if self.__project is not None:
+if self.__ropeConfig and "DefaultConfig" in self.__ropeConfig:
-return self.__project._default_config()
+return self.__ropeConfig["DefaultConfig"]
 else:
 return ""
 ##################################################################
 ## methods below are public utility methods
 self.stopClient()
 self.__projectopen = False
 self.__projectpath = ''
 self.__projectLanguage = ""
+self.__ropeConfig = {}
 # TODO: delete this or move to client
 ##    def getProject(self):
 ##        """
 ##        Public method to get a reference to the rope project object.
 """
 res = e5App().getObject("ViewManager").checkAllDirty()
 self.sendJson("Validate", {})
 return res
+# TODO: port this
 def refreshEditors(self, changes):
 """
 Public method to refresh modified editors.
 @param changes reference to the ChangeSet object
 (rope.base.change.ChangeSet)
 """
 vm = e5App().getObject("ViewManager")
 changedFiles = []
-for resource in changes.get_changed_resources():
+#        for resource in changes.get_changed_resources():
-if not resource.is_folder():
+#            if not resource.is_folder():
-changedFiles.append(resource.real_path)
+#                changedFiles.append(resource.real_path)
 openFiles = [Utilities.normcasepath(f) for f in vm.getOpenFilenames()]
 for file in changedFiles:
 normfile = Utilities.normcasepath(file)
 Public slot to report some changed sources.
 @param filename file name of the changed source (string)
 @param oldSource source code before the change (string)
 """
-if self.__project and self.__e5project.isProjectFile(filename):
+if self.__e5project.isOpen() and \
-try:
+self.__e5project.isProjectFile(filename):
-rope.base.libutils.report_change(
+self.sendJson("ReportChanged", {
-self.__project, filename, oldSource)
+"FileName": filename,
-except RuntimeError:
+"OldSource": oldSource,
-# this could come from trying to do PyQt4/PyQt5 mixed stuff
+})
-# simply ignore it
-pass
 #######################################################################
 ## Methods below handle the network connection
 #######################################################################
 @param method requested method name
 @type str
 @param params dictionary with method specific parameters
 @type dict
 """
-if method == "pong":
+if method == "Config":
-pass
+self.__ropeConfig = params
+# keys: RopeFolderName, DefaultConfig
 elif method == "ClientException":
 if params["ExceptionType"] == "ProtocolError":
 E5MessageBox.critical(
 None,
 if self.__progressDialog is not None:
 self.__progressDialog.reset()
 elif method == "QueryReferencesResult":
 self.__queryReferencesResult(params)
+elif method == "QueryDefinitionResult":
+self.__queryDefinitionResult(params)
+elif method == "QueryImplementationsResult":
+self.__queryImplementationsResult(params)
+elif method == "SoaFinished":
+self.__soaFinished(params)
 def __startRefactoringClient(self, interpreter):
 """
 Private method to start the refactoring client.

Mercurial Repositories > Rope Refactoring / file comparison

comparison: RefactoringRope/Refactoring.py

RefactoringRope/Refactoring.py