Mon, 09 Sep 2013 19:26:51 +0200
Regenerated source docu.
--- a/APIs/Python3/eric5.api Mon Sep 09 19:25:46 2013 +0200 +++ b/APIs/Python3/eric5.api Mon Sep 09 19:26:51 2013 +0200 @@ -3745,6 +3745,7 @@ eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.Pep8Report.error_args?4(line_number, offset, code, check, *args) eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.Pep8Report?1(options) eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.Pep8FixableIssues?7 +eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.Pep8Fixer.finalize?4() eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.Pep8Fixer.fixIssue?4(line, pos, message) eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.Pep8Fixer.mutualStartswith?4(b) eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.Pep8Fixer.saveFile?4(encoding) @@ -3758,6 +3759,15 @@ eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.Pep8Reindenter.getline?4() eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.Pep8Reindenter.run?4() eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.Pep8Reindenter?1(sourceLines) +eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.Pep8NamingChecker.CamelcaseRegexp?7 +eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.Pep8NamingChecker.Codes?7 +eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.Pep8NamingChecker.LowercaseRegex?7 +eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.Pep8NamingChecker.Messages?7 +eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.Pep8NamingChecker.MixedcaseRegexp?7 +eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.Pep8NamingChecker.UppercaseRegexp?7 +eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.Pep8NamingChecker.getMessage?4(code, *args) +eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.Pep8NamingChecker.run?4() +eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.Pep8NamingChecker?1(tree, filename) eric5.Plugins.CheckerPlugins.Pep8.Pep8StatisticsDialog.Pep8StatisticsDialog?1(statistics, parent=None) eric5.Plugins.CheckerPlugins.Pep8.pep8.ARITHMETIC_OP?7 eric5.Plugins.CheckerPlugins.Pep8.pep8.BENCHMARK_KEYS?7 @@ -8373,6 +8383,14 @@ eric5.UtilitiesPython2.Pep8Checker.Pep8Report.repeat?7 eric5.UtilitiesPython2.Pep8Checker.Pep8Report.select?7 eric5.UtilitiesPython2.Pep8Checker.Pep8Report?1(options) +eric5.UtilitiesPython2.Pep8NamingCheckerPy2.Pep8NamingChecker.CamelcaseRegexp?7 +eric5.UtilitiesPython2.Pep8NamingCheckerPy2.Pep8NamingChecker.Codes?7 +eric5.UtilitiesPython2.Pep8NamingCheckerPy2.Pep8NamingChecker.LowercaseRegex?7 +eric5.UtilitiesPython2.Pep8NamingCheckerPy2.Pep8NamingChecker.MixedcaseRegexp?7 +eric5.UtilitiesPython2.Pep8NamingCheckerPy2.Pep8NamingChecker.UppercaseRegexp?7 +eric5.UtilitiesPython2.Pep8NamingCheckerPy2.Pep8NamingChecker.run?4() +eric5.UtilitiesPython2.Pep8NamingCheckerPy2.Pep8NamingChecker.unpackArgs?4() +eric5.UtilitiesPython2.Pep8NamingCheckerPy2.Pep8NamingChecker?1(tree, filename) eric5.UtilitiesPython2.Py2SyntaxChecker.compile?4(file, codestring) eric5.UtilitiesPython2.Py2SyntaxChecker.flakesCheck?4(fileName, codestring, ignoreStarImportWarnings) eric5.UtilitiesPython2.Tabnanny.NannyNag.get_line?4()
--- a/Documentation/Help/source.qhp Mon Sep 09 19:25:46 2013 +0200 +++ b/Documentation/Help/source.qhp Mon Sep 09 19:26:51 2013 +0200 @@ -458,6 +458,7 @@ <section title="eric5.Plugins.CheckerPlugins.Pep8.Pep8CodeSelectionDialog" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8CodeSelectionDialog.html" /> <section title="eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html" /> <section title="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html" /> + <section title="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html" /> <section title="eric5.Plugins.CheckerPlugins.Pep8.Pep8StatisticsDialog" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8StatisticsDialog.html" /> <section title="eric5.Plugins.CheckerPlugins.Pep8.pep8" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html" /> </section> @@ -970,6 +971,7 @@ <section title="eric5.UtilitiesPython2.py2flakes.messages" ref="eric5.UtilitiesPython2.py2flakes.messages.html" /> </section> <section title="eric5.UtilitiesPython2.Pep8Checker" ref="eric5.UtilitiesPython2.Pep8Checker.html" /> + <section title="eric5.UtilitiesPython2.Pep8NamingCheckerPy2" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html" /> <section title="eric5.UtilitiesPython2.Py2SyntaxChecker" ref="eric5.UtilitiesPython2.Py2SyntaxChecker.html" /> <section title="eric5.UtilitiesPython2.PySideImporter" ref="eric5.UtilitiesPython2.PySideImporter.html" /> <section title="eric5.UtilitiesPython2.Tabnanny" ref="eric5.UtilitiesPython2.Tabnanny.html" /> @@ -8011,7 +8013,6 @@ <keyword name="Pep8Fixer (Constructor)" id="Pep8Fixer (Constructor)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__init__" /> <keyword name="Pep8Fixer (Module)" id="Pep8Fixer (Module)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html" /> <keyword name="Pep8Fixer.__codeMatch" id="Pep8Fixer.__codeMatch" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__codeMatch" /> - <keyword name="Pep8Fixer.__finalize" id="Pep8Fixer.__finalize" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__finalize" /> <keyword name="Pep8Fixer.__findLogical" id="Pep8Fixer.__findLogical" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__findLogical" /> <keyword name="Pep8Fixer.__fixE101" id="Pep8Fixer.__fixE101" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixE101" /> <keyword name="Pep8Fixer.__fixE121" id="Pep8Fixer.__fixE121" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixE121" /> @@ -8035,6 +8036,8 @@ <keyword name="Pep8Fixer.__fixE701" id="Pep8Fixer.__fixE701" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixE701" /> <keyword name="Pep8Fixer.__fixE702" id="Pep8Fixer.__fixE702" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixE702" /> <keyword name="Pep8Fixer.__fixE711" id="Pep8Fixer.__fixE711" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixE711" /> + <keyword name="Pep8Fixer.__fixN804" id="Pep8Fixer.__fixN804" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixN804" /> + <keyword name="Pep8Fixer.__fixN806" id="Pep8Fixer.__fixN806" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixN806" /> <keyword name="Pep8Fixer.__fixReindent" id="Pep8Fixer.__fixReindent" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixReindent" /> <keyword name="Pep8Fixer.__fixW291" id="Pep8Fixer.__fixW291" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixW291" /> <keyword name="Pep8Fixer.__fixW292" id="Pep8Fixer.__fixW292" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixW292" /> @@ -8042,10 +8045,12 @@ <keyword name="Pep8Fixer.__fixW603" id="Pep8Fixer.__fixW603" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixW603" /> <keyword name="Pep8Fixer.__fixWhitespace" id="Pep8Fixer.__fixWhitespace" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixWhitespace" /> <keyword name="Pep8Fixer.__getEol" id="Pep8Fixer.__getEol" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__getEol" /> + <keyword name="Pep8Fixer.__getID" id="Pep8Fixer.__getID" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__getID" /> <keyword name="Pep8Fixer.__getIndent" id="Pep8Fixer.__getIndent" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__getIndent" /> <keyword name="Pep8Fixer.__getIndentWord" id="Pep8Fixer.__getIndentWord" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__getIndentWord" /> <keyword name="Pep8Fixer.__getLogical" id="Pep8Fixer.__getLogical" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__getLogical" /> <keyword name="Pep8Fixer.__multilineStringLines" id="Pep8Fixer.__multilineStringLines" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__multilineStringLines" /> + <keyword name="Pep8Fixer.finalize" id="Pep8Fixer.finalize" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.finalize" /> <keyword name="Pep8Fixer.fixIssue" id="Pep8Fixer.fixIssue" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.fixIssue" /> <keyword name="Pep8Fixer.mutualStartswith" id="Pep8Fixer.mutualStartswith" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.mutualStartswith" /> <keyword name="Pep8Fixer.saveFile" id="Pep8Fixer.saveFile" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.saveFile" /> @@ -8065,6 +8070,42 @@ <keyword name="Pep8LineShortener.__shortenComment" id="Pep8LineShortener.__shortenComment" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8LineShortener.__shortenComment" /> <keyword name="Pep8LineShortener.__shortenLine" id="Pep8LineShortener.__shortenLine" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8LineShortener.__shortenLine" /> <keyword name="Pep8LineShortener.shorten" id="Pep8LineShortener.shorten" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8LineShortener.shorten" /> + <keyword name="Pep8NamingChecker" id="Pep8NamingChecker" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker" /> + <keyword name="Pep8NamingChecker" id="Pep8NamingChecker" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker" /> + <keyword name="Pep8NamingChecker (Constructor)" id="Pep8NamingChecker (Constructor)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__init__" /> + <keyword name="Pep8NamingChecker (Constructor)" id="Pep8NamingChecker (Constructor)" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker.__init__" /> + <keyword name="Pep8NamingChecker (Module)" id="Pep8NamingChecker (Module)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html" /> + <keyword name="Pep8NamingChecker.__checkClassName" id="Pep8NamingChecker.__checkClassName" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__checkClassName" /> + <keyword name="Pep8NamingChecker.__checkClassName" id="Pep8NamingChecker.__checkClassName" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker.__checkClassName" /> + <keyword name="Pep8NamingChecker.__checkFunctionArgumentNames" id="Pep8NamingChecker.__checkFunctionArgumentNames" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__checkFunctionArgumentNames" /> + <keyword name="Pep8NamingChecker.__checkFunctionArgumentNames" id="Pep8NamingChecker.__checkFunctionArgumentNames" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker.__checkFunctionArgumentNames" /> + <keyword name="Pep8NamingChecker.__checkFuntionName" id="Pep8NamingChecker.__checkFuntionName" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__checkFuntionName" /> + <keyword name="Pep8NamingChecker.__checkFuntionName" id="Pep8NamingChecker.__checkFuntionName" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker.__checkFuntionName" /> + <keyword name="Pep8NamingChecker.__checkImportAs" id="Pep8NamingChecker.__checkImportAs" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__checkImportAs" /> + <keyword name="Pep8NamingChecker.__checkImportAs" id="Pep8NamingChecker.__checkImportAs" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker.__checkImportAs" /> + <keyword name="Pep8NamingChecker.__checkModule" id="Pep8NamingChecker.__checkModule" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__checkModule" /> + <keyword name="Pep8NamingChecker.__checkModule" id="Pep8NamingChecker.__checkModule" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker.__checkModule" /> + <keyword name="Pep8NamingChecker.__checkVariablesInFunction" id="Pep8NamingChecker.__checkVariablesInFunction" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__checkVariablesInFunction" /> + <keyword name="Pep8NamingChecker.__checkVariablesInFunction" id="Pep8NamingChecker.__checkVariablesInFunction" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker.__checkVariablesInFunction" /> + <keyword name="Pep8NamingChecker.__error" id="Pep8NamingChecker.__error" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__error" /> + <keyword name="Pep8NamingChecker.__error" id="Pep8NamingChecker.__error" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker.__error" /> + <keyword name="Pep8NamingChecker.__findGlobalDefs" id="Pep8NamingChecker.__findGlobalDefs" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__findGlobalDefs" /> + <keyword name="Pep8NamingChecker.__findGlobalDefs" id="Pep8NamingChecker.__findGlobalDefs" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker.__findGlobalDefs" /> + <keyword name="Pep8NamingChecker.__getArgNames" id="Pep8NamingChecker.__getArgNames" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__getArgNames" /> + <keyword name="Pep8NamingChecker.__getArgNames" id="Pep8NamingChecker.__getArgNames" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker.__getArgNames" /> + <keyword name="Pep8NamingChecker.__isNameToBeAvoided" id="Pep8NamingChecker.__isNameToBeAvoided" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__isNameToBeAvoided" /> + <keyword name="Pep8NamingChecker.__isNameToBeAvoided" id="Pep8NamingChecker.__isNameToBeAvoided" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker.__isNameToBeAvoided" /> + <keyword name="Pep8NamingChecker.__tagClassFunctions" id="Pep8NamingChecker.__tagClassFunctions" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__tagClassFunctions" /> + <keyword name="Pep8NamingChecker.__tagClassFunctions" id="Pep8NamingChecker.__tagClassFunctions" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker.__tagClassFunctions" /> + <keyword name="Pep8NamingChecker.__visitNode" id="Pep8NamingChecker.__visitNode" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__visitNode" /> + <keyword name="Pep8NamingChecker.__visitNode" id="Pep8NamingChecker.__visitNode" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker.__visitNode" /> + <keyword name="Pep8NamingChecker.__visitTree" id="Pep8NamingChecker.__visitTree" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__visitTree" /> + <keyword name="Pep8NamingChecker.__visitTree" id="Pep8NamingChecker.__visitTree" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker.__visitTree" /> + <keyword name="Pep8NamingChecker.getMessage" id="Pep8NamingChecker.getMessage" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.getMessage" /> + <keyword name="Pep8NamingChecker.run" id="Pep8NamingChecker.run" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.run" /> + <keyword name="Pep8NamingChecker.run" id="Pep8NamingChecker.run" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker.run" /> + <keyword name="Pep8NamingChecker.unpackArgs" id="Pep8NamingChecker.unpackArgs" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html#Pep8NamingChecker.unpackArgs" /> + <keyword name="Pep8NamingCheckerPy2 (Module)" id="Pep8NamingCheckerPy2 (Module)" ref="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html" /> <keyword name="Pep8Py2Checker" id="Pep8Py2Checker" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker.html#Pep8Py2Checker" /> <keyword name="Pep8Py2Checker (Constructor)" id="Pep8Py2Checker (Constructor)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker.html#Pep8Py2Checker.__init__" /> <keyword name="Pep8Reindenter" id="Pep8Reindenter" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Reindenter" /> @@ -13600,6 +13641,7 @@ <file>eric5.Plugins.CheckerPlugins.Pep8.Pep8CodeSelectionDialog.html</file> <file>eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html</file> <file>eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html</file> + <file>eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html</file> <file>eric5.Plugins.CheckerPlugins.Pep8.Pep8StatisticsDialog.html</file> <file>eric5.Plugins.CheckerPlugins.Pep8.pep8.html</file> <file>eric5.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckerDialog.html</file> @@ -14002,6 +14044,7 @@ <file>eric5.Utilities.py3flakes.messages.html</file> <file>eric5.Utilities.uic.html</file> <file>eric5.UtilitiesPython2.Pep8Checker.html</file> + <file>eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html</file> <file>eric5.UtilitiesPython2.Py2SyntaxChecker.html</file> <file>eric5.UtilitiesPython2.PySideImporter.html</file> <file>eric5.UtilitiesPython2.Tabnanny.html</file>
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker.html Mon Sep 09 19:25:46 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker.html Mon Sep 09 19:26:51 2013 +0200 @@ -93,7 +93,8 @@ maximum allowed line length (integer) </dd><dt><i>hang_closing=</i></dt> <dd> -flag indicating to allow hanging closing brackets (boolean) +flag indicating to allow hanging closing + brackets (boolean) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html Mon Sep 09 19:25:46 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html Mon Sep 09 19:26:51 2013 +0200 @@ -166,7 +166,7 @@ Private method to clear all warning markers of open editors. </p><a NAME="Pep8Dialog.__createResultItem" ID="Pep8Dialog.__createResultItem"></a> <h4>Pep8Dialog.__createResultItem</h4> -<b>__createResultItem</b>(<i>file, line, pos, message, fixed</i>) +<b>__createResultItem</b>(<i>file, line, pos, message, fixed, autofixing</i>) <p> Private method to create an entry in the result list. </p><dl> @@ -185,6 +185,15 @@ </dd><dt><i>fixed</i></dt> <dd> flag indicating a fixed issue (boolean) +</dd><dt><i>autofixing</i></dt> +<dd> +flag indicating, that we are fixing issues + automatically (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the created item (QTreeWidgetItem) </dd> </dl><a NAME="Pep8Dialog.__finish" ID="Pep8Dialog.__finish"></a> <h4>Pep8Dialog.__finish</h4> @@ -219,7 +228,7 @@ </dd> </dl><a NAME="Pep8Dialog.__modifyFixedResultItem" ID="Pep8Dialog.__modifyFixedResultItem"></a> <h4>Pep8Dialog.__modifyFixedResultItem</h4> -<b>__modifyFixedResultItem</b>(<i>itm, text</i>) +<b>__modifyFixedResultItem</b>(<i>itm, text, fixed</i>) <p> Private method to modify a result list entry to show its positive fixed state. @@ -230,6 +239,9 @@ </dd><dt><i>text</i></dt> <dd> text to be appended (string) +</dd><dt><i>fixed</i></dt> +<dd> +flag indicating a fixed issue (boolean) </dd> </dl><a NAME="Pep8Dialog.__resetStatistics" ID="Pep8Dialog.__resetStatistics"></a> <h4>Pep8Dialog.__resetStatistics</h4>
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html Mon Sep 09 19:25:46 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html Mon Sep 09 19:26:51 2013 +0200 @@ -72,9 +72,6 @@ <td><a href="#Pep8Fixer.__codeMatch">__codeMatch</a></td> <td>Private method to check, if the code should be fixed.</td> </tr><tr> -<td><a href="#Pep8Fixer.__finalize">__finalize</a></td> -<td>Private method to apply all deferred fixes.</td> -</tr><tr> <td><a href="#Pep8Fixer.__findLogical">__findLogical</a></td> <td>Private method to extract the index of all the starts and ends of lines.</td> </tr><tr> @@ -82,7 +79,7 @@ <td>Private method to fix obsolete tab usage and indentation errors (E101, E111, W191).</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE121">__fixE121</a></td> -<td>Private method to fix the indentation of continuation lines and closing brackets (E121,E124).</td> +<td>Private method to fix the indentation of continuation lines and closing brackets (E121, E124).</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE122">__fixE122</a></td> <td>Private method to fix a missing indentation of continuation lines (E122).</td> @@ -136,7 +133,7 @@ <td>Private method to fix redundant backslash within brackets (E502).</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE701">__fixE701</a></td> -<td>Private method to fix colon-separated compund statements (E701).</td> +<td>Private method to fix colon-separated compound statements (E701).</td> </tr><tr> <td><a href="#Pep8Fixer.__fixE702">__fixE702</a></td> <td>Private method to fix semicolon-separated compound statements (E702, E703).</td> @@ -144,6 +141,12 @@ <td><a href="#Pep8Fixer.__fixE711">__fixE711</a></td> <td>Private method to fix comparison with None (E711, E712).</td> </tr><tr> +<td><a href="#Pep8Fixer.__fixN804">__fixN804</a></td> +<td>Private method to fix a wrong first argument of normal and class methods (N804, N805).</td> +</tr><tr> +<td><a href="#Pep8Fixer.__fixN806">__fixN806</a></td> +<td>Private method to fix a wrong first argument of static methods (N806).</td> +</tr><tr> <td><a href="#Pep8Fixer.__fixReindent">__fixReindent</a></td> <td>Private method to fix a badly indented line.</td> </tr><tr> @@ -165,6 +168,9 @@ <td><a href="#Pep8Fixer.__getEol">__getEol</a></td> <td>Private method to get the applicable eol string.</td> </tr><tr> +<td><a href="#Pep8Fixer.__getID">__getID</a></td> +<td>Private method to get the ID for a deferred fix.</td> +</tr><tr> <td><a href="#Pep8Fixer.__getIndent">__getIndent</a></td> <td>Private method to get the indentation string.</td> </tr><tr> @@ -177,6 +183,9 @@ <td><a href="#Pep8Fixer.__multilineStringLines">__multilineStringLines</a></td> <td>Private method to determine the line numbers that are within multi line strings and these which are part of a documentation string.</td> </tr><tr> +<td><a href="#Pep8Fixer.finalize">finalize</a></td> +<td>Public method to apply all deferred fixes.</td> +</tr><tr> <td><a href="#Pep8Fixer.fixIssue">fixIssue</a></td> <td>Public method to fix the fixable issues.</td> </tr><tr> @@ -237,12 +246,7 @@ <dd> flag indicating it should be fixed (boolean) </dd> -</dl><a NAME="Pep8Fixer.__finalize" ID="Pep8Fixer.__finalize"></a> -<h4>Pep8Fixer.__finalize</h4> -<b>__finalize</b>(<i></i>) -<p> - Private method to apply all deferred fixes. -</p><a NAME="Pep8Fixer.__findLogical" ID="Pep8Fixer.__findLogical"></a> +</dl><a NAME="Pep8Fixer.__findLogical" ID="Pep8Fixer.__findLogical"></a> <h4>Pep8Fixer.__findLogical</h4> <b>__findLogical</b>(<i></i>) <p> @@ -274,15 +278,16 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE121" ID="Pep8Fixer.__fixE121"></a> <h4>Pep8Fixer.__fixE121</h4> <b>__fixE121</b>(<i>code, line, pos, apply=False</i>) <p> Private method to fix the indentation of continuation lines and - closing brackets (E121,E124). + closing brackets (E121, E124). </p><dl> <dt><i>code</i></dt> <dd> @@ -301,8 +306,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE122" ID="Pep8Fixer.__fixE122"></a> <h4>Pep8Fixer.__fixE122</h4> @@ -328,8 +334,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE123" ID="Pep8Fixer.__fixE123"></a> <h4>Pep8Fixer.__fixE123</h4> @@ -355,8 +362,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE125" ID="Pep8Fixer.__fixE125"></a> <h4>Pep8Fixer.__fixE125</h4> @@ -382,8 +390,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE126" ID="Pep8Fixer.__fixE126"></a> <h4>Pep8Fixer.__fixE126</h4> @@ -409,8 +418,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE127" ID="Pep8Fixer.__fixE127"></a> <h4>Pep8Fixer.__fixE127</h4> @@ -435,8 +445,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE201" ID="Pep8Fixer.__fixE201"></a> <h4>Pep8Fixer.__fixE201</h4> @@ -458,8 +469,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE221" ID="Pep8Fixer.__fixE221"></a> <h4>Pep8Fixer.__fixE221</h4> @@ -482,8 +494,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE231" ID="Pep8Fixer.__fixE231"></a> <h4>Pep8Fixer.__fixE231</h4> @@ -504,8 +517,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE251" ID="Pep8Fixer.__fixE251"></a> <h4>Pep8Fixer.__fixE251</h4> @@ -527,8 +541,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE261" ID="Pep8Fixer.__fixE261"></a> <h4>Pep8Fixer.__fixE261</h4> @@ -550,8 +565,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE301" ID="Pep8Fixer.__fixE301"></a> <h4>Pep8Fixer.__fixE301</h4> @@ -576,8 +592,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE302" ID="Pep8Fixer.__fixE302"></a> <h4>Pep8Fixer.__fixE302</h4> @@ -602,8 +619,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE303" ID="Pep8Fixer.__fixE303"></a> <h4>Pep8Fixer.__fixE303</h4> @@ -628,8 +646,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE304" ID="Pep8Fixer.__fixE304"></a> <h4>Pep8Fixer.__fixE304</h4> @@ -655,8 +674,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE401" ID="Pep8Fixer.__fixE401"></a> <h4>Pep8Fixer.__fixE401</h4> @@ -681,8 +701,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE501" ID="Pep8Fixer.__fixE501"></a> <h4>Pep8Fixer.__fixE501</h4> @@ -707,8 +728,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE502" ID="Pep8Fixer.__fixE502"></a> <h4>Pep8Fixer.__fixE502</h4> @@ -729,14 +751,15 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE701" ID="Pep8Fixer.__fixE701"></a> <h4>Pep8Fixer.__fixE701</h4> <b>__fixE701</b>(<i>code, line, pos, apply=False</i>) <p> - Private method to fix colon-separated compund statements (E701). + Private method to fix colon-separated compound statements (E701). </p><dl> <dt><i>code</i></dt> <dd> @@ -755,8 +778,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE702" ID="Pep8Fixer.__fixE702"></a> <h4>Pep8Fixer.__fixE702</h4> @@ -782,8 +806,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixE711" ID="Pep8Fixer.__fixE711"></a> <h4>Pep8Fixer.__fixE711</h4> @@ -804,8 +829,65 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) +</dd> +</dl><a NAME="Pep8Fixer.__fixN804" ID="Pep8Fixer.__fixN804"></a> +<h4>Pep8Fixer.__fixN804</h4> +<b>__fixN804</b>(<i>code, line, pos, apply=False</i>) +<p> + Private method to fix a wrong first argument of normal and + class methods (N804, N805). +</p><dl> +<dt><i>code</i></dt> +<dd> +code of the issue (string) +</dd><dt><i>line</i></dt> +<dd> +line number of the issue (integer) +</dd><dt><i>pos</i></dt> +<dd> +position inside line (integer) +</dd><dt><i>apply=</i></dt> +<dd> +flag indicating, that the fix should be applied + (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) +</dd> +</dl><a NAME="Pep8Fixer.__fixN806" ID="Pep8Fixer.__fixN806"></a> +<h4>Pep8Fixer.__fixN806</h4> +<b>__fixN806</b>(<i>code, line, pos, apply=False</i>) +<p> + Private method to fix a wrong first argument of static methods + (N806). +</p><dl> +<dt><i>code</i></dt> +<dd> +code of the issue (string) +</dd><dt><i>line</i></dt> +<dd> +line number of the issue (integer) +</dd><dt><i>pos</i></dt> +<dd> +position inside line (integer) +</dd><dt><i>apply=</i></dt> +<dd> +flag indicating, that the fix should be applied + (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixReindent" ID="Pep8Fixer.__fixReindent"></a> <h4>Pep8Fixer.__fixReindent</h4> @@ -846,8 +928,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixW292" ID="Pep8Fixer.__fixW292"></a> <h4>Pep8Fixer.__fixW292</h4> @@ -868,8 +951,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixW391" ID="Pep8Fixer.__fixW391"></a> <h4>Pep8Fixer.__fixW391</h4> @@ -890,8 +974,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixW603" ID="Pep8Fixer.__fixW603"></a> <h4>Pep8Fixer.__fixW603</h4> @@ -912,8 +997,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.__fixWhitespace" ID="Pep8Fixer.__fixWhitespace"></a> <h4>Pep8Fixer.__fixWhitespace</h4> @@ -946,6 +1032,16 @@ <dd> eol string (string) </dd> +</dl><a NAME="Pep8Fixer.__getID" ID="Pep8Fixer.__getID"></a> +<h4>Pep8Fixer.__getID</h4> +<b>__getID</b>(<i></i>) +<p> + Private method to get the ID for a deferred fix. +</p><dl> +<dt>Returns:</dt> +<dd> +ID for a deferred fix (integer) +</dd> </dl><a NAME="Pep8Fixer.__getIndent" ID="Pep8Fixer.__getIndent"></a> <h4>Pep8Fixer.__getIndent</h4> <b>__getIndent</b>(<i>line</i>) @@ -1006,7 +1102,12 @@ string and a set of line numbers belonging to a multi line documentation string (tuple of two set of integer) </dd> -</dl><a NAME="Pep8Fixer.fixIssue" ID="Pep8Fixer.fixIssue"></a> +</dl><a NAME="Pep8Fixer.finalize" ID="Pep8Fixer.finalize"></a> +<h4>Pep8Fixer.finalize</h4> +<b>finalize</b>(<i></i>) +<p> + Public method to apply all deferred fixes. +</p><a NAME="Pep8Fixer.fixIssue" ID="Pep8Fixer.fixIssue"></a> <h4>Pep8Fixer.fixIssue</h4> <b>fixIssue</b>(<i>line, pos, message</i>) <p> @@ -1025,8 +1126,9 @@ </dl><dl> <dt>Returns:</dt> <dd> -flag indicating an applied fix (boolean) and a message for - the fix (string) +value indicating an applied/deferred fix (-1, 0, 1), + a message for the fix (string) and an ID for a deferred + fix (integer) </dd> </dl><a NAME="Pep8Fixer.mutualStartswith" ID="Pep8Fixer.mutualStartswith"></a> <h4>Pep8Fixer.mutualStartswith</h4>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html Mon Sep 09 19:26:51 2013 +0200 @@ -0,0 +1,378 @@ +<!DOCTYPE html> +<html><head> +<title>eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker</h1> +<p> +Module implementing a checker for PEP-8 naming conventions. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#Pep8NamingChecker">Pep8NamingChecker</a></td> +<td>Class implementing a checker for PEP-8 naming conventions.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="Pep8NamingChecker" ID="Pep8NamingChecker"></a> +<h2>Pep8NamingChecker</h2> +<p> + Class implementing a checker for PEP-8 naming conventions. +</p> +<h3>Derived from</h3> +object +<h3>Class Attributes</h3> +<table> +<tr><td>CamelcaseRegexp</td></tr><tr><td>Codes</td></tr><tr><td>LowercaseRegex</td></tr><tr><td>Messages</td></tr><tr><td>MixedcaseRegexp</td></tr><tr><td>UppercaseRegexp</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr> +<td><a href="#Pep8NamingChecker.getMessage">getMessage</a></td> +<td>Class method to get a translated and formatted message for a given code.</td> +</tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#Pep8NamingChecker.__init__">Pep8NamingChecker</a></td> +<td>Constructor (according to pep8.py API)</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkClassName">__checkClassName</a></td> +<td>Private class to check the given node for class name conventions (N801, N831).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkFunctionArgumentNames">__checkFunctionArgumentNames</a></td> +<td>Private class to check the argument names of functions (N803, N804, N805, N806, N831).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkFuntionName">__checkFuntionName</a></td> +<td>Private class to check the given node for function name conventions (N802, N831).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkImportAs">__checkImportAs</a></td> +<td>Private method to check that imports don't change the naming convention (N811, N812, N813, N814).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkModule">__checkModule</a></td> +<td>Private method to check module naming conventions (N807, N808).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkVariablesInFunction">__checkVariablesInFunction</a></td> +<td>Private method to check local variables in functions (N821, N831).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__error">__error</a></td> +<td>Private method to build the error information</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__findGlobalDefs">__findGlobalDefs</a></td> +<td>Private method amend a node with global definitions information.</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__getArgNames">__getArgNames</a></td> +<td>Private method to get the argument names of a function node.</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__isNameToBeAvoided">__isNameToBeAvoided</a></td> +<td>Private method to check, if the given name should be avoided.</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__tagClassFunctions">__tagClassFunctions</a></td> +<td>Private method to tag functions if they are methods, class methods or static methods.</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__visitNode">__visitNode</a></td> +<td>Private method to inspect the given AST node.</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__visitTree">__visitTree</a></td> +<td>Private method to scan the given AST tree.</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.run">run</a></td> +<td>Public method run by the pep8.py checker.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="Pep8NamingChecker.getMessage" ID="Pep8NamingChecker.getMessage"></a> +<h4>Pep8NamingChecker.getMessage (class method)</h4> +<b>getMessage</b>(<i>code, *args</i>) +<p> + Class method to get a translated and formatted message for a + given code. +</p><dl> +<dt><i>code</i></dt> +<dd> +message code (string) +</dd><dt><i>args</i></dt> +<dd> +arguments for a formatted message (list) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +translated and formatted message (string) +</dd> +</dl><a NAME="Pep8NamingChecker.__init__" ID="Pep8NamingChecker.__init__"></a> +<h4>Pep8NamingChecker (Constructor)</h4> +<b>Pep8NamingChecker</b>(<i>tree, filename</i>) +<p> + Constructor (according to pep8.py API) +</p><dl> +<dt><i>tree</i></dt> +<dd> +AST tree of the source file +</dd><dt><i>filename</i></dt> +<dd> +name of the source file (string) +</dd> +</dl><a NAME="Pep8NamingChecker.__checkClassName" ID="Pep8NamingChecker.__checkClassName"></a> +<h4>Pep8NamingChecker.__checkClassName</h4> +<b>__checkClassName</b>(<i>node, parents</i>) +<p> + Private class to check the given node for class name + conventions (N801, N831). +</p><p> + Almost without exception, class names use the CapWords convention. + Classes for internal use have a leading underscore in addition. +</p><dl> +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line and error code + (integer, integer, string) +</dd> +</dl><a NAME="Pep8NamingChecker.__checkFunctionArgumentNames" ID="Pep8NamingChecker.__checkFunctionArgumentNames"></a> +<h4>Pep8NamingChecker.__checkFunctionArgumentNames</h4> +<b>__checkFunctionArgumentNames</b>(<i>node, parents</i>) +<p> + Private class to check the argument names of functions + (N803, N804, N805, N806, N831). +</p><p> + The argument names of a function should be lowercase, with words + separated by underscores. A class method should have 'cls' as the + first argument. A method should have 'self' as the first argument. +</p><dl> +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line and error code + (integer, integer, string) +</dd> +</dl><a NAME="Pep8NamingChecker.__checkFuntionName" ID="Pep8NamingChecker.__checkFuntionName"></a> +<h4>Pep8NamingChecker.__checkFuntionName</h4> +<b>__checkFuntionName</b>(<i>node, parents</i>) +<p> + Private class to check the given node for function name + conventions (N802, N831). +</p><p> + Function names should be lowercase, with words separated by underscores + as necessary to improve readability. Functions <b>not</b> being + methods '__' in front and back are not allowed. Mixed case is allowed + only in contexts where that's already the prevailing style + (e.g. threading.py), to retain backwards compatibility. +</p><dl> +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line and error code + (integer, integer, string) +</dd> +</dl><a NAME="Pep8NamingChecker.__checkImportAs" ID="Pep8NamingChecker.__checkImportAs"></a> +<h4>Pep8NamingChecker.__checkImportAs</h4> +<b>__checkImportAs</b>(<i>node, parents</i>) +<p> + Private method to check that imports don't change the + naming convention (N811, N812, N813, N814). +</p><dl> +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line and error code + (integer, integer, string) +</dd> +</dl><a NAME="Pep8NamingChecker.__checkModule" ID="Pep8NamingChecker.__checkModule"></a> +<h4>Pep8NamingChecker.__checkModule</h4> +<b>__checkModule</b>(<i>node, parents</i>) +<p> + Private method to check module naming conventions (N807, N808). +</p><p> + Module and package names should be lowercase. +</p><dl> +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line and error code + (integer, integer, string) +</dd> +</dl><a NAME="Pep8NamingChecker.__checkVariablesInFunction" ID="Pep8NamingChecker.__checkVariablesInFunction"></a> +<h4>Pep8NamingChecker.__checkVariablesInFunction</h4> +<b>__checkVariablesInFunction</b>(<i>node, parents</i>) +<p> + Private method to check local variables in functions (N821, N831). +</p><p> + Local variables in functions should be lowercase. +</p><dl> +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line and error code + (integer, integer, string) +</dd> +</dl><a NAME="Pep8NamingChecker.__error" ID="Pep8NamingChecker.__error"></a> +<h4>Pep8NamingChecker.__error</h4> +<b>__error</b>(<i>node, code</i>) +<p> + Private method to build the error information +</p><dl> +<dt><i>node</i></dt> +<dd> +AST node to report an error for +</dd><dt><i>code</i></dt> +<dd> +error code to report (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line and error code + (integer, integer, string) +</dd> +</dl><a NAME="Pep8NamingChecker.__findGlobalDefs" ID="Pep8NamingChecker.__findGlobalDefs"></a> +<h4>Pep8NamingChecker.__findGlobalDefs</h4> +<b>__findGlobalDefs</b>(<i>functionNode</i>) +<p> + Private method amend a node with global definitions information. +</p><dl> +<dt><i>functionNode</i></dt> +<dd> +AST tree node to amend +</dd> +</dl><a NAME="Pep8NamingChecker.__getArgNames" ID="Pep8NamingChecker.__getArgNames"></a> +<h4>Pep8NamingChecker.__getArgNames</h4> +<b>__getArgNames</b>(<i>node</i>) +<p> + Private method to get the argument names of a function node. +</p><dl> +<dt><i>node</i></dt> +<dd> +AST node to extract arguments names from +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +list of argument names (list of string) +</dd> +</dl><a NAME="Pep8NamingChecker.__isNameToBeAvoided" ID="Pep8NamingChecker.__isNameToBeAvoided"></a> +<h4>Pep8NamingChecker.__isNameToBeAvoided</h4> +<b>__isNameToBeAvoided</b>(<i>name</i>) +<p> + Private method to check, if the given name should be avoided. +</p><dl> +<dt><i>name</i></dt> +<dd> +name to be checked (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating to avoid it (boolen) +</dd> +</dl><a NAME="Pep8NamingChecker.__tagClassFunctions" ID="Pep8NamingChecker.__tagClassFunctions"></a> +<h4>Pep8NamingChecker.__tagClassFunctions</h4> +<b>__tagClassFunctions</b>(<i>classNode</i>) +<p> + Private method to tag functions if they are methods, class methods or + static methods. +</p><dl> +<dt><i>classNode</i></dt> +<dd> +AST tree node to tag +</dd> +</dl><a NAME="Pep8NamingChecker.__visitNode" ID="Pep8NamingChecker.__visitNode"></a> +<h4>Pep8NamingChecker.__visitNode</h4> +<b>__visitNode</b>(<i>node</i>) +<p> + Private method to inspect the given AST node. +</p><dl> +<dt><i>node</i></dt> +<dd> +AST tree node to inspect +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line, code and + checker function +</dd> +</dl><a NAME="Pep8NamingChecker.__visitTree" ID="Pep8NamingChecker.__visitTree"></a> +<h4>Pep8NamingChecker.__visitTree</h4> +<b>__visitTree</b>(<i>node</i>) +<p> + Private method to scan the given AST tree. +</p><dl> +<dt><i>node</i></dt> +<dd> +AST tree node to scan +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line, code and + checker function +</dd> +</dl><a NAME="Pep8NamingChecker.run" ID="Pep8NamingChecker.run"></a> +<h4>Pep8NamingChecker.run</h4> +<b>run</b>(<i></i>) +<p> + Public method run by the pep8.py checker. +</p><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line, code and + checker function +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- a/Documentation/Source/eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.html Mon Sep 09 19:25:46 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.html Mon Sep 09 19:26:51 2013 +0200 @@ -208,7 +208,8 @@ <h4>E5MessageBoxWizardDialog.on_rAboutQt_toggled</h4> <b>on_rAboutQt_toggled</b>(<i>checked</i>) <p> - Private slot to handle the toggled signal of the rAboutQt radio button. + Private slot to handle the toggled signal of the rAboutQt + radio button. </p><dl> <dt><i>on</i></dt> <dd> @@ -218,7 +219,8 @@ <h4>E5MessageBoxWizardDialog.on_rAbout_toggled</h4> <b>on_rAbout_toggled</b>(<i>checked</i>) <p> - Private slot to handle the toggled signal of the rAbout radio button. + Private slot to handle the toggled signal of the rAbout + radio button. </p><dl> <dt><i>on</i></dt> <dd> @@ -228,7 +230,8 @@ <h4>E5MessageBoxWizardDialog.on_rCritical_toggled</h4> <b>on_rCritical_toggled</b>(<i>checked</i>) <p> - Private slot to handle the toggled signal of the rCritical radio button. + Private slot to handle the toggled signal of the rCritical + radio button. </p><dl> <dt><i>on</i></dt> <dd> @@ -238,7 +241,8 @@ <h4>E5MessageBoxWizardDialog.on_rInformation_toggled</h4> <b>on_rInformation_toggled</b>(<i>checked</i>) <p> - Private slot to handle the toggled signal of the rInformation radio button. + Private slot to handle the toggled signal of the rInformation + radio button. </p><dl> <dt><i>on</i></dt> <dd> @@ -248,7 +252,8 @@ <h4>E5MessageBoxWizardDialog.on_rOkToClearData_toggled</h4> <b>on_rOkToClearData_toggled</b>(<i>checked</i>) <p> - Private slot to handle the toggled signal of the rOkToClearData radio button. + Private slot to handle the toggled signal of the rOkToClearData + radio button. </p><dl> <dt><i>on</i></dt> <dd> @@ -258,7 +263,8 @@ <h4>E5MessageBoxWizardDialog.on_rQuestion_toggled</h4> <b>on_rQuestion_toggled</b>(<i>checked</i>) <p> - Private slot to handle the toggled signal of the rQuestion radio button. + Private slot to handle the toggled signal of the rQuestion + radio button. </p><dl> <dt><i>on</i></dt> <dd> @@ -268,7 +274,8 @@ <h4>E5MessageBoxWizardDialog.on_rRetryAbort_toggled</h4> <b>on_rRetryAbort_toggled</b>(<i>checked</i>) <p> - Private slot to handle the toggled signal of the rRetryAbort radio button. + Private slot to handle the toggled signal of the rRetryAbort + radio button. </p><dl> <dt><i>on</i></dt> <dd> @@ -278,7 +285,8 @@ <h4>E5MessageBoxWizardDialog.on_rStandard_toggled</h4> <b>on_rStandard_toggled</b>(<i>checked</i>) <p> - Private slot to handle the toggled signal of the rStandard radio button. + Private slot to handle the toggled signal of the rStandard + radio button. </p><dl> <dt><i>on</i></dt> <dd> @@ -288,7 +296,8 @@ <h4>E5MessageBoxWizardDialog.on_rWarning_toggled</h4> <b>on_rWarning_toggled</b>(<i>checked</i>) <p> - Private slot to handle the toggled signal of the rWarning radio button. + Private slot to handle the toggled signal of the rWarning + radio button. </p><dl> <dt><i>on</i></dt> <dd> @@ -298,7 +307,8 @@ <h4>E5MessageBoxWizardDialog.on_rYesNo_toggled</h4> <b>on_rYesNo_toggled</b>(<i>checked</i>) <p> - Private slot to handle the toggled signal of the rYesNo radio button. + Private slot to handle the toggled signal of the rYesNo + radio button. </p><dl> <dt><i>on</i></dt> <dd>
--- a/Documentation/Source/eric5.Plugins.WizardPlugins.FontDialogWizard.FontDialogWizardDialog.html Mon Sep 09 19:25:46 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.WizardPlugins.FontDialogWizard.FontDialogWizardDialog.html Mon Sep 09 19:26:51 2013 +0200 @@ -140,8 +140,8 @@ <h4>FontDialogWizardDialog.on_fontButton_clicked</h4> <b>on_fontButton_clicked</b>(<i></i>) <p> - Private slot to handle the button press to select a font via a font selection - dialog. + Private slot to handle the button press to select a font via a + font selection dialog. </p> <div align="right"><a href="#top">Up</a></div> <hr />
--- a/Documentation/Source/eric5.Plugins.WizardPlugins.QRegExpWizard.QRegExpWizardDialog.html Mon Sep 09 19:25:46 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.WizardPlugins.QRegExpWizard.QRegExpWizardDialog.html Mon Sep 09 19:26:51 2013 +0200 @@ -247,7 +247,8 @@ <h4>QRegExpWizardWidget.__getPatternSyntaxCode</h4> <b>__getPatternSyntaxCode</b>(<i>syntaxValue</i>) <p> - Private method to convert a pattern syntax value into a pattern syntax string. + Private method to convert a pattern syntax value into a + pattern syntax string. </p><dl> <dt><i>syntaxValue</i></dt> <dd>
--- a/Documentation/Source/eric5.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardDialog.html Mon Sep 09 19:25:46 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardDialog.html Mon Sep 09 19:26:51 2013 +0200 @@ -295,7 +295,8 @@ </p><dl> <dt><i>commandDict</i></dt> <dd> -dictionary with command string and related data (dict) +dictionary with command string and related + data (dict) </dd> </dl><dl> <dt>Returns:</dt> @@ -376,10 +377,11 @@ <h4>QRegularExpressionWizardWidget.on_executeButton_clicked</h4> <b>on_executeButton_clicked</b>(<i>startpos=0</i>) <p> - Private slot to execute the entered QRegularExpression on the test text. + Private slot to execute the entered QRegularExpression on the test + text. </p><p> - This slot will execute the entered QRegularExpression on the entered test - data and will display the result in the table part of the dialog. + This slot will execute the entered QRegularExpression on the entered + test data and will display the result in the table part of the dialog. </p><dl> <dt><i>startpos</i></dt> <dd>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html Mon Sep 09 19:26:51 2013 +0200 @@ -0,0 +1,374 @@ +<!DOCTYPE html> +<html><head> +<title>eric5.UtilitiesPython2.Pep8NamingCheckerPy2</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.UtilitiesPython2.Pep8NamingCheckerPy2</h1> +<p> +Module implementing a checker for PEP-8 naming conventions for Python2. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#Pep8NamingChecker">Pep8NamingChecker</a></td> +<td>Class implementing a checker for PEP-8 naming conventions for Python2.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="Pep8NamingChecker" ID="Pep8NamingChecker"></a> +<h2>Pep8NamingChecker</h2> +<p> + Class implementing a checker for PEP-8 naming conventions for Python2. +</p> +<h3>Derived from</h3> +object +<h3>Class Attributes</h3> +<table> +<tr><td>CamelcaseRegexp</td></tr><tr><td>Codes</td></tr><tr><td>LowercaseRegex</td></tr><tr><td>MixedcaseRegexp</td></tr><tr><td>UppercaseRegexp</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#Pep8NamingChecker.__init__">Pep8NamingChecker</a></td> +<td>Constructor (according to pep8.py API)</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkClassName">__checkClassName</a></td> +<td>Private class to check the given node for class name conventions (N801, N831).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkFunctionArgumentNames">__checkFunctionArgumentNames</a></td> +<td>Private class to check the argument names of functions (N803, N804, N805, N806, N831).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkFuntionName">__checkFuntionName</a></td> +<td>Private class to check the given node for function name conventions (N802, N831).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkImportAs">__checkImportAs</a></td> +<td>Private method to check that imports don't change the naming convention (N811, N812, N813, N814).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkModule">__checkModule</a></td> +<td>Private method to check module naming conventions (N807, N808).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkVariablesInFunction">__checkVariablesInFunction</a></td> +<td>Private method to check local variables in functions (N821, N831).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__error">__error</a></td> +<td>Private method to build the error information</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__findGlobalDefs">__findGlobalDefs</a></td> +<td>Private method amend a node with global definitions information.</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__getArgNames">__getArgNames</a></td> +<td>Private method to get the argument names of a function node.</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__isNameToBeAvoided">__isNameToBeAvoided</a></td> +<td>Private method to check, if the given name should be avoided.</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__tagClassFunctions">__tagClassFunctions</a></td> +<td>Private method to tag functions if they are methods, class methods or static methods.</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__visitNode">__visitNode</a></td> +<td>Private method to inspect the given AST node.</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__visitTree">__visitTree</a></td> +<td>Private method to scan the given AST tree.</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.run">run</a></td> +<td>Public method run by the pep8.py checker.</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.unpackArgs">unpackArgs</a></td> +<td>Local helper function to unpack function argument names.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="Pep8NamingChecker.__init__" ID="Pep8NamingChecker.__init__"></a> +<h4>Pep8NamingChecker (Constructor)</h4> +<b>Pep8NamingChecker</b>(<i>tree, filename</i>) +<p> + Constructor (according to pep8.py API) +</p><dl> +<dt><i>tree</i></dt> +<dd> +AST tree of the source file +</dd><dt><i>filename</i></dt> +<dd> +name of the source file (string) +</dd> +</dl><a NAME="Pep8NamingChecker.__checkClassName" ID="Pep8NamingChecker.__checkClassName"></a> +<h4>Pep8NamingChecker.__checkClassName</h4> +<b>__checkClassName</b>(<i>node, parents</i>) +<p> + Private class to check the given node for class name + conventions (N801, N831). +</p><p> + Almost without exception, class names use the CapWords convention. + Classes for internal use have a leading underscore in addition. +</p><dl> +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line and error code + (integer, integer, string) +</dd> +</dl><a NAME="Pep8NamingChecker.__checkFunctionArgumentNames" ID="Pep8NamingChecker.__checkFunctionArgumentNames"></a> +<h4>Pep8NamingChecker.__checkFunctionArgumentNames</h4> +<b>__checkFunctionArgumentNames</b>(<i>node, parents</i>) +<p> + Private class to check the argument names of functions + (N803, N804, N805, N806, N831). +</p><p> + The argument names of a function should be lowercase, with words + separated by underscores. A class method should have 'cls' as the + first argument. A method should have 'self' as the first argument. +</p><dl> +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line and error code + (integer, integer, string) +</dd> +</dl><a NAME="Pep8NamingChecker.__checkFuntionName" ID="Pep8NamingChecker.__checkFuntionName"></a> +<h4>Pep8NamingChecker.__checkFuntionName</h4> +<b>__checkFuntionName</b>(<i>node, parents</i>) +<p> + Private class to check the given node for function name + conventions (N802, N831). +</p><p> + Function names should be lowercase, with words separated by underscores + as necessary to improve readability. Functions <b>not</b> being + methods '__' in front and back are not allowed. Mixed case is allowed + only in contexts where that's already the prevailing style + (e.g. threading.py), to retain backwards compatibility. +</p><dl> +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line and error code + (integer, integer, string) +</dd> +</dl><a NAME="Pep8NamingChecker.__checkImportAs" ID="Pep8NamingChecker.__checkImportAs"></a> +<h4>Pep8NamingChecker.__checkImportAs</h4> +<b>__checkImportAs</b>(<i>node, parents</i>) +<p> + Private method to check that imports don't change the + naming convention (N811, N812, N813, N814). +</p><dl> +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line and error code + (integer, integer, string) +</dd> +</dl><a NAME="Pep8NamingChecker.__checkModule" ID="Pep8NamingChecker.__checkModule"></a> +<h4>Pep8NamingChecker.__checkModule</h4> +<b>__checkModule</b>(<i>node, parents</i>) +<p> + Private method to check module naming conventions (N807, N808). +</p><p> + Module and package names should be lowercase. +</p><dl> +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line and error code + (integer, integer, string) +</dd> +</dl><a NAME="Pep8NamingChecker.__checkVariablesInFunction" ID="Pep8NamingChecker.__checkVariablesInFunction"></a> +<h4>Pep8NamingChecker.__checkVariablesInFunction</h4> +<b>__checkVariablesInFunction</b>(<i>node, parents</i>) +<p> + Private method to check local variables in functions (N821, N831). +</p><p> + Local variables in functions should be lowercase. +</p><dl> +<dt><i>node</i></dt> +<dd> +AST note to check +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line and error code + (integer, integer, string) +</dd> +</dl><a NAME="Pep8NamingChecker.__error" ID="Pep8NamingChecker.__error"></a> +<h4>Pep8NamingChecker.__error</h4> +<b>__error</b>(<i>node, code</i>) +<p> + Private method to build the error information +</p><dl> +<dt><i>node</i></dt> +<dd> +AST node to report an error for +</dd><dt><i>code</i></dt> +<dd> +error code to report (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line and error code + (integer, integer, string) +</dd> +</dl><a NAME="Pep8NamingChecker.__findGlobalDefs" ID="Pep8NamingChecker.__findGlobalDefs"></a> +<h4>Pep8NamingChecker.__findGlobalDefs</h4> +<b>__findGlobalDefs</b>(<i>functionNode</i>) +<p> + Private method amend a node with global definitions information. +</p><dl> +<dt><i>functionNode</i></dt> +<dd> +AST tree node to amend +</dd> +</dl><a NAME="Pep8NamingChecker.__getArgNames" ID="Pep8NamingChecker.__getArgNames"></a> +<h4>Pep8NamingChecker.__getArgNames</h4> +<b>__getArgNames</b>(<i>node</i>) +<p> + Private method to get the argument names of a function node. +</p><dl> +<dt><i>node</i></dt> +<dd> +AST node to extract arguments names from +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +list of argument names (list of string) +</dd> +</dl><a NAME="Pep8NamingChecker.__isNameToBeAvoided" ID="Pep8NamingChecker.__isNameToBeAvoided"></a> +<h4>Pep8NamingChecker.__isNameToBeAvoided</h4> +<b>__isNameToBeAvoided</b>(<i>name</i>) +<p> + Private method to check, if the given name should be avoided. +</p><dl> +<dt><i>name</i></dt> +<dd> +name to be checked (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating to avoid it (boolen) +</dd> +</dl><a NAME="Pep8NamingChecker.__tagClassFunctions" ID="Pep8NamingChecker.__tagClassFunctions"></a> +<h4>Pep8NamingChecker.__tagClassFunctions</h4> +<b>__tagClassFunctions</b>(<i>classNode</i>) +<p> + Private method to tag functions if they are methods, class methods or + static methods. +</p><dl> +<dt><i>classNode</i></dt> +<dd> +AST tree node to tag +</dd> +</dl><a NAME="Pep8NamingChecker.__visitNode" ID="Pep8NamingChecker.__visitNode"></a> +<h4>Pep8NamingChecker.__visitNode</h4> +<b>__visitNode</b>(<i>node</i>) +<p> + Private method to inspect the given AST node. +</p><dl> +<dt><i>node</i></dt> +<dd> +AST tree node to inspect +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line, code and + checker function +</dd> +</dl><a NAME="Pep8NamingChecker.__visitTree" ID="Pep8NamingChecker.__visitTree"></a> +<h4>Pep8NamingChecker.__visitTree</h4> +<b>__visitTree</b>(<i>node</i>) +<p> + Private method to scan the given AST tree. +</p><dl> +<dt><i>node</i></dt> +<dd> +AST tree node to scan +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line, code and + checker function +</dd> +</dl><a NAME="Pep8NamingChecker.run" ID="Pep8NamingChecker.run"></a> +<h4>Pep8NamingChecker.run</h4> +<b>run</b>(<i></i>) +<p> + Public method run by the pep8.py checker. +</p><dl> +<dt>Returns:</dt> +<dd> +tuple giving line number, offset within line, code and + checker function +</dd> +</dl><a NAME="Pep8NamingChecker.unpackArgs" ID="Pep8NamingChecker.unpackArgs"></a> +<h4>Pep8NamingChecker.unpackArgs</h4> +<b>unpackArgs</b>(<i></i>) +<p> + Local helper function to unpack function argument names. +</p><dl> +<dt><i>args</i></dt> +<dd> +list of AST node arguments +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +list of argument names (list of string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- a/Documentation/Source/index-eric5.Plugins.CheckerPlugins.Pep8.html Mon Sep 09 19:25:46 2013 +0200 +++ b/Documentation/Source/index-eric5.Plugins.CheckerPlugins.Pep8.html Mon Sep 09 19:26:51 2013 +0200 @@ -40,6 +40,9 @@ <td><a href="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html">Pep8Fixer</a></td> <td>Module implementing a class to fix certain PEP 8 issues.</td> </tr><tr> +<td><a href="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html">Pep8NamingChecker</a></td> +<td>Module implementing a checker for PEP-8 naming conventions.</td> +</tr><tr> <td><a href="eric5.Plugins.CheckerPlugins.Pep8.Pep8StatisticsDialog.html">Pep8StatisticsDialog</a></td> <td>Module implementing a dialog showing statistical data for the last PEP 8 run.</td> </tr><tr>
--- a/Documentation/Source/index-eric5.UtilitiesPython2.html Mon Sep 09 19:25:46 2013 +0200 +++ b/Documentation/Source/index-eric5.UtilitiesPython2.html Mon Sep 09 19:26:51 2013 +0200 @@ -38,6 +38,9 @@ <td><a href="eric5.UtilitiesPython2.Pep8Checker.html">Pep8Checker</a></td> <td>Class implementing the PEP 8 checker for Python2.</td> </tr><tr> +<td><a href="eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html">Pep8NamingCheckerPy2</a></td> +<td>Module implementing a checker for PEP-8 naming conventions for Python2.</td> +</tr><tr> <td><a href="eric5.UtilitiesPython2.Py2SyntaxChecker.html">Py2SyntaxChecker</a></td> <td>Module implementing the syntax check for Python 2.</td> </tr><tr>