Wed, 30 Aug 2023 13:20:08 +0200
Corrected some code style issues and code documentation.
--- a/PluginMetricsRadon.epj Sat May 27 15:34:14 2023 +0200 +++ b/PluginMetricsRadon.epj Wed Aug 30 13:20:08 2023 +0200 @@ -16,6 +16,9 @@ "singledispatch", "singledispatchmethod" ], + "ExemptedTypingSymbols": [ + "" + ], "ForceFutureAnnotations": false, "MaximumComplexity": 3, "MaximumLength": 7, @@ -63,7 +66,7 @@ "CopyrightAuthor": "", "CopyrightMinFileSize": 0, "DocstringType": "eric_black", - "EnabledCheckerCategories": "C, D, E, M, N, S, Y, U, W", + "EnabledCheckerCategories": "C, D, E, I, M, NO, N, S, Y, U, W", "ExcludeFiles": "*/Ui_*.py, */*_rc.py", "ExcludeMessages": "C101,E265,E266,E305,E402,M201,M301,M302,M303,M304,M305,M306,M307,M308,M311,M312,M313,M314,M315,M321,M701,M702,M811,M834,N802,N803,N807,N808,N821,U200,W293,W503,Y119,Y401,Y402", "FixCodes": "", @@ -71,7 +74,10 @@ "FutureChecker": "", "HangClosing": false, "ImportsChecker": { - "ApplicationPackageNames": [], + "ApplicationPackageNames": [ + "RadonMetrics", + "eric7" + ], "BanRelativeImports": "", "BannedModules": [] }, @@ -82,7 +88,10 @@ "MaxDocLineLength": 88, "MaxLineLength": 88, "NameOrderChecker": { - "ApplicationPackageNames": [], + "ApplicationPackageNames": [ + "RadonMetrics", + "eric7" + ], "CombinedAsImports": false, "SortCaseSensitive": false, "SortFromFirst": false, @@ -224,7 +233,7 @@ ], "OTHERTOOLSPARMS": { "Black": { - "exclude": "/(\\.direnv|\\.eggs|\\.git|\\.hg|\\.mypy_cache|\\.nox|\\.tox|\\.venv|venv|\\.svn|\\.ipynb_checkpoints|_build|buck-out|build|dist|__pypackages__)/", + "exclude": "/(\\.direnv|\\.eggs|\\.git|\\.hg|\\.ipynb_checkpoints|\\.mypy_cache|\\.nox|\\.pytest_cache|\\.ruff_cache|\\.tox|\\.svn|\\.venv|\\.vscode|__pypackages__|_build|buck-out|build|dist|venv)/", "extend-exclude": "", "force-exclude": "", "line-length": 88, @@ -232,11 +241,11 @@ "skip-string-normalization": false, "source": "project", "target-version": [ + "py312", "py311", "py310", "py39", - "py38", - "py37" + "py38" ] }, "RadonCodeMetrics": { @@ -284,6 +293,7 @@ "RadonMetrics/__init__.py", "__init__.py" ], + "SOURCESDIR": "", "SPELLEXCLUDES": "", "SPELLLANGUAGE": "en_US", "SPELLWORDS": "",
--- a/PluginMetricsRadon.py Sat May 27 15:34:14 2023 +0200 +++ b/PluginMetricsRadon.py Wed Aug 30 13:20:08 2023 +0200 @@ -13,7 +13,7 @@ from PyQt6.QtCore import QObject, QTranslator, pyqtSignal from PyQt6.QtGui import QAction -from eric7 import Preferences +from eric7 import Globals, Preferences from eric7.EricGui.EricAction import EricAction from eric7.EricWidgets import EricMessageBox from eric7.EricWidgets.EricApplication import ericApp @@ -631,7 +631,11 @@ ) print("Using default.") - def __projectShowMenu(self, menuName, menu): # noqa: U100 + def __projectShowMenu( + self, + menuName, + menu, # noqa: U100 + ): """ Private slot called, when the the project menu or a submenu is about to be shown. @@ -781,7 +785,12 @@ menu.addActions(self.__editorMetricsActs) menu.addAction(self.__editorSeparatorActs[1]) - def __editorShowMenu(self, menuName, menu, editor): # noqa: U100 + def __editorShowMenu( + self, + menuName, + menu, # noqa: U100 + editor, + ): """ Private slot called, when the the editor context menu or a submenu is about to be shown. @@ -816,7 +825,7 @@ ] if self.__projectRawMetricsDialog is None: - from RadonMetrics.RawMetricsDialog import RawMetricsDialog + from RadonMetrics.RawMetricsDialog import RawMetricsDialog # noqa: I101 self.__projectRawMetricsDialog = RawMetricsDialog(self) self.__projectRawMetricsDialog.show() @@ -840,7 +849,7 @@ fn = itm.dirName() if self.__projectBrowserRawMetricsDialog is None: - from RadonMetrics.RawMetricsDialog import RawMetricsDialog + from RadonMetrics.RawMetricsDialog import RawMetricsDialog # noqa: I101 self.__projectBrowserRawMetricsDialog = RawMetricsDialog(self) self.__projectBrowserRawMetricsDialog.show() @@ -858,7 +867,7 @@ and editor.getFileName() is not None ): if self.__editorRawMetricsDialog is None: - from RadonMetrics.RawMetricsDialog import RawMetricsDialog + from RadonMetrics.RawMetricsDialog import RawMetricsDialog # noqa: I101 self.__editorRawMetricsDialog = RawMetricsDialog(self) self.__editorRawMetricsDialog.show() @@ -883,7 +892,7 @@ ] if self.__projectMIDialog is None: - from RadonMetrics.MaintainabilityIndexDialog import ( + from RadonMetrics.MaintainabilityIndexDialog import ( # noqa: I101 MaintainabilityIndexDialog, ) @@ -909,7 +918,7 @@ fn = itm.dirName() if self.__projectBrowserMIDialog is None: - from RadonMetrics.MaintainabilityIndexDialog import ( + from RadonMetrics.MaintainabilityIndexDialog import ( # noqa: I101 MaintainabilityIndexDialog, ) @@ -929,7 +938,7 @@ and editor.getFileName() is not None ): if self.__editorMIDialog is None: - from RadonMetrics.MaintainabilityIndexDialog import ( + from RadonMetrics.MaintainabilityIndexDialog import ( # noqa: I101 MaintainabilityIndexDialog, ) @@ -956,7 +965,7 @@ ] if self.__projectCCDialog is None: - from RadonMetrics.CyclomaticComplexityDialog import ( + from RadonMetrics.CyclomaticComplexityDialog import ( # noqa: I101 CyclomaticComplexityDialog, ) @@ -982,7 +991,7 @@ fn = itm.dirName() if self.__projectBrowserCCDialog is None: - from RadonMetrics.CyclomaticComplexityDialog import ( + from RadonMetrics.CyclomaticComplexityDialog import ( # noqa: I101 CyclomaticComplexityDialog, ) @@ -1004,7 +1013,7 @@ and editor.getFileName() is not None ): if self.__editorCCDialog is None: - from RadonMetrics.CyclomaticComplexityDialog import ( + from RadonMetrics.CyclomaticComplexityDialog import ( # noqa: I101 CyclomaticComplexityDialog, ) @@ -1020,7 +1029,7 @@ """ Private slot to show the version number of the used radon library. """ - from radon import __version__ + from radon import __version__ # noqa: I102 EricMessageBox.information( None, @@ -1062,9 +1071,7 @@ @type function """ try: - from radon import __version__ as radon_version - - from eric7 import Globals + from radon import __version__ as radon_version # noqa: I101, I102 if Globals.versionToTuple(radon_version) < (4, 5, 0): # force an upgrade
--- a/RadonMetrics/CodeMetricsCalculator.py Sat May 27 15:34:14 2023 +0200 +++ b/RadonMetrics/CodeMetricsCalculator.py Wed Aug 30 13:20:08 2023 +0200 @@ -29,7 +29,10 @@ return batchRawCodeMetrics -def rawCodeMetrics(file, text=""): # noqa: U100 +def rawCodeMetrics( + file, # noqa: U100 + text="", +): """ Private function to calculate the raw code metrics of one file. @@ -144,7 +147,7 @@ @return tuple containing the result dictionary @rtype (tuple of dict) """ - from radon.raw import analyze + from radon.raw import analyze # noqa: I102 try: res = __raw2Dict(analyze(text))
--- a/RadonMetrics/CyclomaticComplexityCalculator.py Sat May 27 15:34:14 2023 +0200 +++ b/RadonMetrics/CyclomaticComplexityCalculator.py Wed Aug 30 13:20:08 2023 +0200 @@ -29,7 +29,10 @@ return batchCyclomaticComplexity -def cyclomaticComplexity(file, text=""): # noqa: U100 +def cyclomaticComplexity( + file, # noqa: U100 + text="", +): """ Private function to calculate the cyclomatic complexity of one file. @@ -147,7 +150,7 @@ @return tuple containing the result dictionary @rtype (tuple of dict) """ - from radon.complexity import cc_rank, cc_visit + from radon.complexity import cc_rank, cc_visit # noqa: I102 try: cc = cc_visit(text) @@ -182,8 +185,8 @@ @return conversion result @rtype dict """ - from radon.complexity import cc_rank - from radon.visitors import Function + from radon.complexity import cc_rank # noqa: I102 + from radon.visitors import Function # noqa: I102 result = { "type": __getType(obj), @@ -210,7 +213,7 @@ @return type string for the object @rtype str, one of ["method", "function", "class"] """ - from radon.visitors import Function + from radon.visitors import Function # noqa: I102 if isinstance(obj, Function): if obj.is_method:
--- a/RadonMetrics/CyclomaticComplexityDialog.py Sat May 27 15:34:14 2023 +0200 +++ b/RadonMetrics/CyclomaticComplexityDialog.py Wed Aug 30 13:20:08 2023 +0200 @@ -125,7 +125,7 @@ try: usesDarkPalette = ericApp().usesDarkPalette() except AttributeError: - from PyQt6.QtGui import QPalette + from PyQt6.QtGui import QPalette # noqa: I101, I102 palette = ericApp().palette() lightness = palette.color(QPalette.Window).lightness() @@ -361,7 +361,7 @@ try: self.source = Utilities.readEncodedFile(self.filename)[0] self.source = Utilities.normalizeCode(self.source) - except (UnicodeError, OSError) as msg: + except (OSError, UnicodeError) as msg: self.__createErrorItem(self.filename, str(msg).rstrip()) self.progress += 1 # Continue with next file @@ -386,7 +386,7 @@ try: source = Utilities.readEncodedFile(filename)[0] source = Utilities.normalizeCode(source) - except (UnicodeError, OSError) as msg: + except (OSError, UnicodeError) as msg: self.__createErrorItem(filename, str(msg).rstrip()) continue @@ -471,7 +471,7 @@ """ Private slot called when the action or the user pressed the button. """ - from radon.complexity import cc_rank + from radon.complexity import cc_rank # noqa: I102 if not self.__finished: self.__finished = True
--- a/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.PluginMetricsRadon.html Sat May 27 15:34:14 2023 +0200 +++ b/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.PluginMetricsRadon.html Wed Aug 30 13:20:08 2023 +0200 @@ -115,7 +115,7 @@ </tr> <tr> <td><a href="#RadonMetricsPlugin.__editorShowMenu">__editorShowMenu</a></td> -<td></td> +<td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td> </tr> <tr> <td><a href="#RadonMetricsPlugin.__initialize">__initialize</a></td> @@ -159,7 +159,7 @@ </tr> <tr> <td><a href="#RadonMetricsPlugin.__projectShowMenu">__projectShowMenu</a></td> -<td></td> +<td>Private slot called, when the the project menu or a submenu is about to be shown.</td> </tr> <tr> <td><a href="#RadonMetricsPlugin.__serviceError">__serviceError</a></td> @@ -314,8 +314,27 @@ </dl> <a NAME="RadonMetricsPlugin.__editorShowMenu" ID="RadonMetricsPlugin.__editorShowMenu"></a> <h4>RadonMetricsPlugin.__editorShowMenu</h4> -<b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) +<b>__editorShowMenu</b>(<i>menuName, menu, editor, </i>) + +<p> + Private slot called, when the the editor context menu or a submenu is + about to be shown. +</p> +<dl> +<dt><i>menuName</i> (str)</dt> +<dd> +name of the menu to be shown +</dd> +<dt><i>menu</i> (QMenu)</dt> +<dd> +reference to the menu +</dd> +<dt><i>editor</i> (Editor)</dt> +<dd> +reference to the editor +</dd> +</dl> <a NAME="RadonMetricsPlugin.__initialize" ID="RadonMetricsPlugin.__initialize"></a> <h4>RadonMetricsPlugin.__initialize</h4> <b>__initialize</b>(<i></i>) @@ -405,8 +424,23 @@ </p> <a NAME="RadonMetricsPlugin.__projectShowMenu" ID="RadonMetricsPlugin.__projectShowMenu"></a> <h4>RadonMetricsPlugin.__projectShowMenu</h4> -<b>__projectShowMenu</b>(<i>menuName, menu</i>) +<b>__projectShowMenu</b>(<i>menuName, menu, </i>) + +<p> + Private slot called, when the the project menu or a submenu is + about to be shown. +</p> +<dl> +<dt><i>menuName</i> (str)</dt> +<dd> +name of the menu to be shown +</dd> +<dt><i>menu</i> (QMenu)</dt> +<dd> +reference to the menu +</dd> +</dl> <a NAME="RadonMetricsPlugin.__serviceError" ID="RadonMetricsPlugin.__serviceError"></a> <h4>RadonMetricsPlugin.__serviceError</h4> <b>__serviceError</b>(<i>type_, fn, msg</i>)
--- a/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CodeMetricsCalculator.html Sat May 27 15:34:14 2023 +0200 +++ b/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CodeMetricsCalculator.html Wed Aug 30 13:20:08 2023 +0200 @@ -47,7 +47,7 @@ </tr> <tr> <td><a href="#rawCodeMetrics">rawCodeMetrics</a></td> -<td></td> +<td>Private function to calculate the raw code metrics of one file.</td> </tr> <tr> <td><a href="#workerTask">workerTask</a></td> @@ -182,8 +182,34 @@ <hr /> <a NAME="rawCodeMetrics" ID="rawCodeMetrics"></a> <h2>rawCodeMetrics</h2> -<b>rawCodeMetrics</b>(<i>file, text=""</i>) +<b>rawCodeMetrics</b>(<i>file, text="", </i>) + +<p> + Private function to calculate the raw code metrics of one file. +</p> +<dl> +<dt><i>file</i> (str)</dt> +<dd> +source filename +</dd> +<dt><i>text</i> (str)</dt> +<dd> +source text +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the result dictionary +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +(tuple of dict) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CyclomaticComplexityCalculator.html Sat May 27 15:34:14 2023 +0200 +++ b/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.CyclomaticComplexityCalculator.html Wed Aug 30 13:20:08 2023 +0200 @@ -43,7 +43,7 @@ </tr> <tr> <td><a href="#cyclomaticComplexity">cyclomaticComplexity</a></td> -<td></td> +<td>Private function to calculate the cyclomatic complexity of one file.</td> </tr> <tr> <td><a href="#initBatchService">initBatchService</a></td> @@ -186,8 +186,34 @@ <hr /> <a NAME="cyclomaticComplexity" ID="cyclomaticComplexity"></a> <h2>cyclomaticComplexity</h2> -<b>cyclomaticComplexity</b>(<i>file, text=""</i>) +<b>cyclomaticComplexity</b>(<i>file, text="", </i>) + +<p> + Private function to calculate the cyclomatic complexity of one file. +</p> +<dl> +<dt><i>file</i> (str)</dt> +<dd> +source filename +</dd> +<dt><i>text</i> (str)</dt> +<dd> +source text +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the result dictionary +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +(tuple of dict) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexCalculator.html Sat May 27 15:34:14 2023 +0200 +++ b/RadonMetrics/Documentation/source/Plugin_Metrics_Radon.RadonMetrics.MaintainabilityIndexCalculator.html Wed Aug 30 13:20:08 2023 +0200 @@ -43,7 +43,7 @@ </tr> <tr> <td><a href="#maintainabilityIndex">maintainabilityIndex</a></td> -<td></td> +<td>Private function to calculate the maintainability index of one file.</td> </tr> <tr> <td><a href="#workerTask">workerTask</a></td> @@ -151,8 +151,34 @@ <hr /> <a NAME="maintainabilityIndex" ID="maintainabilityIndex"></a> <h2>maintainabilityIndex</h2> -<b>maintainabilityIndex</b>(<i>file, text=""</i>) +<b>maintainabilityIndex</b>(<i>file, text="", </i>) + +<p> + Private function to calculate the maintainability index of one file. +</p> +<dl> +<dt><i>file</i> (str)</dt> +<dd> +source filename +</dd> +<dt><i>text</i> (str)</dt> +<dd> +source text +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the result dictionary +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +(tuple of dict) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr />
--- a/RadonMetrics/MaintainabilityIndexCalculator.py Sat May 27 15:34:14 2023 +0200 +++ b/RadonMetrics/MaintainabilityIndexCalculator.py Wed Aug 30 13:20:08 2023 +0200 @@ -29,7 +29,10 @@ return batchMaintainabilityIndex -def maintainabilityIndex(file, text=""): # noqa: U100 +def maintainabilityIndex( + file, # noqa: U100 + text="", +): """ Private function to calculate the maintainability index of one file. @@ -147,7 +150,7 @@ @return tuple containing the result dictionary @rtype (tuple of dict) """ - from radon.metrics import mi_rank, mi_visit + from radon.metrics import mi_rank, mi_visit # noqa: I102 try: mi = mi_visit(text, True)
--- a/RadonMetrics/MaintainabilityIndexDialog.py Sat May 27 15:34:14 2023 +0200 +++ b/RadonMetrics/MaintainabilityIndexDialog.py Wed Aug 30 13:20:08 2023 +0200 @@ -89,7 +89,7 @@ try: usesDarkPalette = ericApp().usesDarkPalette() except AttributeError: - from PyQt6.QtGui import QPalette + from PyQt6.QtGui import QPalette # noqa: I101, I102 palette = ericApp().palette() lightness = palette.color(QPalette.Window).lightness() @@ -264,7 +264,7 @@ try: self.source = Utilities.readEncodedFile(self.filename)[0] self.source = Utilities.normalizeCode(self.source) - except (UnicodeError, OSError) as msg: + except (OSError, UnicodeError) as msg: self.__createErrorItem(self.filename, str(msg).rstrip()) self.progress += 1 # Continue with next file @@ -289,7 +289,7 @@ try: source = Utilities.readEncodedFile(filename)[0] source = Utilities.normalizeCode(source) - except (UnicodeError, OSError) as msg: + except (OSError, UnicodeError) as msg: self.__createErrorItem(filename, str(msg).rstrip()) continue
--- a/RadonMetrics/RawMetricsDialog.py Sat May 27 15:34:14 2023 +0200 +++ b/RadonMetrics/RawMetricsDialog.py Wed Aug 30 13:20:08 2023 +0200 @@ -272,7 +272,7 @@ try: self.source = Utilities.readEncodedFile(self.filename)[0] self.source = Utilities.normalizeCode(self.source) - except (UnicodeError, OSError) as msg: + except (OSError, UnicodeError) as msg: self.__createErrorItem(self.filename, str(msg).rstrip()) self.progress += 1 # Continue with next file @@ -297,7 +297,7 @@ try: source = Utilities.readEncodedFile(filename)[0] source = Utilities.normalizeCode(source) - except (UnicodeError, OSError) as msg: + except (OSError, UnicodeError) as msg: self.__createErrorItem(filename, str(msg).rstrip()) continue