Rope Refactoring: comparison RefactoringRope/RefactoringServer.py

-:a111134b5dc7
+:c38750e1bafd
 str = unicode   # __IGNORE_WARNING__
 except NameError:
 pass
 import os
-import sys
-# TODO: eliminate this
-sys.path.insert(0, os.path.dirname(__file__))
 from PyQt5.QtCore import pyqtSlot
 from PyQt5.QtWidgets import QMenu, QApplication, QAction
 from PyQt5.Qsci import QsciScintilla
 from E5Gui.E5Application import e5App
 from E5Gui import E5MessageBox
 from E5Gui.E5Action import E5Action
-from JsonServer import JsonServer
+from .JsonServer import JsonServer
-from RopeProgressDialog import RopeProgressDialog
+from .RopeProgressDialog import RopeProgressDialog
 import Utilities
 import Preferences
 from Preferences.Shortcuts import readShortcuts
 self.__progressDialog = None
 self.__helpDialog = None
 self.__historyDialog = None
 self.__refactoringDialogs = {}
-from FileSystemCommands import E5FileSystemCommands
+from .FileSystemCommands import E5FileSystemCommands
 self.__fsCommands = E5FileSystemCommands(self.__e5project)
 self.__methodMapping = {
 "Config": self.__setConfig,
 "Progress": self.__processProgress,
 def __initMenu(self):
 """
 Private slot to initialize the refactoring menu.
-@return the menu generated (QMenu)
+@return the menu generated
+@rtype QMenu
 """
 menu = QMenu(self.tr('&Refactoring'), self.__ui)
 menu.setTearOffEnabled(True)
 act = menu.addAction('rope', self.__ropeInfo)
 Private method to get the offset into the text treating CRLF as ONE
 character.
 Note: rope seems to convert all EOL styles to just \n.
-@param editor reference to the editor (Editor)
+@param editor reference to the editor
-@param line line for the offset (integer)
+@type QScintilla.Editor
-@param index index into line for the offset (integer)
+@param line line for the offset
-@return rope compliant offset into the file (integer)
+@type int
+@param index index into line for the offset
+@type int
+@return rope compliant offset into the file
+@rtype int
 """
 source = editor.text()
 offset = len("".join(source.splitlines(True)[:line])) + index
 if editor.eolMode() == QsciScintilla.EolWindows:
 offset -= line
 """
 if self.handleRopeError(result):
 changeGroup = result["ChangeGroup"]
 try:
 self.__refactoringDialogs[changeGroup]\
 .processChangeData(result)
 except KeyError:
 # ignore data for non-existing dialogs
 pass
 def __refactoringDialogClosed(self, changeGroup):
 def __doRename(self, title, isLocal=False, renameModule=False):
 """
 Private method to perform the various renaming refactorings.
-@param title title of the refactoring (string)
+@param title title of the refactoring
+@type str
 @param isLocal flag indicating to restrict refactoring to
-the local file (boolean)
+the local file
+@type bool
 @param renameModule flag indicating a module rename refactoring
-(boolean)
+@type bool
 """
 aw = e5App().getObject("ViewManager").activeWindow()
 if aw is None:
 return
 index = int(index + (index1 - index) / 2)
 # keep it inside the object
 offset = self.__getOffset(aw, line, index)
 selectedText = aw.selectedText()
-from RenameDialog import RenameDialog
+from .RenameDialog import RenameDialog
 dlg = RenameDialog(self, title, filename, offset, isLocal,
 selectedText=selectedText, parent=self.__ui)
 changeGroup = dlg.getChangeGroupName()
 self.__refactoringDialogs[changeGroup] = dlg
 dlg.finished.connect(
 filename = aw.getFileName()
 line, index, line1, index1 = aw.getSelection()
 offset = self.__getOffset(aw, line, index)
-from ChangeOccurrencesDialog import ChangeOccurrencesDialog
+from .ChangeOccurrencesDialog import ChangeOccurrencesDialog
 dlg = ChangeOccurrencesDialog(self, title, filename, offset,
 parent=self.__ui)
 changeGroup = dlg.getChangeGroupName()
 self.__refactoringDialogs[changeGroup] = dlg
 dlg.finished.connect(
 filename = aw.getFileName()
 startline, startcolumn, endline, endcolumn = aw.getSelection()
 startOffset = self.__getOffset(aw, startline, startcolumn)
 endOffset = self.__getOffset(aw, endline, endcolumn)
-from ExtractDialog import ExtractDialog
+from .ExtractDialog import ExtractDialog
 dlg = ExtractDialog(self, title, filename, startOffset, endOffset,
 kind, parent=self.__ui)
 changeGroup = dlg.getChangeGroupName()
 self.__refactoringDialogs[changeGroup] = dlg
 dlg.finished.connect(
 filename = aw.getFileName()
 line, index, line1, index1 = aw.getSelection()
 offset = self.__getOffset(aw, line, index)
-from InlineDialog import InlineDialog
+from .InlineDialog import InlineDialog
 dlg = InlineDialog(self, title, filename, offset, parent=self.__ui)
 changeGroup = dlg.getChangeGroupName()
 self.__refactoringDialogs[changeGroup] = dlg
 dlg.finished.connect(
 lambda: self.__refactoringDialogClosed(changeGroup))
 line, index, line1, index1 = aw.getSelection()
 offset = self.__getOffset(aw, line, index)
 else:
 offset = None
-from MoveDialog import MoveDialog
+from .MoveDialog import MoveDialog
 dlg = MoveDialog(self, title, filename, offset, parent=self.__ui)
 changeGroup = dlg.getChangeGroupName()
 self.__refactoringDialogs[changeGroup] = dlg
 dlg.finished.connect(
 lambda: self.__refactoringDialogClosed(changeGroup))
 filename = aw.getFileName()
 line, index, line1, index1 = aw.getSelection()
 offset = self.__getOffset(aw, line, index)
-from UseFunctionDialog import UseFunctionDialog
+from .UseFunctionDialog import UseFunctionDialog
 dlg = UseFunctionDialog(self, title, filename, offset,
 parent=self.__ui)
 changeGroup = dlg.getChangeGroupName()
 self.__refactoringDialogs[changeGroup] = dlg
 dlg.finished.connect(
 filename = aw.getFileName()
 line, index, line1, index1 = aw.getSelection()
 offset = self.__getOffset(aw, line, index)
-from IntroduceFactoryDialog import IntroduceFactoryDialog
+from .IntroduceFactoryDialog import IntroduceFactoryDialog
 dlg = IntroduceFactoryDialog(self, title, filename, offset,
 parent=self.__ui)
 changeGroup = dlg.getChangeGroupName()
 self.__refactoringDialogs[changeGroup] = dlg
 dlg.finished.connect(
 filename = aw.getFileName()
 line, index, line1, index1 = aw.getSelection()
 offset = self.__getOffset(aw, line, index)
-from IntroduceParameterDialog import IntroduceParameterDialog
+from .IntroduceParameterDialog import IntroduceParameterDialog
 dlg = IntroduceParameterDialog(self, title, filename, offset,
 parent=self.__ui)
 changeGroup = dlg.getChangeGroupName()
 self.__refactoringDialogs[changeGroup] = dlg
 dlg.finished.connect(
 line, index, line1, index1 = aw.getSelection()
 offset = self.__getOffset(aw, line, index)
 else:
 offset = None
-from ConfirmationDialog import ConfirmationDialog
+from .ConfirmationDialog import ConfirmationDialog
 dlg = ConfirmationDialog(
 self, title, "Imports", "CalculateImportsChanges", {
 "MethodName": methodName,
 "FileName": filename,
 "Offset": offset,
 def __restructure(self):
 """
 Private slot to restructure code.
 """
-from RestructureDialog import RestructureDialog
+from .RestructureDialog import RestructureDialog
 title = self.tr("Restructure")
 dlg = RestructureDialog(self, title, parent=self.__ui)
 changeGroup = dlg.getChangeGroupName()
 self.__refactoringDialogs[changeGroup] = dlg
 dlg.finished.connect(
 filename = aw.getFileName()
 line, index, line1, index1 = aw.getSelection()
 offset = self.__getOffset(aw, line, index)
-from ChangeSignatureDialog import ChangeSignatureDialog
+from .ChangeSignatureDialog import ChangeSignatureDialog
 dlg = ChangeSignatureDialog(self, title, filename, offset,
 parent=self.__ui)
 changeGroup = dlg.getChangeGroupName()
 self.__refactoringDialogs[changeGroup] = dlg
 dlg.finished.connect(
 filename = aw.getFileName()
 line, index, line1, index1 = aw.getSelection()
 offset = self.__getOffset(aw, line, index)
-from InlineArgumentDefaultDialog import InlineArgumentDefaultDialog
+from .InlineArgumentDefaultDialog import InlineArgumentDefaultDialog
 dlg = InlineArgumentDefaultDialog(self, title, filename, offset,
 parent=self.__ui)
 changeGroup = dlg.getChangeGroupName()
 self.__refactoringDialogs[changeGroup] = dlg
 dlg.finished.connect(
 if not self.confirmAllBuffersSaved():
 return
 filename = aw.getFileName()
-from ConfirmationDialog import ConfirmationDialog
+from .ConfirmationDialog import ConfirmationDialog
 dlg = ConfirmationDialog(
 self, title, "ModuleToPackage", "CalculateModuleToPackageChanges",
 {
 "FileName": filename,
 },
 filename = aw.getFileName()
 line, index, line1, index1 = aw.getSelection()
 offset = self.__getOffset(aw, line, index)
-from GetterSetterDialog import GetterSetterDialog
+from .GetterSetterDialog import GetterSetterDialog
 dlg = GetterSetterDialog(self, title, filename, offset,
 parent=self.__ui)
 changeGroup = dlg.getChangeGroupName()
 self.__refactoringDialogs[changeGroup] = dlg
 dlg.finished.connect(
 filename = aw.getFileName()
 line, index, line1, index1 = aw.getSelection()
 offset = self.__getOffset(aw, line, index)
-from ConfirmationDialog import ConfirmationDialog
+from .ConfirmationDialog import ConfirmationDialog
 dlg = ConfirmationDialog(
 self, title, "LocalToAttribute",
 "CalculateLocalToAttributeChanges", {
 "FileName": filename,
 "Offset": offset,
 filename = aw.getFileName()
 line, index, line1, index1 = aw.getSelection()
 offset = self.__getOffset(aw, line, index)
-from MethodToMethodObjectDialog import MethodToMethodObjectDialog
+from .MethodToMethodObjectDialog import MethodToMethodObjectDialog
 dlg = MethodToMethodObjectDialog(self, title, filename, offset,
 parent=self.__ui)
 changeGroup = dlg.getChangeGroupName()
 self.__refactoringDialogs[changeGroup] = dlg
 dlg.finished.connect(
 Private method to show the project refactoring history.
 """
 if self.__historyDialog is not None:
 self.__historyDialog.close()
-from HistoryDialog import HistoryDialog
+from .HistoryDialog import HistoryDialog
 self.__historyDialog = HistoryDialog(self, parent=self.__ui)
 self.__historyDialog.finished.connect(self.__historyDialogClosed)
 self.__historyDialog.show()
 def __showFileHistory(self):
 return
 if self.__historyDialog is not None:
 self.__historyDialog.close()
-from HistoryDialog import HistoryDialog
+from .HistoryDialog import HistoryDialog
 filename = aw.getFileName()
 if filename:
 self.__historyDialog = HistoryDialog(
 self, filename=filename, parent=self.__ui)
 self.__historyDialog.show()
 @type dict
 """
 if self.handleRopeError(result):
 title = result["Title"]
 if result["EntriesCount"] > 0:
-from MatchesDialog import MatchesDialog
+from .MatchesDialog import MatchesDialog
 self.dlg = MatchesDialog(self.__ui, True)
 self.dlg.show()
 for occurrence in result["Entries"]:
 self.dlg.addEntry(
 # file name, lineno, unsure
 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 (Editor)
+@param editor reference to the calling editor
+@type QScintilla.Editor
 """
 filename = editor.getFileName()
 line, index = editor.getCursorPosition()
 offset = self.__getOffset(editor, line, index)
 if self.handleRopeError(result):
 title = result["Title"]
 if "Location" in result:
 location = result["Location"]
-from MatchesDialog import MatchesDialog
+from .MatchesDialog import MatchesDialog
 self.dlg = MatchesDialog(self.__ui, False)
 self.dlg.show()
 self.dlg.addEntry(location[0], location[1])
 # file name, lineno
 else:
 @type dict
 """
 if self.handleRopeError(result):
 title = result["Title"]
 if result["EntriesCount"] > 0:
-from MatchesDialog import MatchesDialog
+from .MatchesDialog import MatchesDialog
 self.dlg = MatchesDialog(self.__ui, True)
 self.dlg.show()
 for occurrence in result["Entries"]:
 self.dlg.addEntry(
 # file name, lineno, unsure
 def __showRopeHelp(self):
 """
 Private slot to show help about the refactorings offered by Rope.
 """
 if self.__helpDialog is None:
-from HelpDialog import HelpDialog
+from .HelpDialog import HelpDialog
 self.__helpDialog = \
 HelpDialog(self.tr("Help about rope refactorings"),
 self.__ropeConfig["RopeHelpFile"])
 self.__helpDialog.show()
 def __ropeConfigFile(self):
 """
 Private method to get the name of the rope configuration file.
-@return name of the rope configuration file (string)
+@return name of the rope configuration file
+@rtype str
 """
 configfile = None
 if self.__ropeConfig:
 ropedir = self.__ropeConfig["RopeFolderName"]
 if ropedir:
 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)
+configuration
+@rtype str
 """
 if self.__ropeConfig and "DefaultConfig" in self.__ropeConfig:
 return self.__ropeConfig["DefaultConfig"]
 else:
 return ""
 def getActions(self):
 """
 Public method to get a list of all actions.
-@return list of all actions (list of E5Action)
+@return list of all actions
+@rtype list of E5Action
 """
 return self.actions[:]
 def projectOpened(self):
 """
 def confirmBufferIsSaved(self, editor):
 """
 Public method to check, if an editor has unsaved changes.
 @param editor reference to the editor to be checked
+@type QScintilla.Editor
 @return flag indicating, that the editor doesn't contain
-unsaved edits (boolean)
+unsaved edits
+@rtype bool
 """
 res = editor.checkDirty()
 self.sendJson("Validate", {})
 return res
 def confirmAllBuffersSaved(self):
 """
 Public method to check, if any editor has unsaved changes.
 @return flag indicating, that no editor contains unsaved edits
-(boolean)
+@rtype bool
 """
 res = e5App().getObject("ViewManager").checkAllDirty()
 self.sendJson("Validate", {})
 return res

Mercurial Repositories > Rope Refactoring / file comparison

comparison: RefactoringRope/RefactoringServer.py

RefactoringRope/RefactoringServer.py