Mon, 11 Jul 2022 16:47:57 +0200
Updated source documentation.
--- a/eric7.epj Mon Jul 11 16:42:50 2022 +0200 +++ b/eric7.epj Mon Jul 11 16:47:57 2022 +0200 @@ -192,7 +192,7 @@ "Python3" ], "outputFile": "src/eric7/APIs/%L/eric7.api", - "startDirectory": "src", + "startDirectory": "src/eric7", "useRecursion": true }, "ERIC4DOC": { @@ -247,7 +247,7 @@ "qtHelpOutputDirectory": "src/eric7/Documentation/Help", "qtHelpTitle": "The eric7 IDE", "qtHelpVirtualFolder": "eric7", - "startDirectory": "src", + "startDirectory": "src/eric7", "useRecursion": true } },
--- a/src/eric7/APIs/Python3/eric7.api Mon Jul 11 16:42:50 2022 +0200 +++ b/src/eric7/APIs/Python3/eric7.api Mon Jul 11 16:47:57 2022 +0200 @@ -1,3 +1,28 @@ +eric7.CodeFormatting.BlackConfigurationDialog.BlackConfigurationDialog.getConfiguration?4() +eric7.CodeFormatting.BlackConfigurationDialog.BlackConfigurationDialog.on_excludeEdit_textChanged?4() +eric7.CodeFormatting.BlackConfigurationDialog.BlackConfigurationDialog.on_sourceComboBox_currentTextChanged?4(selection) +eric7.CodeFormatting.BlackConfigurationDialog.BlackConfigurationDialog.on_validateButton_clicked?4() +eric7.CodeFormatting.BlackConfigurationDialog.BlackConfigurationDialog?1(withProject=True, parent=None) +eric7.CodeFormatting.BlackDiffWidget.BlackDiffWidget.closeEvent?4(evt) +eric7.CodeFormatting.BlackDiffWidget.BlackDiffWidget.showDiff?4(diff) +eric7.CodeFormatting.BlackDiffWidget.BlackDiffWidget?1(parent=None) +eric7.CodeFormatting.BlackFormattingAction.BlackFormattingAction.Check?7 +eric7.CodeFormatting.BlackFormattingAction.BlackFormattingAction.Diff?7 +eric7.CodeFormatting.BlackFormattingAction.BlackFormattingAction.Format?7 +eric7.CodeFormatting.BlackFormattingDialog.BlackFormattingDialog.DataRole?7 +eric7.CodeFormatting.BlackFormattingDialog.BlackFormattingDialog.DataTypeRole?7 +eric7.CodeFormatting.BlackFormattingDialog.BlackFormattingDialog.addResultEntry?4(status, fileName, isError=False, data=None) +eric7.CodeFormatting.BlackFormattingDialog.BlackFormattingDialog.closeEvent?4(evt) +eric7.CodeFormatting.BlackFormattingDialog.BlackFormattingDialog.on_buttonBox_clicked?4(button) +eric7.CodeFormatting.BlackFormattingDialog.BlackFormattingDialog.on_resultsList_itemDoubleClicked?4(item, column) +eric7.CodeFormatting.BlackFormattingDialog.BlackFormattingDialog?1(configuration, filesList, project=None, action=BlackFormattingAction.Format, parent=None) +eric7.CodeFormatting.BlackFormattingDialog.BlackReport.done?4(src, changed, diff="") +eric7.CodeFormatting.BlackFormattingDialog.BlackReport.failed?4(src, message) +eric7.CodeFormatting.BlackFormattingDialog.BlackReport.path_ignored?4(src, message="") +eric7.CodeFormatting.BlackFormattingDialog.BlackReport?1(dialog) +eric7.CodeFormatting.BlackUtilities.compileRegExp?4(regexp) +eric7.CodeFormatting.BlackUtilities.getDefaultConfiguration?4() +eric7.CodeFormatting.BlackUtilities.validateRegExp?4(regexp) eric7.CondaInterface.Conda.Conda.RootName?7 eric7.CondaInterface.Conda.Conda.cleanConda?4(cleanAction) eric7.CondaInterface.Conda.Conda.condaEnvironmentCreated?7
--- a/src/eric7/APIs/Python3/eric7.bas Mon Jul 11 16:42:50 2022 +0200 +++ b/src/eric7/APIs/Python3/eric7.bas Mon Jul 11 16:47:57 2022 +0200 @@ -39,6 +39,11 @@ AutoScroller QObject BackgroundService QTcpServer BinaryModel QAbstractTableModel +BlackConfigurationDialog QDialog Ui_BlackConfigurationDialog +BlackDiffWidget QWidget Ui_BlackDiffWidget +BlackFormattingAction enum.Enum +BlackFormattingDialog QDialog Ui_BlackFormattingDialog +BlackReport black.Report BoardDataDialog QDialog Ui_BoardDataDialog BookmarkActionSelectionDialog QDialog Ui_BookmarkActionSelectionDialog BookmarkInfoDialog QDialog Ui_BookmarkInfoDialog
--- a/src/eric7/Documentation/Help/source.qhp Mon Jul 11 16:42:50 2022 +0200 +++ b/src/eric7/Documentation/Help/source.qhp Mon Jul 11 16:47:57 2022 +0200 @@ -12,6 +12,13 @@ <toc> <section title="The eric7 IDE" ref="index.html"> <section title="eric7" ref="index-eric7.html"> + <section title="eric7.CodeFormatting" ref="index-eric7.CodeFormatting.html"> + <section title="eric7.CodeFormatting.BlackConfigurationDialog" ref="eric7.CodeFormatting.BlackConfigurationDialog.html" /> + <section title="eric7.CodeFormatting.BlackDiffWidget" ref="eric7.CodeFormatting.BlackDiffWidget.html" /> + <section title="eric7.CodeFormatting.BlackFormattingAction" ref="eric7.CodeFormatting.BlackFormattingAction.html" /> + <section title="eric7.CodeFormatting.BlackFormattingDialog" ref="eric7.CodeFormatting.BlackFormattingDialog.html" /> + <section title="eric7.CodeFormatting.BlackUtilities" ref="eric7.CodeFormatting.BlackUtilities.html" /> + </section> <section title="eric7.CondaInterface" ref="index-eric7.CondaInterface.html"> <section title="eric7.CondaInterface.Conda" ref="eric7.CondaInterface.Conda.html" /> <section title="eric7.CondaInterface.CondaExecDialog" ref="eric7.CondaInterface.CondaExecDialog.html" /> @@ -2032,6 +2039,44 @@ <keyword name="BinaryModel.setBitsAndValue" id="BinaryModel.setBitsAndValue" ref="eric7.UI.NumbersWidget.html#BinaryModel.setBitsAndValue" /> <keyword name="BinaryModel.setData" id="BinaryModel.setData" ref="eric7.UI.NumbersWidget.html#BinaryModel.setData" /> <keyword name="BinaryModel.setValue" id="BinaryModel.setValue" ref="eric7.UI.NumbersWidget.html#BinaryModel.setValue" /> + <keyword name="BlackConfigurationDialog" id="BlackConfigurationDialog" ref="eric7.CodeFormatting.BlackConfigurationDialog.html#BlackConfigurationDialog" /> + <keyword name="BlackConfigurationDialog (Constructor)" id="BlackConfigurationDialog (Constructor)" ref="eric7.CodeFormatting.BlackConfigurationDialog.html#BlackConfigurationDialog.__init__" /> + <keyword name="BlackConfigurationDialog (Module)" id="BlackConfigurationDialog (Module)" ref="eric7.CodeFormatting.BlackConfigurationDialog.html" /> + <keyword name="BlackConfigurationDialog.__createTomlSnippet" id="BlackConfigurationDialog.__createTomlSnippet" ref="eric7.CodeFormatting.BlackConfigurationDialog.html#BlackConfigurationDialog.__createTomlSnippet" /> + <keyword name="BlackConfigurationDialog.__getTargetList" id="BlackConfigurationDialog.__getTargetList" ref="eric7.CodeFormatting.BlackConfigurationDialog.html#BlackConfigurationDialog.__getTargetList" /> + <keyword name="BlackConfigurationDialog.__loadConfiguration" id="BlackConfigurationDialog.__loadConfiguration" ref="eric7.CodeFormatting.BlackConfigurationDialog.html#BlackConfigurationDialog.__loadConfiguration" /> + <keyword name="BlackConfigurationDialog.__populateTargetVersionsList" id="BlackConfigurationDialog.__populateTargetVersionsList" ref="eric7.CodeFormatting.BlackConfigurationDialog.html#BlackConfigurationDialog.__populateTargetVersionsList" /> + <keyword name="BlackConfigurationDialog.getConfiguration" id="BlackConfigurationDialog.getConfiguration" ref="eric7.CodeFormatting.BlackConfigurationDialog.html#BlackConfigurationDialog.getConfiguration" /> + <keyword name="BlackConfigurationDialog.on_excludeEdit_textChanged" id="BlackConfigurationDialog.on_excludeEdit_textChanged" ref="eric7.CodeFormatting.BlackConfigurationDialog.html#BlackConfigurationDialog.on_excludeEdit_textChanged" /> + <keyword name="BlackConfigurationDialog.on_sourceComboBox_currentTextChanged" id="BlackConfigurationDialog.on_sourceComboBox_currentTextChanged" ref="eric7.CodeFormatting.BlackConfigurationDialog.html#BlackConfigurationDialog.on_sourceComboBox_currentTextChanged" /> + <keyword name="BlackConfigurationDialog.on_validateButton_clicked" id="BlackConfigurationDialog.on_validateButton_clicked" ref="eric7.CodeFormatting.BlackConfigurationDialog.html#BlackConfigurationDialog.on_validateButton_clicked" /> + <keyword name="BlackDiffWidget" id="BlackDiffWidget" ref="eric7.CodeFormatting.BlackDiffWidget.html#BlackDiffWidget" /> + <keyword name="BlackDiffWidget (Constructor)" id="BlackDiffWidget (Constructor)" ref="eric7.CodeFormatting.BlackDiffWidget.html#BlackDiffWidget.__init__" /> + <keyword name="BlackDiffWidget (Module)" id="BlackDiffWidget (Module)" ref="eric7.CodeFormatting.BlackDiffWidget.html" /> + <keyword name="BlackDiffWidget.closeEvent" id="BlackDiffWidget.closeEvent" ref="eric7.CodeFormatting.BlackDiffWidget.html#BlackDiffWidget.closeEvent" /> + <keyword name="BlackDiffWidget.showDiff" id="BlackDiffWidget.showDiff" ref="eric7.CodeFormatting.BlackDiffWidget.html#BlackDiffWidget.showDiff" /> + <keyword name="BlackFormattingAction" id="BlackFormattingAction" ref="eric7.CodeFormatting.BlackFormattingAction.html#BlackFormattingAction" /> + <keyword name="BlackFormattingAction (Module)" id="BlackFormattingAction (Module)" ref="eric7.CodeFormatting.BlackFormattingAction.html" /> + <keyword name="BlackFormattingDialog" id="BlackFormattingDialog" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackFormattingDialog" /> + <keyword name="BlackFormattingDialog (Constructor)" id="BlackFormattingDialog (Constructor)" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackFormattingDialog.__init__" /> + <keyword name="BlackFormattingDialog (Module)" id="BlackFormattingDialog (Module)" ref="eric7.CodeFormatting.BlackFormattingDialog.html" /> + <keyword name="BlackFormattingDialog.__diffFormatFile" id="BlackFormattingDialog.__diffFormatFile" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackFormattingDialog.__diffFormatFile" /> + <keyword name="BlackFormattingDialog.__filterFiles" id="BlackFormattingDialog.__filterFiles" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackFormattingDialog.__filterFiles" /> + <keyword name="BlackFormattingDialog.__finish" id="BlackFormattingDialog.__finish" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackFormattingDialog.__finish" /> + <keyword name="BlackFormattingDialog.__formatFiles" id="BlackFormattingDialog.__formatFiles" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackFormattingDialog.__formatFiles" /> + <keyword name="BlackFormattingDialog.__resizeColumns" id="BlackFormattingDialog.__resizeColumns" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackFormattingDialog.__resizeColumns" /> + <keyword name="BlackFormattingDialog.__resort" id="BlackFormattingDialog.__resort" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackFormattingDialog.__resort" /> + <keyword name="BlackFormattingDialog.__updateStatistics" id="BlackFormattingDialog.__updateStatistics" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackFormattingDialog.__updateStatistics" /> + <keyword name="BlackFormattingDialog.addResultEntry" id="BlackFormattingDialog.addResultEntry" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackFormattingDialog.addResultEntry" /> + <keyword name="BlackFormattingDialog.closeEvent" id="BlackFormattingDialog.closeEvent" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackFormattingDialog.closeEvent" /> + <keyword name="BlackFormattingDialog.on_buttonBox_clicked" id="BlackFormattingDialog.on_buttonBox_clicked" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackFormattingDialog.on_buttonBox_clicked" /> + <keyword name="BlackFormattingDialog.on_resultsList_itemDoubleClicked" id="BlackFormattingDialog.on_resultsList_itemDoubleClicked" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackFormattingDialog.on_resultsList_itemDoubleClicked" /> + <keyword name="BlackReport" id="BlackReport" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackReport" /> + <keyword name="BlackReport (Constructor)" id="BlackReport (Constructor)" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackReport.__init__" /> + <keyword name="BlackReport.done" id="BlackReport.done" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackReport.done" /> + <keyword name="BlackReport.failed" id="BlackReport.failed" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackReport.failed" /> + <keyword name="BlackReport.path_ignored" id="BlackReport.path_ignored" ref="eric7.CodeFormatting.BlackFormattingDialog.html#BlackReport.path_ignored" /> + <keyword name="BlackUtilities (Module)" id="BlackUtilities (Module)" ref="eric7.CodeFormatting.BlackUtilities.html" /> <keyword name="BoardDataDialog" id="BoardDataDialog" ref="eric7.MicroPython.BoardDataDialog.html#BoardDataDialog" /> <keyword name="BoardDataDialog (Constructor)" id="BoardDataDialog (Constructor)" ref="eric7.MicroPython.BoardDataDialog.html#BoardDataDialog.__init__" /> <keyword name="BoardDataDialog (Module)" id="BoardDataDialog (Module)" ref="eric7.MicroPython.BoardDataDialog.html" /> @@ -2682,6 +2727,7 @@ <keyword name="CodeDocumentationViewer.shutdown" id="CodeDocumentationViewer.shutdown" ref="eric7.UI.CodeDocumentationViewer.html#CodeDocumentationViewer.shutdown" /> <keyword name="CodeDocumentationViewer.unregisterProvider" id="CodeDocumentationViewer.unregisterProvider" ref="eric7.UI.CodeDocumentationViewer.html#CodeDocumentationViewer.unregisterProvider" /> <keyword name="CodeDocumentationViewerTemplate (Module)" id="CodeDocumentationViewerTemplate (Module)" ref="eric7.UI.CodeDocumentationViewerTemplate.html" /> + <keyword name="CodeFormatting (Package)" id="CodeFormatting (Package)" ref="index-eric7.CodeFormatting.html" /> <keyword name="CodeMetrics (Module)" id="CodeMetrics (Module)" ref="eric7.DataViews.CodeMetrics.html" /> <keyword name="CodeMetricsDialog" id="CodeMetricsDialog" ref="eric7.DataViews.CodeMetricsDialog.html#CodeMetricsDialog" /> <keyword name="CodeMetricsDialog (Constructor)" id="CodeMetricsDialog (Constructor)" ref="eric7.DataViews.CodeMetricsDialog.html#CodeMetricsDialog.__init__" /> @@ -4128,6 +4174,7 @@ <keyword name="Editor.__initContextMenuChecks" id="Editor.__initContextMenuChecks" ref="eric7.QScintilla.Editor.html#Editor.__initContextMenuChecks" /> <keyword name="Editor.__initContextMenuEncodings" id="Editor.__initContextMenuEncodings" ref="eric7.QScintilla.Editor.html#Editor.__initContextMenuEncodings" /> <keyword name="Editor.__initContextMenuEol" id="Editor.__initContextMenuEol" ref="eric7.QScintilla.Editor.html#Editor.__initContextMenuEol" /> + <keyword name="Editor.__initContextMenuFormatting" id="Editor.__initContextMenuFormatting" ref="eric7.QScintilla.Editor.html#Editor.__initContextMenuFormatting" /> <keyword name="Editor.__initContextMenuGraphics" id="Editor.__initContextMenuGraphics" ref="eric7.QScintilla.Editor.html#Editor.__initContextMenuGraphics" /> <keyword name="Editor.__initContextMenuLanguages" id="Editor.__initContextMenuLanguages" ref="eric7.QScintilla.Editor.html#Editor.__initContextMenuLanguages" /> <keyword name="Editor.__initContextMenuMargins" id="Editor.__initContextMenuMargins" ref="eric7.QScintilla.Editor.html#Editor.__initContextMenuMargins" /> @@ -4162,6 +4209,7 @@ <keyword name="Editor.__newViewNewSplit" id="Editor.__newViewNewSplit" ref="eric7.QScintilla.Editor.html#Editor.__newViewNewSplit" /> <keyword name="Editor.__normalizedEncoding" id="Editor.__normalizedEncoding" ref="eric7.QScintilla.Editor.html#Editor.__normalizedEncoding" /> <keyword name="Editor.__onlineChangeTraceTimerTimeout" id="Editor.__onlineChangeTraceTimerTimeout" ref="eric7.QScintilla.Editor.html#Editor.__onlineChangeTraceTimerTimeout" /> + <keyword name="Editor.__performFormatWithBlack" id="Editor.__performFormatWithBlack" ref="eric7.QScintilla.Editor.html#Editor.__performFormatWithBlack" /> <keyword name="Editor.__popupDocstringMenu" id="Editor.__popupDocstringMenu" ref="eric7.QScintilla.Editor.html#Editor.__popupDocstringMenu" /> <keyword name="Editor.__printPreview" id="Editor.__printPreview" ref="eric7.QScintilla.Editor.html#Editor.__printPreview" /> <keyword name="Editor.__processEndEditCommand" id="Editor.__processEndEditCommand" ref="eric7.QScintilla.Editor.html#Editor.__processEndEditCommand" /> @@ -4213,6 +4261,7 @@ <keyword name="Editor.__showContextMenuChecks" id="Editor.__showContextMenuChecks" ref="eric7.QScintilla.Editor.html#Editor.__showContextMenuChecks" /> <keyword name="Editor.__showContextMenuEncodings" id="Editor.__showContextMenuEncodings" ref="eric7.QScintilla.Editor.html#Editor.__showContextMenuEncodings" /> <keyword name="Editor.__showContextMenuEol" id="Editor.__showContextMenuEol" ref="eric7.QScintilla.Editor.html#Editor.__showContextMenuEol" /> + <keyword name="Editor.__showContextMenuFormatting" id="Editor.__showContextMenuFormatting" ref="eric7.QScintilla.Editor.html#Editor.__showContextMenuFormatting" /> <keyword name="Editor.__showContextMenuGraphics" id="Editor.__showContextMenuGraphics" ref="eric7.QScintilla.Editor.html#Editor.__showContextMenuGraphics" /> <keyword name="Editor.__showContextMenuLanguages" id="Editor.__showContextMenuLanguages" ref="eric7.QScintilla.Editor.html#Editor.__showContextMenuLanguages" /> <keyword name="Editor.__showContextMenuMargin" id="Editor.__showContextMenuMargin" ref="eric7.QScintilla.Editor.html#Editor.__showContextMenuMargin" /> @@ -11845,6 +11894,7 @@ <keyword name="Project (Constructor)" id="Project (Constructor)" ref="eric7.Project.Project.html#Project.__init__" /> <keyword name="Project (Module)" id="Project (Module)" ref="eric7.Project.Project.html" /> <keyword name="Project (Package)" id="Project (Package)" ref="index-eric7.Project.html" /> + <keyword name="Project.__aboutBlack" id="Project.__aboutBlack" ref="eric7.Project.Project.html#Project.__aboutBlack" /> <keyword name="Project.__addRecursiveDirectory" id="Project.__addRecursiveDirectory" ref="eric7.Project.Project.html#Project.__addRecursiveDirectory" /> <keyword name="Project.__addSingleDirectory" id="Project.__addSingleDirectory" ref="eric7.Project.Project.html#Project.__addSingleDirectory" /> <keyword name="Project.__binaryTranslationFile" id="Project.__binaryTranslationFile" ref="eric7.Project.Project.html#Project.__binaryTranslationFile" /> @@ -11869,6 +11919,7 @@ <keyword name="Project.__makeReadStdErr" id="Project.__makeReadStdErr" ref="eric7.Project.Project.html#Project.__makeReadStdErr" /> <keyword name="Project.__makeReadStdOut" id="Project.__makeReadStdOut" ref="eric7.Project.Project.html#Project.__makeReadStdOut" /> <keyword name="Project.__openRecent" id="Project.__openRecent" ref="eric7.Project.Project.html#Project.__openRecent" /> + <keyword name="Project.__performFormatWithBlack" id="Project.__performFormatWithBlack" ref="eric7.Project.Project.html#Project.__performFormatWithBlack" /> <keyword name="Project.__pluginCreateArchives" id="Project.__pluginCreateArchives" ref="eric7.Project.Project.html#Project.__pluginCreateArchives" /> <keyword name="Project.__pluginCreatePkgList" id="Project.__pluginCreatePkgList" ref="eric7.Project.Project.html#Project.__pluginCreatePkgList" /> <keyword name="Project.__pluginCreateSnapshotArchives" id="Project.__pluginCreateSnapshotArchives" ref="eric7.Project.Project.html#Project.__pluginCreateSnapshotArchives" /> @@ -11888,6 +11939,7 @@ <keyword name="Project.__showContextMenuApiDoc" id="Project.__showContextMenuApiDoc" ref="eric7.Project.Project.html#Project.__showContextMenuApiDoc" /> <keyword name="Project.__showContextMenuChecks" id="Project.__showContextMenuChecks" ref="eric7.Project.Project.html#Project.__showContextMenuChecks" /> <keyword name="Project.__showContextMenuDebugger" id="Project.__showContextMenuDebugger" ref="eric7.Project.Project.html#Project.__showContextMenuDebugger" /> + <keyword name="Project.__showContextMenuFormat" id="Project.__showContextMenuFormat" ref="eric7.Project.Project.html#Project.__showContextMenuFormat" /> <keyword name="Project.__showContextMenuGraphics" id="Project.__showContextMenuGraphics" ref="eric7.Project.Project.html#Project.__showContextMenuGraphics" /> <keyword name="Project.__showContextMenuMake" id="Project.__showContextMenuMake" ref="eric7.Project.Project.html#Project.__showContextMenuMake" /> <keyword name="Project.__showContextMenuOthers" id="Project.__showContextMenuOthers" ref="eric7.Project.Project.html#Project.__showContextMenuOthers" /> @@ -12360,6 +12412,7 @@ <keyword name="ProjectSourcesBrowser.__createRubyPopupMenus" id="ProjectSourcesBrowser.__createRubyPopupMenus" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__createRubyPopupMenus" /> <keyword name="ProjectSourcesBrowser.__deleteFile" id="ProjectSourcesBrowser.__deleteFile" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__deleteFile" /> <keyword name="ProjectSourcesBrowser.__loadDiagram" id="ProjectSourcesBrowser.__loadDiagram" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__loadDiagram" /> + <keyword name="ProjectSourcesBrowser.__performFormatWithBlack" id="ProjectSourcesBrowser.__performFormatWithBlack" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__performFormatWithBlack" /> <keyword name="ProjectSourcesBrowser.__showApplicationDiagram" id="ProjectSourcesBrowser.__showApplicationDiagram" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__showApplicationDiagram" /> <keyword name="ProjectSourcesBrowser.__showClassDiagram" id="ProjectSourcesBrowser.__showClassDiagram" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__showClassDiagram" /> <keyword name="ProjectSourcesBrowser.__showCodeCoverage" id="ProjectSourcesBrowser.__showCodeCoverage" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__showCodeCoverage" /> @@ -12369,6 +12422,7 @@ <keyword name="ProjectSourcesBrowser.__showContextMenuCheck" id="ProjectSourcesBrowser.__showContextMenuCheck" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__showContextMenuCheck" /> <keyword name="ProjectSourcesBrowser.__showContextMenuDir" id="ProjectSourcesBrowser.__showContextMenuDir" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__showContextMenuDir" /> <keyword name="ProjectSourcesBrowser.__showContextMenuDirMulti" id="ProjectSourcesBrowser.__showContextMenuDirMulti" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__showContextMenuDirMulti" /> + <keyword name="ProjectSourcesBrowser.__showContextMenuFormatting" id="ProjectSourcesBrowser.__showContextMenuFormatting" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__showContextMenuFormatting" /> <keyword name="ProjectSourcesBrowser.__showContextMenuGraphics" id="ProjectSourcesBrowser.__showContextMenuGraphics" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__showContextMenuGraphics" /> <keyword name="ProjectSourcesBrowser.__showContextMenuMulti" id="ProjectSourcesBrowser.__showContextMenuMulti" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__showContextMenuMulti" /> <keyword name="ProjectSourcesBrowser.__showContextMenuShow" id="ProjectSourcesBrowser.__showContextMenuShow" ref="eric7.Project.ProjectSourcesBrowser.html#ProjectSourcesBrowser.__showContextMenuShow" /> @@ -18294,6 +18348,7 @@ <keyword name="comparison_negative" id="comparison_negative" ref="eric7.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#comparison_negative" /> <keyword name="comparison_to_singleton" id="comparison_to_singleton" ref="eric7.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#comparison_to_singleton" /> <keyword name="comparison_type" id="comparison_type" ref="eric7.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#comparison_type" /> + <keyword name="compileRegExp" id="compileRegExp" ref="eric7.CodeFormatting.BlackUtilities.html#compileRegExp" /> <keyword name="compileUiFiles" id="compileUiFiles" ref="eric7.Utilities.uic.html#compileUiFiles" /> <keyword name="completeFormData" id="completeFormData" ref="eric7.WebBrowser.Tools.Scripts.html#completeFormData" /> <keyword name="composeCallPath" id="composeCallPath" ref="eric7.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#composeCallPath" /> @@ -18589,6 +18644,7 @@ <keyword name="getCoverageFileName" id="getCoverageFileName" ref="eric7.Utilities.__init__.html#getCoverageFileName" /> <keyword name="getCoverageFileNames" id="getCoverageFileNames" ref="eric7.Utilities.__init__.html#getCoverageFileNames" /> <keyword name="getDebugger" id="getDebugger" ref="eric7.Preferences.__init__.html#getDebugger" /> + <keyword name="getDefaultConfiguration" id="getDefaultConfiguration" ref="eric7.CodeFormatting.BlackUtilities.html#getDefaultConfiguration" /> <keyword name="getDefaultIconPaths" id="getDefaultIconPaths" ref="eric7.Toolbox.Startup.html#getDefaultIconPaths" /> <keyword name="getDefaultLexerAssociations" id="getDefaultLexerAssociations" ref="eric7.QScintilla.Lexers.__init__.html#getDefaultLexerAssociations" /> <keyword name="getDefaults" id="getDefaults" ref="eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.__init__.html#getDefaults" /> @@ -19171,6 +19227,7 @@ <keyword name="usage" id="usage" ref="eric7.eric7_api.html#usage" /> <keyword name="usage" id="usage" ref="eric7.eric7_doc.html#usage" /> <keyword name="userConfiguration" id="userConfiguration" ref="eric7.CondaInterface.__init__.html#userConfiguration" /> + <keyword name="validateRegExp" id="validateRegExp" ref="eric7.CodeFormatting.BlackUtilities.html#validateRegExp" /> <keyword name="value_to_enum_key" id="value_to_enum_key" ref="eric7.PipInterface.piplicenses.html#value_to_enum_key" /> <keyword name="vcsGit (Package)" id="vcsGit (Package)" ref="index-eric7.Plugins.VcsPlugins.vcsGit.html" /> <keyword name="vcsMercurial (Package)" id="vcsMercurial (Package)" ref="index-eric7.Plugins.VcsPlugins.vcsMercurial.html" /> @@ -19209,6 +19266,11 @@ <keyword name="yesNo" id="yesNo" ref="eric7.EricWidgets.EricMessageBox.html#yesNo" /> </keywords> <files> + <file>eric7.CodeFormatting.BlackConfigurationDialog.html</file> + <file>eric7.CodeFormatting.BlackDiffWidget.html</file> + <file>eric7.CodeFormatting.BlackFormattingAction.html</file> + <file>eric7.CodeFormatting.BlackFormattingDialog.html</file> + <file>eric7.CodeFormatting.BlackUtilities.html</file> <file>eric7.CondaInterface.Conda.html</file> <file>eric7.CondaInterface.CondaExecDialog.html</file> <file>eric7.CondaInterface.CondaExportDialog.html</file> @@ -20360,6 +20422,7 @@ <file>eric7.eric7_uipreviewer.html</file> <file>eric7.eric7_virtualenv.html</file> <file>eric7.eric7config.html</file> + <file>index-eric7.CodeFormatting.html</file> <file>index-eric7.CondaInterface.html</file> <file>index-eric7.Cooperation.html</file> <file>index-eric7.CycloneDXInterface.html</file>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.CodeFormatting.BlackConfigurationDialog.html Mon Jul 11 16:47:57 2022 +0200 @@ -0,0 +1,224 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.CodeFormatting.BlackConfigurationDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.CodeFormatting.BlackConfigurationDialog</h1> + +<p> +Module implementing a dialog to enter the parameters for a Black formatting run. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#BlackConfigurationDialog">BlackConfigurationDialog</a></td> +<td>Class implementing a dialog to enter the parameters for a Black formatting run.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="BlackConfigurationDialog" ID="BlackConfigurationDialog"></a> +<h2>BlackConfigurationDialog</h2> + +<p> + Class implementing a dialog to enter the parameters for a Black formatting run. +</p> +<h3>Derived from</h3> +QDialog, Ui_BlackConfigurationDialog +<h3>Class Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#BlackConfigurationDialog.__init__">BlackConfigurationDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#BlackConfigurationDialog.__createTomlSnippet">__createTomlSnippet</a></td> +<td>Private slot to generate a TOML snippet of the current configuration.</td> +</tr> +<tr> +<td><a href="#BlackConfigurationDialog.__getTargetList">__getTargetList</a></td> +<td>Private method to get the list of checked target versions.</td> +</tr> +<tr> +<td><a href="#BlackConfigurationDialog.__loadConfiguration">__loadConfiguration</a></td> +<td>Private method to load the configuration section with data of the given dictionary.</td> +</tr> +<tr> +<td><a href="#BlackConfigurationDialog.__populateTargetVersionsList">__populateTargetVersionsList</a></td> +<td>Private method to populate the target versions list widget with checkable Python version entries.</td> +</tr> +<tr> +<td><a href="#BlackConfigurationDialog.getConfiguration">getConfiguration</a></td> +<td>Public method to get the current configuration parameters.</td> +</tr> +<tr> +<td><a href="#BlackConfigurationDialog.on_excludeEdit_textChanged">on_excludeEdit_textChanged</a></td> +<td>Private slot to enable the validate button depending on the exclude text.</td> +</tr> +<tr> +<td><a href="#BlackConfigurationDialog.on_sourceComboBox_currentTextChanged">on_sourceComboBox_currentTextChanged</a></td> +<td>Private slot to handle the selection of a configuration source.</td> +</tr> +<tr> +<td><a href="#BlackConfigurationDialog.on_validateButton_clicked">on_validateButton_clicked</a></td> +<td>Private slot to validate the entered exclusion regular expression.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="BlackConfigurationDialog.__init__" ID="BlackConfigurationDialog.__init__"></a> +<h4>BlackConfigurationDialog (Constructor)</h4> +<b>BlackConfigurationDialog</b>(<i>withProject=True, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>withProject</i> (bool)</dt> +<dd> +flag indicating to look for project configurations + (defaults to True) +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="BlackConfigurationDialog.__createTomlSnippet" ID="BlackConfigurationDialog.__createTomlSnippet"></a> +<h4>BlackConfigurationDialog.__createTomlSnippet</h4> +<b>__createTomlSnippet</b>(<i></i>) + +<p> + Private slot to generate a TOML snippet of the current configuration. +</p> +<p> + Note: Only non-default values are included in this snippet. +</p> +<p> + The code snippet is copied to the clipboard and may be placed inside the + 'pyproject.toml' file. +</p> +<a NAME="BlackConfigurationDialog.__getTargetList" ID="BlackConfigurationDialog.__getTargetList"></a> +<h4>BlackConfigurationDialog.__getTargetList</h4> +<b>__getTargetList</b>(<i></i>) + +<p> + Private method to get the list of checked target versions. +</p> +<dl> +<dt>Return:</dt> +<dd> +list of target versions +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> +<a NAME="BlackConfigurationDialog.__loadConfiguration" ID="BlackConfigurationDialog.__loadConfiguration"></a> +<h4>BlackConfigurationDialog.__loadConfiguration</h4> +<b>__loadConfiguration</b>(<i>configurationDict</i>) + +<p> + Private method to load the configuration section with data of the given + dictionary. +</p> +<dl> + +<dt><i>configurationDict</i> (dict)</dt> +<dd> +reference to the data to be loaded +</dd> +</dl> +<a NAME="BlackConfigurationDialog.__populateTargetVersionsList" ID="BlackConfigurationDialog.__populateTargetVersionsList"></a> +<h4>BlackConfigurationDialog.__populateTargetVersionsList</h4> +<b>__populateTargetVersionsList</b>(<i></i>) + +<p> + Private method to populate the target versions list widget with checkable + Python version entries. +</p> +<a NAME="BlackConfigurationDialog.getConfiguration" ID="BlackConfigurationDialog.getConfiguration"></a> +<h4>BlackConfigurationDialog.getConfiguration</h4> +<b>getConfiguration</b>(<i></i>) + +<p> + Public method to get the current configuration parameters. +</p> +<dl> +<dt>Return:</dt> +<dd> +dictionary containing the configuration parameters +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<a NAME="BlackConfigurationDialog.on_excludeEdit_textChanged" ID="BlackConfigurationDialog.on_excludeEdit_textChanged"></a> +<h4>BlackConfigurationDialog.on_excludeEdit_textChanged</h4> +<b>on_excludeEdit_textChanged</b>(<i></i>) + +<p> + Private slot to enable the validate button depending on the exclude text. +</p> +<a NAME="BlackConfigurationDialog.on_sourceComboBox_currentTextChanged" ID="BlackConfigurationDialog.on_sourceComboBox_currentTextChanged"></a> +<h4>BlackConfigurationDialog.on_sourceComboBox_currentTextChanged</h4> +<b>on_sourceComboBox_currentTextChanged</b>(<i>selection</i>) + +<p> + Private slot to handle the selection of a configuration source. +</p> +<dl> + +<dt><i>selection</i> (str)</dt> +<dd> +text of the currently selected item +</dd> +</dl> +<a NAME="BlackConfigurationDialog.on_validateButton_clicked" ID="BlackConfigurationDialog.on_validateButton_clicked"></a> +<h4>BlackConfigurationDialog.on_validateButton_clicked</h4> +<b>on_validateButton_clicked</b>(<i></i>) + +<p> + Private slot to validate the entered exclusion regular expression. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.CodeFormatting.BlackDiffWidget.html Mon Jul 11 16:47:57 2022 +0200 @@ -0,0 +1,120 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.CodeFormatting.BlackDiffWidget</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.CodeFormatting.BlackDiffWidget</h1> + +<p> +Module implementing a window to show a unified diff.. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#BlackDiffWidget">BlackDiffWidget</a></td> +<td>Class implementing a window to show a unified diff..</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="BlackDiffWidget" ID="BlackDiffWidget"></a> +<h2>BlackDiffWidget</h2> + +<p> + Class implementing a window to show a unified diff.. +</p> +<h3>Derived from</h3> +QWidget, Ui_BlackDiffWidget +<h3>Class Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#BlackDiffWidget.__init__">BlackDiffWidget</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#BlackDiffWidget.closeEvent">closeEvent</a></td> +<td>Protected slot implementing a close event handler.</td> +</tr> +<tr> +<td><a href="#BlackDiffWidget.showDiff">showDiff</a></td> +<td>Public method to show the given diff.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="BlackDiffWidget.__init__" ID="BlackDiffWidget.__init__"></a> +<h4>BlackDiffWidget (Constructor)</h4> +<b>BlackDiffWidget</b>(<i>parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="BlackDiffWidget.closeEvent" ID="BlackDiffWidget.closeEvent"></a> +<h4>BlackDiffWidget.closeEvent</h4> +<b>closeEvent</b>(<i>evt</i>) + +<p> + Protected slot implementing a close event handler. +</p> +<dl> + +<dt><i>evt</i> (QCloseEvent)</dt> +<dd> +reference to the close event +</dd> +</dl> +<a NAME="BlackDiffWidget.showDiff" ID="BlackDiffWidget.showDiff"></a> +<h4>BlackDiffWidget.showDiff</h4> +<b>showDiff</b>(<i>diff</i>) + +<p> + Public method to show the given diff. +</p> +<dl> + +<dt><i>diff</i> (str)</dt> +<dd> +text containing the unified diff +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.CodeFormatting.BlackFormattingAction.html Mon Jul 11 16:47:57 2022 +0200 @@ -0,0 +1,66 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.CodeFormatting.BlackFormattingAction</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.CodeFormatting.BlackFormattingAction</h1> + +<p> +Module implementing an enum defining the various code formatting actions. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#BlackFormattingAction">BlackFormattingAction</a></td> +<td>Class defining the various code formatting actions.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="BlackFormattingAction" ID="BlackFormattingAction"></a> +<h2>BlackFormattingAction</h2> + +<p> + Class defining the various code formatting actions. +</p> +<h3>Derived from</h3> +enum.Enum +<h3>Class Attributes</h3> + +<table> +<tr><td>Check</td></tr><tr><td>Diff</td></tr><tr><td>Format</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.CodeFormatting.BlackFormattingDialog.html Mon Jul 11 16:47:57 2022 +0200 @@ -0,0 +1,430 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.CodeFormatting.BlackFormattingDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.CodeFormatting.BlackFormattingDialog</h1> + +<p> +Module implementing a dialog showing the code formatting progress and the result. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#BlackFormattingDialog">BlackFormattingDialog</a></td> +<td>Class implementing a dialog showing the code formatting progress and the result.</td> +</tr> +<tr> +<td><a href="#BlackReport">BlackReport</a></td> +<td>Class extending the black Report to work with our dialog.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="BlackFormattingDialog" ID="BlackFormattingDialog"></a> +<h2>BlackFormattingDialog</h2> + +<p> + Class implementing a dialog showing the code formatting progress and the result. +</p> +<h3>Derived from</h3> +QDialog, Ui_BlackFormattingDialog +<h3>Class Attributes</h3> + +<table> +<tr><td>DataRole</td></tr><tr><td>DataTypeRole</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#BlackFormattingDialog.__init__">BlackFormattingDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#BlackFormattingDialog.__diffFormatFile">__diffFormatFile</a></td> +<td>Private method to check, if the given files need to be reformatted, and generate a unified diff.</td> +</tr> +<tr> +<td><a href="#BlackFormattingDialog.__filterFiles">__filterFiles</a></td> +<td>Private method to filter the given list of files according the configuration parameters.</td> +</tr> +<tr> +<td><a href="#BlackFormattingDialog.__finish">__finish</a></td> +<td>Private method to perform some actions after the run was performed or canceled.</td> +</tr> +<tr> +<td><a href="#BlackFormattingDialog.__formatFiles">__formatFiles</a></td> +<td>Private method to format the list of files according the configuration.</td> +</tr> +<tr> +<td><a href="#BlackFormattingDialog.__resizeColumns">__resizeColumns</a></td> +<td>Private method to resize the columns of the result list.</td> +</tr> +<tr> +<td><a href="#BlackFormattingDialog.__resort">__resort</a></td> +<td>Private method to resort the result list.</td> +</tr> +<tr> +<td><a href="#BlackFormattingDialog.__updateStatistics">__updateStatistics</a></td> +<td>Private method to update the statistics about the recent formatting run.</td> +</tr> +<tr> +<td><a href="#BlackFormattingDialog.addResultEntry">addResultEntry</a></td> +<td>Public method to add an entry to the result list.</td> +</tr> +<tr> +<td><a href="#BlackFormattingDialog.closeEvent">closeEvent</a></td> +<td>Protected slot implementing a close event handler.</td> +</tr> +<tr> +<td><a href="#BlackFormattingDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot to handle button presses of the dialog buttons.</td> +</tr> +<tr> +<td><a href="#BlackFormattingDialog.on_resultsList_itemDoubleClicked">on_resultsList_itemDoubleClicked</a></td> +<td>Private slot handling a double click of a result item.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="BlackFormattingDialog.__init__" ID="BlackFormattingDialog.__init__"></a> +<h4>BlackFormattingDialog (Constructor)</h4> +<b>BlackFormattingDialog</b>(<i>configuration, filesList, project=None, action=BlackFormattingAction.Format, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>configuration</i> (dict)</dt> +<dd> +dictionary containing the configuration parameters +</dd> +<dt><i>filesList</i> (list of str)</dt> +<dd> +list of absolute file paths to be processed +</dd> +<dt><i>project</i> (Project (optional))</dt> +<dd> +reference to the project object (defaults to None) +</dd> +<dt><i>action</i> (BlackFormattingAction (optional))</dt> +<dd> +action to be performed (defaults to BlackFormattingAction.Format) +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="BlackFormattingDialog.__diffFormatFile" ID="BlackFormattingDialog.__diffFormatFile"></a> +<h4>BlackFormattingDialog.__diffFormatFile</h4> +<b>__diffFormatFile</b>(<i>src, fast, mode, report</i>) + +<p> + Private method to check, if the given files need to be reformatted, and generate + a unified diff. +</p> +<dl> + +<dt><i>src</i> (pathlib.Path)</dt> +<dd> +path of file to be checked +</dd> +<dt><i>fast</i> (bool)</dt> +<dd> +flag indicating fast operation +</dd> +<dt><i>mode</i> (black.Mode)</dt> +<dd> +code formatting options +</dd> +<dt><i>report</i> (BlackReport)</dt> +<dd> +reference to the report object +</dd> +</dl> +<a NAME="BlackFormattingDialog.__filterFiles" ID="BlackFormattingDialog.__filterFiles"></a> +<h4>BlackFormattingDialog.__filterFiles</h4> +<b>__filterFiles</b>(<i>filesList</i>) + +<p> + Private method to filter the given list of files according the + configuration parameters. +</p> +<dl> + +<dt><i>filesList</i> (list of str)</dt> +<dd> +list of files +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list of filtered files +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> +<a NAME="BlackFormattingDialog.__finish" ID="BlackFormattingDialog.__finish"></a> +<h4>BlackFormattingDialog.__finish</h4> +<b>__finish</b>(<i></i>) + +<p> + Private method to perform some actions after the run was performed or canceled. +</p> +<a NAME="BlackFormattingDialog.__formatFiles" ID="BlackFormattingDialog.__formatFiles"></a> +<h4>BlackFormattingDialog.__formatFiles</h4> +<b>__formatFiles</b>(<i></i>) + +<p> + Private method to format the list of files according the configuration. +</p> +<a NAME="BlackFormattingDialog.__resizeColumns" ID="BlackFormattingDialog.__resizeColumns"></a> +<h4>BlackFormattingDialog.__resizeColumns</h4> +<b>__resizeColumns</b>(<i></i>) + +<p> + Private method to resize the columns of the result list. +</p> +<a NAME="BlackFormattingDialog.__resort" ID="BlackFormattingDialog.__resort"></a> +<h4>BlackFormattingDialog.__resort</h4> +<b>__resort</b>(<i></i>) + +<p> + Private method to resort the result list. +</p> +<a NAME="BlackFormattingDialog.__updateStatistics" ID="BlackFormattingDialog.__updateStatistics"></a> +<h4>BlackFormattingDialog.__updateStatistics</h4> +<b>__updateStatistics</b>(<i></i>) + +<p> + Private method to update the statistics about the recent formatting run. +</p> +<a NAME="BlackFormattingDialog.addResultEntry" ID="BlackFormattingDialog.addResultEntry"></a> +<h4>BlackFormattingDialog.addResultEntry</h4> +<b>addResultEntry</b>(<i>status, fileName, isError=False, data=None</i>) + +<p> + Public method to add an entry to the result list. +</p> +<dl> + +<dt><i>status</i> (str)</dt> +<dd> +status of the operation +</dd> +<dt><i>fileName</i> (str)</dt> +<dd> +name of the processed file +</dd> +<dt><i>isError</i> (bool (optional))</dt> +<dd> +flag indicating that data contains an error message (defaults to + False) +</dd> +<dt><i>data</i> (str (optional))</dt> +<dd> +associated data (diff or error message) (defaults to None) +</dd> +</dl> +<a NAME="BlackFormattingDialog.closeEvent" ID="BlackFormattingDialog.closeEvent"></a> +<h4>BlackFormattingDialog.closeEvent</h4> +<b>closeEvent</b>(<i>evt</i>) + +<p> + Protected slot implementing a close event handler. +</p> +<dl> + +<dt><i>evt</i> (QCloseEvent)</dt> +<dd> +reference to the close event +</dd> +</dl> +<a NAME="BlackFormattingDialog.on_buttonBox_clicked" ID="BlackFormattingDialog.on_buttonBox_clicked"></a> +<h4>BlackFormattingDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) + +<p> + Private slot to handle button presses of the dialog buttons. +</p> +<dl> + +<dt><i>button</i> (QAbstractButton)</dt> +<dd> +reference to the pressed button +</dd> +</dl> +<a NAME="BlackFormattingDialog.on_resultsList_itemDoubleClicked" ID="BlackFormattingDialog.on_resultsList_itemDoubleClicked"></a> +<h4>BlackFormattingDialog.on_resultsList_itemDoubleClicked</h4> +<b>on_resultsList_itemDoubleClicked</b>(<i>item, column</i>) + +<p> + Private slot handling a double click of a result item. +</p> +<dl> + +<dt><i>item</i> (QTreeWidgetItem)</dt> +<dd> +reference to the double clicked item +</dd> +<dt><i>column</i> (int)</dt> +<dd> +column number that was double clicked +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="BlackReport" ID="BlackReport"></a> +<h2>BlackReport</h2> + +<p> + Class extending the black Report to work with our dialog. +</p> +<h3>Derived from</h3> +black.Report +<h3>Class Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#BlackReport.__init__">BlackReport</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#BlackReport.done">done</a></td> +<td>Public method to handle the end of a reformat.</td> +</tr> +<tr> +<td><a href="#BlackReport.failed">failed</a></td> +<td>Public method to handle a reformat failure.</td> +</tr> +<tr> +<td><a href="#BlackReport.path_ignored">path_ignored</a></td> +<td>Public method handling an ignored path.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="BlackReport.__init__" ID="BlackReport.__init__"></a> +<h4>BlackReport (Constructor)</h4> +<b>BlackReport</b>(<i>dialog</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>dialog</i> (QDialog)</dt> +<dd> +reference to the result dialog +</dd> +</dl> +<a NAME="BlackReport.done" ID="BlackReport.done"></a> +<h4>BlackReport.done</h4> +<b>done</b>(<i>src, changed, diff=""</i>) + +<p> + Public method to handle the end of a reformat. +</p> +<dl> + +<dt><i>src</i> (pathlib.Path)</dt> +<dd> +name of the processed file +</dd> +<dt><i>changed</i> (black.Changed)</dt> +<dd> +change status +</dd> +<dt><i>diff</i> (str)</dt> +<dd> +unified diff of potential changes (defaults to "") +</dd> +</dl> +<a NAME="BlackReport.failed" ID="BlackReport.failed"></a> +<h4>BlackReport.failed</h4> +<b>failed</b>(<i>src, message</i>) + +<p> + Public method to handle a reformat failure. +</p> +<dl> + +<dt><i>src</i> (pathlib.Path)</dt> +<dd> +name of the processed file +</dd> +<dt><i>message</i> (str)</dt> +<dd> +error message +</dd> +</dl> +<a NAME="BlackReport.path_ignored" ID="BlackReport.path_ignored"></a> +<h4>BlackReport.path_ignored</h4> +<b>path_ignored</b>(<i>src, message=""</i>) + +<p> + Public method handling an ignored path. +</p> +<dl> + +<dt><i>src</i> (pathlib.Path or str)</dt> +<dd> +name of the processed file +</dd> +<dt><i>message</i> (str (optional))</dt> +<dd> +ignore message (default to "") +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.CodeFormatting.BlackUtilities.html Mon Jul 11 16:47:57 2022 +0200 @@ -0,0 +1,122 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.CodeFormatting.BlackUtilities</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.CodeFormatting.BlackUtilities</h1> + +<p> +Module implementing some utility functions for the Black based code formatting. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#compileRegExp">compileRegExp</a></td> +<td>Function to compile a given regular expression.</td> +</tr> +<tr> +<td><a href="#getDefaultConfiguration">getDefaultConfiguration</a></td> +<td>Function to generate a default set of configuration parameters.</td> +</tr> +<tr> +<td><a href="#validateRegExp">validateRegExp</a></td> +<td>Function to validate a given regular expression.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="compileRegExp" ID="compileRegExp"></a> +<h2>compileRegExp</h2> +<b>compileRegExp</b>(<i>regexp</i>) + +<p> + Function to compile a given regular expression. +</p> +<dl> + +<dt><i>regexp</i> (str)</dt> +<dd> +regular expression to be compiled +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +compiled regular expression object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +re.Pattern +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getDefaultConfiguration" ID="getDefaultConfiguration"></a> +<h2>getDefaultConfiguration</h2> +<b>getDefaultConfiguration</b>(<i></i>) + +<p> + Function to generate a default set of configuration parameters. +</p> +<dl> +<dt>Return:</dt> +<dd> +dictionary containing the default parameters +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="validateRegExp" ID="validateRegExp"></a> +<h2>validateRegExp</h2> +<b>validateRegExp</b>(<i>regexp</i>) + +<p> + Function to validate a given regular expression. +</p> +<dl> + +<dt><i>regexp</i> (str)</dt> +<dd> +regular expression to be validated +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a flag indicating validity and an error message +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, str) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.Project.Project.html Mon Jul 11 16:42:50 2022 +0200 +++ b/src/eric7/Documentation/Source/eric7.Project.Project.html Mon Jul 11 16:47:57 2022 +0200 @@ -257,6 +257,10 @@ <td>Constructor</td> </tr> <tr> +<td><a href="#Project.__aboutBlack">__aboutBlack</a></td> +<td>Private slot to show some information about the installed 'Black' tool.</td> +</tr> +<tr> <td><a href="#Project.__addRecursiveDirectory">__addRecursiveDirectory</a></td> <td>Private method used to add all files of a directory tree.</td> </tr> @@ -353,6 +357,10 @@ <td>Private method to open a project from the list of rencently opened projects.</td> </tr> <tr> +<td><a href="#Project.__performFormatWithBlack">__performFormatWithBlack</a></td> +<td>Private method to format the project sources using the 'Black' tool.</td> +</tr> +<tr> <td><a href="#Project.__pluginCreateArchives">__pluginCreateArchives</a></td> <td>Private slot to create eric plugin archives.</td> </tr> @@ -429,6 +437,10 @@ <td>Private slot called before the Debugger menu is shown.</td> </tr> <tr> +<td><a href="#Project.__showContextMenuFormat">__showContextMenuFormat</a></td> +<td>Private slot called before the 'Code Formatting' menu is shown.</td> +</tr> +<tr> <td><a href="#Project.__showContextMenuGraphics">__showContextMenuGraphics</a></td> <td>Private slot called before the graphics menu is shown.</td> </tr> @@ -1121,6 +1133,13 @@ optional filename of a project file to open (string) </dd> </dl> +<a NAME="Project.__aboutBlack" ID="Project.__aboutBlack"></a> +<h4>Project.__aboutBlack</h4> +<b>__aboutBlack</b>(<i></i>) + +<p> + Private slot to show some information about the installed 'Black' tool. +</p> <a NAME="Project.__addRecursiveDirectory" ID="Project.__addRecursiveDirectory"></a> <h4>Project.__addRecursiveDirectory</h4> <b>__addRecursiveDirectory</b>(<i>filetype, source, target</i>) @@ -1481,6 +1500,30 @@ reference to the action that triggered (QAction) </dd> </dl> +<a NAME="Project.__performFormatWithBlack" ID="Project.__performFormatWithBlack"></a> +<h4>Project.__performFormatWithBlack</h4> +<b>__performFormatWithBlack</b>(<i>action</i>) + +<p> + Private method to format the project sources using the 'Black' tool. +</p> +<p> + 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> +</p> +<dl> + +<dt><i>action</i> (BlackFormattingAction)</dt> +<dd> +formatting operation to be performed +</dd> +</dl> <a NAME="Project.__pluginCreateArchives" ID="Project.__pluginCreateArchives"></a> <h4>Project.__pluginCreateArchives</h4> <b>__pluginCreateArchives</b>(<i>snapshot=False</i>) @@ -1690,6 +1733,13 @@ <p> Private slot called before the Debugger menu is shown. </p> +<a NAME="Project.__showContextMenuFormat" ID="Project.__showContextMenuFormat"></a> +<h4>Project.__showContextMenuFormat</h4> +<b>__showContextMenuFormat</b>(<i></i>) + +<p> + Private slot called before the 'Code Formatting' menu is shown. +</p> <a NAME="Project.__showContextMenuGraphics" ID="Project.__showContextMenuGraphics"></a> <h4>Project.__showContextMenuGraphics</h4> <b>__showContextMenuGraphics</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Project.ProjectSourcesBrowser.html Mon Jul 11 16:42:50 2022 +0200 +++ b/src/eric7/Documentation/Source/eric7.Project.ProjectSourcesBrowser.html Mon Jul 11 16:47:57 2022 +0200 @@ -120,6 +120,10 @@ <td>Private slot to load a diagram from file.</td> </tr> <tr> +<td><a href="#ProjectSourcesBrowser.__performFormatWithBlack">__performFormatWithBlack</a></td> +<td>Private method to format the selected project sources using the 'Black' tool.</td> +</tr> +<tr> <td><a href="#ProjectSourcesBrowser.__showApplicationDiagram">__showApplicationDiagram</a></td> <td>Private method to handle the application diagram context menu action.</td> </tr> @@ -156,6 +160,10 @@ <td>Private slot called by the dirMultiMenu aboutToShow signal.</td> </tr> <tr> +<td><a href="#ProjectSourcesBrowser.__showContextMenuFormatting">__showContextMenuFormatting</a></td> +<td>Private slot called before the Code Formatting menu is shown.</td> +</tr> +<tr> <td><a href="#ProjectSourcesBrowser.__showContextMenuGraphics">__showContextMenuGraphics</a></td> <td>Private slot called before the checks menu is shown.</td> </tr> @@ -311,6 +319,30 @@ <p> Private slot to load a diagram from file. </p> +<a NAME="ProjectSourcesBrowser.__performFormatWithBlack" ID="ProjectSourcesBrowser.__performFormatWithBlack"></a> +<h4>ProjectSourcesBrowser.__performFormatWithBlack</h4> +<b>__performFormatWithBlack</b>(<i>action</i>) + +<p> + Private method to format the selected project sources using the 'Black' tool. +</p> +<p> + 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> +</p> +<dl> + +<dt><i>action</i> (BlackFormattingAction)</dt> +<dd> +formatting operation to be performed +</dd> +</dl> <a NAME="ProjectSourcesBrowser.__showApplicationDiagram" ID="ProjectSourcesBrowser.__showApplicationDiagram"></a> <h4>ProjectSourcesBrowser.__showApplicationDiagram</h4> <b>__showApplicationDiagram</b>(<i></i>) @@ -374,6 +406,13 @@ <p> Private slot called by the dirMultiMenu aboutToShow signal. </p> +<a NAME="ProjectSourcesBrowser.__showContextMenuFormatting" ID="ProjectSourcesBrowser.__showContextMenuFormatting"></a> +<h4>ProjectSourcesBrowser.__showContextMenuFormatting</h4> +<b>__showContextMenuFormatting</b>(<i></i>) + +<p> + Private slot called before the Code Formatting menu is shown. +</p> <a NAME="ProjectSourcesBrowser.__showContextMenuGraphics" ID="ProjectSourcesBrowser.__showContextMenuGraphics"></a> <h4>ProjectSourcesBrowser.__showContextMenuGraphics</h4> <b>__showContextMenuGraphics</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Editor.html Mon Jul 11 16:42:50 2022 +0200 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Editor.html Mon Jul 11 16:47:57 2022 +0200 @@ -459,6 +459,10 @@ <td>Private method to setup the eol context sub menu.</td> </tr> <tr> +<td><a href="#Editor.__initContextMenuFormatting">__initContextMenuFormatting</a></td> +<td>Private method used to setup the Code Formatting context sub menu.</td> +</tr> +<tr> <td><a href="#Editor.__initContextMenuGraphics">__initContextMenuGraphics</a></td> <td>Private method used to setup the diagrams context sub menu.</td> </tr> @@ -595,6 +599,10 @@ <td>Private slot to mark added and changed lines.</td> </tr> <tr> +<td><a href="#Editor.__performFormatWithBlack">__performFormatWithBlack</a></td> +<td>Private method to format the source code using the 'Black' tool.</td> +</tr> +<tr> <td><a href="#Editor.__popupDocstringMenu">__popupDocstringMenu</a></td> <td>Private slot to pop up a menu asking the user, if a docstring should be inserted.</td> </tr> @@ -799,6 +807,10 @@ <td>Private slot handling the aboutToShow signal of the eol context menu.</td> </tr> <tr> +<td><a href="#Editor.__showContextMenuFormatting">__showContextMenuFormatting</a></td> +<td>Private slot handling the aboutToShow signal of the code formatting context menu.</td> +</tr> +<tr> <td><a href="#Editor.__showContextMenuGraphics">__showContextMenuGraphics</a></td> <td>Private slot handling the aboutToShow signal of the diagrams context menu.</td> </tr> @@ -2739,6 +2751,25 @@ QMenu </dd> </dl> +<a NAME="Editor.__initContextMenuFormatting" ID="Editor.__initContextMenuFormatting"></a> +<h4>Editor.__initContextMenuFormatting</h4> +<b>__initContextMenuFormatting</b>(<i></i>) + +<p> + Private method used to setup the Code Formatting context sub menu. +</p> +<dl> +<dt>Return:</dt> +<dd> +reference to the generated menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu +</dd> +</dl> <a NAME="Editor.__initContextMenuGraphics" ID="Editor.__initContextMenuGraphics"></a> <h4>Editor.__initContextMenuGraphics</h4> <b>__initContextMenuGraphics</b>(<i></i>) @@ -3245,6 +3276,30 @@ <p> Private slot to mark added and changed lines. </p> +<a NAME="Editor.__performFormatWithBlack" ID="Editor.__performFormatWithBlack"></a> +<h4>Editor.__performFormatWithBlack</h4> +<b>__performFormatWithBlack</b>(<i>action</i>) + +<p> + Private method to format the source code using the 'Black' tool. +</p> +<p> + 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> +</p> +<dl> + +<dt><i>action</i> (BlackFormattingAction)</dt> +<dd> +formatting operation to be performed +</dd> +</dl> <a NAME="Editor.__popupDocstringMenu" ID="Editor.__popupDocstringMenu"></a> <h4>Editor.__popupDocstringMenu</h4> <b>__popupDocstringMenu</b>(<i>lastLineText, lastCursorPosition</i>) @@ -3779,6 +3834,14 @@ <p> Private slot handling the aboutToShow signal of the eol context menu. </p> +<a NAME="Editor.__showContextMenuFormatting" ID="Editor.__showContextMenuFormatting"></a> +<h4>Editor.__showContextMenuFormatting</h4> +<b>__showContextMenuFormatting</b>(<i></i>) + +<p> + Private slot handling the aboutToShow signal of the code formatting context + menu. +</p> <a NAME="Editor.__showContextMenuGraphics" ID="Editor.__showContextMenuGraphics"></a> <h4>Editor.__showContextMenuGraphics</h4> <b>__showContextMenuGraphics</b>(<i></i>)
--- a/src/eric7/Documentation/Source/eric7.Utilities.__init__.html Mon Jul 11 16:42:50 2022 +0200 +++ b/src/eric7/Documentation/Source/eric7.Utilities.__init__.html Mon Jul 11 16:47:57 2022 +0200 @@ -1066,15 +1066,21 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -path to be converted (string) +path to be converted </dd> </dl> <dl> <dt>Return:</dt> <dd> -path with converted separator characters (string) +path with converted separator characters +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -2501,15 +2507,21 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -path to be converted (string) +path to be converted </dd> </dl> <dl> <dt>Return:</dt> <dd> -path with converted separator characters (string) +path with converted separator characters +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/index-eric7.CodeFormatting.html Mon Jul 11 16:47:57 2022 +0200 @@ -0,0 +1,45 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.CodeFormatting</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<h1>eric7.CodeFormatting</h1> + +<p> +Package implementing dialogs to perform some code formatting. +</p> +<p> +The supported code formatting systems are these. +<ul> +<li><a href="https://github.com/psf/black">Black</a></li> +</ul +</p> + + +<h3>Modules</h3> +<table> + +<tr> +<td><a href="eric7.CodeFormatting.BlackConfigurationDialog.html">BlackConfigurationDialog</a></td> +<td>Module implementing a dialog to enter the parameters for a Black formatting run.</td> +</tr> +<tr> +<td><a href="eric7.CodeFormatting.BlackDiffWidget.html">BlackDiffWidget</a></td> +<td>Module implementing a window to show a unified diff..</td> +</tr> +<tr> +<td><a href="eric7.CodeFormatting.BlackFormattingAction.html">BlackFormattingAction</a></td> +<td>Module implementing an enum defining the various code formatting actions.</td> +</tr> +<tr> +<td><a href="eric7.CodeFormatting.BlackFormattingDialog.html">BlackFormattingDialog</a></td> +<td>Module implementing a dialog showing the code formatting progress and the result.</td> +</tr> +<tr> +<td><a href="eric7.CodeFormatting.BlackUtilities.html">BlackUtilities</a></td> +<td>Module implementing some utility functions for the Black based code formatting.</td> +</tr> +</table> +</body></html> \ No newline at end of file
--- a/src/eric7/Documentation/Source/index-eric7.html Mon Jul 11 16:42:50 2022 +0200 +++ b/src/eric7/Documentation/Source/index-eric7.html Mon Jul 11 16:47:57 2022 +0200 @@ -19,6 +19,10 @@ <table> <tr> +<td><a href="index-eric7.CodeFormatting.html">CodeFormatting</a></td> +<td>Package implementing dialogs to perform some code formatting.</td> +</tr> +<tr> <td><a href="index-eric7.CondaInterface.html">CondaInterface</a></td> <td>Package implementing the various conda related modules.</td> </tr>