eric: comparison src/eric7/Project/Project.py

-:2bf743848d2f
+:bd28e56047d7
 from .DebuggerPropertiesFile import DebuggerPropertiesFile
 from Sessions.SessionFile import SessionFile
 from Tasks.TasksFile import TasksFile
+from CodeFormatting.BlackFormattingAction import BlackFormattingAction
 class Project(QObject):
 """
 Class implementing the project management functionality.
 self.makeGrp.setEnabled(
 self.pdata["MAKEPARAMS"]["MakeEnabled"])
 self.menuMakeAct.setEnabled(
 self.pdata["MAKEPARAMS"]["MakeEnabled"])
 self.menuOtherToolsAct.setEnabled(True)
+self.menuFormattingAct.setEnabled(True)
 self.projectAboutToBeCreated.emit()
 hashStr = str(QCryptographicHash.hash(
 QByteArray(self.ppath.encode("utf-8")),
 self.makeGrp.setEnabled(
 self.pdata["MAKEPARAMS"]["MakeEnabled"])
 self.menuMakeAct.setEnabled(
 self.pdata["MAKEPARAMS"]["MakeEnabled"])
 self.menuOtherToolsAct.setEnabled(True)
+self.menuFormattingAct.setEnabled(True)
 # open a project debugger properties file being quiet
 # about errors
 if Preferences.getProject("AutoLoadDbgProperties"):
 self.__readDebugProperties(True)
 self.menuPackagersAct.setEnabled(False)
 self.pluginGrp.setEnabled(False)
 self.makeGrp.setEnabled(False)
 self.menuMakeAct.setEnabled(False)
 self.menuOtherToolsAct.setEnabled(False)
+self.menuFormattingAct.setEnabled(False)
 self.__model.projectClosed()
 self.projectClosedHooks.emit()
 self.projectClosed.emit(shutdown)
 project specific word and exclude list
 """
 pwl = ""
 if self.pdata["SPELLWORDS"]:
 pwl = os.path.join(self.ppath, self.pdata["SPELLWORDS"])
+if not os.path.isfile(pwl):
+pwl = ""
 pel = ""
 if self.pdata["SPELLEXCLUDES"]:
 pel = os.path.join(self.ppath, self.pdata["SPELLEXCLUDES"])
+if not os.path.isfile(pel):
+pel = ""
 return (pwl, pel)
 def getDefaultSourceExtension(self):
 """
 def initActions(self):
 """
 Public slot to initialize the project related actions.
 """
 self.actions = []
+###################################################################
+## Project actions
+###################################################################
 self.actGrp1 = createActionGroup(self)
 act = EricAction(
 self.tr('New project'),
 """<b>Save as</b>"""
 """<p>This saves the current project to a new file.</p>"""
 ))
 self.saveasAct.triggered.connect(self.saveProjectAs)
 self.actions.append(self.saveasAct)
+###################################################################
+## Project management actions
+###################################################################
 self.actGrp2 = createActionGroup(self)
 self.addFilesAct = EricAction(
 self.tr('Add files to project'),
 UI.PixmapCache.getIcon("fileMisc"),
 """ associations. Lexers are used to highlight the editor"""
 """ text.</p>"""
 ))
 self.lexersAct.triggered.connect(self.__showLexerAssociations)
 self.actions.append(self.lexersAct)
+###################################################################
+## Project debug actions
+###################################################################
 self.dbgActGrp = createActionGroup(self)
 act = EricAction(
 self.tr('Debugger Properties'),
 self.tr('Debugger &Properties...'), 0, 0,
 """<p>This resets the project specific debugger settings.</p>"""
 ))
 act.triggered.connect(self.__initDebugProperties)
 self.actions.append(act)
+###################################################################
+## Project session actions
+###################################################################
 self.sessActGrp = createActionGroup(self)
 act = EricAction(
 self.tr('Load session'),
 self.tr('Load session'), 0, 0,
 self.sessActGrp, 'project_load_session')
 act.setStatusTip(self.tr('Load the projects session file.'))
 """<b>Delete session</b>"""
 """<p>This deletes the projects session file</p>"""
 ))
 act.triggered.connect(self.__deleteSession)
 self.actions.append(act)
+###################################################################
+## Project Tools - check actions
+###################################################################
 self.chkGrp = createActionGroup(self)
 self.codeMetricsAct = EricAction(
 self.tr('Code Metrics'),
 """<b>Profile Data...</b>"""
 """<p>This shows the profiling data for the project.</p>"""
 ))
 self.codeProfileAct.triggered.connect(self.__showProfileData)
 self.actions.append(self.codeProfileAct)
+###################################################################
+## Project Tools - graphics actions
+###################################################################
 self.graphicsGrp = createActionGroup(self)
 self.applicationDiagramAct = EricAction(
 self.tr('Application Diagram'),
 """<b>Load Diagram...</b>"""
 """<p>This loads a diagram from file.</p>"""
 ))
 self.loadDiagramAct.triggered.connect(self.__loadDiagram)
 self.actions.append(self.loadDiagramAct)
+###################################################################
+## Project Tools - plugin packaging actions
+###################################################################
 self.pluginGrp = createActionGroup(self)
 self.pluginPkgListAct = EricAction(
 self.tr('Create Package List'),
 UI.PixmapCache.getIcon("pluginArchiveList"),
 self.tr('Create &Package List'), 0, 0,
 self.pluginGrp, 'project_plugin_pkglist')
 """ is modified to reflect a snapshot release.</p>"""
 ))
 self.pluginSArchiveAct.triggered.connect(
 self.__pluginCreateSnapshotArchives)
 self.actions.append(self.pluginSArchiveAct)
+###################################################################
+## Project Tools - make actions
+###################################################################
 self.makeGrp = createActionGroup(self)
 self.makeExecuteAct = EricAction(
 self.tr('Execute Make'),
 ))
 self.makeTestAct.triggered.connect(
 lambda: self.__executeMake(questionOnly=True))
 self.actions.append(self.makeTestAct)
+###################################################################
+## Project Tools - other tools actions
+###################################################################
+self.othersGrp = createActionGroup(self)
 self.createSBOMAct = EricAction(
 self.tr('Create SBOM File'),
 self.tr('Create &SBOM File'), 0, 0,
-self, 'project_create_sbom')
+self.othersGrp, 'project_create_sbom')
 self.createSBOMAct.setStatusTip(
 self.tr("Create a SBOM file of the project dependencies."))
 self.createSBOMAct.setWhatsThis(self.tr(
 """<b>Create SBOM File</b>"""
 """<p>This allows the creation of a SBOM file of the project"""
 """ dependencies. This may be based on various input sources"""
 """ and will be saved as a CycloneDX SBOM file.</p>"""
 ))
 self.createSBOMAct.triggered.connect(self.__createSBOMFile)
 self.actions.append(self.createSBOMAct)
+###################################################################
+## Project Tools - code formatting actions
+###################################################################
+self.blackFormattingGrp = createActionGroup(self)
+self.blackAboutAct = EricAction(
+self.tr("About Black"),
+self.tr("&Black"),
+0, 0,
+self.blackFormattingGrp, "project_black_about"
+)
+self.blackAboutAct.setStatusTip(
+self.tr("Show some information about 'Black'.")
+)
+self.blackAboutAct.setWhatsThis(self.tr(
+"<b>Black</b>"
+"<p>This shows some information about the installed 'Black' tool.</p>"
+))
+self.blackAboutAct.triggered.connect(self.__aboutBlack)
+self.actions.append(self.blackAboutAct)
+font = self.blackAboutAct.font()
+font.setBold(True)
+self.blackAboutAct.setFont(font)
+self.blackFormatAct = EricAction(
+self.tr("Format Code"),
+self.tr("&Format Code"),
+0, 0,
+self.blackFormattingGrp, "project_black_format_code"
+)
+self.blackFormatAct.setStatusTip(
+self.tr("Format the project sources with 'Black'.")
+)
+self.blackFormatAct.setWhatsThis(self.tr(
+"<b>Format Code</b>"
+"<p>This shows a dialog to enter parameters for the formatting run and"
+" reformats the project sources using 'Black'.</p>"
+))
+self.blackFormatAct.triggered.connect(
+lambda: self.__performFormatWithBlack(BlackFormattingAction.Format)
+)
+self.actions.append(self.blackFormatAct)
+self.blackCheckFormattingAct = EricAction(
+self.tr("Check Code Formatting"),
+self.tr("&Check Code Formatting"),
+0, 0,
+self.blackFormattingGrp, "project_black_check_code"
+)
+self.blackCheckFormattingAct.setStatusTip(
+self.tr(
+"Check, if the project sources need to be reformatted with 'Black'."
+)
+)
+self.blackCheckFormattingAct.setWhatsThis(self.tr(
+"<b>Check Code Formatting</b>"
+"<p>This shows a dialog to enter parameters for the format check run and"
+" performs a check, if the project sources need to be reformatted using"
+" 'Black'.</p>"
+))
+self.blackCheckFormattingAct.triggered.connect(
+lambda: self.__performFormatWithBlack(BlackFormattingAction.Check)
+)
+self.actions.append(self.blackCheckFormattingAct)
+self.blackDiffFormattingAct = EricAction(
+self.tr("Code Formatting Diff"),
+self.tr("Code Formatting &Diff"),
+0, 0,
+self.blackFormattingGrp, "project_black_diff_code"
+)
+self.blackDiffFormattingAct.setStatusTip(
+self.tr(
+"Generate a unified diff of potential project source reformatting"
+" with 'Black'."
+)
+)
+self.blackDiffFormattingAct.setWhatsThis(self.tr(
+"<b>Diff Code Formatting</b>"
+"<p>This shows a dialog to enter parameters for the format diff run and"
+" generates a unified diff of potential project source reformatting using"
+" 'Black'.</p>"
+))
+self.blackDiffFormattingAct.triggered.connect(
+lambda: self.__performFormatWithBlack(BlackFormattingAction.Diff)
+)
+self.actions.append(self.blackDiffFormattingAct)
 self.closeAct.setEnabled(False)
 self.saveAct.setEnabled(False)
 self.saveasAct.setEnabled(False)
 self.actGrp2.setEnabled(False)
 self.propsAct.setEnabled(False)
 self.vcsMenu.setTearOffEnabled(True)
 self.vcsProjectHelper.initMenu(self.vcsMenu)
 self.vcsMenu.setEnabled(self.vcsSoftwareAvailable())
 self.checksMenu = QMenu(self.tr('Chec&k'), toolsMenu)
 self.checksMenu.setTearOffEnabled(True)
+self.formattingMenu = QMenu(self.tr("Code &Formatting"), toolsMenu)
+self.formattingMenu.setTearOffEnabled(True)
 self.menuShow = QMenu(self.tr('Sho&w'), toolsMenu)
 self.graphicsMenu = QMenu(self.tr('&Diagrams'), toolsMenu)
 self.packagersMenu = QMenu(self.tr('Pac&kagers'), toolsMenu)
 self.apidocMenu = QMenu(self.tr('Source &Documentation'), toolsMenu)
 self.apidocMenu.setTearOffEnabled(True)
 "Apidoc": self.apidocMenu,
 "Debugger": self.debuggerMenu,
 "Packagers": self.packagersMenu,
 "Make": self.makeMenu,
 "OtherTools": self.othersMenu,
+"Formatting": self.formattingMenu,
 }
 # connect the aboutToShow signals
 self.recentMenu.aboutToShow.connect(self.__showContextMenuRecent)
 self.recentMenu.triggered.connect(self.__openRecent)
 self.packagersMenu.aboutToShow.connect(self.__showContextMenuPackagers)
 self.sessionMenu.aboutToShow.connect(self.__showContextMenuSession)
 self.debuggerMenu.aboutToShow.connect(self.__showContextMenuDebugger)
 self.makeMenu.aboutToShow.connect(self.__showContextMenuMake)
 self.othersMenu.aboutToShow.connect(self.__showContextMenuOthers)
+self.formattingMenu.aboutToShow.connect(self.__showContextMenuFormat)
 menu.aboutToShow.connect(self.__showMenu)
 # build the show menu
 self.menuShow.setTearOffEnabled(True)
 self.menuShow.addAction(self.codeMetricsAct)
 self.makeMenu.addActions(self.makeGrp.actions())
 self.makeMenu.addSeparator()
 # build the 'Other Tools' menu
 self.othersMenu.setTearOffEnabled(True)
-self.othersMenu.addAction(self.createSBOMAct)
+self.othersMenu.addActions(self.othersGrp.actions())
+self.othersMenu.addSeparator()
+# build the 'Code Formatting' menu
+self.formattingMenu.setTearOffEnabled(True)
+self.formattingMenu.addActions(self.blackFormattingGrp.actions())
+self.formattingMenu.addSeparator()
 # build the project main menu
 menu.setTearOffEnabled(True)
 menu.addActions(self.actGrp1.actions())
 self.menuRecentAct = menu.addMenu(self.recentMenu)
 toolsMenu.addSeparator()
 toolsMenu.addMenu(self.vcsMenu)
 toolsMenu.addSeparator()
 self.menuCheckAct = toolsMenu.addMenu(self.checksMenu)
 toolsMenu.addSeparator()
+self.menuFormattingAct = toolsMenu.addMenu(self.formattingMenu)
+toolsMenu.addSeparator()
 self.menuMakeAct = toolsMenu.addMenu(self.makeMenu)
 toolsMenu.addSeparator()
 self.menuDiagramAct = toolsMenu.addMenu(self.graphicsMenu)
 toolsMenu.addSeparator()
 self.menuShowAct = toolsMenu.addMenu(self.menuShow)
 self.menuDebuggerAct.setEnabled(False)
 self.menuApidocAct.setEnabled(False)
 self.menuPackagersAct.setEnabled(False)
 self.menuMakeAct.setEnabled(False)
 self.menuOtherToolsAct.setEnabled(False)
+self.menuFormattingAct.setEnabled(False)
 self.__menu = menu
 self.__toolsMenu = toolsMenu
 return menu, toolsMenu
 return self.pdata["DOCSTRING"]
 #########################################################################
 ## Below are methods implementing the 'SBOM' support
 #########################################################################
 def __showContextMenuOthers(self):
 """
 Private slot called before the 'Other Tools' menu is shown.
 """
 self.showMenu.emit("OtherTools", self.othersMenu)
 Private slot to create a SBOM file of the project dependencies.
 """
 import CycloneDXInterface
 CycloneDXInterface.createCycloneDXFile("<project>")
+#########################################################################
+## Below are methods implementing the 'Code Formatting' support
+#########################################################################
+def __showContextMenuFormat(self):
+"""
+Private slot called before the 'Code Formatting' menu is shown.
+"""
+self.showMenu.emit("Formatting", self.othersMenu)
+@pyqtSlot()
+def __aboutBlack(self):
+"""
+Private slot to show some information about the installed 'Black' tool.
+"""
+import black
+EricMessageBox.information(
+None,
+self.tr("About Black"),
+self.tr("""<p><b>Black Version {0}</b></p>"""
+"""<p><i>Black</i> is the uncompromising Python code"""
+""" formatter.</p>""").format(black.__version__)
+)
+def __performFormatWithBlack(self, action):
+"""
+Private method to format the project sources using the 'Black' tool.
+Following actions are supported.
+<ul>
+<li>BlackFormattingAction.Format - the code reformatting is performed</li>
+<li>BlackFormattingAction.Check - a check is performed, if code formatting
+is necessary</li>
+<li>BlackFormattingAction.Diff - a unified diff of potential code formatting
+changes is generated</li>
+</ul>
+@param action formatting operation to be performed
+@type BlackFormattingAction
+"""
+from CodeFormatting.BlackConfigurationDialog import BlackConfigurationDialog
+from CodeFormatting.BlackFormattingDialog import BlackFormattingDialog
+if ericApp().getObject("ViewManager").checkAllDirty():
+dlg = BlackConfigurationDialog(withProject=True)
+if dlg.exec() == QDialog.DialogCode.Accepted:
+config = dlg.getConfiguration()
+formattingDialog = BlackFormattingDialog(
+config,
+self.getProjectFiles("SOURCES", normalized=True),
+project=self,
+action=action
+)
+formattingDialog.exec()
 #
 # eflag: noqa = M601

Mercurial Repositories > eric / file comparison

comparison: src/eric7/Project/Project.py

src/eric7/Project/Project.py