Tue, 15 Oct 2013 22:03:54 +0200
Merge with default branch before style changes.
--- a/APIs/Python3/eric5.api Sun Sep 08 19:04:07 2013 +0200 +++ b/APIs/Python3/eric5.api Tue Oct 15 22:03:54 2013 +0200 @@ -1,3 +1,37 @@ +Pep257CheckerPy2.Pep257Checker.Codes?7 +Pep257CheckerPy2.Pep257Checker.run?4() +Pep257CheckerPy2.Pep257Checker.unpackArgs?4() +Pep257CheckerPy2.Pep257Checker?1(source, filename, select, ignore, expected, repeat, maxLineLength=79, docType="pep257") +Pep257CheckerPy2.Pep257Context.contextType?4() +Pep257CheckerPy2.Pep257Context.end?4() +Pep257CheckerPy2.Pep257Context.indent?4() +Pep257CheckerPy2.Pep257Context.source?4() +Pep257CheckerPy2.Pep257Context.ssource?4() +Pep257CheckerPy2.Pep257Context.start?4() +Pep257CheckerPy2.Pep257Context?1(source, startLine, contextType) +Pep8Checker.Pep8Report.docType?7 +Pep8Checker.Pep8Report.error_args?4(line_number, offset, code, check, *args) +Pep8Checker.Pep8Report.filename?7 +Pep8Checker.Pep8Report.hang_closing?7 +Pep8Checker.Pep8Report.ignore?7 +Pep8Checker.Pep8Report.max_line_length?7 +Pep8Checker.Pep8Report.repeat?7 +Pep8Checker.Pep8Report.select?7 +Pep8Checker.Pep8Report?1(options) +Pep8NamingCheckerPy2.Pep8NamingChecker.CamelcaseRegexp?7 +Pep8NamingCheckerPy2.Pep8NamingChecker.Codes?7 +Pep8NamingCheckerPy2.Pep8NamingChecker.LowercaseRegex?7 +Pep8NamingCheckerPy2.Pep8NamingChecker.MixedcaseRegexp?7 +Pep8NamingCheckerPy2.Pep8NamingChecker.UppercaseRegexp?7 +Pep8NamingCheckerPy2.Pep8NamingChecker.run?4() +Pep8NamingCheckerPy2.Pep8NamingChecker.unpackArgs?4() +Pep8NamingCheckerPy2.Pep8NamingChecker?1(tree, filename, options) +Tools.coding_regexps?7 +Tools.decode?4(text) +Tools.extractLineFlags?4(line, startComment=") +Tools.get_coding?4(text) +Tools.normalizeCode?4(codestring) +Tools.readEncodedFile?4(filename) eric5.Cooperation.ChatWidget.ChatWidget.appendMessage?4(from_, message) eric5.Cooperation.ChatWidget.ChatWidget.cancelEdit?7 eric5.Cooperation.ChatWidget.ChatWidget.checkEditorActions?4(editor) @@ -3687,7 +3721,7 @@ eric5.PluginManager.PluginManager.PluginManager.preferencesChanged?4() eric5.PluginManager.PluginManager.PluginManager.removePluginFromSysModules?4(pluginName, package, internalPackages) eric5.PluginManager.PluginManager.PluginManager.shutdown?7 -eric5.PluginManager.PluginManager.PluginManager.unloadPlugin?4(name, directory) +eric5.PluginManager.PluginManager.PluginManager.unloadPlugin?4(name) eric5.PluginManager.PluginManager.PluginManager?1(parent=None, doLoadPlugins=True, develPlugin=None) eric5.PluginManager.PluginRepositoryDialog.PluginRepositoryDialog.getDownloadedPlugins?4() eric5.PluginManager.PluginRepositoryDialog.PluginRepositoryDialog?1(parent=None) @@ -3716,6 +3750,20 @@ eric5.Plugins.AboutPlugin.AboutDialog.licenseText?7 eric5.Plugins.AboutPlugin.AboutDialog.thanksText?7 eric5.Plugins.AboutPlugin.AboutDialog.titleText?7 +eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Checker.Codes?7 +eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Checker.Messages?7 +eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Checker.getMessage?4(code, *args) +eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Checker.run?4() +eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Checker.unpackArgs?4() +eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Checker?1(source, filename, select, ignore, expected, repeat, maxLineLength=79, docType="pep257") +eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Context.contextType?4() +eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Context.end?4() +eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Context.indent?4() +eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Context.source?4() +eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Context.ssource?4() +eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Context.start?4() +eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.Pep257Context?1(source, startLine, contextType) +eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker.Pep8Py2Checker?1(filename, lines, repeat=False, select="", ignore="", max_line_length=79, hang_closing=False, docType="pep257") eric5.Plugins.CheckerPlugins.Pep8.Pep8CodeSelectionDialog.Pep8CodeSelectionDialog.getSelectedCodes?4() eric5.Plugins.CheckerPlugins.Pep8.Pep8CodeSelectionDialog.Pep8CodeSelectionDialog?1(codes, showFixCodes, parent=None) eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.Pep8Dialog.codeRole?7 @@ -3744,6 +3792,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) @@ -3757,6 +3806,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, options) 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 @@ -5803,6 +5861,8 @@ eric5.Preferences.ConfigurationPages.EditorSpellCheckingPage.create?4(dlg) eric5.Preferences.ConfigurationPages.EditorStylesPage.EditorStylesPage.on_annotationsErrorBgButton_clicked?4() eric5.Preferences.ConfigurationPages.EditorStylesPage.EditorStylesPage.on_annotationsErrorFgButton_clicked?4() +eric5.Preferences.ConfigurationPages.EditorStylesPage.EditorStylesPage.on_annotationsStyleWarningBgButton_clicked?4() +eric5.Preferences.ConfigurationPages.EditorStylesPage.EditorStylesPage.on_annotationsStyleWarningFgButton_clicked?4() eric5.Preferences.ConfigurationPages.EditorStylesPage.EditorStylesPage.on_annotationsWarningBgButton_clicked?4() eric5.Preferences.ConfigurationPages.EditorStylesPage.EditorStylesPage.on_annotationsWarningFgButton_clicked?4() eric5.Preferences.ConfigurationPages.EditorStylesPage.EditorStylesPage.on_defaultFontButton_clicked?4() @@ -5932,9 +5992,6 @@ eric5.Preferences.ConfigurationPages.ProjectPage.ProjectPage.save?4() eric5.Preferences.ConfigurationPages.ProjectPage.ProjectPage?1() eric5.Preferences.ConfigurationPages.ProjectPage.create?4(dlg) -eric5.Preferences.ConfigurationPages.Py3FlakesPage.Py3FlakesPage.save?4() -eric5.Preferences.ConfigurationPages.Py3FlakesPage.Py3FlakesPage?1() -eric5.Preferences.ConfigurationPages.Py3FlakesPage.create?4(dlg) eric5.Preferences.ConfigurationPages.PythonPage.PythonPage.save?4() eric5.Preferences.ConfigurationPages.PythonPage.PythonPage?1() eric5.Preferences.ConfigurationPages.PythonPage.create?4(dlg) @@ -6619,6 +6676,8 @@ eric5.QScintilla.Editor.Editor.StartEditToken?7 eric5.QScintilla.Editor.Editor.SyncToken?7 eric5.QScintilla.Editor.Editor.TemplateImageID?7 +eric5.QScintilla.Editor.Editor.WarningCode?7 +eric5.QScintilla.Editor.Editor.WarningStyle?7 eric5.QScintilla.Editor.Editor.addClone?4(editor) eric5.QScintilla.Editor.Editor.addedToProject?4() eric5.QScintilla.Editor.Editor.autoComplete?4(auto=False, context=True) @@ -6792,7 +6851,7 @@ eric5.QScintilla.Editor.Editor.taskMarkersUpdated?7 eric5.QScintilla.Editor.Editor.toggleBookmark?4(line) eric5.QScintilla.Editor.Editor.toggleCommentBlock?4() -eric5.QScintilla.Editor.Editor.toggleFlakesWarning?4(line, warning, msg="") +eric5.QScintilla.Editor.Editor.toggleFlakesWarning?4(line, warning, msg="", warningType=WarningCode) eric5.QScintilla.Editor.Editor.toggleSyntaxError?4(line, index, error, msg="", show=False) eric5.QScintilla.Editor.Editor.uncommentLine?4() eric5.QScintilla.Editor.Editor.uncommentLineOrSelection?4() @@ -8843,3 +8902,115 @@ eric5.uninstall.uninstallEric?4() eric5.uninstall.usage?4(rcode=2) eric5.uninstall.wrapperName?4(dname, wfile) +pep8.ARITHMETIC_OP?7 +pep8.BENCHMARK_KEYS?7 +pep8.BaseReport.error?4(line_number, offset, text, check) +pep8.BaseReport.error_args?4(line_number, offset, code, check, *args) +pep8.BaseReport.get_count?4(prefix='') +pep8.BaseReport.get_file_results?4() +pep8.BaseReport.get_statistics?4(prefix='') +pep8.BaseReport.increment_logical_line?4() +pep8.BaseReport.init_file?4(filename, lines, expected, line_offset) +pep8.BaseReport.print_benchmark?4() +pep8.BaseReport.print_filename?7 +pep8.BaseReport.print_statistics?4(prefix='') +pep8.BaseReport.start?4() +pep8.BaseReport.stop?4() +pep8.BaseReport?1(options) +pep8.COMMENT_WITH_NL?7 +pep8.COMPARE_SINGLETON_REGEX?7 +pep8.COMPARE_TYPE_REGEX?7 +pep8.Checker.build_tokens_line?4() +pep8.Checker.check_all?4(expected=None, line_offset=0) +pep8.Checker.check_ast?4() +pep8.Checker.check_logical?4() +pep8.Checker.check_physical?4(line) +pep8.Checker.generate_tokens?4() +pep8.Checker.readline?4() +pep8.Checker.readline_check_physical?4() +pep8.Checker.report_invalid_syntax?4() +pep8.Checker.run_check?4(check, argument_names) +pep8.Checker?1(filename=None, lines=None, options=None, report=None, **kwargs) +pep8.DEFAULT_EXCLUDE?7 +pep8.DEFAULT_IGNORE?7 +pep8.DOCSTRING_REGEX?7 +pep8.DiffReport.error?4(line_number, offset, text, check) +pep8.DiffReport?1(options) +pep8.ERRORCODE_REGEX?7 +pep8.EXTRANEOUS_WHITESPACE_REGEX?7 +pep8.FileReport.print_filename?7 +pep8.HUNK_REGEX?7 +pep8.INDENT_REGEX?7 +pep8.KEYWORDS?7 +pep8.KEYWORD_REGEX?7 +pep8.LAMBDA_REGEX?7 +pep8.MAX_LINE_LENGTH?7 +pep8.OPERATOR_REGEX?7 +pep8.PROJECT_CONFIG?7 +pep8.PyCF_ONLY_AST?7 +pep8.RAISE_COMMA_REGEX?7 +pep8.REPORT_FORMAT?7 +pep8.RERAISE_COMMA_REGEX?7 +pep8.SINGLETONS?7 +pep8.SKIP_TOKENS?7 +pep8.StandardReport.error?4(line_number, offset, text, check) +pep8.StandardReport.error_args?4(line_number, offset, code, check, *args) +pep8.StandardReport.get_file_results?4() +pep8.StandardReport.init_file?4(filename, lines, expected, line_offset) +pep8.StandardReport?1(options) +pep8.StyleGuide.check_files?4(paths=None) +pep8.StyleGuide.excluded?4(filename, parent=None) +pep8.StyleGuide.get_checks?4(argument_name) +pep8.StyleGuide.ignore_code?4(code) +pep8.StyleGuide.init_report?4(reporter=None) +pep8.StyleGuide.input_dir?4(dirname) +pep8.StyleGuide.input_file?4(filename, lines=None, expected=None, line_offset=0) +pep8.StyleGuide?1(*args, **kwargs) +pep8.TESTSUITE_PATH?7 +pep8.UNARY_OPERATORS?7 +pep8.WHITESPACE?7 +pep8.WHITESPACE_AFTER_COMMA_REGEX?7 +pep8.WS_NEEDED_OPERATORS?7 +pep8.WS_OPTIONAL_OPERATORS?7 +pep8._add_check?5(check, kind, codes, args) +pep8._checks?8 +pep8._main?5() +pep8.blank_lines?4(logical_line, blank_lines, indent_level, line_number, previous_logical, previous_indent_level) +pep8.comparison_to_singleton?4(logical_line, noqa) +pep8.comparison_type?4(logical_line) +pep8.compound_statements?4(logical_line) +pep8.continued_indentation?4(logical_line, tokens, indent_level, hang_closing, noqa, verbose) +pep8.expand_indent?4(line) +pep8.explicit_line_join?4(logical_line, tokens) +pep8.extraneous_whitespace?4(logical_line) +pep8.filename_match?4(filename, patterns, default=True) +pep8.get_parser?4(prog='pep8', version=__version__) +pep8.imports_on_separate_lines?4(logical_line) +pep8.indentation?4(logical_line, previous_logical, indent_char, indent_level, previous_indent_level) +pep8.init_checks_registry?4() +pep8.maximum_line_length?4(physical_line, max_line_length) +pep8.missing_newline?4(physical_line) +pep8.missing_whitespace?4(logical_line) +pep8.missing_whitespace_around_operator?4(logical_line, tokens) +pep8.mute_string?4(text) +pep8.noqa?7 +pep8.parse_udiff?4(diff, patterns=None, parent='.') +pep8.process_options?4(arglist=None, parse_argv=False, config_file=None, parser=None) +pep8.python_3000_backticks?4(logical_line) +pep8.python_3000_has_key?4(logical_line) +pep8.python_3000_not_equal?4(logical_line) +pep8.python_3000_raise_comma?4(logical_line) +pep8.read_config?4(options, args, arglist, parser) +pep8.readlines?4(filename) +pep8.register_check?4(check, codes=None) +pep8.stdin_get_value?4() +pep8.tabs_obsolete?4(physical_line) +pep8.tabs_or_spaces?4(physical_line, indent_char) +pep8.trailing_blank_lines?4(physical_line, lines, line_number) +pep8.trailing_whitespace?4(physical_line) +pep8.whitespace_around_comma?4(logical_line) +pep8.whitespace_around_keywords?4(logical_line) +pep8.whitespace_around_named_parameter_equals?4(logical_line, tokens) +pep8.whitespace_around_operator?4(logical_line) +pep8.whitespace_before_inline_comment?4(logical_line, tokens) +pep8.whitespace_before_parameters?4(logical_line, tokens)
--- a/APIs/Python3/eric5.bas Sun Sep 08 19:04:07 2013 +0200 +++ b/APIs/Python3/eric5.bas Tue Oct 15 22:03:54 2013 +0200 @@ -481,7 +481,7 @@ Pep8CodeSelectionDialog QDialog Ui_Pep8CodeSelectionDialog Pep8Dialog QDialog Ui_Pep8Dialog Pep8Fixer QObject -Pep8Report pep8.BaseReport +Pep8Report pep8 Pep8StatisticsDialog QDialog Ui_Pep8StatisticsDialog PersonalDataDialog QDialog Ui_PersonalDataDialog PersonalInformationManager QObject @@ -537,7 +537,6 @@ PropertiesDialog QDialog Ui_PropertiesDialog Purge HgExtension PurgeProjectHelper HgExtensionProjectHelper -Py3FlakesPage ConfigurationPageBase Ui_Py3FlakesPage PyCoverageDialog QDialog Ui_PyCoverageDialog PyProfile profile.Profile PyProfileDialog QDialog Ui_PyProfileDialog
--- a/DebugClients/Python/DebugBase.py Sun Sep 08 19:04:07 2013 +0200 +++ b/DebugClients/Python/DebugBase.py Tue Oct 15 22:03:54 2013 +0200 @@ -636,68 +636,72 @@ self._dbgClient.progTerminated(excval.code) return - elif exctype in [SyntaxError, IndentationError]: + if exctype in [SyntaxError, IndentationError]: try: message, (filename, linenr, charnr, text) = excval except ValueError: exclist = [] + realSyntaxError = True else: exclist = [message, [filename, linenr, charnr]] - - self._dbgClient.write("%s%s\n" % (ResponseSyntax, unicode(exclist))) - - else: - if type(exctype) in [types.ClassType, # Python up to 2.4 - types.TypeType]: # Python 2.5+ - exctype = exctype.__name__ - - if excval is None: - excval = '' + realSyntaxError = os.path.exists(filename) - if unhandled: - exctypetxt = "unhandled %s" % unicode(exctype) - else: - exctypetxt = unicode(exctype) - try: - exclist = [exctypetxt, - unicode(excval).encode(self._dbgClient.getCoding())] - except TypeError: - exclist = [exctypetxt, str(excval)] + if realSyntaxError: + self._dbgClient.write("%s%s\n" % (ResponseSyntax, unicode(exclist))) + self._dbgClient.eventLoop() + return + + if type(exctype) in [types.ClassType, # Python up to 2.4 + types.TypeType]: # Python 2.5+ + exctype = exctype.__name__ + + if excval is None: + excval = '' + + if unhandled: + exctypetxt = "unhandled %s" % unicode(exctype) + else: + exctypetxt = unicode(exctype) + try: + exclist = [exctypetxt, + unicode(excval).encode(self._dbgClient.getCoding())] + except TypeError: + exclist = [exctypetxt, str(excval)] + + if exctb: + frlist = self.__extract_stack(exctb) + frlist.reverse() - if exctb: - frlist = self.__extract_stack(exctb) - frlist.reverse() + self.currentFrame = frlist[0] + self.currentFrameLocals = frlist[0].f_locals + # remember the locals because it is reinitialized when accessed + + for fr in frlist: + filename = self._dbgClient.absPath(self.fix_frame_filename(fr)) - self.currentFrame = frlist[0] - self.currentFrameLocals = frlist[0].f_locals - # remember the locals because it is reinitialized when accessed + if os.path.basename(filename).startswith("DebugClient") or \ + os.path.basename(filename) == "bdb.py": + break + + linenr = fr.f_lineno + ffunc = fr.f_code.co_name + + if ffunc == '?': + ffunc = '' - for fr in frlist: - filename = self._dbgClient.absPath(self.fix_frame_filename(fr)) - - if os.path.basename(filename).startswith("DebugClient") or \ - os.path.basename(filename) == "bdb.py": - break - - linenr = fr.f_lineno - ffunc = fr.f_code.co_name - - if ffunc == '?': - ffunc = '' - - if ffunc and not ffunc.startswith("<"): - argInfo = inspect.getargvalues(fr) - fargs = inspect.formatargvalues(argInfo[0], argInfo[1], - argInfo[2], argInfo[3]) - else: - fargs = "" - - exclist.append([filename, linenr, ffunc, fargs]) - - self._dbgClient.write("%s%s\n" % (ResponseException, unicode(exclist))) - - if exctb is None: - return + if ffunc and not ffunc.startswith("<"): + argInfo = inspect.getargvalues(fr) + fargs = inspect.formatargvalues(argInfo[0], argInfo[1], + argInfo[2], argInfo[3]) + else: + fargs = "" + + exclist.append([filename, linenr, ffunc, fargs]) + + self._dbgClient.write("%s%s\n" % (ResponseException, unicode(exclist))) + + if exctb is None: + return self._dbgClient.eventLoop()
--- a/DebugClients/Python3/DebugBase.py Sun Sep 08 19:04:07 2013 +0200 +++ b/DebugClients/Python3/DebugBase.py Tue Oct 15 22:03:54 2013 +0200 @@ -647,66 +647,70 @@ self._dbgClient.progTerminated(excval.code) return - elif exctype in [SyntaxError, IndentationError]: + if exctype in [SyntaxError, IndentationError]: try: message, (filename, linenr, charnr, text) = excval[0], excval[1] except ValueError: exclist = [] + realSyntaxError = True else: exclist = [message, [filename, linenr, charnr]] - - self._dbgClient.write("{0}{1}\n".format(ResponseSyntax, str(exclist))) - - else: - exctype = self.__extractExceptionName(exctype) - - if excval is None: - excval = '' + realSyntaxError = os.path.exists(filename) - if unhandled: - exctypetxt = "unhandled {0!s}".format(str(exctype)) - else: - exctypetxt = str(exctype) - try: - exclist = [exctypetxt, str(excval)] - except TypeError: - exclist = [exctypetxt, str(excval)] + if realSyntaxError: + self._dbgClient.write("{0}{1}\n".format(ResponseSyntax, str(exclist))) + self._dbgClient.eventLoop() + return + + exctype = self.__extractExceptionName(exctype) + + if excval is None: + excval = '' + + if unhandled: + exctypetxt = "unhandled {0!s}".format(str(exctype)) + else: + exctypetxt = str(exctype) + try: + exclist = [exctypetxt, str(excval)] + except TypeError: + exclist = [exctypetxt, str(excval)] + + if exctb: + frlist = self.__extract_stack(exctb) + frlist.reverse() - if exctb: - frlist = self.__extract_stack(exctb) - frlist.reverse() - - self.currentFrame = frlist[0] - self.currentFrameLocals = frlist[0].f_locals - # remember the locals because it is reinitialized when accessed + self.currentFrame = frlist[0] + self.currentFrameLocals = frlist[0].f_locals + # remember the locals because it is reinitialized when accessed + + for fr in frlist: + filename = self._dbgClient.absPath(self.fix_frame_filename(fr)) - for fr in frlist: - filename = self._dbgClient.absPath(self.fix_frame_filename(fr)) - - if os.path.basename(filename).startswith("DebugClient") or \ - os.path.basename(filename) == "bdb.py": - break - - linenr = fr.f_lineno - ffunc = fr.f_code.co_name - - if ffunc == '?': - ffunc = '' - - if ffunc and not ffunc.startswith("<"): - argInfo = inspect.getargvalues(fr) - fargs = inspect.formatargvalues(argInfo.args, argInfo.varargs, - argInfo.keywords, argInfo.locals) - else: - fargs = "" - - exclist.append([filename, linenr, ffunc, fargs]) - - self._dbgClient.write("{0}{1}\n".format(ResponseException, str(exclist))) - - if exctb is None: - return - + if os.path.basename(filename).startswith("DebugClient") or \ + os.path.basename(filename) == "bdb.py": + break + + linenr = fr.f_lineno + ffunc = fr.f_code.co_name + + if ffunc == '?': + ffunc = '' + + if ffunc and not ffunc.startswith("<"): + argInfo = inspect.getargvalues(fr) + fargs = inspect.formatargvalues(argInfo.args, argInfo.varargs, + argInfo.keywords, argInfo.locals) + else: + fargs = "" + + exclist.append([filename, linenr, ffunc, fargs]) + + self._dbgClient.write("{0}{1}\n".format(ResponseException, str(exclist))) + + if exctb is None: + return + self._dbgClient.eventLoop() def __extractExceptionName(self, exctype):
--- a/Documentation/Help/source.qhp Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Help/source.qhp Tue Oct 15 22:03:54 2013 +0200 @@ -454,9 +454,12 @@ </section> <section title="eric5.Plugins.CheckerPlugins" ref="index-eric5.Plugins.CheckerPlugins.html"> <section title="eric5.Plugins.CheckerPlugins.Pep8" ref="index-eric5.Plugins.CheckerPlugins.Pep8.html"> + <section title="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html" /> + <section title="eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker.html" /> <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> @@ -755,7 +758,6 @@ <section title="eric5.Preferences.ConfigurationPages.PrinterPage" ref="eric5.Preferences.ConfigurationPages.PrinterPage.html" /> <section title="eric5.Preferences.ConfigurationPages.ProjectBrowserPage" ref="eric5.Preferences.ConfigurationPages.ProjectBrowserPage.html" /> <section title="eric5.Preferences.ConfigurationPages.ProjectPage" ref="eric5.Preferences.ConfigurationPages.ProjectPage.html" /> - <section title="eric5.Preferences.ConfigurationPages.Py3FlakesPage" ref="eric5.Preferences.ConfigurationPages.Py3FlakesPage.html" /> <section title="eric5.Preferences.ConfigurationPages.PythonPage" ref="eric5.Preferences.ConfigurationPages.PythonPage.html" /> <section title="eric5.Preferences.ConfigurationPages.QtPage" ref="eric5.Preferences.ConfigurationPages.QtPage.html" /> <section title="eric5.Preferences.ConfigurationPages.SecurityPage" ref="eric5.Preferences.ConfigurationPages.SecurityPage.html" /> @@ -1013,6 +1015,11 @@ <section title="eric5.patch_modpython" ref="eric5.patch_modpython.html" /> <section title="eric5.uninstall" ref="eric5.uninstall.html" /> </section> + <section title="Pep257CheckerPy2" ref="Pep257CheckerPy2.html" /> + <section title="Pep8Checker" ref="Pep8Checker.html" /> + <section title="Pep8NamingCheckerPy2" ref="Pep8NamingCheckerPy2.html" /> + <section title="Tools" ref="Tools.html" /> + <section title="pep8" ref="pep8.html" /> </section> </toc> <keywords> @@ -1456,18 +1463,31 @@ <keyword name="AutoSaver.saveIfNeccessary" id="AutoSaver.saveIfNeccessary" ref="eric5.Utilities.AutoSaver.html#AutoSaver.saveIfNeccessary" /> <keyword name="AutoSaver.timerEvent" id="AutoSaver.timerEvent" ref="eric5.Utilities.AutoSaver.html#AutoSaver.timerEvent" /> <keyword name="BaseReport" id="BaseReport" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#BaseReport" /> + <keyword name="BaseReport" id="BaseReport" ref="pep8.html#BaseReport" /> <keyword name="BaseReport (Constructor)" id="BaseReport (Constructor)" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#BaseReport.__init__" /> + <keyword name="BaseReport (Constructor)" id="BaseReport (Constructor)" ref="pep8.html#BaseReport.__init__" /> <keyword name="BaseReport.error" id="BaseReport.error" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#BaseReport.error" /> + <keyword name="BaseReport.error" id="BaseReport.error" ref="pep8.html#BaseReport.error" /> <keyword name="BaseReport.error_args" id="BaseReport.error_args" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#BaseReport.error_args" /> + <keyword name="BaseReport.error_args" id="BaseReport.error_args" ref="pep8.html#BaseReport.error_args" /> <keyword name="BaseReport.get_count" id="BaseReport.get_count" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#BaseReport.get_count" /> + <keyword name="BaseReport.get_count" id="BaseReport.get_count" ref="pep8.html#BaseReport.get_count" /> <keyword name="BaseReport.get_file_results" id="BaseReport.get_file_results" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#BaseReport.get_file_results" /> + <keyword name="BaseReport.get_file_results" id="BaseReport.get_file_results" ref="pep8.html#BaseReport.get_file_results" /> <keyword name="BaseReport.get_statistics" id="BaseReport.get_statistics" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#BaseReport.get_statistics" /> + <keyword name="BaseReport.get_statistics" id="BaseReport.get_statistics" ref="pep8.html#BaseReport.get_statistics" /> <keyword name="BaseReport.increment_logical_line" id="BaseReport.increment_logical_line" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#BaseReport.increment_logical_line" /> + <keyword name="BaseReport.increment_logical_line" id="BaseReport.increment_logical_line" ref="pep8.html#BaseReport.increment_logical_line" /> <keyword name="BaseReport.init_file" id="BaseReport.init_file" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#BaseReport.init_file" /> + <keyword name="BaseReport.init_file" id="BaseReport.init_file" ref="pep8.html#BaseReport.init_file" /> <keyword name="BaseReport.print_benchmark" id="BaseReport.print_benchmark" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#BaseReport.print_benchmark" /> + <keyword name="BaseReport.print_benchmark" id="BaseReport.print_benchmark" ref="pep8.html#BaseReport.print_benchmark" /> <keyword name="BaseReport.print_statistics" id="BaseReport.print_statistics" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#BaseReport.print_statistics" /> + <keyword name="BaseReport.print_statistics" id="BaseReport.print_statistics" ref="pep8.html#BaseReport.print_statistics" /> <keyword name="BaseReport.start" id="BaseReport.start" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#BaseReport.start" /> + <keyword name="BaseReport.start" id="BaseReport.start" ref="pep8.html#BaseReport.start" /> <keyword name="BaseReport.stop" id="BaseReport.stop" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#BaseReport.stop" /> + <keyword name="BaseReport.stop" id="BaseReport.stop" ref="pep8.html#BaseReport.stop" /> <keyword name="BinaryModel" id="BinaryModel" ref="eric5.UI.NumbersWidget.html#BinaryModel" /> <keyword name="BinaryModel (Constructor)" id="BinaryModel (Constructor)" ref="eric5.UI.NumbersWidget.html#BinaryModel.__init__" /> <keyword name="BinaryModel.columnCount" id="BinaryModel.columnCount" ref="eric5.UI.NumbersWidget.html#BinaryModel.columnCount" /> @@ -1954,9 +1974,11 @@ <keyword name="Checker" id="Checker" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#Checker" /> <keyword name="Checker" id="Checker" ref="eric5.Utilities.py2flakes.checker.html#Checker" /> <keyword name="Checker" id="Checker" ref="eric5.Utilities.py3flakes.checker.html#Checker" /> + <keyword name="Checker" id="Checker" ref="pep8.html#Checker" /> <keyword name="Checker (Constructor)" id="Checker (Constructor)" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#Checker.__init__" /> <keyword name="Checker (Constructor)" id="Checker (Constructor)" ref="eric5.Utilities.py2flakes.checker.html#Checker.__init__" /> <keyword name="Checker (Constructor)" id="Checker (Constructor)" ref="eric5.Utilities.py3flakes.checker.html#Checker.__init__" /> + <keyword name="Checker (Constructor)" id="Checker (Constructor)" ref="pep8.html#Checker.__init__" /> <keyword name="Checker.ASSIGN" id="Checker.ASSIGN" ref="eric5.Utilities.py2flakes.checker.html#Checker.ASSIGN" /> <keyword name="Checker.ASSIGN" id="Checker.ASSIGN" ref="eric5.Utilities.py3flakes.checker.html#Checker.ASSIGN" /> <keyword name="Checker.AUGASSIGN" id="Checker.AUGASSIGN" ref="eric5.Utilities.py2flakes.checker.html#Checker.AUGASSIGN" /> @@ -1990,14 +2012,19 @@ <keyword name="Checker.addBinding" id="Checker.addBinding" ref="eric5.Utilities.py2flakes.checker.html#Checker.addBinding" /> <keyword name="Checker.addBinding" id="Checker.addBinding" ref="eric5.Utilities.py3flakes.checker.html#Checker.addBinding" /> <keyword name="Checker.build_tokens_line" id="Checker.build_tokens_line" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#Checker.build_tokens_line" /> + <keyword name="Checker.build_tokens_line" id="Checker.build_tokens_line" ref="pep8.html#Checker.build_tokens_line" /> <keyword name="Checker.checkDeadScopes" id="Checker.checkDeadScopes" ref="eric5.Utilities.py2flakes.checker.html#Checker.checkDeadScopes" /> <keyword name="Checker.checkUnusedAssignments" id="Checker.checkUnusedAssignments" ref="eric5.Utilities.py2flakes.checker.html#Checker.checkUnusedAssignments" /> <keyword name="Checker.checkUnusedAssignments" id="Checker.checkUnusedAssignments" ref="eric5.Utilities.py3flakes.checker.html#Checker.checkUnusedAssignments" /> <keyword name="Checker.check_all" id="Checker.check_all" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#Checker.check_all" /> + <keyword name="Checker.check_all" id="Checker.check_all" ref="pep8.html#Checker.check_all" /> <keyword name="Checker.check_ast" id="Checker.check_ast" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#Checker.check_ast" /> + <keyword name="Checker.check_ast" id="Checker.check_ast" ref="pep8.html#Checker.check_ast" /> <keyword name="Checker.check_dead_scopes" id="Checker.check_dead_scopes" ref="eric5.Utilities.py3flakes.checker.html#Checker.check_dead_scopes" /> <keyword name="Checker.check_logical" id="Checker.check_logical" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#Checker.check_logical" /> + <keyword name="Checker.check_logical" id="Checker.check_logical" ref="pep8.html#Checker.check_logical" /> <keyword name="Checker.check_physical" id="Checker.check_physical" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#Checker.check_physical" /> + <keyword name="Checker.check_physical" id="Checker.check_physical" ref="pep8.html#Checker.check_physical" /> <keyword name="Checker.collectLoopVars" id="Checker.collectLoopVars" ref="eric5.Utilities.py2flakes.checker.html#Checker.collectLoopVars" /> <keyword name="Checker.collectLoopVars" id="Checker.collectLoopVars" ref="eric5.Utilities.py3flakes.checker.html#Checker.collectLoopVars" /> <keyword name="Checker.deferAssignment" id="Checker.deferAssignment" ref="eric5.Utilities.py2flakes.checker.html#Checker.deferAssignment" /> @@ -2007,6 +2034,7 @@ <keyword name="Checker.descendantOf" id="Checker.descendantOf" ref="eric5.Utilities.py2flakes.checker.html#Checker.descendantOf" /> <keyword name="Checker.differentForks" id="Checker.differentForks" ref="eric5.Utilities.py2flakes.checker.html#Checker.differentForks" /> <keyword name="Checker.generate_tokens" id="Checker.generate_tokens" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#Checker.generate_tokens" /> + <keyword name="Checker.generate_tokens" id="Checker.generate_tokens" ref="pep8.html#Checker.generate_tokens" /> <keyword name="Checker.getCommonAncestor" id="Checker.getCommonAncestor" ref="eric5.Utilities.py2flakes.checker.html#Checker.getCommonAncestor" /> <keyword name="Checker.handleAssignName" id="Checker.handleAssignName" ref="eric5.Utilities.py3flakes.checker.html#Checker.handleAssignName" /> <keyword name="Checker.handleBody" id="Checker.handleBody" ref="eric5.Utilities.py3flakes.checker.html#Checker.handleBody" /> @@ -2030,14 +2058,18 @@ <keyword name="Checker.pushFunctionScope" id="Checker.pushFunctionScope" ref="eric5.Utilities.py2flakes.checker.html#Checker.pushFunctionScope" /> <keyword name="Checker.pushFunctionScope" id="Checker.pushFunctionScope" ref="eric5.Utilities.py3flakes.checker.html#Checker.pushFunctionScope" /> <keyword name="Checker.readline" id="Checker.readline" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#Checker.readline" /> + <keyword name="Checker.readline" id="Checker.readline" ref="pep8.html#Checker.readline" /> <keyword name="Checker.readline_check_physical" id="Checker.readline_check_physical" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#Checker.readline_check_physical" /> + <keyword name="Checker.readline_check_physical" id="Checker.readline_check_physical" ref="pep8.html#Checker.readline_check_physical" /> <keyword name="Checker.report" id="Checker.report" ref="eric5.Utilities.py2flakes.checker.html#Checker.report" /> <keyword name="Checker.report" id="Checker.report" ref="eric5.Utilities.py3flakes.checker.html#Checker.report" /> <keyword name="Checker.report_invalid_syntax" id="Checker.report_invalid_syntax" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#Checker.report_invalid_syntax" /> + <keyword name="Checker.report_invalid_syntax" id="Checker.report_invalid_syntax" ref="pep8.html#Checker.report_invalid_syntax" /> <keyword name="Checker.runDeferred" id="Checker.runDeferred" ref="eric5.Utilities.py2flakes.checker.html#Checker.runDeferred" /> <keyword name="Checker.runFunction" id="Checker.runFunction" ref="eric5.Utilities.py2flakes.checker.html#Checker.runFunction" /> <keyword name="Checker.runFunction" id="Checker.runFunction" ref="eric5.Utilities.py3flakes.checker.html#Checker.runFunction" /> <keyword name="Checker.run_check" id="Checker.run_check" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#Checker.run_check" /> + <keyword name="Checker.run_check" id="Checker.run_check" ref="pep8.html#Checker.run_check" /> <keyword name="Checker.scope" id="Checker.scope" ref="eric5.Utilities.py2flakes.checker.html#Checker.scope" /> <keyword name="Checker.scope" id="Checker.scope" ref="eric5.Utilities.py3flakes.checker.html#Checker.scope" /> <keyword name="CheckerPlugins (Package)" id="CheckerPlugins (Package)" ref="index-eric5.Plugins.CheckerPlugins.html" /> @@ -3255,8 +3287,11 @@ <keyword name="DiffDialog.on_saveButton_clicked" id="DiffDialog.on_saveButton_clicked" ref="eric5.UI.DiffDialog.html#DiffDialog.on_saveButton_clicked" /> <keyword name="DiffDialog.show" id="DiffDialog.show" ref="eric5.UI.DiffDialog.html#DiffDialog.show" /> <keyword name="DiffReport" id="DiffReport" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#DiffReport" /> + <keyword name="DiffReport" id="DiffReport" ref="pep8.html#DiffReport" /> <keyword name="DiffReport (Constructor)" id="DiffReport (Constructor)" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#DiffReport.__init__" /> + <keyword name="DiffReport (Constructor)" id="DiffReport (Constructor)" ref="pep8.html#DiffReport.__init__" /> <keyword name="DiffReport.error" id="DiffReport.error" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#DiffReport.error" /> + <keyword name="DiffReport.error" id="DiffReport.error" ref="pep8.html#DiffReport.error" /> <keyword name="DiffWindow" id="DiffWindow" ref="eric5.UI.DiffDialog.html#DiffWindow" /> <keyword name="DiffWindow (Constructor)" id="DiffWindow (Constructor)" ref="eric5.UI.DiffDialog.html#DiffWindow.__init__" /> <keyword name="DiffWindow.eventFilter" id="DiffWindow.eventFilter" ref="eric5.UI.DiffDialog.html#DiffWindow.eventFilter" /> @@ -4404,6 +4439,8 @@ <keyword name="EditorStylesPage (Module)" id="EditorStylesPage (Module)" ref="eric5.Preferences.ConfigurationPages.EditorStylesPage.html" /> <keyword name="EditorStylesPage.on_annotationsErrorBgButton_clicked" id="EditorStylesPage.on_annotationsErrorBgButton_clicked" ref="eric5.Preferences.ConfigurationPages.EditorStylesPage.html#EditorStylesPage.on_annotationsErrorBgButton_clicked" /> <keyword name="EditorStylesPage.on_annotationsErrorFgButton_clicked" id="EditorStylesPage.on_annotationsErrorFgButton_clicked" ref="eric5.Preferences.ConfigurationPages.EditorStylesPage.html#EditorStylesPage.on_annotationsErrorFgButton_clicked" /> + <keyword name="EditorStylesPage.on_annotationsStyleWarningBgButton_clicked" id="EditorStylesPage.on_annotationsStyleWarningBgButton_clicked" ref="eric5.Preferences.ConfigurationPages.EditorStylesPage.html#EditorStylesPage.on_annotationsStyleWarningBgButton_clicked" /> + <keyword name="EditorStylesPage.on_annotationsStyleWarningFgButton_clicked" id="EditorStylesPage.on_annotationsStyleWarningFgButton_clicked" ref="eric5.Preferences.ConfigurationPages.EditorStylesPage.html#EditorStylesPage.on_annotationsStyleWarningFgButton_clicked" /> <keyword name="EditorStylesPage.on_annotationsWarningBgButton_clicked" id="EditorStylesPage.on_annotationsWarningBgButton_clicked" ref="eric5.Preferences.ConfigurationPages.EditorStylesPage.html#EditorStylesPage.on_annotationsWarningBgButton_clicked" /> <keyword name="EditorStylesPage.on_annotationsWarningFgButton_clicked" id="EditorStylesPage.on_annotationsWarningFgButton_clicked" ref="eric5.Preferences.ConfigurationPages.EditorStylesPage.html#EditorStylesPage.on_annotationsWarningFgButton_clicked" /> <keyword name="EditorStylesPage.on_defaultFontButton_clicked" id="EditorStylesPage.on_defaultFontButton_clicked" ref="eric5.Preferences.ConfigurationPages.EditorStylesPage.html#EditorStylesPage.on_defaultFontButton_clicked" /> @@ -4679,6 +4716,7 @@ <keyword name="FileReply.isSequential" id="FileReply.isSequential" ref="eric5.Helpviewer.Network.FileReply.html#FileReply.isSequential" /> <keyword name="FileReply.readData" id="FileReply.readData" ref="eric5.Helpviewer.Network.FileReply.html#FileReply.readData" /> <keyword name="FileReport" id="FileReport" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#FileReport" /> + <keyword name="FileReport" id="FileReport" ref="pep8.html#FileReport" /> <keyword name="FiletypeAssociationDialog" id="FiletypeAssociationDialog" ref="eric5.Project.FiletypeAssociationDialog.html#FiletypeAssociationDialog" /> <keyword name="FiletypeAssociationDialog (Constructor)" id="FiletypeAssociationDialog (Constructor)" ref="eric5.Project.FiletypeAssociationDialog.html#FiletypeAssociationDialog.__init__" /> <keyword name="FiletypeAssociationDialog (Module)" id="FiletypeAssociationDialog (Module)" ref="eric5.Project.FiletypeAssociationDialog.html" /> @@ -7934,7 +7972,114 @@ <keyword name="PasswordsDialog (Module)" id="PasswordsDialog (Module)" ref="eric5.Helpviewer.Passwords.PasswordsDialog.html" /> <keyword name="PasswordsDialog.__calculateHeaderSizes" id="PasswordsDialog.__calculateHeaderSizes" ref="eric5.Helpviewer.Passwords.PasswordsDialog.html#PasswordsDialog.__calculateHeaderSizes" /> <keyword name="PasswordsDialog.on_passwordsButton_clicked" id="PasswordsDialog.on_passwordsButton_clicked" ref="eric5.Helpviewer.Passwords.PasswordsDialog.html#PasswordsDialog.on_passwordsButton_clicked" /> + <keyword name="Pep257Checker" id="Pep257Checker" ref="Pep257CheckerPy2.html#Pep257Checker" /> + <keyword name="Pep257Checker" id="Pep257Checker" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker" /> + <keyword name="Pep257Checker (Constructor)" id="Pep257Checker (Constructor)" ref="Pep257CheckerPy2.html#Pep257Checker.__init__" /> + <keyword name="Pep257Checker (Constructor)" id="Pep257Checker (Constructor)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__init__" /> + <keyword name="Pep257Checker (Module)" id="Pep257Checker (Module)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html" /> + <keyword name="Pep257Checker.__checkBackslashes" id="Pep257Checker.__checkBackslashes" ref="Pep257CheckerPy2.html#Pep257Checker.__checkBackslashes" /> + <keyword name="Pep257Checker.__checkBackslashes" id="Pep257Checker.__checkBackslashes" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkBackslashes" /> + <keyword name="Pep257Checker.__checkBlankAfterLastParagraph" id="Pep257Checker.__checkBlankAfterLastParagraph" ref="Pep257CheckerPy2.html#Pep257Checker.__checkBlankAfterLastParagraph" /> + <keyword name="Pep257Checker.__checkBlankAfterLastParagraph" id="Pep257Checker.__checkBlankAfterLastParagraph" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkBlankAfterLastParagraph" /> + <keyword name="Pep257Checker.__checkBlankAfterSummary" id="Pep257Checker.__checkBlankAfterSummary" ref="Pep257CheckerPy2.html#Pep257Checker.__checkBlankAfterSummary" /> + <keyword name="Pep257Checker.__checkBlankAfterSummary" id="Pep257Checker.__checkBlankAfterSummary" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkBlankAfterSummary" /> + <keyword name="Pep257Checker.__checkBlankBeforeAndAfterClass" id="Pep257Checker.__checkBlankBeforeAndAfterClass" ref="Pep257CheckerPy2.html#Pep257Checker.__checkBlankBeforeAndAfterClass" /> + <keyword name="Pep257Checker.__checkBlankBeforeAndAfterClass" id="Pep257Checker.__checkBlankBeforeAndAfterClass" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkBlankBeforeAndAfterClass" /> + <keyword name="Pep257Checker.__checkClassDocstring" id="Pep257Checker.__checkClassDocstring" ref="Pep257CheckerPy2.html#Pep257Checker.__checkClassDocstring" /> + <keyword name="Pep257Checker.__checkClassDocstring" id="Pep257Checker.__checkClassDocstring" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkClassDocstring" /> + <keyword name="Pep257Checker.__checkEndsWithPeriod" id="Pep257Checker.__checkEndsWithPeriod" ref="Pep257CheckerPy2.html#Pep257Checker.__checkEndsWithPeriod" /> + <keyword name="Pep257Checker.__checkEndsWithPeriod" id="Pep257Checker.__checkEndsWithPeriod" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEndsWithPeriod" /> + <keyword name="Pep257Checker.__checkEricBlankAfterSummary" id="Pep257Checker.__checkEricBlankAfterSummary" ref="Pep257CheckerPy2.html#Pep257Checker.__checkEricBlankAfterSummary" /> + <keyword name="Pep257Checker.__checkEricBlankAfterSummary" id="Pep257Checker.__checkEricBlankAfterSummary" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricBlankAfterSummary" /> + <keyword name="Pep257Checker.__checkEricEndsWithPeriod" id="Pep257Checker.__checkEricEndsWithPeriod" ref="Pep257CheckerPy2.html#Pep257Checker.__checkEricEndsWithPeriod" /> + <keyword name="Pep257Checker.__checkEricEndsWithPeriod" id="Pep257Checker.__checkEricEndsWithPeriod" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricEndsWithPeriod" /> + <keyword name="Pep257Checker.__checkEricException" id="Pep257Checker.__checkEricException" ref="Pep257CheckerPy2.html#Pep257Checker.__checkEricException" /> + <keyword name="Pep257Checker.__checkEricException" id="Pep257Checker.__checkEricException" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricException" /> + <keyword name="Pep257Checker.__checkEricFunctionArguments" id="Pep257Checker.__checkEricFunctionArguments" ref="Pep257CheckerPy2.html#Pep257Checker.__checkEricFunctionArguments" /> + <keyword name="Pep257Checker.__checkEricFunctionArguments" id="Pep257Checker.__checkEricFunctionArguments" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricFunctionArguments" /> + <keyword name="Pep257Checker.__checkEricNBlankAfterLastParagraph" id="Pep257Checker.__checkEricNBlankAfterLastParagraph" ref="Pep257CheckerPy2.html#Pep257Checker.__checkEricNBlankAfterLastParagraph" /> + <keyword name="Pep257Checker.__checkEricNBlankAfterLastParagraph" id="Pep257Checker.__checkEricNBlankAfterLastParagraph" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricNBlankAfterLastParagraph" /> + <keyword name="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" id="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ref="Pep257CheckerPy2.html#Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" /> + <keyword name="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" id="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" /> + <keyword name="Pep257Checker.__checkEricQuotesOnSeparateLines" id="Pep257Checker.__checkEricQuotesOnSeparateLines" ref="Pep257CheckerPy2.html#Pep257Checker.__checkEricQuotesOnSeparateLines" /> + <keyword name="Pep257Checker.__checkEricQuotesOnSeparateLines" id="Pep257Checker.__checkEricQuotesOnSeparateLines" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricQuotesOnSeparateLines" /> + <keyword name="Pep257Checker.__checkEricReturn" id="Pep257Checker.__checkEricReturn" ref="Pep257CheckerPy2.html#Pep257Checker.__checkEricReturn" /> + <keyword name="Pep257Checker.__checkEricReturn" id="Pep257Checker.__checkEricReturn" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkEricReturn" /> + <keyword name="Pep257Checker.__checkFunctionDocstring" id="Pep257Checker.__checkFunctionDocstring" ref="Pep257CheckerPy2.html#Pep257Checker.__checkFunctionDocstring" /> + <keyword name="Pep257Checker.__checkFunctionDocstring" id="Pep257Checker.__checkFunctionDocstring" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkFunctionDocstring" /> + <keyword name="Pep257Checker.__checkImperativeMood" id="Pep257Checker.__checkImperativeMood" ref="Pep257CheckerPy2.html#Pep257Checker.__checkImperativeMood" /> + <keyword name="Pep257Checker.__checkImperativeMood" id="Pep257Checker.__checkImperativeMood" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkImperativeMood" /> + <keyword name="Pep257Checker.__checkIndent" id="Pep257Checker.__checkIndent" ref="Pep257CheckerPy2.html#Pep257Checker.__checkIndent" /> + <keyword name="Pep257Checker.__checkIndent" id="Pep257Checker.__checkIndent" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkIndent" /> + <keyword name="Pep257Checker.__checkModulesDocstrings" id="Pep257Checker.__checkModulesDocstrings" ref="Pep257CheckerPy2.html#Pep257Checker.__checkModulesDocstrings" /> + <keyword name="Pep257Checker.__checkModulesDocstrings" id="Pep257Checker.__checkModulesDocstrings" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkModulesDocstrings" /> + <keyword name="Pep257Checker.__checkNoBlankLineBefore" id="Pep257Checker.__checkNoBlankLineBefore" ref="Pep257CheckerPy2.html#Pep257Checker.__checkNoBlankLineBefore" /> + <keyword name="Pep257Checker.__checkNoBlankLineBefore" id="Pep257Checker.__checkNoBlankLineBefore" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkNoBlankLineBefore" /> + <keyword name="Pep257Checker.__checkNoSignature" id="Pep257Checker.__checkNoSignature" ref="Pep257CheckerPy2.html#Pep257Checker.__checkNoSignature" /> + <keyword name="Pep257Checker.__checkNoSignature" id="Pep257Checker.__checkNoSignature" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkNoSignature" /> + <keyword name="Pep257Checker.__checkOneLiner" id="Pep257Checker.__checkOneLiner" ref="Pep257CheckerPy2.html#Pep257Checker.__checkOneLiner" /> + <keyword name="Pep257Checker.__checkOneLiner" id="Pep257Checker.__checkOneLiner" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkOneLiner" /> + <keyword name="Pep257Checker.__checkReturnType" id="Pep257Checker.__checkReturnType" ref="Pep257CheckerPy2.html#Pep257Checker.__checkReturnType" /> + <keyword name="Pep257Checker.__checkReturnType" id="Pep257Checker.__checkReturnType" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkReturnType" /> + <keyword name="Pep257Checker.__checkTripleDoubleQuotes" id="Pep257Checker.__checkTripleDoubleQuotes" ref="Pep257CheckerPy2.html#Pep257Checker.__checkTripleDoubleQuotes" /> + <keyword name="Pep257Checker.__checkTripleDoubleQuotes" id="Pep257Checker.__checkTripleDoubleQuotes" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkTripleDoubleQuotes" /> + <keyword name="Pep257Checker.__checkUnicode" id="Pep257Checker.__checkUnicode" ref="Pep257CheckerPy2.html#Pep257Checker.__checkUnicode" /> + <keyword name="Pep257Checker.__checkUnicode" id="Pep257Checker.__checkUnicode" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__checkUnicode" /> + <keyword name="Pep257Checker.__error" id="Pep257Checker.__error" ref="Pep257CheckerPy2.html#Pep257Checker.__error" /> + <keyword name="Pep257Checker.__error" id="Pep257Checker.__error" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__error" /> + <keyword name="Pep257Checker.__getArgNames" id="Pep257Checker.__getArgNames" ref="Pep257CheckerPy2.html#Pep257Checker.__getArgNames" /> + <keyword name="Pep257Checker.__getArgNames" id="Pep257Checker.__getArgNames" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__getArgNames" /> + <keyword name="Pep257Checker.__getSummaryLine" id="Pep257Checker.__getSummaryLine" ref="Pep257CheckerPy2.html#Pep257Checker.__getSummaryLine" /> + <keyword name="Pep257Checker.__getSummaryLine" id="Pep257Checker.__getSummaryLine" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__getSummaryLine" /> + <keyword name="Pep257Checker.__getSummaryLines" id="Pep257Checker.__getSummaryLines" ref="Pep257CheckerPy2.html#Pep257Checker.__getSummaryLines" /> + <keyword name="Pep257Checker.__getSummaryLines" id="Pep257Checker.__getSummaryLines" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__getSummaryLines" /> + <keyword name="Pep257Checker.__ignoreCode" id="Pep257Checker.__ignoreCode" ref="Pep257CheckerPy2.html#Pep257Checker.__ignoreCode" /> + <keyword name="Pep257Checker.__ignoreCode" id="Pep257Checker.__ignoreCode" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__ignoreCode" /> + <keyword name="Pep257Checker.__parseClasses" id="Pep257Checker.__parseClasses" ref="Pep257CheckerPy2.html#Pep257Checker.__parseClasses" /> + <keyword name="Pep257Checker.__parseClasses" id="Pep257Checker.__parseClasses" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__parseClasses" /> + <keyword name="Pep257Checker.__parseContexts" id="Pep257Checker.__parseContexts" ref="Pep257CheckerPy2.html#Pep257Checker.__parseContexts" /> + <keyword name="Pep257Checker.__parseContexts" id="Pep257Checker.__parseContexts" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__parseContexts" /> + <keyword name="Pep257Checker.__parseDocstring" id="Pep257Checker.__parseDocstring" ref="Pep257CheckerPy2.html#Pep257Checker.__parseDocstring" /> + <keyword name="Pep257Checker.__parseDocstring" id="Pep257Checker.__parseDocstring" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__parseDocstring" /> + <keyword name="Pep257Checker.__parseFunctions" id="Pep257Checker.__parseFunctions" ref="Pep257CheckerPy2.html#Pep257Checker.__parseFunctions" /> + <keyword name="Pep257Checker.__parseFunctions" id="Pep257Checker.__parseFunctions" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__parseFunctions" /> + <keyword name="Pep257Checker.__parseMethods" id="Pep257Checker.__parseMethods" ref="Pep257CheckerPy2.html#Pep257Checker.__parseMethods" /> + <keyword name="Pep257Checker.__parseMethods" id="Pep257Checker.__parseMethods" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__parseMethods" /> + <keyword name="Pep257Checker.__parseModuleDocstring" id="Pep257Checker.__parseModuleDocstring" ref="Pep257CheckerPy2.html#Pep257Checker.__parseModuleDocstring" /> + <keyword name="Pep257Checker.__parseModuleDocstring" id="Pep257Checker.__parseModuleDocstring" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__parseModuleDocstring" /> + <keyword name="Pep257Checker.__parseTopLevel" id="Pep257Checker.__parseTopLevel" ref="Pep257CheckerPy2.html#Pep257Checker.__parseTopLevel" /> + <keyword name="Pep257Checker.__parseTopLevel" id="Pep257Checker.__parseTopLevel" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__parseTopLevel" /> + <keyword name="Pep257Checker.__readline" id="Pep257Checker.__readline" ref="Pep257CheckerPy2.html#Pep257Checker.__readline" /> + <keyword name="Pep257Checker.__readline" id="Pep257Checker.__readline" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__readline" /> + <keyword name="Pep257Checker.__resetReadline" id="Pep257Checker.__resetReadline" ref="Pep257CheckerPy2.html#Pep257Checker.__resetReadline" /> + <keyword name="Pep257Checker.__resetReadline" id="Pep257Checker.__resetReadline" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__resetReadline" /> + <keyword name="Pep257Checker.__skipIndentedBlock" id="Pep257Checker.__skipIndentedBlock" ref="Pep257CheckerPy2.html#Pep257Checker.__skipIndentedBlock" /> + <keyword name="Pep257Checker.__skipIndentedBlock" id="Pep257Checker.__skipIndentedBlock" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.__skipIndentedBlock" /> + <keyword name="Pep257Checker.getMessage" id="Pep257Checker.getMessage" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.getMessage" /> + <keyword name="Pep257Checker.run" id="Pep257Checker.run" ref="Pep257CheckerPy2.html#Pep257Checker.run" /> + <keyword name="Pep257Checker.run" id="Pep257Checker.run" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.run" /> + <keyword name="Pep257Checker.unpackArgs" id="Pep257Checker.unpackArgs" ref="Pep257CheckerPy2.html#Pep257Checker.unpackArgs" /> + <keyword name="Pep257Checker.unpackArgs" id="Pep257Checker.unpackArgs" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Checker.unpackArgs" /> + <keyword name="Pep257CheckerPy2 (Module)" id="Pep257CheckerPy2 (Module)" ref="Pep257CheckerPy2.html" /> + <keyword name="Pep257Context" id="Pep257Context" ref="Pep257CheckerPy2.html#Pep257Context" /> + <keyword name="Pep257Context" id="Pep257Context" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Context" /> + <keyword name="Pep257Context (Constructor)" id="Pep257Context (Constructor)" ref="Pep257CheckerPy2.html#Pep257Context.__init__" /> + <keyword name="Pep257Context (Constructor)" id="Pep257Context (Constructor)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Context.__init__" /> + <keyword name="Pep257Context.contextType" id="Pep257Context.contextType" ref="Pep257CheckerPy2.html#Pep257Context.contextType" /> + <keyword name="Pep257Context.contextType" id="Pep257Context.contextType" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Context.contextType" /> + <keyword name="Pep257Context.end" id="Pep257Context.end" ref="Pep257CheckerPy2.html#Pep257Context.end" /> + <keyword name="Pep257Context.end" id="Pep257Context.end" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Context.end" /> + <keyword name="Pep257Context.indent" id="Pep257Context.indent" ref="Pep257CheckerPy2.html#Pep257Context.indent" /> + <keyword name="Pep257Context.indent" id="Pep257Context.indent" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Context.indent" /> + <keyword name="Pep257Context.source" id="Pep257Context.source" ref="Pep257CheckerPy2.html#Pep257Context.source" /> + <keyword name="Pep257Context.source" id="Pep257Context.source" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Context.source" /> + <keyword name="Pep257Context.ssource" id="Pep257Context.ssource" ref="Pep257CheckerPy2.html#Pep257Context.ssource" /> + <keyword name="Pep257Context.ssource" id="Pep257Context.ssource" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Context.ssource" /> + <keyword name="Pep257Context.start" id="Pep257Context.start" ref="Pep257CheckerPy2.html#Pep257Context.start" /> + <keyword name="Pep257Context.start" id="Pep257Context.start" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html#Pep257Context.start" /> <keyword name="Pep8 (Package)" id="Pep8 (Package)" ref="index-eric5.Plugins.CheckerPlugins.Pep8.html" /> + <keyword name="Pep8Checker (Module)" id="Pep8Checker (Module)" ref="Pep8Checker.html" /> + <keyword name="Pep8Checker (Module)" id="Pep8Checker (Module)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker.html" /> <keyword name="Pep8CheckerPlugin" id="Pep8CheckerPlugin" ref="eric5.Plugins.PluginPep8Checker.html#Pep8CheckerPlugin" /> <keyword name="Pep8CheckerPlugin (Constructor)" id="Pep8CheckerPlugin (Constructor)" ref="eric5.Plugins.PluginPep8Checker.html#Pep8CheckerPlugin.__init__" /> <keyword name="Pep8CheckerPlugin.__editorClosed" id="Pep8CheckerPlugin.__editorClosed" ref="eric5.Plugins.PluginPep8Checker.html#Pep8CheckerPlugin.__editorClosed" /> @@ -7986,8 +8131,20 @@ <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.__fixD111" id="Pep8Fixer.__fixD111" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD111" /> + <keyword name="Pep8Fixer.__fixD112" id="Pep8Fixer.__fixD112" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD112" /> + <keyword name="Pep8Fixer.__fixD121" id="Pep8Fixer.__fixD121" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD121" /> + <keyword name="Pep8Fixer.__fixD131" id="Pep8Fixer.__fixD131" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD131" /> + <keyword name="Pep8Fixer.__fixD141" id="Pep8Fixer.__fixD141" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD141" /> + <keyword name="Pep8Fixer.__fixD142" id="Pep8Fixer.__fixD142" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD142" /> + <keyword name="Pep8Fixer.__fixD143" id="Pep8Fixer.__fixD143" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD143" /> + <keyword name="Pep8Fixer.__fixD144" id="Pep8Fixer.__fixD144" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD144" /> + <keyword name="Pep8Fixer.__fixD145" id="Pep8Fixer.__fixD145" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD145" /> + <keyword name="Pep8Fixer.__fixD221" id="Pep8Fixer.__fixD221" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD221" /> + <keyword name="Pep8Fixer.__fixD242" id="Pep8Fixer.__fixD242" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD242" /> + <keyword name="Pep8Fixer.__fixD243" id="Pep8Fixer.__fixD243" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD243" /> + <keyword name="Pep8Fixer.__fixD247" id="Pep8Fixer.__fixD247" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixD247" /> <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" /> <keyword name="Pep8Fixer.__fixE122" id="Pep8Fixer.__fixE122" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Fixer.__fixE122" /> @@ -8010,6 +8167,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" /> @@ -8017,10 +8176,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" /> @@ -8040,6 +8201,46 @@ <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="Pep8NamingCheckerPy2.html#Pep8NamingChecker" /> + <keyword name="Pep8NamingChecker" id="Pep8NamingChecker" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker" /> + <keyword name="Pep8NamingChecker (Constructor)" id="Pep8NamingChecker (Constructor)" ref="Pep8NamingCheckerPy2.html#Pep8NamingChecker.__init__" /> + <keyword name="Pep8NamingChecker (Constructor)" id="Pep8NamingChecker (Constructor)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.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="Pep8NamingCheckerPy2.html#Pep8NamingChecker.__checkClassName" /> + <keyword name="Pep8NamingChecker.__checkClassName" id="Pep8NamingChecker.__checkClassName" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__checkClassName" /> + <keyword name="Pep8NamingChecker.__checkFunctionArgumentNames" id="Pep8NamingChecker.__checkFunctionArgumentNames" ref="Pep8NamingCheckerPy2.html#Pep8NamingChecker.__checkFunctionArgumentNames" /> + <keyword name="Pep8NamingChecker.__checkFunctionArgumentNames" id="Pep8NamingChecker.__checkFunctionArgumentNames" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__checkFunctionArgumentNames" /> + <keyword name="Pep8NamingChecker.__checkFuntionName" id="Pep8NamingChecker.__checkFuntionName" ref="Pep8NamingCheckerPy2.html#Pep8NamingChecker.__checkFuntionName" /> + <keyword name="Pep8NamingChecker.__checkFuntionName" id="Pep8NamingChecker.__checkFuntionName" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__checkFuntionName" /> + <keyword name="Pep8NamingChecker.__checkImportAs" id="Pep8NamingChecker.__checkImportAs" ref="Pep8NamingCheckerPy2.html#Pep8NamingChecker.__checkImportAs" /> + <keyword name="Pep8NamingChecker.__checkImportAs" id="Pep8NamingChecker.__checkImportAs" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__checkImportAs" /> + <keyword name="Pep8NamingChecker.__checkModule" id="Pep8NamingChecker.__checkModule" ref="Pep8NamingCheckerPy2.html#Pep8NamingChecker.__checkModule" /> + <keyword name="Pep8NamingChecker.__checkModule" id="Pep8NamingChecker.__checkModule" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__checkModule" /> + <keyword name="Pep8NamingChecker.__checkNameToBeAvoided" id="Pep8NamingChecker.__checkNameToBeAvoided" ref="Pep8NamingCheckerPy2.html#Pep8NamingChecker.__checkNameToBeAvoided" /> + <keyword name="Pep8NamingChecker.__checkNameToBeAvoided" id="Pep8NamingChecker.__checkNameToBeAvoided" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__checkNameToBeAvoided" /> + <keyword name="Pep8NamingChecker.__checkVariablesInFunction" id="Pep8NamingChecker.__checkVariablesInFunction" ref="Pep8NamingCheckerPy2.html#Pep8NamingChecker.__checkVariablesInFunction" /> + <keyword name="Pep8NamingChecker.__checkVariablesInFunction" id="Pep8NamingChecker.__checkVariablesInFunction" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__checkVariablesInFunction" /> + <keyword name="Pep8NamingChecker.__error" id="Pep8NamingChecker.__error" ref="Pep8NamingCheckerPy2.html#Pep8NamingChecker.__error" /> + <keyword name="Pep8NamingChecker.__error" id="Pep8NamingChecker.__error" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__error" /> + <keyword name="Pep8NamingChecker.__findGlobalDefs" id="Pep8NamingChecker.__findGlobalDefs" ref="Pep8NamingCheckerPy2.html#Pep8NamingChecker.__findGlobalDefs" /> + <keyword name="Pep8NamingChecker.__findGlobalDefs" id="Pep8NamingChecker.__findGlobalDefs" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__findGlobalDefs" /> + <keyword name="Pep8NamingChecker.__getArgNames" id="Pep8NamingChecker.__getArgNames" ref="Pep8NamingCheckerPy2.html#Pep8NamingChecker.__getArgNames" /> + <keyword name="Pep8NamingChecker.__getArgNames" id="Pep8NamingChecker.__getArgNames" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__getArgNames" /> + <keyword name="Pep8NamingChecker.__isNameToBeAvoided" id="Pep8NamingChecker.__isNameToBeAvoided" ref="Pep8NamingCheckerPy2.html#Pep8NamingChecker.__isNameToBeAvoided" /> + <keyword name="Pep8NamingChecker.__isNameToBeAvoided" id="Pep8NamingChecker.__isNameToBeAvoided" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__isNameToBeAvoided" /> + <keyword name="Pep8NamingChecker.__tagClassFunctions" id="Pep8NamingChecker.__tagClassFunctions" ref="Pep8NamingCheckerPy2.html#Pep8NamingChecker.__tagClassFunctions" /> + <keyword name="Pep8NamingChecker.__tagClassFunctions" id="Pep8NamingChecker.__tagClassFunctions" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__tagClassFunctions" /> + <keyword name="Pep8NamingChecker.__visitNode" id="Pep8NamingChecker.__visitNode" ref="Pep8NamingCheckerPy2.html#Pep8NamingChecker.__visitNode" /> + <keyword name="Pep8NamingChecker.__visitNode" id="Pep8NamingChecker.__visitNode" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.__visitNode" /> + <keyword name="Pep8NamingChecker.__visitTree" id="Pep8NamingChecker.__visitTree" ref="Pep8NamingCheckerPy2.html#Pep8NamingChecker.__visitTree" /> + <keyword name="Pep8NamingChecker.__visitTree" id="Pep8NamingChecker.__visitTree" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.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="Pep8NamingCheckerPy2.html#Pep8NamingChecker.run" /> + <keyword name="Pep8NamingChecker.run" id="Pep8NamingChecker.run" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html#Pep8NamingChecker.run" /> + <keyword name="Pep8NamingChecker.unpackArgs" id="Pep8NamingChecker.unpackArgs" ref="Pep8NamingCheckerPy2.html#Pep8NamingChecker.unpackArgs" /> + <keyword name="Pep8NamingCheckerPy2 (Module)" id="Pep8NamingCheckerPy2 (Module)" ref="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" /> <keyword name="Pep8Reindenter (Constructor)" id="Pep8Reindenter (Constructor)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Reindenter.__init__" /> <keyword name="Pep8Reindenter.__genStats" id="Pep8Reindenter.__genStats" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Reindenter.__genStats" /> @@ -8047,8 +8248,11 @@ <keyword name="Pep8Reindenter.fixedLine" id="Pep8Reindenter.fixedLine" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Reindenter.fixedLine" /> <keyword name="Pep8Reindenter.getline" id="Pep8Reindenter.getline" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Reindenter.getline" /> <keyword name="Pep8Reindenter.run" id="Pep8Reindenter.run" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html#Pep8Reindenter.run" /> + <keyword name="Pep8Report" id="Pep8Report" ref="Pep8Checker.html#Pep8Report" /> <keyword name="Pep8Report" id="Pep8Report" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html#Pep8Report" /> + <keyword name="Pep8Report (Constructor)" id="Pep8Report (Constructor)" ref="Pep8Checker.html#Pep8Report.__init__" /> <keyword name="Pep8Report (Constructor)" id="Pep8Report (Constructor)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html#Pep8Report.__init__" /> + <keyword name="Pep8Report.error_args" id="Pep8Report.error_args" ref="Pep8Checker.html#Pep8Report.error_args" /> <keyword name="Pep8Report.error_args" id="Pep8Report.error_args" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html#Pep8Report.error_args" /> <keyword name="Pep8StatisticsDialog" id="Pep8StatisticsDialog" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8StatisticsDialog.html#Pep8StatisticsDialog" /> <keyword name="Pep8StatisticsDialog (Constructor)" id="Pep8StatisticsDialog (Constructor)" ref="eric5.Plugins.CheckerPlugins.Pep8.Pep8StatisticsDialog.html#Pep8StatisticsDialog.__init__" /> @@ -8882,10 +9086,6 @@ <keyword name="PurgeProjectHelper.initActions" id="PurgeProjectHelper.initActions" ref="eric5.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.ProjectHelper.html#PurgeProjectHelper.initActions" /> <keyword name="PurgeProjectHelper.initMenu" id="PurgeProjectHelper.initMenu" ref="eric5.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.ProjectHelper.html#PurgeProjectHelper.initMenu" /> <keyword name="PurgeProjectHelper.menuTitle" id="PurgeProjectHelper.menuTitle" ref="eric5.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.ProjectHelper.html#PurgeProjectHelper.menuTitle" /> - <keyword name="Py3FlakesPage" id="Py3FlakesPage" ref="eric5.Preferences.ConfigurationPages.Py3FlakesPage.html#Py3FlakesPage" /> - <keyword name="Py3FlakesPage (Constructor)" id="Py3FlakesPage (Constructor)" ref="eric5.Preferences.ConfigurationPages.Py3FlakesPage.html#Py3FlakesPage.__init__" /> - <keyword name="Py3FlakesPage (Module)" id="Py3FlakesPage (Module)" ref="eric5.Preferences.ConfigurationPages.Py3FlakesPage.html" /> - <keyword name="Py3FlakesPage.save" id="Py3FlakesPage.save" ref="eric5.Preferences.ConfigurationPages.Py3FlakesPage.html#Py3FlakesPage.save" /> <keyword name="PyCoverageDialog" id="PyCoverageDialog" ref="eric5.DataViews.PyCoverageDialog.html#PyCoverageDialog" /> <keyword name="PyCoverageDialog (Constructor)" id="PyCoverageDialog (Constructor)" ref="eric5.DataViews.PyCoverageDialog.html#PyCoverageDialog.__init__" /> <keyword name="PyCoverageDialog (Module)" id="PyCoverageDialog (Module)" ref="eric5.DataViews.PyCoverageDialog.html" /> @@ -9969,11 +10169,17 @@ <keyword name="StackedWidget.setCurrentIndex" id="StackedWidget.setCurrentIndex" ref="eric5.Plugins.ViewManagerPlugins.Listspace.Listspace.html#StackedWidget.setCurrentIndex" /> <keyword name="StackedWidget.setCurrentWidget" id="StackedWidget.setCurrentWidget" ref="eric5.Plugins.ViewManagerPlugins.Listspace.Listspace.html#StackedWidget.setCurrentWidget" /> <keyword name="StandardReport" id="StandardReport" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#StandardReport" /> + <keyword name="StandardReport" id="StandardReport" ref="pep8.html#StandardReport" /> <keyword name="StandardReport (Constructor)" id="StandardReport (Constructor)" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#StandardReport.__init__" /> + <keyword name="StandardReport (Constructor)" id="StandardReport (Constructor)" ref="pep8.html#StandardReport.__init__" /> <keyword name="StandardReport.error" id="StandardReport.error" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#StandardReport.error" /> + <keyword name="StandardReport.error" id="StandardReport.error" ref="pep8.html#StandardReport.error" /> <keyword name="StandardReport.error_args" id="StandardReport.error_args" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#StandardReport.error_args" /> + <keyword name="StandardReport.error_args" id="StandardReport.error_args" ref="pep8.html#StandardReport.error_args" /> <keyword name="StandardReport.get_file_results" id="StandardReport.get_file_results" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#StandardReport.get_file_results" /> + <keyword name="StandardReport.get_file_results" id="StandardReport.get_file_results" ref="pep8.html#StandardReport.get_file_results" /> <keyword name="StandardReport.init_file" id="StandardReport.init_file" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#StandardReport.init_file" /> + <keyword name="StandardReport.init_file" id="StandardReport.init_file" ref="pep8.html#StandardReport.init_file" /> <keyword name="StartDialog" id="StartDialog" ref="eric5.Debugger.StartDialog.html#StartDialog" /> <keyword name="StartDialog (Constructor)" id="StartDialog (Constructor)" ref="eric5.Debugger.StartDialog.html#StartDialog.__init__" /> <keyword name="StartDialog (Module)" id="StartDialog (Module)" ref="eric5.Debugger.StartDialog.html" /> @@ -9999,14 +10205,23 @@ <keyword name="StatusMonitorLed._showContextMenu" id="StatusMonitorLed._showContextMenu" ref="eric5.VCS.StatusMonitorLed.html#StatusMonitorLed._showContextMenu" /> <keyword name="StatusMonitorThread (Module)" id="StatusMonitorThread (Module)" ref="eric5.VCS.StatusMonitorThread.html" /> <keyword name="StyleGuide" id="StyleGuide" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#StyleGuide" /> + <keyword name="StyleGuide" id="StyleGuide" ref="pep8.html#StyleGuide" /> <keyword name="StyleGuide (Constructor)" id="StyleGuide (Constructor)" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#StyleGuide.__init__" /> + <keyword name="StyleGuide (Constructor)" id="StyleGuide (Constructor)" ref="pep8.html#StyleGuide.__init__" /> <keyword name="StyleGuide.check_files" id="StyleGuide.check_files" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#StyleGuide.check_files" /> + <keyword name="StyleGuide.check_files" id="StyleGuide.check_files" ref="pep8.html#StyleGuide.check_files" /> <keyword name="StyleGuide.excluded" id="StyleGuide.excluded" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#StyleGuide.excluded" /> + <keyword name="StyleGuide.excluded" id="StyleGuide.excluded" ref="pep8.html#StyleGuide.excluded" /> <keyword name="StyleGuide.get_checks" id="StyleGuide.get_checks" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#StyleGuide.get_checks" /> + <keyword name="StyleGuide.get_checks" id="StyleGuide.get_checks" ref="pep8.html#StyleGuide.get_checks" /> <keyword name="StyleGuide.ignore_code" id="StyleGuide.ignore_code" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#StyleGuide.ignore_code" /> + <keyword name="StyleGuide.ignore_code" id="StyleGuide.ignore_code" ref="pep8.html#StyleGuide.ignore_code" /> <keyword name="StyleGuide.init_report" id="StyleGuide.init_report" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#StyleGuide.init_report" /> + <keyword name="StyleGuide.init_report" id="StyleGuide.init_report" ref="pep8.html#StyleGuide.init_report" /> <keyword name="StyleGuide.input_dir" id="StyleGuide.input_dir" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#StyleGuide.input_dir" /> + <keyword name="StyleGuide.input_dir" id="StyleGuide.input_dir" ref="pep8.html#StyleGuide.input_dir" /> <keyword name="StyleGuide.input_file" id="StyleGuide.input_file" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#StyleGuide.input_file" /> + <keyword name="StyleGuide.input_file" id="StyleGuide.input_file" ref="pep8.html#StyleGuide.input_file" /> <keyword name="Subversion" id="Subversion" ref="eric5.Plugins.VcsPlugins.vcsPySvn.subversion.html#Subversion" /> <keyword name="Subversion" id="Subversion" ref="eric5.Plugins.VcsPlugins.vcsSubversion.subversion.html#Subversion" /> <keyword name="Subversion (Constructor)" id="Subversion (Constructor)" ref="eric5.Plugins.VcsPlugins.vcsPySvn.subversion.html#Subversion.__init__" /> @@ -11287,6 +11502,7 @@ <keyword name="ToolGroupConfigurationDialog.on_newButton_clicked" id="ToolGroupConfigurationDialog.on_newButton_clicked" ref="eric5.Preferences.ToolGroupConfigurationDialog.html#ToolGroupConfigurationDialog.on_newButton_clicked" /> <keyword name="ToolGroupConfigurationDialog.on_upButton_clicked" id="ToolGroupConfigurationDialog.on_upButton_clicked" ref="eric5.Preferences.ToolGroupConfigurationDialog.html#ToolGroupConfigurationDialog.on_upButton_clicked" /> <keyword name="Toolbox (Package)" id="Toolbox (Package)" ref="index-eric5.Toolbox.html" /> + <keyword name="Tools (Module)" id="Tools (Module)" ref="Tools.html" /> <keyword name="Tools (Package)" id="Tools (Package)" ref="index-eric5.Tools.html" /> <keyword name="Translation" id="Translation" ref="eric5.Tools.TRPreviewer.html#Translation" /> <keyword name="Translation (Constructor)" id="Translation (Constructor)" ref="eric5.Tools.TRPreviewer.html#Translation.__init__" /> @@ -12500,6 +12716,7 @@ <keyword name="__setAction" id="__setAction" ref="eric5.Preferences.Shortcuts.html#__setAction" /> <keyword name="__showwarning" id="__showwarning" ref="eric5.Utilities.__init__.html#__showwarning" /> <keyword name="_add_check" id="_add_check" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#_add_check" /> + <keyword name="_add_check" id="_add_check" ref="pep8.html#_add_check" /> <keyword name="_buildChildrenLists" id="_buildChildrenLists" ref="eric5.Graphics.GraphicsUtilities.html#_buildChildrenLists" /> <keyword name="_debugclient_start_new_thread" id="_debugclient_start_new_thread" ref="eric5.DebugClients.Python.DebugClientThreads.html#_debugclient_start_new_thread" /> <keyword name="_debugclient_start_new_thread" id="_debugclient_start_new_thread" ref="eric5.DebugClients.Python3.DebugClientThreads.html#_debugclient_start_new_thread" /> @@ -12507,6 +12724,7 @@ <keyword name="_indent" id="_indent" ref="eric5.Utilities.ClassBrowsers.pyclbr.html#_indent" /> <keyword name="_indent" id="_indent" ref="eric5.Utilities.ModuleParser.html#_indent" /> <keyword name="_main" id="_main" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#_main" /> + <keyword name="_main" id="_main" ref="pep8.html#_main" /> <keyword name="_percentReplacementFunc" id="_percentReplacementFunc" ref="eric5.Utilities.__init__.html#_percentReplacementFunc" /> <keyword name="addActions" id="addActions" ref="eric5.E5Gui.E5Action.html#addActions" /> <keyword name="addSearchPath" id="addSearchPath" ref="eric5.UI.PixmapCache.html#addSearchPath" /> @@ -12516,6 +12734,7 @@ <keyword name="append_PKCS7_padding" id="append_PKCS7_padding" ref="eric5.Utilities.crypto.py3AES.html#append_PKCS7_padding" /> <keyword name="binplistlib (Module)" id="binplistlib (Module)" ref="eric5.Utilities.binplistlib.html" /> <keyword name="blank_lines" id="blank_lines" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#blank_lines" /> + <keyword name="blank_lines" id="blank_lines" ref="pep8.html#blank_lines" /> <keyword name="bookmarks (Module)" id="bookmarks (Module)" ref="eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.bookmarks.html" /> <keyword name="changeRememberedMaster" id="changeRememberedMaster" ref="eric5.Utilities.crypto.__init__.html#changeRememberedMaster" /> <keyword name="check" id="check" ref="eric5.Plugins.CheckerPlugins.Tabnanny.Tabnanny.html#check" /> @@ -12527,7 +12746,9 @@ <keyword name="close" id="close" ref="eric5.DebugClients.Ruby.AsyncFile.html#close" /> <keyword name="compactPath" id="compactPath" ref="eric5.Utilities.__init__.html#compactPath" /> <keyword name="comparison_to_singleton" id="comparison_to_singleton" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#comparison_to_singleton" /> + <keyword name="comparison_to_singleton" id="comparison_to_singleton" ref="pep8.html#comparison_to_singleton" /> <keyword name="comparison_type" id="comparison_type" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#comparison_type" /> + <keyword name="comparison_type" id="comparison_type" ref="pep8.html#comparison_type" /> <keyword name="compatibility_fixes (Module)" id="compatibility_fixes (Module)" ref="eric5.Utilities.compatibility_fixes.html" /> <keyword name="compile" id="compile" ref="eric5.Utilities.__init__.html#compile" /> <keyword name="compileUiDir" id="compileUiDir" ref="eric5.Utilities.uic.html#compileUiDir" /> @@ -12543,10 +12764,12 @@ <keyword name="compile_ui" id="compile_ui" ref="eric5.compileUiFiles.html#compile_ui" /> <keyword name="compile_ui" id="compile_ui" ref="eric5.install.html#compile_ui" /> <keyword name="compound_statements" id="compound_statements" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#compound_statements" /> + <keyword name="compound_statements" id="compound_statements" ref="pep8.html#compound_statements" /> <keyword name="contentSniff" id="contentSniff" ref="eric5.Helpviewer.HelpBrowserWV.html#contentSniff" /> <keyword name="context" id="context" ref="eric5.DebugClients.Ruby.Debuggee.html#context" /> <keyword name="context_diff" id="context_diff" ref="eric5.UI.DiffDialog.html#context_diff" /> <keyword name="continued_indentation" id="continued_indentation" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#continued_indentation" /> + <keyword name="continued_indentation" id="continued_indentation" ref="pep8.html#continued_indentation" /> <keyword name="convertLineEnds" id="convertLineEnds" ref="eric5.Utilities.__init__.html#convertLineEnds" /> <keyword name="convertPasswords" id="convertPasswords" ref="eric5.Preferences.__init__.html#convertPasswords" /> <keyword name="copyToFile" id="copyToFile" ref="eric5.install.html#copyToFile" /> @@ -12593,7 +12816,6 @@ <keyword name="create" id="create" ref="eric5.Preferences.ConfigurationPages.PrinterPage.html#create" /> <keyword name="create" id="create" ref="eric5.Preferences.ConfigurationPages.ProjectBrowserPage.html#create" /> <keyword name="create" id="create" ref="eric5.Preferences.ConfigurationPages.ProjectPage.html#create" /> - <keyword name="create" id="create" ref="eric5.Preferences.ConfigurationPages.Py3FlakesPage.html#create" /> <keyword name="create" id="create" ref="eric5.Preferences.ConfigurationPages.PythonPage.html#create" /> <keyword name="create" id="create" ref="eric5.Preferences.ConfigurationPages.QtPage.html#create" /> <keyword name="create" id="create" ref="eric5.Preferences.ConfigurationPages.SecurityPage.html#create" /> @@ -12641,6 +12863,7 @@ <keyword name="dataString" id="dataString" ref="eric5.Helpviewer.Download.DownloadUtilities.html#dataString" /> <keyword name="dateFromTime_t" id="dateFromTime_t" ref="eric5.Plugins.VcsPlugins.vcsPySvn.SvnUtilities.html#dateFromTime_t" /> <keyword name="debug_thread_info" id="debug_thread_info" ref="eric5.DebugClients.Ruby.Debuggee.html#debug_thread_info" /> + <keyword name="decode" id="decode" ref="Tools.html#decode" /> <keyword name="decode" id="decode" ref="eric5.Utilities.SyntaxCheck.html#decode" /> <keyword name="decodeBytes" id="decodeBytes" ref="eric5.Utilities.__init__.html#decodeBytes" /> <keyword name="decodeString" id="decodeString" ref="eric5.Utilities.__init__.html#decodeString" /> @@ -12694,17 +12917,22 @@ <keyword name="exit" id="exit" ref="eric5.install.html#exit" /> <keyword name="exit" id="exit" ref="eric5.uninstall.html#exit" /> <keyword name="expand_indent" id="expand_indent" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#expand_indent" /> + <keyword name="expand_indent" id="expand_indent" ref="pep8.html#expand_indent" /> <keyword name="explicit_line_join" id="explicit_line_join" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#explicit_line_join" /> + <keyword name="explicit_line_join" id="explicit_line_join" ref="pep8.html#explicit_line_join" /> <keyword name="exportPreferences" id="exportPreferences" ref="eric5.Preferences.__init__.html#exportPreferences" /> <keyword name="exportShortcuts" id="exportShortcuts" ref="eric5.Preferences.Shortcuts.html#exportShortcuts" /> <keyword name="extractFlags" id="extractFlags" ref="eric5.Utilities.__init__.html#extractFlags" /> <keyword name="extractFlagsFromFile" id="extractFlagsFromFile" ref="eric5.Utilities.__init__.html#extractFlagsFromFile" /> + <keyword name="extractLineFlags" id="extractLineFlags" ref="Tools.html#extractLineFlags" /> <keyword name="extractLineFlags" id="extractLineFlags" ref="eric5.Utilities.SyntaxCheck.html#extractLineFlags" /> <keyword name="extraneous_whitespace" id="extraneous_whitespace" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#extraneous_whitespace" /> + <keyword name="extraneous_whitespace" id="extraneous_whitespace" ref="pep8.html#extraneous_whitespace" /> <keyword name="factory" id="factory" ref="eric5.VCS.__init__.html#factory" /> <keyword name="factory" id="factory" ref="eric5.ViewManager.__init__.html#factory" /> <keyword name="fetch (Module)" id="fetch (Module)" ref="eric5.Plugins.VcsPlugins.vcsMercurial.FetchExtension.fetch.html" /> <keyword name="filename_match" id="filename_match" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#filename_match" /> + <keyword name="filename_match" id="filename_match" ref="pep8.html#filename_match" /> <keyword name="fileno" id="fileno" ref="eric5.DebugClients.Ruby.AsyncFile.html#fileno" /> <keyword name="filterCharsFromFilename" id="filterCharsFromFilename" ref="eric5.Helpviewer.HelpUtilities.html#filterCharsFromFilename" /> <keyword name="findPythonInterpreters" id="findPythonInterpreters" ref="eric5.Globals.__init__.html#findPythonInterpreters" /> @@ -12832,9 +13060,11 @@ <keyword name="getViewManager" id="getViewManager" ref="eric5.Preferences.__init__.html#getViewManager" /> <keyword name="get_class_members" id="get_class_members" ref="eric5.DebugClients.Python.FlexCompleter.html#get_class_members" /> <keyword name="get_class_members" id="get_class_members" ref="eric5.DebugClients.Python3.FlexCompleter.html#get_class_members" /> + <keyword name="get_coding" id="get_coding" ref="Tools.html#get_coding" /> <keyword name="get_coding" id="get_coding" ref="eric5.Utilities.__init__.html#get_coding" /> <keyword name="get_codingBytes" id="get_codingBytes" ref="eric5.Utilities.SyntaxCheck.html#get_codingBytes" /> <keyword name="get_parser" id="get_parser" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#get_parser" /> + <keyword name="get_parser" id="get_parser" ref="pep8.html#get_parser" /> <keyword name="get_thread" id="get_thread" ref="eric5.DebugClients.Ruby.Debuggee.html#get_thread" /> <keyword name="getpass" id="getpass" ref="eric5.DebugClients.Python.getpass.html#getpass" /> <keyword name="getpass" id="getpass" ref="eric5.DebugClients.Python3.getpass.html#getpass" /> @@ -12857,7 +13087,9 @@ <keyword name="importPreferences" id="importPreferences" ref="eric5.Preferences.__init__.html#importPreferences" /> <keyword name="importShortcuts" id="importShortcuts" ref="eric5.Preferences.Shortcuts.html#importShortcuts" /> <keyword name="imports_on_separate_lines" id="imports_on_separate_lines" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#imports_on_separate_lines" /> + <keyword name="imports_on_separate_lines" id="imports_on_separate_lines" ref="pep8.html#imports_on_separate_lines" /> <keyword name="indentation" id="indentation" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#indentation" /> + <keyword name="indentation" id="indentation" ref="pep8.html#indentation" /> <keyword name="information" id="information" ref="eric5.E5Gui.E5MessageBox.html#information" /> <keyword name="initDebugger" id="initDebugger" ref="eric5.DebugClients.Python.eric5dbgstub.html#initDebugger" /> <keyword name="initDebugger" id="initDebugger" ref="eric5.DebugClients.Python3.eric5dbgstub.html#initDebugger" /> @@ -12867,6 +13099,7 @@ <keyword name="initPreferences" id="initPreferences" ref="eric5.Preferences.__init__.html#initPreferences" /> <keyword name="initRecentSettings" id="initRecentSettings" ref="eric5.Preferences.__init__.html#initRecentSettings" /> <keyword name="init_checks_registry" id="init_checks_registry" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#init_checks_registry" /> + <keyword name="init_checks_registry" id="init_checks_registry" ref="pep8.html#init_checks_registry" /> <keyword name="initializeResourceSearchPath" id="initializeResourceSearchPath" ref="eric5.Toolbox.Startup.html#initializeResourceSearchPath" /> <keyword name="install (Module)" id="install (Module)" ref="eric5.install.html" /> <keyword name="install-i18n (Module)" id="install-i18n (Module)" ref="eric5.install-i18n.html" /> @@ -12920,16 +13153,22 @@ <keyword name="makeAppInfo" id="makeAppInfo" ref="eric5.Globals.AppInfo.html#makeAppInfo" /> <keyword name="make_thread_list" id="make_thread_list" ref="eric5.DebugClients.Ruby.Debuggee.html#make_thread_list" /> <keyword name="maximum_line_length" id="maximum_line_length" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#maximum_line_length" /> + <keyword name="maximum_line_length" id="maximum_line_length" ref="pep8.html#maximum_line_length" /> <keyword name="messageHandler" id="messageHandler" ref="eric5.E5Gui.E5ErrorMessage.html#messageHandler" /> <keyword name="messageHandlerInstalled" id="messageHandlerInstalled" ref="eric5.E5Gui.E5ErrorMessage.html#messageHandlerInstalled" /> <keyword name="messages (Module)" id="messages (Module)" ref="eric5.Utilities.py2flakes.messages.html" /> <keyword name="messages (Module)" id="messages (Module)" ref="eric5.Utilities.py3flakes.messages.html" /> <keyword name="missing_newline" id="missing_newline" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#missing_newline" /> + <keyword name="missing_newline" id="missing_newline" ref="pep8.html#missing_newline" /> <keyword name="missing_whitespace" id="missing_whitespace" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#missing_whitespace" /> + <keyword name="missing_whitespace" id="missing_whitespace" ref="pep8.html#missing_whitespace" /> <keyword name="missing_whitespace_around_operator" id="missing_whitespace_around_operator" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#missing_whitespace_around_operator" /> + <keyword name="missing_whitespace_around_operator" id="missing_whitespace_around_operator" ref="pep8.html#missing_whitespace_around_operator" /> <keyword name="mute_string" id="mute_string" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#mute_string" /> + <keyword name="mute_string" id="mute_string" ref="pep8.html#mute_string" /> <keyword name="normabsjoinpath" id="normabsjoinpath" ref="eric5.Utilities.__init__.html#normabsjoinpath" /> <keyword name="normabspath" id="normabspath" ref="eric5.Utilities.__init__.html#normabspath" /> + <keyword name="normalizeCode" id="normalizeCode" ref="Tools.html#normalizeCode" /> <keyword name="normalizeCode" id="normalizeCode" ref="eric5.Utilities.SyntaxCheck.html#normalizeCode" /> <keyword name="normcaseabspath" id="normcaseabspath" ref="eric5.Utilities.__init__.html#normcaseabspath" /> <keyword name="normcasepath" id="normcasepath" ref="eric5.Utilities.__init__.html#normcasepath" /> @@ -12940,10 +13179,12 @@ <keyword name="parseOptionString" id="parseOptionString" ref="eric5.Utilities.__init__.html#parseOptionString" /> <keyword name="parseString" id="parseString" ref="eric5.Utilities.__init__.html#parseString" /> <keyword name="parse_udiff" id="parse_udiff" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#parse_udiff" /> + <keyword name="parse_udiff" id="parse_udiff" ref="pep8.html#parse_udiff" /> <keyword name="patch_modpython (Module)" id="patch_modpython (Module)" ref="eric5.patch_modpython.html" /> <keyword name="pbkdf2" id="pbkdf2" ref="eric5.Utilities.crypto.py3PBKDF2.html#pbkdf2" /> <keyword name="pendingWrite" id="pendingWrite" ref="eric5.DebugClients.Ruby.AsyncFile.html#pendingWrite" /> <keyword name="pep8 (Module)" id="pep8 (Module)" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html" /> + <keyword name="pep8 (Module)" id="pep8 (Module)" ref="pep8.html" /> <keyword name="prepareProcess" id="prepareProcess" ref="eric5.Plugins.VcsPlugins.vcsMercurial.HgUtilities.html#prepareProcess" /> <keyword name="prepareQtMacBundle" id="prepareQtMacBundle" ref="eric5.Utilities.__init__.html#prepareQtMacBundle" /> <keyword name="prepareUninstall" id="prepareUninstall" ref="eric5.Plugins.PluginVcsMercurial.html#prepareUninstall" /> @@ -12954,6 +13195,7 @@ <keyword name="printerr" id="printerr" ref="eric5.DebugClients.Python.DebugBase.html#printerr" /> <keyword name="printerr" id="printerr" ref="eric5.DebugClients.Python3.DebugBase.html#printerr" /> <keyword name="process_options" id="process_options" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#process_options" /> + <keyword name="process_options" id="process_options" ref="pep8.html#process_options" /> <keyword name="process_tokens" id="process_tokens" ref="eric5.Plugins.CheckerPlugins.Tabnanny.Tabnanny.html#process_tokens" /> <keyword name="proxyAuthenticationRequired" id="proxyAuthenticationRequired" ref="eric5.E5Network.E5NetworkProxyFactory.html#proxyAuthenticationRequired" /> <keyword name="purge (Module)" id="purge (Module)" ref="eric5.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge.html" /> @@ -12973,14 +13215,19 @@ <keyword name="pyName" id="pyName" ref="eric5.install.html#pyName" /> <keyword name="pyclbr (Module)" id="pyclbr (Module)" ref="eric5.Utilities.ClassBrowsers.pyclbr.html" /> <keyword name="python_3000_backticks" id="python_3000_backticks" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#python_3000_backticks" /> + <keyword name="python_3000_backticks" id="python_3000_backticks" ref="pep8.html#python_3000_backticks" /> <keyword name="python_3000_has_key" id="python_3000_has_key" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#python_3000_has_key" /> + <keyword name="python_3000_has_key" id="python_3000_has_key" ref="pep8.html#python_3000_has_key" /> <keyword name="python_3000_not_equal" id="python_3000_not_equal" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#python_3000_not_equal" /> + <keyword name="python_3000_not_equal" id="python_3000_not_equal" ref="pep8.html#python_3000_not_equal" /> <keyword name="python_3000_raise_comma" id="python_3000_raise_comma" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#python_3000_raise_comma" /> + <keyword name="python_3000_raise_comma" id="python_3000_raise_comma" ref="pep8.html#python_3000_raise_comma" /> <keyword name="qtHandler" id="qtHandler" ref="eric5.E5Gui.E5ErrorMessage.html#qtHandler" /> <keyword name="question" id="question" ref="eric5.E5Gui.E5MessageBox.html#question" /> <keyword name="queues (Module)" id="queues (Module)" ref="eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.queues.html" /> <keyword name="rbclbr (Module)" id="rbclbr (Module)" ref="eric5.Utilities.ClassBrowsers.rbclbr.html" /> <keyword name="read" id="read" ref="eric5.DebugClients.Ruby.AsyncFile.html#read" /> + <keyword name="readEncodedFile" id="readEncodedFile" ref="Tools.html#readEncodedFile" /> <keyword name="readEncodedFile" id="readEncodedFile" ref="eric5.Utilities.SyntaxCheck.html#readEncodedFile" /> <keyword name="readEncodedFileWithHash" id="readEncodedFileWithHash" ref="eric5.Utilities.__init__.html#readEncodedFileWithHash" /> <keyword name="readModule" id="readModule" ref="eric5.Utilities.ModuleParser.html#readModule" /> @@ -12990,10 +13237,13 @@ <keyword name="readStringFromStream" id="readStringFromStream" ref="eric5.Utilities.__init__.html#readStringFromStream" /> <keyword name="readToolGroups" id="readToolGroups" ref="eric5.Preferences.__init__.html#readToolGroups" /> <keyword name="read_config" id="read_config" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#read_config" /> + <keyword name="read_config" id="read_config" ref="pep8.html#read_config" /> <keyword name="readline" id="readline" ref="eric5.DebugClients.Ruby.AsyncFile.html#readline" /> <keyword name="readlines" id="readlines" ref="eric5.DebugClients.Ruby.AsyncFile.html#readlines" /> <keyword name="readlines" id="readlines" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#readlines" /> + <keyword name="readlines" id="readlines" ref="pep8.html#readlines" /> <keyword name="readlines_1" id="readlines_1" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#readlines_1" /> + <keyword name="readlines_1" id="readlines_1" ref="pep8.html#readlines_1" /> <keyword name="readmodule" id="readmodule" ref="eric5.Utilities.ClassBrowsers.__init__.html#readmodule" /> <keyword name="readmodule_ex" id="readmodule_ex" ref="eric5.Utilities.ClassBrowsers.idlclbr.html#readmodule_ex" /> <keyword name="readmodule_ex" id="readmodule_ex" ref="eric5.Utilities.ClassBrowsers.jsclbr.html#readmodule_ex" /> @@ -13002,6 +13252,7 @@ <keyword name="rebase (Module)" id="rebase (Module)" ref="eric5.Plugins.VcsPlugins.vcsMercurial.RebaseExtension.rebase.html" /> <keyword name="registerLexer" id="registerLexer" ref="eric5.QScintilla.Lexers.__init__.html#registerLexer" /> <keyword name="register_check" id="register_check" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#register_check" /> + <keyword name="register_check" id="register_check" ref="pep8.html#register_check" /> <keyword name="rehashPassword" id="rehashPassword" ref="eric5.Utilities.crypto.py3PBKDF2.html#rehashPassword" /> <keyword name="relpath" id="relpath" ref="eric5.Utilities.__init__.html#relpath" /> <keyword name="removeMarkers" id="removeMarkers" ref="eric5.UI.CompareDialog.html#removeMarkers" /> @@ -13077,13 +13328,16 @@ <keyword name="startDebugger" id="startDebugger" ref="eric5.DebugClients.Python.eric5dbgstub.html#startDebugger" /> <keyword name="startDebugger" id="startDebugger" ref="eric5.DebugClients.Python3.eric5dbgstub.html#startDebugger" /> <keyword name="stdin_get_value" id="stdin_get_value" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#stdin_get_value" /> + <keyword name="stdin_get_value" id="stdin_get_value" ref="pep8.html#stdin_get_value" /> <keyword name="strip_PKCS7_padding" id="strip_PKCS7_padding" ref="eric5.Utilities.crypto.py3AES.html#strip_PKCS7_padding" /> <keyword name="subversion (Module)" id="subversion (Module)" ref="eric5.Plugins.VcsPlugins.vcsPySvn.subversion.html" /> <keyword name="subversion (Module)" id="subversion (Module)" ref="eric5.Plugins.VcsPlugins.vcsSubversion.subversion.html" /> <keyword name="summarize" id="summarize" ref="eric5.DataViews.CodeMetrics.html#summarize" /> <keyword name="syncPreferences" id="syncPreferences" ref="eric5.Preferences.__init__.html#syncPreferences" /> <keyword name="tabs_obsolete" id="tabs_obsolete" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#tabs_obsolete" /> + <keyword name="tabs_obsolete" id="tabs_obsolete" ref="pep8.html#tabs_obsolete" /> <keyword name="tabs_or_spaces" id="tabs_or_spaces" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#tabs_or_spaces" /> + <keyword name="tabs_or_spaces" id="tabs_or_spaces" ref="pep8.html#tabs_or_spaces" /> <keyword name="tell" id="tell" ref="eric5.DebugClients.Ruby.AsyncFile.html#tell" /> <keyword name="thread_list" id="thread_list" ref="eric5.DebugClients.Ruby.Debuggee.html#thread_list" /> <keyword name="thread_list_all" id="thread_list_all" ref="eric5.DebugClients.Ruby.Debuggee.html#thread_list_all" /> @@ -13097,7 +13351,9 @@ <keyword name="toSecondLevelDomain" id="toSecondLevelDomain" ref="eric5.Helpviewer.AdBlock.AdBlockRule.html#toSecondLevelDomain" /> <keyword name="traceRuby?" id="traceRuby?" ref="eric5.DebugClients.Ruby.Debuggee.html#traceRuby?" /> <keyword name="trailing_blank_lines" id="trailing_blank_lines" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#trailing_blank_lines" /> + <keyword name="trailing_blank_lines" id="trailing_blank_lines" ref="pep8.html#trailing_blank_lines" /> <keyword name="trailing_whitespace" id="trailing_whitespace" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#trailing_whitespace" /> + <keyword name="trailing_whitespace" id="trailing_whitespace" ref="pep8.html#trailing_whitespace" /> <keyword name="transplant (Module)" id="transplant (Module)" ref="eric5.Plugins.VcsPlugins.vcsMercurial.TransplantExtension.transplant.html" /> <keyword name="uiStartUp" id="uiStartUp" ref="eric5.eric5.html#uiStartUp" /> <keyword name="uic (Module)" id="uic (Module)" ref="eric5.Utilities.uic.html" /> @@ -13125,11 +13381,17 @@ <keyword name="version" id="version" ref="eric5.eric5_doc.html#version" /> <keyword name="warning" id="warning" ref="eric5.E5Gui.E5MessageBox.html#warning" /> <keyword name="whitespace_around_comma" id="whitespace_around_comma" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#whitespace_around_comma" /> + <keyword name="whitespace_around_comma" id="whitespace_around_comma" ref="pep8.html#whitespace_around_comma" /> <keyword name="whitespace_around_keywords" id="whitespace_around_keywords" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#whitespace_around_keywords" /> + <keyword name="whitespace_around_keywords" id="whitespace_around_keywords" ref="pep8.html#whitespace_around_keywords" /> <keyword name="whitespace_around_named_parameter_equals" id="whitespace_around_named_parameter_equals" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#whitespace_around_named_parameter_equals" /> + <keyword name="whitespace_around_named_parameter_equals" id="whitespace_around_named_parameter_equals" ref="pep8.html#whitespace_around_named_parameter_equals" /> <keyword name="whitespace_around_operator" id="whitespace_around_operator" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#whitespace_around_operator" /> + <keyword name="whitespace_around_operator" id="whitespace_around_operator" ref="pep8.html#whitespace_around_operator" /> <keyword name="whitespace_before_inline_comment" id="whitespace_before_inline_comment" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#whitespace_before_inline_comment" /> + <keyword name="whitespace_before_inline_comment" id="whitespace_before_inline_comment" ref="pep8.html#whitespace_before_inline_comment" /> <keyword name="whitespace_before_parameters" id="whitespace_before_parameters" ref="eric5.Plugins.CheckerPlugins.Pep8.pep8.html#whitespace_before_parameters" /> + <keyword name="whitespace_before_parameters" id="whitespace_before_parameters" ref="pep8.html#whitespace_before_parameters" /> <keyword name="wildcardMatch" id="wildcardMatch" ref="eric5.Helpviewer.GreaseMonkey.GreaseMonkeyUrlMatcher.html#wildcardMatch" /> <keyword name="win32_GetUserName" id="win32_GetUserName" ref="eric5.Utilities.__init__.html#win32_GetUserName" /> <keyword name="win32_Kill" id="win32_Kill" ref="eric5.Utilities.__init__.html#win32_Kill" /> @@ -13144,6 +13406,10 @@ <keyword name="yesNo" id="yesNo" ref="eric5.E5Gui.E5MessageBox.html#yesNo" /> </keywords> <files> + <file>Pep257CheckerPy2.html</file> + <file>Pep8Checker.html</file> + <file>Pep8NamingCheckerPy2.html</file> + <file>Tools.html</file> <file>eric5.Cooperation.ChatWidget.html</file> <file>eric5.Cooperation.Connection.html</file> <file>eric5.Cooperation.CooperationClient.html</file> @@ -13494,10 +13760,12 @@ <file>eric5.PluginManager.PluginRepositoryDialog.html</file> <file>eric5.PluginManager.PluginUninstallDialog.html</file> <file>eric5.Plugins.AboutPlugin.AboutDialog.html</file> + <file>eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html</file> <file>eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker.html</file> <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> @@ -13728,7 +13996,6 @@ <file>eric5.Preferences.ConfigurationPages.PrinterPage.html</file> <file>eric5.Preferences.ConfigurationPages.ProjectBrowserPage.html</file> <file>eric5.Preferences.ConfigurationPages.ProjectPage.html</file> - <file>eric5.Preferences.ConfigurationPages.Py3FlakesPage.html</file> <file>eric5.Preferences.ConfigurationPages.PythonPage.html</file> <file>eric5.Preferences.ConfigurationPages.QtPage.html</file> <file>eric5.Preferences.ConfigurationPages.SecurityPage.html</file> @@ -13904,6 +14171,8 @@ <file>eric5.Utilities.py3flakes.checker.html</file> <file>eric5.Utilities.py3flakes.messages.html</file> <file>eric5.Utilities.uic.html</file> + <file>eric5.UtilitiesPython2.Pep257CheckerPy2.html</file> + <file>eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html</file> <file>eric5.VCS.CommandOptionsDialog.html</file> <file>eric5.VCS.ProjectBrowserHelper.html</file> <file>eric5.VCS.ProjectHelper.html</file> @@ -14045,6 +14314,7 @@ <file>index-eric5.ViewManager.html</file> <file>index-eric5.html</file> <file>index.html</file> + <file>pep8.html</file> </files> </filterSection> </QtHelpProject>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/Pep257CheckerPy2.html Tue Oct 15 22:03:54 2013 +0200 @@ -0,0 +1,896 @@ +<!DOCTYPE html> +<html><head> +<title>Pep257CheckerPy2</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>Pep257CheckerPy2</h1> +<p> +Module implementing a checker for PEP-257 documentation string conventions. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#Pep257Checker">Pep257Checker</a></td> +<td>Class implementing a checker for PEP-257 documentation string conventions.</td> +</tr><tr> +<td><a href="#Pep257Context">Pep257Context</a></td> +<td>Class implementing the source context.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="Pep257Checker" ID="Pep257Checker"></a> +<h2>Pep257Checker</h2> +<p> + Class implementing a checker for PEP-257 documentation string conventions. +</p> +<h3>Derived from</h3> +object +<h3>Class Attributes</h3> +<table> +<tr><td>Codes</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#Pep257Checker.__init__">Pep257Checker</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkBackslashes">__checkBackslashes</a></td> +<td>Private method to check, that all docstrings containing backslashes are surrounded by raw triple double quotes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkBlankAfterLastParagraph">__checkBlankAfterLastParagraph</a></td> +<td>Private method to check, that the last paragraph of docstrings is followed by a blank line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkBlankAfterSummary">__checkBlankAfterSummary</a></td> +<td>Private method to check, that docstring summaries are followed by a blank line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkBlankBeforeAndAfterClass">__checkBlankBeforeAndAfterClass</a></td> +<td>Private method to check, that class docstrings have one blank line around them.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkClassDocstring">__checkClassDocstring</a></td> +<td>Private method to check, that all public functions and methods have a docstring.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEndsWithPeriod">__checkEndsWithPeriod</a></td> +<td>Private method to check, that docstring summaries end with a period.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricBlankAfterSummary">__checkEricBlankAfterSummary</a></td> +<td>Private method to check, that docstring summaries are followed by a blank line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td> +<td>Private method to check, that docstring summaries end with a period.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricException">__checkEricException</a></td> +<td>Private method to check, that docstrings contain an @exception line if they raise an exception and don't otherwise.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricFunctionArguments">__checkEricFunctionArguments</a></td> +<td>Private method to check, that docstrings contain an @param and/or @keyparam line for each argument.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricNBlankAfterLastParagraph">__checkEricNBlankAfterLastParagraph</a></td> +<td>Private method to check, that the last paragraph of docstrings is not followed by a blank line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction">__checkEricNoBlankBeforeAndAfterClassOrFunction</a></td> +<td>Private method to check, that class and function/method docstrings have no blank line around them.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricQuotesOnSeparateLines">__checkEricQuotesOnSeparateLines</a></td> +<td>Private method to check, that leading and trailing quotes are on a line by themselves.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricReturn">__checkEricReturn</a></td> +<td>Private method to check, that docstrings contain an @return line if they return anything and don't otherwise.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkFunctionDocstring">__checkFunctionDocstring</a></td> +<td>Private method to check, that all public functions and methods have a docstring.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkImperativeMood">__checkImperativeMood</a></td> +<td>Private method to check, that docstring summaries are in imperative mood.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkIndent">__checkIndent</a></td> +<td>Private method to check, that docstrings are properly indented.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkModulesDocstrings">__checkModulesDocstrings</a></td> +<td>Private method to check, if the module has a docstring.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkNoBlankLineBefore">__checkNoBlankLineBefore</a></td> +<td>Private method to check, that function/method docstrings are not preceded by a blank line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkNoSignature">__checkNoSignature</a></td> +<td>Private method to check, that docstring summaries don't repeat the function's signature.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkOneLiner">__checkOneLiner</a></td> +<td>Private method to check, that one-liner docstrings fit on one line with quotes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkReturnType">__checkReturnType</a></td> +<td>Private method to check, that docstrings mention the return value type.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td> +<td>Private method to check, that all docstrings are surrounded by triple double quotes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkUnicode">__checkUnicode</a></td> +<td>Private method to check, that all docstrings containing unicode characters are surrounded by unicode triple double quotes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__error">__error</a></td> +<td>Private method to record an issue.</td> +</tr><tr> +<td><a href="#Pep257Checker.__getArgNames">__getArgNames</a></td> +<td></td> +</tr><tr> +<td><a href="#Pep257Checker.__getSummaryLine">__getSummaryLine</a></td> +<td>Private method to extract the summary line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__getSummaryLines">__getSummaryLines</a></td> +<td>Private method to extract the summary lines.</td> +</tr><tr> +<td><a href="#Pep257Checker.__ignoreCode">__ignoreCode</a></td> +<td>Private method to check if the error code should be ignored.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseClasses">__parseClasses</a></td> +<td>Private method to extract top-level classes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseContexts">__parseContexts</a></td> +<td>Private method to extract a context from the source.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseDocstring">__parseDocstring</a></td> +<td>Private method to extract a docstring given `def` or `class` source.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseFunctions">__parseFunctions</a></td> +<td>Private method to extract top-level functions.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseMethods">__parseMethods</a></td> +<td>Private method to extract methods of all classes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseModuleDocstring">__parseModuleDocstring</a></td> +<td>Private method to extract a docstring given a module source.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseTopLevel">__parseTopLevel</a></td> +<td>Private method to extract top-level functions or classes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__readline">__readline</a></td> +<td>Private method to get the next line from the source.</td> +</tr><tr> +<td><a href="#Pep257Checker.__resetReadline">__resetReadline</a></td> +<td>Private method to reset the internal readline function.</td> +</tr><tr> +<td><a href="#Pep257Checker.__skipIndentedBlock">__skipIndentedBlock</a></td> +<td>Private method to skip over an indented block of source code.</td> +</tr><tr> +<td><a href="#Pep257Checker.run">run</a></td> +<td>Public method to check the given source for violations of doc string conventions according to PEP-257.</td> +</tr><tr> +<td><a href="#Pep257Checker.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="Pep257Checker.__init__" ID="Pep257Checker.__init__"></a> +<h4>Pep257Checker (Constructor)</h4> +<b>Pep257Checker</b>(<i>source, filename, select, ignore, expected, repeat, maxLineLength=79, docType="pep257"</i>) +<p> + Constructor +</p><dl> +<dt><i>source</i></dt> +<dd> +source code to be checked (list of string) +</dd><dt><i>filename</i></dt> +<dd> +name of the source file (string) +</dd><dt><i>select</i></dt> +<dd> +list of selected codes (list of string) +</dd><dt><i>ignore</i></dt> +<dd> +list of codes to be ignored (list of string) +</dd><dt><i>expected</i></dt> +<dd> +list of expected codes (list of string) +</dd><dt><i>repeat</i></dt> +<dd> +flag indicating to report each occurrence of a code + (boolean) +</dd><dt><i>maxLineLength=</i></dt> +<dd> +allowed line length (integer) +</dd><dt><i>docType=</i></dt> +<dd> +type of the documentation strings + (string, one of 'eric' or 'pep257') +</dd> +</dl><a NAME="Pep257Checker.__checkBackslashes" ID="Pep257Checker.__checkBackslashes"></a> +<h4>Pep257Checker.__checkBackslashes</h4> +<b>__checkBackslashes</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all docstrings containing + backslashes are surrounded by raw triple double quotes. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkBlankAfterLastParagraph" ID="Pep257Checker.__checkBlankAfterLastParagraph"></a> +<h4>Pep257Checker.__checkBlankAfterLastParagraph</h4> +<b>__checkBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that the last paragraph of docstrings is + followed by a blank line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkBlankAfterSummary" ID="Pep257Checker.__checkBlankAfterSummary"></a> +<h4>Pep257Checker.__checkBlankAfterSummary</h4> +<b>__checkBlankAfterSummary</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries are followed + by a blank line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkBlankBeforeAndAfterClass" ID="Pep257Checker.__checkBlankBeforeAndAfterClass"></a> +<h4>Pep257Checker.__checkBlankBeforeAndAfterClass</h4> +<b>__checkBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that class docstrings have one + blank line around them. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkClassDocstring" ID="Pep257Checker.__checkClassDocstring"></a> +<h4>Pep257Checker.__checkClassDocstring</h4> +<b>__checkClassDocstring</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all public functions and methods + have a docstring. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEndsWithPeriod" ID="Pep257Checker.__checkEndsWithPeriod"></a> +<h4>Pep257Checker.__checkEndsWithPeriod</h4> +<b>__checkEndsWithPeriod</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries end with a period. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricBlankAfterSummary" ID="Pep257Checker.__checkEricBlankAfterSummary"></a> +<h4>Pep257Checker.__checkEricBlankAfterSummary</h4> +<b>__checkEricBlankAfterSummary</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries are followed + by a blank line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricEndsWithPeriod" ID="Pep257Checker.__checkEricEndsWithPeriod"></a> +<h4>Pep257Checker.__checkEricEndsWithPeriod</h4> +<b>__checkEricEndsWithPeriod</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries end with a period. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricException" ID="Pep257Checker.__checkEricException"></a> +<h4>Pep257Checker.__checkEricException</h4> +<b>__checkEricException</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstrings contain an @exception line + if they raise an exception and don't otherwise. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricFunctionArguments" ID="Pep257Checker.__checkEricFunctionArguments"></a> +<h4>Pep257Checker.__checkEricFunctionArguments</h4> +<b>__checkEricFunctionArguments</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstrings contain an @param and/or + @keyparam line for each argument. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricNBlankAfterLastParagraph" ID="Pep257Checker.__checkEricNBlankAfterLastParagraph"></a> +<h4>Pep257Checker.__checkEricNBlankAfterLastParagraph</h4> +<b>__checkEricNBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that the last paragraph of docstrings is + not followed by a blank line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a> +<h4>Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction</h4> +<b>__checkEricNoBlankBeforeAndAfterClassOrFunction</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that class and function/method docstrings + have no blank line around them. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricQuotesOnSeparateLines" ID="Pep257Checker.__checkEricQuotesOnSeparateLines"></a> +<h4>Pep257Checker.__checkEricQuotesOnSeparateLines</h4> +<b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that leading and trailing quotes are on + a line by themselves. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricReturn" ID="Pep257Checker.__checkEricReturn"></a> +<h4>Pep257Checker.__checkEricReturn</h4> +<b>__checkEricReturn</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstrings contain an @return line + if they return anything and don't otherwise. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkFunctionDocstring" ID="Pep257Checker.__checkFunctionDocstring"></a> +<h4>Pep257Checker.__checkFunctionDocstring</h4> +<b>__checkFunctionDocstring</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all public functions and methods + have a docstring. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkImperativeMood" ID="Pep257Checker.__checkImperativeMood"></a> +<h4>Pep257Checker.__checkImperativeMood</h4> +<b>__checkImperativeMood</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries are in + imperative mood. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkIndent" ID="Pep257Checker.__checkIndent"></a> +<h4>Pep257Checker.__checkIndent</h4> +<b>__checkIndent</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstrings are properly indented. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkModulesDocstrings" ID="Pep257Checker.__checkModulesDocstrings"></a> +<h4>Pep257Checker.__checkModulesDocstrings</h4> +<b>__checkModulesDocstrings</b>(<i>docstringContext, context</i>) +<p> + Private method to check, if the module has a docstring. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkNoBlankLineBefore" ID="Pep257Checker.__checkNoBlankLineBefore"></a> +<h4>Pep257Checker.__checkNoBlankLineBefore</h4> +<b>__checkNoBlankLineBefore</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that function/method docstrings are not + preceded by a blank line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkNoSignature" ID="Pep257Checker.__checkNoSignature"></a> +<h4>Pep257Checker.__checkNoSignature</h4> +<b>__checkNoSignature</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries don't repeat + the function's signature. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkOneLiner" ID="Pep257Checker.__checkOneLiner"></a> +<h4>Pep257Checker.__checkOneLiner</h4> +<b>__checkOneLiner</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that one-liner docstrings fit on + one line with quotes. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkReturnType" ID="Pep257Checker.__checkReturnType"></a> +<h4>Pep257Checker.__checkReturnType</h4> +<b>__checkReturnType</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstrings mention the return value type. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkTripleDoubleQuotes" ID="Pep257Checker.__checkTripleDoubleQuotes"></a> +<h4>Pep257Checker.__checkTripleDoubleQuotes</h4> +<b>__checkTripleDoubleQuotes</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all docstrings are surrounded + by triple double quotes. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkUnicode" ID="Pep257Checker.__checkUnicode"></a> +<h4>Pep257Checker.__checkUnicode</h4> +<b>__checkUnicode</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all docstrings containing unicode + characters are surrounded by unicode triple double quotes. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__error" ID="Pep257Checker.__error"></a> +<h4>Pep257Checker.__error</h4> +<b>__error</b>(<i>lineNumber, offset, code, *args</i>) +<p> + Private method to record an issue. +</p><dl> +<dt><i>lineNumber</i></dt> +<dd> +line number of the issue (integer) +</dd><dt><i>offset</i></dt> +<dd> +position within line of the issue (integer) +</dd><dt><i>code</i></dt> +<dd> +message code (string) +</dd><dt><i>args</i></dt> +<dd> +arguments for the message (list) +</dd> +</dl><a NAME="Pep257Checker.__getArgNames" ID="Pep257Checker.__getArgNames"></a> +<h4>Pep257Checker.__getArgNames</h4> +<b>__getArgNames</b>(<i>node</i>) +<a NAME="Pep257Checker.__getSummaryLine" ID="Pep257Checker.__getSummaryLine"></a> +<h4>Pep257Checker.__getSummaryLine</h4> +<b>__getSummaryLine</b>(<i>docstringContext</i>) +<p> + Private method to extract the summary line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +summary line (string) and the line it was found on (integer) +</dd> +</dl><a NAME="Pep257Checker.__getSummaryLines" ID="Pep257Checker.__getSummaryLines"></a> +<h4>Pep257Checker.__getSummaryLines</h4> +<b>__getSummaryLines</b>(<i>docstringContext</i>) +<p> + Private method to extract the summary lines. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +summary lines (list of string) and the line it was found on + (integer) +</dd> +</dl><a NAME="Pep257Checker.__ignoreCode" ID="Pep257Checker.__ignoreCode"></a> +<h4>Pep257Checker.__ignoreCode</h4> +<b>__ignoreCode</b>(<i>code</i>) +<p> + Private method to check if the error code should be ignored. +</p><dl> +<dt><i>code</i></dt> +<dd> +message code to check for (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating to ignore the given code (boolean) +</dd> +</dl><a NAME="Pep257Checker.__parseClasses" ID="Pep257Checker.__parseClasses"></a> +<h4>Pep257Checker.__parseClasses</h4> +<b>__parseClasses</b>(<i></i>) +<p> + Private method to extract top-level classes. +</p><dl> +<dt>Returns:</dt> +<dd> +extracted class contexts (list of Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseContexts" ID="Pep257Checker.__parseContexts"></a> +<h4>Pep257Checker.__parseContexts</h4> +<b>__parseContexts</b>(<i>kind</i>) +<p> + Private method to extract a context from the source. +</p><dl> +<dt><i>kind</i></dt> +<dd> +kind of context to extract (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +requested contexts (list of Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseDocstring" ID="Pep257Checker.__parseDocstring"></a> +<h4>Pep257Checker.__parseDocstring</h4> +<b>__parseDocstring</b>(<i>context, what=''</i>) +<p> + Private method to extract a docstring given `def` or `class` source. +</p><dl> +<dt><i>context</i></dt> +<dd> +context data to get the docstring from (Pep257Context) +</dd><dt><i>what</i></dt> +<dd> +string denoting what is being parsed (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +context of extracted docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseFunctions" ID="Pep257Checker.__parseFunctions"></a> +<h4>Pep257Checker.__parseFunctions</h4> +<b>__parseFunctions</b>(<i></i>) +<p> + Private method to extract top-level functions. +</p><dl> +<dt>Returns:</dt> +<dd> +extracted function contexts (list of Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseMethods" ID="Pep257Checker.__parseMethods"></a> +<h4>Pep257Checker.__parseMethods</h4> +<b>__parseMethods</b>(<i></i>) +<p> + Private method to extract methods of all classes. +</p><dl> +<dt>Returns:</dt> +<dd> +extracted method contexts (list of Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseModuleDocstring" ID="Pep257Checker.__parseModuleDocstring"></a> +<h4>Pep257Checker.__parseModuleDocstring</h4> +<b>__parseModuleDocstring</b>(<i>source</i>) +<p> + Private method to extract a docstring given a module source. +</p><dl> +<dt><i>source</i></dt> +<dd> +source to parse (list of string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +context of extracted docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseTopLevel" ID="Pep257Checker.__parseTopLevel"></a> +<h4>Pep257Checker.__parseTopLevel</h4> +<b>__parseTopLevel</b>(<i>keyword</i>) +<p> + Private method to extract top-level functions or classes. +</p><dl> +<dt><i>keyword</i></dt> +<dd> +keyword signaling what to extract (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +extracted function or class contexts (list of Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__readline" ID="Pep257Checker.__readline"></a> +<h4>Pep257Checker.__readline</h4> +<b>__readline</b>(<i></i>) +<p> + Private method to get the next line from the source. +</p><dl> +<dt>Returns:</dt> +<dd> +next line of source (string) +</dd> +</dl><a NAME="Pep257Checker.__resetReadline" ID="Pep257Checker.__resetReadline"></a> +<h4>Pep257Checker.__resetReadline</h4> +<b>__resetReadline</b>(<i></i>) +<p> + Private method to reset the internal readline function. +</p><a NAME="Pep257Checker.__skipIndentedBlock" ID="Pep257Checker.__skipIndentedBlock"></a> +<h4>Pep257Checker.__skipIndentedBlock</h4> +<b>__skipIndentedBlock</b>(<i>tokenGenerator</i>) +<p> + Private method to skip over an indented block of source code. +</p><dl> +<dt><i>tokenGenerator</i></dt> +<dd> +token generator +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +last token of the indented block +</dd> +</dl><a NAME="Pep257Checker.run" ID="Pep257Checker.run"></a> +<h4>Pep257Checker.run</h4> +<b>run</b>(<i></i>) +<p> + Public method to check the given source for violations of doc string + conventions according to PEP-257. +</p><a NAME="Pep257Checker.unpackArgs" ID="Pep257Checker.unpackArgs"></a> +<h4>Pep257Checker.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 /><hr /> +<a NAME="Pep257Context" ID="Pep257Context"></a> +<h2>Pep257Context</h2> +<p> + Class implementing the source context. +</p> +<h3>Derived from</h3> +object +<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="#Pep257Context.__init__">Pep257Context</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#Pep257Context.contextType">contextType</a></td> +<td>Public method to get the context type.</td> +</tr><tr> +<td><a href="#Pep257Context.end">end</a></td> +<td>Public method to get the end line number.</td> +</tr><tr> +<td><a href="#Pep257Context.indent">indent</a></td> +<td>Public method to get the indentation of the first line.</td> +</tr><tr> +<td><a href="#Pep257Context.source">source</a></td> +<td>Public method to get the source.</td> +</tr><tr> +<td><a href="#Pep257Context.ssource">ssource</a></td> +<td>Public method to get the joined source lines.</td> +</tr><tr> +<td><a href="#Pep257Context.start">start</a></td> +<td>Public method to get the start line number.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="Pep257Context.__init__" ID="Pep257Context.__init__"></a> +<h4>Pep257Context (Constructor)</h4> +<b>Pep257Context</b>(<i>source, startLine, contextType</i>) +<p> + Constructor +</p><dl> +<dt><i>source</i></dt> +<dd> +source code of the context (list of string or string) +</dd><dt><i>startLine</i></dt> +<dd> +line number the context starts in the source (integer) +</dd><dt><i>contextType</i></dt> +<dd> +type of the context object (string) +</dd> +</dl><a NAME="Pep257Context.contextType" ID="Pep257Context.contextType"></a> +<h4>Pep257Context.contextType</h4> +<b>contextType</b>(<i></i>) +<p> + Public method to get the context type. +</p><dl> +<dt>Returns:</dt> +<dd> +context type (string) +</dd> +</dl><a NAME="Pep257Context.end" ID="Pep257Context.end"></a> +<h4>Pep257Context.end</h4> +<b>end</b>(<i></i>) +<p> + Public method to get the end line number. +</p><dl> +<dt>Returns:</dt> +<dd> +end line number (integer) +</dd> +</dl><a NAME="Pep257Context.indent" ID="Pep257Context.indent"></a> +<h4>Pep257Context.indent</h4> +<b>indent</b>(<i></i>) +<p> + Public method to get the indentation of the first line. +</p><dl> +<dt>Returns:</dt> +<dd> +indentation string (string) +</dd> +</dl><a NAME="Pep257Context.source" ID="Pep257Context.source"></a> +<h4>Pep257Context.source</h4> +<b>source</b>(<i></i>) +<p> + Public method to get the source. +</p><dl> +<dt>Returns:</dt> +<dd> +source (list of string) +</dd> +</dl><a NAME="Pep257Context.ssource" ID="Pep257Context.ssource"></a> +<h4>Pep257Context.ssource</h4> +<b>ssource</b>(<i></i>) +<p> + Public method to get the joined source lines. +</p><dl> +<dt>Returns:</dt> +<dd> +source (string) +</dd> +</dl><a NAME="Pep257Context.start" ID="Pep257Context.start"></a> +<h4>Pep257Context.start</h4> +<b>start</b>(<i></i>) +<p> + Public method to get the start line number. +</p><dl> +<dt>Returns:</dt> +<dd> +start line number (integer) +</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/Documentation/Source/Pep8Checker.html Tue Oct 15 22:03:54 2013 +0200 @@ -0,0 +1,106 @@ +<!DOCTYPE html> +<html><head> +<title>Pep8Checker</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>Pep8Checker</h1> +<p> +Class implementing the PEP 8 checker for Python2. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#Pep8Report">Pep8Report</a></td> +<td>Class implementing a special report to be used with our dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="Pep8Report" ID="Pep8Report"></a> +<h2>Pep8Report</h2> +<p> + Class implementing a special report to be used with our dialog. +</p> +<h3>Derived from</h3> +pep8 +<h3>Class Attributes</h3> +<table> +<tr><td>docType</td></tr><tr><td>filename</td></tr><tr><td>hang_closing</td></tr><tr><td>ignore</td></tr><tr><td>max_line_length</td></tr><tr><td>repeat</td></tr><tr><td>select</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#Pep8Report.__init__">Pep8Report</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#Pep8Report.error_args">error_args</a></td> +<td>Public method to collect the error messages.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="Pep8Report.__init__" ID="Pep8Report.__init__"></a> +<h4>Pep8Report (Constructor)</h4> +<b>Pep8Report</b>(<i>options</i>) +<p> + Constructor +</p><dl> +<dt><i>options</i></dt> +<dd> +options for the report (optparse.Values) +</dd> +</dl><a NAME="Pep8Report.error_args" ID="Pep8Report.error_args"></a> +<h4>Pep8Report.error_args</h4> +<b>error_args</b>(<i>line_number, offset, code, check, *args</i>) +<p> + Public method to collect the error messages. +</p><dl> +<dt><i>line_number</i></dt> +<dd> +line number of the issue (integer) +</dd><dt><i>offset</i></dt> +<dd> +position within line of the issue (integer) +</dd><dt><i>code</i></dt> +<dd> +message code (string) +</dd><dt><i>check</i></dt> +<dd> +reference to the checker function (function) +</dd><dt><i>args</i></dt> +<dd> +arguments for the message (list) +</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/Documentation/Source/Pep8NamingCheckerPy2.html Tue Oct 15 22:03:54 2013 +0200 @@ -0,0 +1,396 @@ +<!DOCTYPE html> +<html><head> +<title>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>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 'extended' 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).</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).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkFuntionName">__checkFuntionName</a></td> +<td>Private class to check the given node for function name conventions (N802).</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.__checkNameToBeAvoided">__checkNameToBeAvoided</a></td> +<td>Private class to check the given node for a name to be avoided (N831).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkVariablesInFunction">__checkVariablesInFunction</a></td> +<td>Private method to check local variables in functions (N821).</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, options</i>) +<p> + Constructor (according to 'extended' 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><dt><i>options</i></dt> +<dd> +options as parsed by pep8.StyleGuide +</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). +</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). +</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). +</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.__checkNameToBeAvoided" ID="Pep8NamingChecker.__checkNameToBeAvoided"></a> +<h4>Pep8NamingChecker.__checkNameToBeAvoided</h4> +<b>__checkNameToBeAvoided</b>(<i>node, parents</i>) +<p> + Private class to check the given node for a name to be avoided (N831). +</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). +</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
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/Tools.html Tue Oct 15 22:03:54 2013 +0200 @@ -0,0 +1,150 @@ +<!DOCTYPE html> +<html><head> +<title>Tools</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>Tools</h1> +<p> +Module implementing tool functions. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>coding_regexps</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> +<table> +<tr> +<td><a href="#decode">decode</a></td> +<td>Function to decode a text.</td> +</tr><tr> +<td><a href="#extractLineFlags">extractLineFlags</a></td> +<td>Function to extract flags starting and ending with '__' from a line comment.</td> +</tr><tr> +<td><a href="#get_coding">get_coding</a></td> +<td>Function to get the coding of a text.</td> +</tr><tr> +<td><a href="#normalizeCode">normalizeCode</a></td> +<td>Function to normalize the given code.</td> +</tr><tr> +<td><a href="#readEncodedFile">readEncodedFile</a></td> +<td>Function to read a file and decode its contents into proper text.</td> +</tr> +</table> +<hr /><hr /> +<a NAME="decode" ID="decode"></a> +<h2>decode</h2> +<b>decode</b>(<i>text</i>) +<p> + Function to decode a text. +</p><dl> +<dt><i>text</i></dt> +<dd> +text to decode (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +decoded text and encoding +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="extractLineFlags" ID="extractLineFlags"></a> +<h2>extractLineFlags</h2> +<b>extractLineFlags</b>(<i>line, startComment="</i>) +<p> + Function to extract flags starting and ending with '__' from a line comment. +</p><dl> +<dt><i>line</i></dt> +<dd> +line to extract flags from (string) +</dd><dt><i>startComment=</i></dt> +<dd> +string identifying the start of the comment (string) +</dd><dt><i>endComment=</i></dt> +<dd> +string identifying the end of a comment (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +list containing the extracted flags (list of strings) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="get_coding" ID="get_coding"></a> +<h2>get_coding</h2> +<b>get_coding</b>(<i>text</i>) +<p> + Function to get the coding of a text. +</p><dl> +<dt><i>text</i></dt> +<dd> +text to inspect (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +coding string +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="normalizeCode" ID="normalizeCode"></a> +<h2>normalizeCode</h2> +<b>normalizeCode</b>(<i>codestring</i>) +<p> + Function to normalize the given code. +</p><dl> +<dt><i>codestring</i></dt> +<dd> +code to be normalized (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +normalized code (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="readEncodedFile" ID="readEncodedFile"></a> +<h2>readEncodedFile</h2> +<b>readEncodedFile</b>(<i>filename</i>) +<p> + Function to read a file and decode its contents into proper text. +</p><dl> +<dt><i>filename</i></dt> +<dd> +name of the file to read (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple of decoded text and encoding (string, string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- a/Documentation/Source/eric5.PluginManager.PluginManager.html Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Source/eric5.PluginManager.PluginManager.html Tue Oct 15 22:03:54 2013 +0200 @@ -670,16 +670,13 @@ </dd> </dl><a NAME="PluginManager.unloadPlugin" ID="PluginManager.unloadPlugin"></a> <h4>PluginManager.unloadPlugin</h4> -<b>unloadPlugin</b>(<i>name, directory</i>) +<b>unloadPlugin</b>(<i>name</i>) <p> Public method to unload a plugin module. </p><dl> <dt><i>name</i></dt> <dd> name of the module to be unloaded (string) -</dd><dt><i>directory</i></dt> -<dd> -name of the plugin directory (string) </dd> </dl><dl> <dt>Returns:</dt>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html Tue Oct 15 22:03:54 2013 +0200 @@ -0,0 +1,918 @@ +<!DOCTYPE html> +<html><head> +<title>eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker</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.Pep257Checker</h1> +<p> +Module implementing a checker for PEP-257 documentation string conventions. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#Pep257Checker">Pep257Checker</a></td> +<td>Class implementing a checker for PEP-257 documentation string conventions.</td> +</tr><tr> +<td><a href="#Pep257Context">Pep257Context</a></td> +<td>Class implementing the source context.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="Pep257Checker" ID="Pep257Checker"></a> +<h2>Pep257Checker</h2> +<p> + Class implementing a checker for PEP-257 documentation string conventions. +</p> +<h3>Derived from</h3> +object +<h3>Class Attributes</h3> +<table> +<tr><td>Codes</td></tr><tr><td>Messages</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr> +<td><a href="#Pep257Checker.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="#Pep257Checker.__init__">Pep257Checker</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkBackslashes">__checkBackslashes</a></td> +<td>Private method to check, that all docstrings containing backslashes are surrounded by raw triple double quotes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkBlankAfterLastParagraph">__checkBlankAfterLastParagraph</a></td> +<td>Private method to check, that the last paragraph of docstrings is followed by a blank line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkBlankAfterSummary">__checkBlankAfterSummary</a></td> +<td>Private method to check, that docstring summaries are followed by a blank line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkBlankBeforeAndAfterClass">__checkBlankBeforeAndAfterClass</a></td> +<td>Private method to check, that class docstrings have one blank line around them.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkClassDocstring">__checkClassDocstring</a></td> +<td>Private method to check, that all public functions and methods have a docstring.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEndsWithPeriod">__checkEndsWithPeriod</a></td> +<td>Private method to check, that docstring summaries end with a period.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricBlankAfterSummary">__checkEricBlankAfterSummary</a></td> +<td>Private method to check, that docstring summaries are followed by a blank line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td> +<td>Private method to check, that docstring summaries end with a period.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricException">__checkEricException</a></td> +<td>Private method to check, that docstrings contain an @exception line if they raise an exception and don't otherwise.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricFunctionArguments">__checkEricFunctionArguments</a></td> +<td>Private method to check, that docstrings contain an @param and/or @keyparam line for each argument.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricNBlankAfterLastParagraph">__checkEricNBlankAfterLastParagraph</a></td> +<td>Private method to check, that the last paragraph of docstrings is not followed by a blank line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction">__checkEricNoBlankBeforeAndAfterClassOrFunction</a></td> +<td>Private method to check, that class and function/method docstrings have no blank line around them.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricQuotesOnSeparateLines">__checkEricQuotesOnSeparateLines</a></td> +<td>Private method to check, that leading and trailing quotes are on a line by themselves.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricReturn">__checkEricReturn</a></td> +<td>Private method to check, that docstrings contain an @return line if they return anything and don't otherwise.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkFunctionDocstring">__checkFunctionDocstring</a></td> +<td>Private method to check, that all public functions and methods have a docstring.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkImperativeMood">__checkImperativeMood</a></td> +<td>Private method to check, that docstring summaries are in imperative mood.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkIndent">__checkIndent</a></td> +<td>Private method to check, that docstrings are properly indented.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkModulesDocstrings">__checkModulesDocstrings</a></td> +<td>Private method to check, if the module has a docstring.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkNoBlankLineBefore">__checkNoBlankLineBefore</a></td> +<td>Private method to check, that function/method docstrings are not preceded by a blank line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkNoSignature">__checkNoSignature</a></td> +<td>Private method to check, that docstring summaries don't repeat the function's signature.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkOneLiner">__checkOneLiner</a></td> +<td>Private method to check, that one-liner docstrings fit on one line with quotes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkReturnType">__checkReturnType</a></td> +<td>Private method to check, that docstrings mention the return value type.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td> +<td>Private method to check, that all docstrings are surrounded by triple double quotes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkUnicode">__checkUnicode</a></td> +<td>Private method to check, that all docstrings containing unicode characters are surrounded by unicode triple double quotes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__error">__error</a></td> +<td>Private method to record an issue.</td> +</tr><tr> +<td><a href="#Pep257Checker.__getArgNames">__getArgNames</a></td> +<td></td> +</tr><tr> +<td><a href="#Pep257Checker.__getSummaryLine">__getSummaryLine</a></td> +<td>Private method to extract the summary line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__getSummaryLines">__getSummaryLines</a></td> +<td>Private method to extract the summary lines.</td> +</tr><tr> +<td><a href="#Pep257Checker.__ignoreCode">__ignoreCode</a></td> +<td>Private method to check if the error code should be ignored.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseClasses">__parseClasses</a></td> +<td>Private method to extract top-level classes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseContexts">__parseContexts</a></td> +<td>Private method to extract a context from the source.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseDocstring">__parseDocstring</a></td> +<td>Private method to extract a docstring given `def` or `class` source.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseFunctions">__parseFunctions</a></td> +<td>Private method to extract top-level functions.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseMethods">__parseMethods</a></td> +<td>Private method to extract methods of all classes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseModuleDocstring">__parseModuleDocstring</a></td> +<td>Private method to extract a docstring given a module source.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseTopLevel">__parseTopLevel</a></td> +<td>Private method to extract top-level functions or classes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__readline">__readline</a></td> +<td>Private method to get the next line from the source.</td> +</tr><tr> +<td><a href="#Pep257Checker.__resetReadline">__resetReadline</a></td> +<td>Private method to reset the internal readline function.</td> +</tr><tr> +<td><a href="#Pep257Checker.__skipIndentedBlock">__skipIndentedBlock</a></td> +<td>Private method to skip over an indented block of source code.</td> +</tr><tr> +<td><a href="#Pep257Checker.run">run</a></td> +<td>Public method to check the given source for violations of doc string conventions according to PEP-257.</td> +</tr><tr> +<td><a href="#Pep257Checker.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="Pep257Checker.getMessage" ID="Pep257Checker.getMessage"></a> +<h4>Pep257Checker.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="Pep257Checker.__init__" ID="Pep257Checker.__init__"></a> +<h4>Pep257Checker (Constructor)</h4> +<b>Pep257Checker</b>(<i>source, filename, select, ignore, expected, repeat, maxLineLength=79, docType="pep257"</i>) +<p> + Constructor +</p><dl> +<dt><i>source</i></dt> +<dd> +source code to be checked (list of string) +</dd><dt><i>filename</i></dt> +<dd> +name of the source file (string) +</dd><dt><i>select</i></dt> +<dd> +list of selected codes (list of string) +</dd><dt><i>ignore</i></dt> +<dd> +list of codes to be ignored (list of string) +</dd><dt><i>expected</i></dt> +<dd> +list of expected codes (list of string) +</dd><dt><i>repeat</i></dt> +<dd> +flag indicating to report each occurrence of a code + (boolean) +</dd><dt><i>maxLineLength=</i></dt> +<dd> +allowed line length (integer) +</dd><dt><i>docType=</i></dt> +<dd> +type of the documentation strings + (string, one of 'eric' or 'pep257') +</dd> +</dl><a NAME="Pep257Checker.__checkBackslashes" ID="Pep257Checker.__checkBackslashes"></a> +<h4>Pep257Checker.__checkBackslashes</h4> +<b>__checkBackslashes</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all docstrings containing + backslashes are surrounded by raw triple double quotes. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkBlankAfterLastParagraph" ID="Pep257Checker.__checkBlankAfterLastParagraph"></a> +<h4>Pep257Checker.__checkBlankAfterLastParagraph</h4> +<b>__checkBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that the last paragraph of docstrings is + followed by a blank line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkBlankAfterSummary" ID="Pep257Checker.__checkBlankAfterSummary"></a> +<h4>Pep257Checker.__checkBlankAfterSummary</h4> +<b>__checkBlankAfterSummary</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries are followed + by a blank line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkBlankBeforeAndAfterClass" ID="Pep257Checker.__checkBlankBeforeAndAfterClass"></a> +<h4>Pep257Checker.__checkBlankBeforeAndAfterClass</h4> +<b>__checkBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that class docstrings have one + blank line around them. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkClassDocstring" ID="Pep257Checker.__checkClassDocstring"></a> +<h4>Pep257Checker.__checkClassDocstring</h4> +<b>__checkClassDocstring</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all public functions and methods + have a docstring. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEndsWithPeriod" ID="Pep257Checker.__checkEndsWithPeriod"></a> +<h4>Pep257Checker.__checkEndsWithPeriod</h4> +<b>__checkEndsWithPeriod</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries end with a period. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricBlankAfterSummary" ID="Pep257Checker.__checkEricBlankAfterSummary"></a> +<h4>Pep257Checker.__checkEricBlankAfterSummary</h4> +<b>__checkEricBlankAfterSummary</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries are followed + by a blank line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricEndsWithPeriod" ID="Pep257Checker.__checkEricEndsWithPeriod"></a> +<h4>Pep257Checker.__checkEricEndsWithPeriod</h4> +<b>__checkEricEndsWithPeriod</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries end with a period. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricException" ID="Pep257Checker.__checkEricException"></a> +<h4>Pep257Checker.__checkEricException</h4> +<b>__checkEricException</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstrings contain an @exception line + if they raise an exception and don't otherwise. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricFunctionArguments" ID="Pep257Checker.__checkEricFunctionArguments"></a> +<h4>Pep257Checker.__checkEricFunctionArguments</h4> +<b>__checkEricFunctionArguments</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstrings contain an @param and/or + @keyparam line for each argument. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricNBlankAfterLastParagraph" ID="Pep257Checker.__checkEricNBlankAfterLastParagraph"></a> +<h4>Pep257Checker.__checkEricNBlankAfterLastParagraph</h4> +<b>__checkEricNBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that the last paragraph of docstrings is + not followed by a blank line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a> +<h4>Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction</h4> +<b>__checkEricNoBlankBeforeAndAfterClassOrFunction</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that class and function/method docstrings + have no blank line around them. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricQuotesOnSeparateLines" ID="Pep257Checker.__checkEricQuotesOnSeparateLines"></a> +<h4>Pep257Checker.__checkEricQuotesOnSeparateLines</h4> +<b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that leading and trailing quotes are on + a line by themselves. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricReturn" ID="Pep257Checker.__checkEricReturn"></a> +<h4>Pep257Checker.__checkEricReturn</h4> +<b>__checkEricReturn</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstrings contain an @return line + if they return anything and don't otherwise. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkFunctionDocstring" ID="Pep257Checker.__checkFunctionDocstring"></a> +<h4>Pep257Checker.__checkFunctionDocstring</h4> +<b>__checkFunctionDocstring</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all public functions and methods + have a docstring. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkImperativeMood" ID="Pep257Checker.__checkImperativeMood"></a> +<h4>Pep257Checker.__checkImperativeMood</h4> +<b>__checkImperativeMood</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries are in + imperative mood. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkIndent" ID="Pep257Checker.__checkIndent"></a> +<h4>Pep257Checker.__checkIndent</h4> +<b>__checkIndent</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstrings are properly indented. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkModulesDocstrings" ID="Pep257Checker.__checkModulesDocstrings"></a> +<h4>Pep257Checker.__checkModulesDocstrings</h4> +<b>__checkModulesDocstrings</b>(<i>docstringContext, context</i>) +<p> + Private method to check, if the module has a docstring. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkNoBlankLineBefore" ID="Pep257Checker.__checkNoBlankLineBefore"></a> +<h4>Pep257Checker.__checkNoBlankLineBefore</h4> +<b>__checkNoBlankLineBefore</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that function/method docstrings are not + preceded by a blank line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkNoSignature" ID="Pep257Checker.__checkNoSignature"></a> +<h4>Pep257Checker.__checkNoSignature</h4> +<b>__checkNoSignature</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries don't repeat + the function's signature. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkOneLiner" ID="Pep257Checker.__checkOneLiner"></a> +<h4>Pep257Checker.__checkOneLiner</h4> +<b>__checkOneLiner</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that one-liner docstrings fit on + one line with quotes. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkReturnType" ID="Pep257Checker.__checkReturnType"></a> +<h4>Pep257Checker.__checkReturnType</h4> +<b>__checkReturnType</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstrings mention the return value type. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkTripleDoubleQuotes" ID="Pep257Checker.__checkTripleDoubleQuotes"></a> +<h4>Pep257Checker.__checkTripleDoubleQuotes</h4> +<b>__checkTripleDoubleQuotes</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all docstrings are surrounded + by triple double quotes. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkUnicode" ID="Pep257Checker.__checkUnicode"></a> +<h4>Pep257Checker.__checkUnicode</h4> +<b>__checkUnicode</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all docstrings containing unicode + characters are surrounded by unicode triple double quotes. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__error" ID="Pep257Checker.__error"></a> +<h4>Pep257Checker.__error</h4> +<b>__error</b>(<i>lineNumber, offset, code, *args</i>) +<p> + Private method to record an issue. +</p><dl> +<dt><i>lineNumber</i></dt> +<dd> +line number of the issue (integer) +</dd><dt><i>offset</i></dt> +<dd> +position within line of the issue (integer) +</dd><dt><i>code</i></dt> +<dd> +message code (string) +</dd><dt><i>args</i></dt> +<dd> +arguments for the message (list) +</dd> +</dl><a NAME="Pep257Checker.__getArgNames" ID="Pep257Checker.__getArgNames"></a> +<h4>Pep257Checker.__getArgNames</h4> +<b>__getArgNames</b>(<i>node</i>) +<a NAME="Pep257Checker.__getSummaryLine" ID="Pep257Checker.__getSummaryLine"></a> +<h4>Pep257Checker.__getSummaryLine</h4> +<b>__getSummaryLine</b>(<i>docstringContext</i>) +<p> + Private method to extract the summary line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +summary line (string) and the line it was found on (integer) +</dd> +</dl><a NAME="Pep257Checker.__getSummaryLines" ID="Pep257Checker.__getSummaryLines"></a> +<h4>Pep257Checker.__getSummaryLines</h4> +<b>__getSummaryLines</b>(<i>docstringContext</i>) +<p> + Private method to extract the summary lines. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +summary lines (list of string) and the line it was found on + (integer) +</dd> +</dl><a NAME="Pep257Checker.__ignoreCode" ID="Pep257Checker.__ignoreCode"></a> +<h4>Pep257Checker.__ignoreCode</h4> +<b>__ignoreCode</b>(<i>code</i>) +<p> + Private method to check if the error code should be ignored. +</p><dl> +<dt><i>code</i></dt> +<dd> +message code to check for (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating to ignore the given code (boolean) +</dd> +</dl><a NAME="Pep257Checker.__parseClasses" ID="Pep257Checker.__parseClasses"></a> +<h4>Pep257Checker.__parseClasses</h4> +<b>__parseClasses</b>(<i></i>) +<p> + Private method to extract top-level classes. +</p><dl> +<dt>Returns:</dt> +<dd> +extracted class contexts (list of Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseContexts" ID="Pep257Checker.__parseContexts"></a> +<h4>Pep257Checker.__parseContexts</h4> +<b>__parseContexts</b>(<i>kind</i>) +<p> + Private method to extract a context from the source. +</p><dl> +<dt><i>kind</i></dt> +<dd> +kind of context to extract (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +requested contexts (list of Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseDocstring" ID="Pep257Checker.__parseDocstring"></a> +<h4>Pep257Checker.__parseDocstring</h4> +<b>__parseDocstring</b>(<i>context, what=''</i>) +<p> + Private method to extract a docstring given `def` or `class` source. +</p><dl> +<dt><i>context</i></dt> +<dd> +context data to get the docstring from (Pep257Context) +</dd><dt><i>what</i></dt> +<dd> +string denoting what is being parsed (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +context of extracted docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseFunctions" ID="Pep257Checker.__parseFunctions"></a> +<h4>Pep257Checker.__parseFunctions</h4> +<b>__parseFunctions</b>(<i></i>) +<p> + Private method to extract top-level functions. +</p><dl> +<dt>Returns:</dt> +<dd> +extracted function contexts (list of Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseMethods" ID="Pep257Checker.__parseMethods"></a> +<h4>Pep257Checker.__parseMethods</h4> +<b>__parseMethods</b>(<i></i>) +<p> + Private method to extract methods of all classes. +</p><dl> +<dt>Returns:</dt> +<dd> +extracted method contexts (list of Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseModuleDocstring" ID="Pep257Checker.__parseModuleDocstring"></a> +<h4>Pep257Checker.__parseModuleDocstring</h4> +<b>__parseModuleDocstring</b>(<i>source</i>) +<p> + Private method to extract a docstring given a module source. +</p><dl> +<dt><i>source</i></dt> +<dd> +source to parse (list of string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +context of extracted docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseTopLevel" ID="Pep257Checker.__parseTopLevel"></a> +<h4>Pep257Checker.__parseTopLevel</h4> +<b>__parseTopLevel</b>(<i>keyword</i>) +<p> + Private method to extract top-level functions or classes. +</p><dl> +<dt><i>keyword</i></dt> +<dd> +keyword signaling what to extract (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +extracted function or class contexts (list of Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__readline" ID="Pep257Checker.__readline"></a> +<h4>Pep257Checker.__readline</h4> +<b>__readline</b>(<i></i>) +<p> + Private method to get the next line from the source. +</p><dl> +<dt>Returns:</dt> +<dd> +next line of source (string) +</dd> +</dl><a NAME="Pep257Checker.__resetReadline" ID="Pep257Checker.__resetReadline"></a> +<h4>Pep257Checker.__resetReadline</h4> +<b>__resetReadline</b>(<i></i>) +<p> + Private method to reset the internal readline function. +</p><a NAME="Pep257Checker.__skipIndentedBlock" ID="Pep257Checker.__skipIndentedBlock"></a> +<h4>Pep257Checker.__skipIndentedBlock</h4> +<b>__skipIndentedBlock</b>(<i>tokenGenerator</i>) +<p> + Private method to skip over an indented block of source code. +</p><dl> +<dt><i>tokenGenerator</i></dt> +<dd> +token generator +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +last token of the indented block +</dd> +</dl><a NAME="Pep257Checker.run" ID="Pep257Checker.run"></a> +<h4>Pep257Checker.run</h4> +<b>run</b>(<i></i>) +<p> + Public method to check the given source for violations of doc string + conventions according to PEP-257. +</p><a NAME="Pep257Checker.unpackArgs" ID="Pep257Checker.unpackArgs"></a> +<h4>Pep257Checker.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 /><hr /> +<a NAME="Pep257Context" ID="Pep257Context"></a> +<h2>Pep257Context</h2> +<p> + Class implementing the source context. +</p> +<h3>Derived from</h3> +object +<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="#Pep257Context.__init__">Pep257Context</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#Pep257Context.contextType">contextType</a></td> +<td>Public method to get the context type.</td> +</tr><tr> +<td><a href="#Pep257Context.end">end</a></td> +<td>Public method to get the end line number.</td> +</tr><tr> +<td><a href="#Pep257Context.indent">indent</a></td> +<td>Public method to get the indentation of the first line.</td> +</tr><tr> +<td><a href="#Pep257Context.source">source</a></td> +<td>Public method to get the source.</td> +</tr><tr> +<td><a href="#Pep257Context.ssource">ssource</a></td> +<td>Public method to get the joined source lines.</td> +</tr><tr> +<td><a href="#Pep257Context.start">start</a></td> +<td>Public method to get the start line number.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="Pep257Context.__init__" ID="Pep257Context.__init__"></a> +<h4>Pep257Context (Constructor)</h4> +<b>Pep257Context</b>(<i>source, startLine, contextType</i>) +<p> + Constructor +</p><dl> +<dt><i>source</i></dt> +<dd> +source code of the context (list of string or string) +</dd><dt><i>startLine</i></dt> +<dd> +line number the context starts in the source (integer) +</dd><dt><i>contextType</i></dt> +<dd> +type of the context object (string) +</dd> +</dl><a NAME="Pep257Context.contextType" ID="Pep257Context.contextType"></a> +<h4>Pep257Context.contextType</h4> +<b>contextType</b>(<i></i>) +<p> + Public method to get the context type. +</p><dl> +<dt>Returns:</dt> +<dd> +context type (string) +</dd> +</dl><a NAME="Pep257Context.end" ID="Pep257Context.end"></a> +<h4>Pep257Context.end</h4> +<b>end</b>(<i></i>) +<p> + Public method to get the end line number. +</p><dl> +<dt>Returns:</dt> +<dd> +end line number (integer) +</dd> +</dl><a NAME="Pep257Context.indent" ID="Pep257Context.indent"></a> +<h4>Pep257Context.indent</h4> +<b>indent</b>(<i></i>) +<p> + Public method to get the indentation of the first line. +</p><dl> +<dt>Returns:</dt> +<dd> +indentation string (string) +</dd> +</dl><a NAME="Pep257Context.source" ID="Pep257Context.source"></a> +<h4>Pep257Context.source</h4> +<b>source</b>(<i></i>) +<p> + Public method to get the source. +</p><dl> +<dt>Returns:</dt> +<dd> +source (list of string) +</dd> +</dl><a NAME="Pep257Context.ssource" ID="Pep257Context.ssource"></a> +<h4>Pep257Context.ssource</h4> +<b>ssource</b>(<i></i>) +<p> + Public method to get the joined source lines. +</p><dl> +<dt>Returns:</dt> +<dd> +source (string) +</dd> +</dl><a NAME="Pep257Context.start" ID="Pep257Context.start"></a> +<h4>Pep257Context.start</h4> +<b>start</b>(<i></i>) +<p> + Public method to get the start line number. +</p><dl> +<dt>Returns:</dt> +<dd> +start line number (integer) +</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.CheckerPlugins.Pep8.Pep8Checker.html Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker.html Tue Oct 15 22:03:54 2013 +0200 @@ -67,7 +67,7 @@ </table> <a NAME="Pep8Py2Checker.__init__" ID="Pep8Py2Checker.__init__"></a> <h4>Pep8Py2Checker (Constructor)</h4> -<b>Pep8Py2Checker</b>(<i>filename, lines, repeat=False, select="", ignore="", max_line_length=79, hang_closing=False</i>) +<b>Pep8Py2Checker</b>(<i>filename, lines, repeat=False, select="", ignore="", max_line_length=79, hang_closing=False, docType="pep257"</i>) <p> Constructor </p><dl> @@ -93,7 +93,12 @@ 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><dt><i>docType=</i></dt> +<dd> +type of the documentation strings + (string, one of 'eric' or 'pep257') </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Dialog.html Tue Oct 15 22:03:54 2013 +0200 @@ -118,7 +118,7 @@ <td>Private slot to select the issue codes not to be fixed via a selection dialog.</td> </tr><tr> <td><a href="#Pep8Dialog.on_resetDefaultButton_clicked">on_resetDefaultButton_clicked</a></td> -<td>Slot documentation goes here.</td> +<td>Private slot to reset the configuration values to their default values.</td> </tr><tr> <td><a href="#Pep8Dialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td> <td>Private slot to handle the activation of an item.</td> @@ -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> @@ -327,7 +339,7 @@ <h4>Pep8Dialog.on_resetDefaultButton_clicked</h4> <b>on_resetDefaultButton_clicked</b>(<i></i>) <p> - Slot documentation goes here. + Private slot to reset the configuration values to their default values. </p><a NAME="Pep8Dialog.on_resultList_itemActivated" ID="Pep8Dialog.on_resultList_itemActivated"></a> <h4>Pep8Dialog.on_resultList_itemActivated</h4> <b>on_resultList_itemActivated</b>(<i>item, column</i>) @@ -408,7 +420,7 @@ Class implementing a special report to be used with our dialog. </p> <h3>Derived from</h3> -pep8.BaseReport +pep8 <h3>Class Attributes</h3> <table> <tr><td>None</td></tr>
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html Tue Oct 15 22:03:54 2013 +0200 @@ -21,7 +21,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer</h1> <p> -Module implementing a class to fix certain PEP 8 issues. +Module implementing a class to fix certain code style issues. </p> <h3>Global Attributes</h3> <table> @@ -31,7 +31,7 @@ <table> <tr> <td><a href="#Pep8Fixer">Pep8Fixer</a></td> -<td>Class implementing a fixer for certain PEP 8 issues.</td> +<td>Class implementing a fixer for certain code style issues.</td> </tr><tr> <td><a href="#Pep8IndentationWrapper">Pep8IndentationWrapper</a></td> <td>Class used by fixers dealing with indentation.</td> @@ -51,7 +51,7 @@ <a NAME="Pep8Fixer" ID="Pep8Fixer"></a> <h2>Pep8Fixer</h2> <p> - Class implementing a fixer for certain PEP 8 issues. + Class implementing a fixer for certain code style issues. </p> <h3>Derived from</h3> QObject @@ -72,17 +72,53 @@ <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> +<td><a href="#Pep8Fixer.__fixD111">__fixD111</a></td> +<td>Private method to fix docstring enclosed in wrong quotes (D111).</td> +</tr><tr> +<td><a href="#Pep8Fixer.__fixD112">__fixD112</a></td> +<td>Private method to fix docstring 'r' or 'u' in leading quotes (D112, D113).</td> +</tr><tr> +<td><a href="#Pep8Fixer.__fixD121">__fixD121</a></td> +<td>Private method to fix a single line docstring on multiple lines (D121).</td> +</tr><tr> +<td><a href="#Pep8Fixer.__fixD131">__fixD131</a></td> +<td>Private method to fix a docstring summary not ending with a period (D131).</td> +</tr><tr> +<td><a href="#Pep8Fixer.__fixD141">__fixD141</a></td> +<td>Private method to fix a function/method docstring preceded by a blank line (D141).</td> +</tr><tr> +<td><a href="#Pep8Fixer.__fixD142">__fixD142</a></td> +<td>Private method to fix a class docstring not preceded by a blank line (D142).</td> +</tr><tr> +<td><a href="#Pep8Fixer.__fixD143">__fixD143</a></td> +<td>Private method to fix a class docstring not followed by a blank line (D143).</td> +</tr><tr> +<td><a href="#Pep8Fixer.__fixD144">__fixD144</a></td> +<td>Private method to fix a docstring summary not followed by a blank line (D144).</td> +</tr><tr> +<td><a href="#Pep8Fixer.__fixD145">__fixD145</a></td> +<td>Private method to fix the last paragraph of a multi-line docstring not followed by a blank line (D143).</td> +</tr><tr> +<td><a href="#Pep8Fixer.__fixD221">__fixD221</a></td> +<td>Private method to fix leading and trailing quotes of docstring not on separate lines (D221, D222).</td> +</tr><tr> +<td><a href="#Pep8Fixer.__fixD242">__fixD242</a></td> +<td>Private method to fix a class or function/method docstring preceded by a blank line (D242, D244).</td> +</tr><tr> +<td><a href="#Pep8Fixer.__fixD243">__fixD243</a></td> +<td>Private method to fix a class or function/method docstring followed by a blank line (D243, D245).</td> +</tr><tr> +<td><a href="#Pep8Fixer.__fixD247">__fixD247</a></td> +<td>Private method to fix a last paragraph of a docstring followed by a blank line (D247).</td> +</tr><tr> <td><a href="#Pep8Fixer.__fixE101">__fixE101</a></td> <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 +172,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 +180,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 +207,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 +222,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 +285,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> @@ -254,6 +297,356 @@ tuple containing two lists of integer with start and end tuples of lines </dd> +</dl><a NAME="Pep8Fixer.__fixD111" ID="Pep8Fixer.__fixD111"></a> +<h4>Pep8Fixer.__fixD111</h4> +<b>__fixD111</b>(<i>code, line, pos</i>) +<p> + Private method to fix docstring enclosed in wrong quotes (D111). +</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> +</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.__fixD112" ID="Pep8Fixer.__fixD112"></a> +<h4>Pep8Fixer.__fixD112</h4> +<b>__fixD112</b>(<i>code, line, pos</i>) +<p> + Private method to fix docstring 'r' or 'u' in leading quotes + (D112, D113). +</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> +</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.__fixD121" ID="Pep8Fixer.__fixD121"></a> +<h4>Pep8Fixer.__fixD121</h4> +<b>__fixD121</b>(<i>code, line, pos, apply=False</i>) +<p> + Private method to fix a single line docstring on multiple lines (D121). +</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.__fixD131" ID="Pep8Fixer.__fixD131"></a> +<h4>Pep8Fixer.__fixD131</h4> +<b>__fixD131</b>(<i>code, line, pos</i>) +<p> + Private method to fix a docstring summary not ending with a + period (D131). +</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> +</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.__fixD141" ID="Pep8Fixer.__fixD141"></a> +<h4>Pep8Fixer.__fixD141</h4> +<b>__fixD141</b>(<i>code, line, pos, apply=False</i>) +<p> + Private method to fix a function/method docstring preceded by a + blank line (D141). +</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.__fixD142" ID="Pep8Fixer.__fixD142"></a> +<h4>Pep8Fixer.__fixD142</h4> +<b>__fixD142</b>(<i>code, line, pos, apply=False</i>) +<p> + Private method to fix a class docstring not preceded by a + blank line (D142). +</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.__fixD143" ID="Pep8Fixer.__fixD143"></a> +<h4>Pep8Fixer.__fixD143</h4> +<b>__fixD143</b>(<i>code, line, pos, apply=False</i>) +<p> + Private method to fix a class docstring not followed by a + blank line (D143). +</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.__fixD144" ID="Pep8Fixer.__fixD144"></a> +<h4>Pep8Fixer.__fixD144</h4> +<b>__fixD144</b>(<i>code, line, pos, apply=False</i>) +<p> + Private method to fix a docstring summary not followed by a + blank line (D144). +</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.__fixD145" ID="Pep8Fixer.__fixD145"></a> +<h4>Pep8Fixer.__fixD145</h4> +<b>__fixD145</b>(<i>code, line, pos, apply=False</i>) +<p> + Private method to fix the last paragraph of a multi-line docstring + not followed by a blank line (D143). +</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.__fixD221" ID="Pep8Fixer.__fixD221"></a> +<h4>Pep8Fixer.__fixD221</h4> +<b>__fixD221</b>(<i>code, line, pos, apply=False</i>) +<p> + Private method to fix leading and trailing quotes of docstring + not on separate lines (D221, D222). +</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.__fixD242" ID="Pep8Fixer.__fixD242"></a> +<h4>Pep8Fixer.__fixD242</h4> +<b>__fixD242</b>(<i>code, line, pos, apply=False</i>) +<p> + Private method to fix a class or function/method docstring preceded + by a blank line (D242, D244). +</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.__fixD243" ID="Pep8Fixer.__fixD243"></a> +<h4>Pep8Fixer.__fixD243</h4> +<b>__fixD243</b>(<i>code, line, pos, apply=False</i>) +<p> + Private method to fix a class or function/method docstring followed + by a blank line (D243, D245). +</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.__fixD247" ID="Pep8Fixer.__fixD247"></a> +<h4>Pep8Fixer.__fixD247</h4> +<b>__fixD247</b>(<i>code, line, pos, apply=False</i>) +<p> + Private method to fix a last paragraph of a docstring followed + by a blank line (D247). +</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.__fixE101" ID="Pep8Fixer.__fixE101"></a> <h4>Pep8Fixer.__fixE101</h4> <b>__fixE101</b>(<i>code, line, pos</i>) @@ -274,15 +667,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 +695,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 +723,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 +751,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 +779,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 +807,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 +834,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 +858,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 +883,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 +906,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 +930,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 +954,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 +981,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 +1008,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 +1035,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 +1063,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 +1090,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 +1117,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 +1140,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 +1167,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 +1195,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 +1218,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 +1317,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 +1340,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 +1363,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 +1386,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 +1421,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 +1491,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 +1515,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 Tue Oct 15 22:03:54 2013 +0200 @@ -0,0 +1,400 @@ +<!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 'extended' 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).</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).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkFuntionName">__checkFuntionName</a></td> +<td>Private class to check the given node for function name conventions (N802).</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.__checkNameToBeAvoided">__checkNameToBeAvoided</a></td> +<td>Private class to check the given node for a name to be avoided (N831).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkVariablesInFunction">__checkVariablesInFunction</a></td> +<td>Private method to check local variables in functions (N821).</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, options</i>) +<p> + Constructor (according to 'extended' 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><dt><i>options</i></dt> +<dd> +options as parsed by pep8.StyleGuide +</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). +</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). +</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). +</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.__checkNameToBeAvoided" ID="Pep8NamingChecker.__checkNameToBeAvoided"></a> +<h4>Pep8NamingChecker.__checkNameToBeAvoided</h4> +<b>__checkNameToBeAvoided</b>(<i>node, parents</i>) +<p> + Private class to check the given node for a name to be avoided (N831). +</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). +</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.CheckerPlugins.Pep8.Pep8StatisticsDialog.html Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8StatisticsDialog.html Tue Oct 15 22:03:54 2013 +0200 @@ -21,7 +21,8 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.Plugins.CheckerPlugins.Pep8.Pep8StatisticsDialog</h1> <p> -Module implementing a dialog showing statistical data for the last PEP 8 run. +Module implementing a dialog showing statistical data for the last code +style checker run. </p> <h3>Global Attributes</h3> <table> @@ -31,7 +32,7 @@ <table> <tr> <td><a href="#Pep8StatisticsDialog">Pep8StatisticsDialog</a></td> -<td>Class implementing a dialog showing statistical data for the last PEP 8 run.</td> +<td>Class implementing a dialog showing statistical data for the last code style checker run.</td> </tr> </table> <h3>Functions</h3> @@ -43,7 +44,7 @@ <h2>Pep8StatisticsDialog</h2> <p> Class implementing a dialog showing statistical data for the last - PEP 8 run. + code style checker run. </p> <h3>Derived from</h3> QDialog, Ui_Pep8StatisticsDialog
--- a/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.pep8.html Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.pep8.html Tue Oct 15 22:03:54 2013 +0200 @@ -57,7 +57,7 @@ <td>Parse options and run checks on Python source.</td> </tr><tr> <td><a href="#blank_lines">blank_lines</a></td> -<td></td> +<td>Separate top-level function and class definitions with two blank lines.</td> </tr><tr> <td><a href="#comparison_to_singleton">comparison_to_singleton</a></td> <td>Comparisons to singletons like None should always be done with "is" or "is not", never the equality operators.</td> @@ -66,16 +66,16 @@ <td>Object type comparisons should always use isinstance() instead of comparing types directly.</td> </tr><tr> <td><a href="#compound_statements">compound_statements</a></td> -<td></td> +<td>Compound statements (multiple statements on the same line) are generally discouraged.</td> </tr><tr> <td><a href="#continued_indentation">continued_indentation</a></td> -<td></td> +<td>Continuation lines should align wrapped elements either vertically using Python's implicit line joining inside parentheses, brackets and braces, or using a hanging indent.</td> </tr><tr> <td><a href="#expand_indent">expand_indent</a></td> -<td></td> +<td>Return the amount of indentation.</td> </tr><tr> <td><a href="#explicit_line_join">explicit_line_join</a></td> -<td></td> +<td>Avoid explicit line join between brackets.</td> </tr><tr> <td><a href="#extraneous_whitespace">extraneous_whitespace</a></td> <td>Avoid extraneous whitespace in the following situations:</td> @@ -90,10 +90,10 @@ <td></td> </tr><tr> <td><a href="#imports_on_separate_lines">imports_on_separate_lines</a></td> -<td></td> +<td>Imports should usually be on separate lines.</td> </tr><tr> <td><a href="#indentation">indentation</a></td> -<td></td> +<td>Use 4 spaces per indentation level.</td> </tr><tr> <td><a href="#init_checks_registry">init_checks_registry</a></td> <td>Register all globally visible functions where the first argument name is 'physical_line' or 'logical_line'.</td> @@ -108,7 +108,7 @@ <td>JCR: Each comma, semicolon or colon should be followed by whitespace.</td> </tr><tr> <td><a href="#missing_whitespace_around_operator">missing_whitespace_around_operator</a></td> -<td></td> +<td>- Always surround these binary operators with a single space on either side: assignment (=), augmented assignment (+=, -= etc.), comparisons (==, <, >, !=, <>, <=, >=, in, not in, is, is not), Booleans (and, or, not).</td> </tr><tr> <td><a href="#mute_string">mute_string</a></td> <td>Replace contents with 'xxx' to prevent syntax matching.</td> @@ -123,7 +123,7 @@ <td>Backticks are removed in Python 3.</td> </tr><tr> <td><a href="#python_3000_has_key">python_3000_has_key</a></td> -<td></td> +<td>The {}.has_key() method is removed in the Python 3.</td> </tr><tr> <td><a href="#python_3000_not_equal">python_3000_not_equal</a></td> <td>!= can also be written <>, but this is an obsolete usage kept for backwards compatibility only.</td> @@ -147,22 +147,22 @@ <td></td> </tr><tr> <td><a href="#tabs_obsolete">tabs_obsolete</a></td> -<td></td> +<td>For new projects, spaces-only are strongly recommended over tabs.</td> </tr><tr> <td><a href="#tabs_or_spaces">tabs_or_spaces</a></td> -<td></td> +<td>Never mix tabs and spaces.</td> </tr><tr> <td><a href="#trailing_blank_lines">trailing_blank_lines</a></td> -<td></td> +<td>JCR: Trailing blank lines are superfluous.</td> </tr><tr> <td><a href="#trailing_whitespace">trailing_whitespace</a></td> -<td></td> +<td>JCR: Trailing whitespace is superfluous.</td> </tr><tr> <td><a href="#whitespace_around_comma">whitespace_around_comma</a></td> <td>Avoid extraneous whitespace in the following situations:</td> </tr><tr> <td><a href="#whitespace_around_keywords">whitespace_around_keywords</a></td> -<td></td> +<td>Avoid extraneous whitespace around keywords.</td> </tr><tr> <td><a href="#whitespace_around_named_parameter_equals">whitespace_around_named_parameter_equals</a></td> <td>Don't use spaces around the '=' sign when used to indicate a keyword argument or a default parameter value.</td> @@ -648,7 +648,26 @@ <a NAME="blank_lines" ID="blank_lines"></a> <h2>blank_lines</h2> <b>blank_lines</b>(<i>logical_line, blank_lines, indent_level, line_number, previous_logical, previous_indent_level</i>) - +<p> + Separate top-level function and class definitions with two blank lines. +</p><p> + Method definitions inside a class are separated by a single blank line. +</p><p> + Extra blank lines may be used (sparingly) to separate groups of related + functions. Blank lines may be omitted between a bunch of related + one-liners (e.g. a set of dummy implementations). +</p><p> + Use blank lines in functions, sparingly, to indicate logical sections. +</p><p> + Okay: def a():\n pass\n\n\ndef b():\n pass + Okay: def a():\n pass\n\n\n# Foo\n# Bar\n\ndef b():\n pass +</p><p> + E301: class Foo:\n b = 0\n def bar():\n pass + E302: def a():\n pass\n\ndef b(n):\n pass + E303: def a():\n pass\n\n\n\ndef b(n):\n pass + E303: def a():\n\n\n\n pass + E304: @decorator\n\ndef a():\n pass +</p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="comparison_to_singleton" ID="comparison_to_singleton"></a> @@ -691,25 +710,101 @@ <a NAME="compound_statements" ID="compound_statements"></a> <h2>compound_statements</h2> <b>compound_statements</b>(<i>logical_line</i>) - +<p> + Compound statements (multiple statements on the same line) are + generally discouraged. +</p><p> + While sometimes it's okay to put an if/for/while with a small body + on the same line, never do this for multi-clause statements. Also + avoid folding such long lines! +</p><p> + Okay: if foo == 'blah':\n do_blah_thing() + Okay: do_one() + Okay: do_two() + Okay: do_three() +</p><p> + E701: if foo == 'blah': do_blah_thing() + E701: for x in lst: total += x + E701: while t < 10: t = delay() + E701: if foo == 'blah': do_blah_thing() + E701: else: do_non_blah_thing() + E701: try: something() + E701: finally: cleanup() + E701: if foo == 'blah': one(); two(); three() +</p><p> + E702: do_one(); do_two(); do_three() + E703: do_four(); # useless semicolon +</p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="continued_indentation" ID="continued_indentation"></a> <h2>continued_indentation</h2> <b>continued_indentation</b>(<i>logical_line, tokens, indent_level, hang_closing, noqa, verbose</i>) - +<p> + Continuation lines should align wrapped elements either vertically using + Python's implicit line joining inside parentheses, brackets and braces, or + using a hanging indent. +</p><p> + When using a hanging indent the following considerations should be applied: +</p><p> + - there should be no arguments on the first line, and +</p><p> + - further indentation should be used to clearly distinguish itself as a + continuation line. +</p><p> + Okay: a = (\n) + E123: a = (\n ) +</p><p> + Okay: a = (\n 42) + E121: a = (\n 42) + E122: a = (\n42) + E123: a = (\n 42\n ) + E124: a = (24,\n 42\n) + E125: if (a or\n b):\n pass + E126: a = (\n 42) + E127: a = (24,\n 42) + E128: a = (24,\n 42) +</p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="expand_indent" ID="expand_indent"></a> <h2>expand_indent</h2> <b>expand_indent</b>(<i>line</i>) - +<p> + Return the amount of indentation. + Tabs are expanded to the next multiple of 8. +</p><p> + >>> expand_indent(' ') + 4 + >>> expand_indent('\t') + 8 + >>> expand_indent(' \t') + 8 + >>> expand_indent(' \t') + 8 + >>> expand_indent(' \t') + 16 +</p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="explicit_line_join" ID="explicit_line_join"></a> <h2>explicit_line_join</h2> <b>explicit_line_join</b>(<i>logical_line, tokens</i>) - +<p> + Avoid explicit line join between brackets. +</p><p> + The preferred way of wrapping long lines is by using Python's implied line + continuation inside parentheses, brackets and braces. Long lines can be + broken over multiple lines by wrapping expressions in parentheses. These + should be used in preference to using a backslash for line continuation. +</p><p> + E502: aaa = [123, \\n 123] + E502: aaa = ("bbb " \\n "ccc") +</p><p> + Okay: aaa = [123,\n 123] + Okay: aaa = ("bbb "\n "ccc") + Okay: aaa = "bbb " \\n "ccc" +</p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="extraneous_whitespace" ID="extraneous_whitespace"></a> @@ -775,13 +870,39 @@ <a NAME="imports_on_separate_lines" ID="imports_on_separate_lines"></a> <h2>imports_on_separate_lines</h2> <b>imports_on_separate_lines</b>(<i>logical_line</i>) - +<p> + Imports should usually be on separate lines. +</p><p> + Okay: import os\nimport sys + E401: import sys, os +</p><p> + Okay: from subprocess import Popen, PIPE + Okay: from myclas import MyClass + Okay: from foo.bar.yourclass import YourClass + Okay: import myclass + Okay: import foo.bar.yourclass +</p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="indentation" ID="indentation"></a> <h2>indentation</h2> <b>indentation</b>(<i>logical_line, previous_logical, indent_char, indent_level, previous_indent_level</i>) - +<p> + Use 4 spaces per indentation level. +</p><p> + For really old code that you don't want to mess up, you can continue to + use 8-space tabs. +</p><p> + Okay: a = 1 + Okay: if a == 0:\n a = 1 + E111: a = 1 +</p><p> + Okay: for item in items:\n pass + E112: for item in items:\npass +</p><p> + Okay: a = 1\nb = 2 + E113: a = 1\n b = 2 +</p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="init_checks_registry" ID="init_checks_registry"></a> @@ -841,7 +962,31 @@ <a NAME="missing_whitespace_around_operator" ID="missing_whitespace_around_operator"></a> <h2>missing_whitespace_around_operator</h2> <b>missing_whitespace_around_operator</b>(<i>logical_line, tokens</i>) - +<p> + - Always surround these binary operators with a single space on + either side: assignment (=), augmented assignment (+=, -= etc.), + comparisons (==, <, >, !=, <>, <=, >=, in, not in, is, is not), + Booleans (and, or, not). +</p><p> + - Use spaces around arithmetic operators. +</p><p> + Okay: i = i + 1 + Okay: submitted += 1 + Okay: x = x * 2 - 1 + Okay: hypot2 = x * x + y * y + Okay: c = (a + b) * (a - b) + Okay: foo(bar, key='word', *args, **kwargs) + Okay: alpha[:-i] +</p><p> + E225: i=i+1 + E225: submitted +=1 + E225: x = x /2 - 1 + E225: z = x **y + E226: c = (a+b) * (a-b) + E226: hypot2 = x*x + y*y + E227: c = a|b + E228: msg = fmt%(errno, errmsg) +</p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="mute_string" ID="mute_string"></a> @@ -890,7 +1035,13 @@ <a NAME="python_3000_has_key" ID="python_3000_has_key"></a> <h2>python_3000_has_key</h2> <b>python_3000_has_key</b>(<i>logical_line</i>) - +<p> + The {}.has_key() method is removed in the Python 3. + Use the 'in' operation instead. +</p><p> + Okay: if "alph" in d:\n print d["alph"] + W601: assert d.has_key('alph') +</p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="python_3000_not_equal" ID="python_3000_not_equal"></a> @@ -960,25 +1111,65 @@ <a NAME="tabs_obsolete" ID="tabs_obsolete"></a> <h2>tabs_obsolete</h2> <b>tabs_obsolete</b>(<i>physical_line</i>) - +<p> + For new projects, spaces-only are strongly recommended over tabs. Most + editors have features that make this easy to do. +</p><p> + Okay: if True:\n return + W191: if True:\n\treturn +</p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="tabs_or_spaces" ID="tabs_or_spaces"></a> <h2>tabs_or_spaces</h2> <b>tabs_or_spaces</b>(<i>physical_line, indent_char</i>) - +<p> + Never mix tabs and spaces. +</p><p> + The most popular way of indenting Python is with spaces only. The + second-most popular way is with tabs only. Code indented with a mixture + of tabs and spaces should be converted to using spaces exclusively. When + invoking the Python command line interpreter with the -t option, it issues + warnings about code that illegally mixes tabs and spaces. When using -tt + these warnings become errors. These options are highly recommended! +</p><p> + Okay: if a == 0:\n a = 1\n b = 1 + E101: if a == 0:\n a = 1\n\tb = 1 +</p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="trailing_blank_lines" ID="trailing_blank_lines"></a> <h2>trailing_blank_lines</h2> <b>trailing_blank_lines</b>(<i>physical_line, lines, line_number</i>) - +<p> + JCR: Trailing blank lines are superfluous. +</p><p> + Okay: spam(1) + W391: spam(1)\n +</p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="trailing_whitespace" ID="trailing_whitespace"></a> <h2>trailing_whitespace</h2> <b>trailing_whitespace</b>(<i>physical_line</i>) - +<p> + JCR: Trailing whitespace is superfluous. + FBM: Except when it occurs as part of a blank line (i.e. the line is + nothing but whitespace). According to Python docs[1] a line with only + whitespace is considered a blank line, and is to be ignored. However, + matching a blank line to its indentation level avoids mistakenly + terminating a multi-line statement (e.g. class declaration) when + pasting code into the standard Python interpreter. +</p><p> + [1] http://docs.python.org/reference/lexical_analysis.html#blank-lines +</p><p> + The warning returned varies on whether the line itself is blank, for easier + filtering for those who want to indent their blank lines. +</p><p> + Okay: spam(1)\n# + W291: spam(1) \n# + W293: class Foo(object):\n \n bang = 12 +</p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="whitespace_around_comma" ID="whitespace_around_comma"></a> @@ -1002,7 +1193,15 @@ <a NAME="whitespace_around_keywords" ID="whitespace_around_keywords"></a> <h2>whitespace_around_keywords</h2> <b>whitespace_around_keywords</b>(<i>logical_line</i>) - +<p> + Avoid extraneous whitespace around keywords. +</p><p> + Okay: True and False + E271: True and False + E272: True and False + E273: True and\tFalse + E274: True\tand False +</p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="whitespace_around_named_parameter_equals" ID="whitespace_around_named_parameter_equals"></a>
--- a/Documentation/Source/eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.html Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.WizardPlugins.E5MessageBoxWizard.E5MessageBoxWizardDialog.html Tue Oct 15 22:03:54 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 Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.WizardPlugins.FontDialogWizard.FontDialogWizardDialog.html Tue Oct 15 22:03:54 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 Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.WizardPlugins.QRegExpWizard.QRegExpWizardDialog.html Tue Oct 15 22:03:54 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 Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Source/eric5.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardDialog.html Tue Oct 15 22:03:54 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>
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorStylesPage.html Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Source/eric5.Preferences.ConfigurationPages.EditorStylesPage.html Tue Oct 15 22:03:54 2013 +0200 @@ -69,6 +69,12 @@ <td><a href="#EditorStylesPage.on_annotationsErrorFgButton_clicked">on_annotationsErrorFgButton_clicked</a></td> <td>Private slot to set the foreground colour of the error annotations.</td> </tr><tr> +<td><a href="#EditorStylesPage.on_annotationsStyleWarningBgButton_clicked">on_annotationsStyleWarningBgButton_clicked</a></td> +<td>Private slot to set the background colour of the style annotations.</td> +</tr><tr> +<td><a href="#EditorStylesPage.on_annotationsStyleWarningFgButton_clicked">on_annotationsStyleWarningFgButton_clicked</a></td> +<td>Private slot to set the foreground colour of the style annotations.</td> +</tr><tr> <td><a href="#EditorStylesPage.on_annotationsWarningBgButton_clicked">on_annotationsWarningBgButton_clicked</a></td> <td>Private slot to set the background colour of the warning annotations.</td> </tr><tr> @@ -110,6 +116,16 @@ <b>on_annotationsErrorFgButton_clicked</b>(<i></i>) <p> Private slot to set the foreground colour of the error annotations. +</p><a NAME="EditorStylesPage.on_annotationsStyleWarningBgButton_clicked" ID="EditorStylesPage.on_annotationsStyleWarningBgButton_clicked"></a> +<h4>EditorStylesPage.on_annotationsStyleWarningBgButton_clicked</h4> +<b>on_annotationsStyleWarningBgButton_clicked</b>(<i></i>) +<p> + Private slot to set the background colour of the style annotations. +</p><a NAME="EditorStylesPage.on_annotationsStyleWarningFgButton_clicked" ID="EditorStylesPage.on_annotationsStyleWarningFgButton_clicked"></a> +<h4>EditorStylesPage.on_annotationsStyleWarningFgButton_clicked</h4> +<b>on_annotationsStyleWarningFgButton_clicked</b>(<i></i>) +<p> + Private slot to set the foreground colour of the style annotations. </p><a NAME="EditorStylesPage.on_annotationsWarningBgButton_clicked" ID="EditorStylesPage.on_annotationsWarningBgButton_clicked"></a> <h4>EditorStylesPage.on_annotationsWarningBgButton_clicked</h4> <b>on_annotationsWarningBgButton_clicked</b>(<i></i>) @@ -134,7 +150,8 @@ <h4>EditorStylesPage.on_monospacedFontButton_clicked</h4> <b>on_monospacedFontButton_clicked</b>(<i></i>) <p> - Private method used to select the font to be used as the monospaced font. + Private method used to select the font to be used as the monospaced + font. </p><a NAME="EditorStylesPage.polishPage" ID="EditorStylesPage.polishPage"></a> <h4>EditorStylesPage.polishPage</h4> <b>polishPage</b>(<i></i>)
--- a/Documentation/Source/eric5.Preferences.ConfigurationPages.Py3FlakesPage.html Sun Sep 08 19:04:07 2013 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,100 +0,0 @@ -<!DOCTYPE html> -<html><head> -<title>eric5.Preferences.ConfigurationPages.Py3FlakesPage</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.Preferences.ConfigurationPages.Py3FlakesPage</h1> -<p> -Module implementing the Py3Flakes configuration page. -</p> -<h3>Global Attributes</h3> -<table> -<tr><td>None</td></tr> -</table> -<h3>Classes</h3> -<table> -<tr> -<td><a href="#Py3FlakesPage">Py3FlakesPage</a></td> -<td>Class implementing the Python configuration page.</td> -</tr> -</table> -<h3>Functions</h3> -<table> -<tr> -<td><a href="#create">create</a></td> -<td>Module function to create the configuration page.</td> -</tr> -</table> -<hr /><hr /> -<a NAME="Py3FlakesPage" ID="Py3FlakesPage"></a> -<h2>Py3FlakesPage</h2> -<p> - Class implementing the Python configuration page. -</p> -<h3>Derived from</h3> -ConfigurationPageBase, Ui_Py3FlakesPage -<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="#Py3FlakesPage.__init__">Py3FlakesPage</a></td> -<td>Constructor</td> -</tr><tr> -<td><a href="#Py3FlakesPage.save">save</a></td> -<td>Public slot to save the Python configuration.</td> -</tr> -</table> -<h3>Static Methods</h3> -<table> -<tr><td>None</td></tr> -</table> -<a NAME="Py3FlakesPage.__init__" ID="Py3FlakesPage.__init__"></a> -<h4>Py3FlakesPage (Constructor)</h4> -<b>Py3FlakesPage</b>(<i></i>) -<p> - Constructor -</p><a NAME="Py3FlakesPage.save" ID="Py3FlakesPage.save"></a> -<h4>Py3FlakesPage.save</h4> -<b>save</b>(<i></i>) -<p> - Public slot to save the Python configuration. -</p> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="create" ID="create"></a> -<h2>create</h2> -<b>create</b>(<i>dlg</i>) -<p> - Module function to create the configuration page. -</p><dl> -<dt><i>dlg</i></dt> -<dd> -reference to the configuration dialog -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -</body></html> \ No newline at end of file
--- a/Documentation/Source/eric5.QScintilla.Editor.html Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Source/eric5.QScintilla.Editor.html Tue Oct 15 22:03:54 2013 +0200 @@ -131,7 +131,7 @@ QsciScintillaCompat <h3>Class Attributes</h3> <table> -<tr><td>AttributeID</td></tr><tr><td>AttributePrivateID</td></tr><tr><td>AttributeProtectedID</td></tr><tr><td>CancelEditToken</td></tr><tr><td>ClassID</td></tr><tr><td>ClassPrivateID</td></tr><tr><td>ClassProtectedID</td></tr><tr><td>EndEditToken</td></tr><tr><td>EnumID</td></tr><tr><td>FromDocumentID</td></tr><tr><td>MethodID</td></tr><tr><td>MethodPrivateID</td></tr><tr><td>MethodProtectedID</td></tr><tr><td>RequestSyncToken</td></tr><tr><td>Separator</td></tr><tr><td>StartEditToken</td></tr><tr><td>SyncToken</td></tr><tr><td>TemplateImageID</td></tr> +<tr><td>AttributeID</td></tr><tr><td>AttributePrivateID</td></tr><tr><td>AttributeProtectedID</td></tr><tr><td>CancelEditToken</td></tr><tr><td>ClassID</td></tr><tr><td>ClassPrivateID</td></tr><tr><td>ClassProtectedID</td></tr><tr><td>EndEditToken</td></tr><tr><td>EnumID</td></tr><tr><td>FromDocumentID</td></tr><tr><td>MethodID</td></tr><tr><td>MethodPrivateID</td></tr><tr><td>MethodProtectedID</td></tr><tr><td>RequestSyncToken</td></tr><tr><td>Separator</td></tr><tr><td>StartEditToken</td></tr><tr><td>SyncToken</td></tr><tr><td>TemplateImageID</td></tr><tr><td>WarningCode</td></tr><tr><td>WarningStyle</td></tr> </table> <h3>Class Methods</h3> <table> @@ -3611,7 +3611,7 @@ The later works independent of the current selection. </p><a NAME="Editor.toggleFlakesWarning" ID="Editor.toggleFlakesWarning"></a> <h4>Editor.toggleFlakesWarning</h4> -<b>toggleFlakesWarning</b>(<i>line, warning, msg=""</i>) +<b>toggleFlakesWarning</b>(<i>line, warning, msg="", warningType=WarningCode</i>) <p> Public method to toggle a flakes warning indicator. </p><p> @@ -3627,6 +3627,9 @@ </dd><dt><i>msg</i></dt> <dd> warning message (string) +</dd><dt><i>warningType=</i></dt> +<dd> +type of warning message (integer) </dd> </dl><a NAME="Editor.toggleSyntaxError" ID="Editor.toggleSyntaxError"></a> <h4>Editor.toggleSyntaxError</h4>
--- a/Documentation/Source/eric5.QScintilla.Shell.html Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Source/eric5.QScintilla.Shell.html Tue Oct 15 22:03:54 2013 +0200 @@ -53,7 +53,8 @@ <dl> <dt>searchStringFound(found)</dt> <dd> -emitted to indicate the search result (boolean) +emitted to indicate the search + result (boolean) </dd> </dl> <h3>Derived from</h3> @@ -247,7 +248,7 @@ <td>Private slot to show the shell history dialog.</td> </tr><tr> <td><a href="#Shell.__startDebugClient">__startDebugClient</a></td> -<td>Private slot to start a debug client accoding to the action triggered[()].</td> +<td>Private slot to start a debug client according to the action triggered[()].</td> </tr><tr> <td><a href="#Shell.__useHistory">__useHistory</a></td> <td>Private method to display a command from the history.</td> @@ -445,7 +446,8 @@ <h4>Shell.__QScintillaLeftDeleteCommand</h4> <b>__QScintillaLeftDeleteCommand</b>(<i>method</i>) <p> - Private method to handle a QScintilla delete command working to the left. + Private method to handle a QScintilla delete command working to + the left. </p><dl> <dt><i>method</i></dt> <dd> @@ -679,7 +681,8 @@ <h4>Shell.__insertTextNoEcho</h4> <b>__insertTextNoEcho</b>(<i>s</i>) <p> - Private method to insert some text at the end of the buffer without echoing it. + Private method to insert some text at the end of the buffer without + echoing it. </p><dl> <dt><i>s</i></dt> <dd> @@ -836,7 +839,8 @@ <h4>Shell.__startDebugClient</h4> <b>__startDebugClient</b>(<i>action</i>) <p> - Private slot to start a debug client accoding to the action triggered[()]. + Private slot to start a debug client according to the action + triggered[()]. </p><dl> <dt><i>action</i></dt> <dd> @@ -1124,7 +1128,8 @@ <h4>Shell.reloadHistory</h4> <b>reloadHistory</b>(<i></i>) <p> - Public method to reload the history of the currently selected client type. + Public method to reload the history of the currently selected client + type. </p><a NAME="Shell.saveHistory" ID="Shell.saveHistory"></a> <h4>Shell.saveHistory</h4> <b>saveHistory</b>(<i>clientType</i>)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.UtilitiesPython2.Pep257CheckerPy2.html Tue Oct 15 22:03:54 2013 +0200 @@ -0,0 +1,896 @@ +<!DOCTYPE html> +<html><head> +<title>eric5.UtilitiesPython2.Pep257CheckerPy2</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.Pep257CheckerPy2</h1> +<p> +Module implementing a checker for PEP-257 documentation string conventions. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#Pep257Checker">Pep257Checker</a></td> +<td>Class implementing a checker for PEP-257 documentation string conventions.</td> +</tr><tr> +<td><a href="#Pep257Context">Pep257Context</a></td> +<td>Class implementing the source context.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="Pep257Checker" ID="Pep257Checker"></a> +<h2>Pep257Checker</h2> +<p> + Class implementing a checker for PEP-257 documentation string conventions. +</p> +<h3>Derived from</h3> +object +<h3>Class Attributes</h3> +<table> +<tr><td>Codes</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#Pep257Checker.__init__">Pep257Checker</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkBackslashes">__checkBackslashes</a></td> +<td>Private method to check, that all docstrings containing backslashes are surrounded by raw triple double quotes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkBlankAfterLastParagraph">__checkBlankAfterLastParagraph</a></td> +<td>Private method to check, that the last paragraph of docstrings is followed by a blank line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkBlankAfterSummary">__checkBlankAfterSummary</a></td> +<td>Private method to check, that docstring summaries are followed by a blank line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkBlankBeforeAndAfterClass">__checkBlankBeforeAndAfterClass</a></td> +<td>Private method to check, that class docstrings have one blank line around them.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkClassDocstring">__checkClassDocstring</a></td> +<td>Private method to check, that all public functions and methods have a docstring.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEndsWithPeriod">__checkEndsWithPeriod</a></td> +<td>Private method to check, that docstring summaries end with a period.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricBlankAfterSummary">__checkEricBlankAfterSummary</a></td> +<td>Private method to check, that docstring summaries are followed by a blank line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td> +<td>Private method to check, that docstring summaries end with a period.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricException">__checkEricException</a></td> +<td>Private method to check, that docstrings contain an @exception line if they raise an exception and don't otherwise.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricFunctionArguments">__checkEricFunctionArguments</a></td> +<td>Private method to check, that docstrings contain an @param and/or @keyparam line for each argument.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricNBlankAfterLastParagraph">__checkEricNBlankAfterLastParagraph</a></td> +<td>Private method to check, that the last paragraph of docstrings is not followed by a blank line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction">__checkEricNoBlankBeforeAndAfterClassOrFunction</a></td> +<td>Private method to check, that class and function/method docstrings have no blank line around them.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricQuotesOnSeparateLines">__checkEricQuotesOnSeparateLines</a></td> +<td>Private method to check, that leading and trailing quotes are on a line by themselves.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkEricReturn">__checkEricReturn</a></td> +<td>Private method to check, that docstrings contain an @return line if they return anything and don't otherwise.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkFunctionDocstring">__checkFunctionDocstring</a></td> +<td>Private method to check, that all public functions and methods have a docstring.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkImperativeMood">__checkImperativeMood</a></td> +<td>Private method to check, that docstring summaries are in imperative mood.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkIndent">__checkIndent</a></td> +<td>Private method to check, that docstrings are properly indented.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkModulesDocstrings">__checkModulesDocstrings</a></td> +<td>Private method to check, if the module has a docstring.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkNoBlankLineBefore">__checkNoBlankLineBefore</a></td> +<td>Private method to check, that function/method docstrings are not preceded by a blank line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkNoSignature">__checkNoSignature</a></td> +<td>Private method to check, that docstring summaries don't repeat the function's signature.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkOneLiner">__checkOneLiner</a></td> +<td>Private method to check, that one-liner docstrings fit on one line with quotes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkReturnType">__checkReturnType</a></td> +<td>Private method to check, that docstrings mention the return value type.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td> +<td>Private method to check, that all docstrings are surrounded by triple double quotes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__checkUnicode">__checkUnicode</a></td> +<td>Private method to check, that all docstrings containing unicode characters are surrounded by unicode triple double quotes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__error">__error</a></td> +<td>Private method to record an issue.</td> +</tr><tr> +<td><a href="#Pep257Checker.__getArgNames">__getArgNames</a></td> +<td></td> +</tr><tr> +<td><a href="#Pep257Checker.__getSummaryLine">__getSummaryLine</a></td> +<td>Private method to extract the summary line.</td> +</tr><tr> +<td><a href="#Pep257Checker.__getSummaryLines">__getSummaryLines</a></td> +<td>Private method to extract the summary lines.</td> +</tr><tr> +<td><a href="#Pep257Checker.__ignoreCode">__ignoreCode</a></td> +<td>Private method to check if the error code should be ignored.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseClasses">__parseClasses</a></td> +<td>Private method to extract top-level classes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseContexts">__parseContexts</a></td> +<td>Private method to extract a context from the source.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseDocstring">__parseDocstring</a></td> +<td>Private method to extract a docstring given `def` or `class` source.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseFunctions">__parseFunctions</a></td> +<td>Private method to extract top-level functions.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseMethods">__parseMethods</a></td> +<td>Private method to extract methods of all classes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseModuleDocstring">__parseModuleDocstring</a></td> +<td>Private method to extract a docstring given a module source.</td> +</tr><tr> +<td><a href="#Pep257Checker.__parseTopLevel">__parseTopLevel</a></td> +<td>Private method to extract top-level functions or classes.</td> +</tr><tr> +<td><a href="#Pep257Checker.__readline">__readline</a></td> +<td>Private method to get the next line from the source.</td> +</tr><tr> +<td><a href="#Pep257Checker.__resetReadline">__resetReadline</a></td> +<td>Private method to reset the internal readline function.</td> +</tr><tr> +<td><a href="#Pep257Checker.__skipIndentedBlock">__skipIndentedBlock</a></td> +<td>Private method to skip over an indented block of source code.</td> +</tr><tr> +<td><a href="#Pep257Checker.run">run</a></td> +<td>Public method to check the given source for violations of doc string conventions according to PEP-257.</td> +</tr><tr> +<td><a href="#Pep257Checker.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="Pep257Checker.__init__" ID="Pep257Checker.__init__"></a> +<h4>Pep257Checker (Constructor)</h4> +<b>Pep257Checker</b>(<i>source, filename, select, ignore, expected, repeat, maxLineLength=79, docType="pep257"</i>) +<p> + Constructor +</p><dl> +<dt><i>source</i></dt> +<dd> +source code to be checked (list of string) +</dd><dt><i>filename</i></dt> +<dd> +name of the source file (string) +</dd><dt><i>select</i></dt> +<dd> +list of selected codes (list of string) +</dd><dt><i>ignore</i></dt> +<dd> +list of codes to be ignored (list of string) +</dd><dt><i>expected</i></dt> +<dd> +list of expected codes (list of string) +</dd><dt><i>repeat</i></dt> +<dd> +flag indicating to report each occurrence of a code + (boolean) +</dd><dt><i>maxLineLength=</i></dt> +<dd> +allowed line length (integer) +</dd><dt><i>docType=</i></dt> +<dd> +type of the documentation strings + (string, one of 'eric' or 'pep257') +</dd> +</dl><a NAME="Pep257Checker.__checkBackslashes" ID="Pep257Checker.__checkBackslashes"></a> +<h4>Pep257Checker.__checkBackslashes</h4> +<b>__checkBackslashes</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all docstrings containing + backslashes are surrounded by raw triple double quotes. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkBlankAfterLastParagraph" ID="Pep257Checker.__checkBlankAfterLastParagraph"></a> +<h4>Pep257Checker.__checkBlankAfterLastParagraph</h4> +<b>__checkBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that the last paragraph of docstrings is + followed by a blank line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkBlankAfterSummary" ID="Pep257Checker.__checkBlankAfterSummary"></a> +<h4>Pep257Checker.__checkBlankAfterSummary</h4> +<b>__checkBlankAfterSummary</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries are followed + by a blank line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkBlankBeforeAndAfterClass" ID="Pep257Checker.__checkBlankBeforeAndAfterClass"></a> +<h4>Pep257Checker.__checkBlankBeforeAndAfterClass</h4> +<b>__checkBlankBeforeAndAfterClass</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that class docstrings have one + blank line around them. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkClassDocstring" ID="Pep257Checker.__checkClassDocstring"></a> +<h4>Pep257Checker.__checkClassDocstring</h4> +<b>__checkClassDocstring</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all public functions and methods + have a docstring. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEndsWithPeriod" ID="Pep257Checker.__checkEndsWithPeriod"></a> +<h4>Pep257Checker.__checkEndsWithPeriod</h4> +<b>__checkEndsWithPeriod</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries end with a period. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricBlankAfterSummary" ID="Pep257Checker.__checkEricBlankAfterSummary"></a> +<h4>Pep257Checker.__checkEricBlankAfterSummary</h4> +<b>__checkEricBlankAfterSummary</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries are followed + by a blank line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricEndsWithPeriod" ID="Pep257Checker.__checkEricEndsWithPeriod"></a> +<h4>Pep257Checker.__checkEricEndsWithPeriod</h4> +<b>__checkEricEndsWithPeriod</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries end with a period. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricException" ID="Pep257Checker.__checkEricException"></a> +<h4>Pep257Checker.__checkEricException</h4> +<b>__checkEricException</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstrings contain an @exception line + if they raise an exception and don't otherwise. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricFunctionArguments" ID="Pep257Checker.__checkEricFunctionArguments"></a> +<h4>Pep257Checker.__checkEricFunctionArguments</h4> +<b>__checkEricFunctionArguments</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstrings contain an @param and/or + @keyparam line for each argument. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricNBlankAfterLastParagraph" ID="Pep257Checker.__checkEricNBlankAfterLastParagraph"></a> +<h4>Pep257Checker.__checkEricNBlankAfterLastParagraph</h4> +<b>__checkEricNBlankAfterLastParagraph</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that the last paragraph of docstrings is + not followed by a blank line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a> +<h4>Pep257Checker.__checkEricNoBlankBeforeAndAfterClassOrFunction</h4> +<b>__checkEricNoBlankBeforeAndAfterClassOrFunction</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that class and function/method docstrings + have no blank line around them. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricQuotesOnSeparateLines" ID="Pep257Checker.__checkEricQuotesOnSeparateLines"></a> +<h4>Pep257Checker.__checkEricQuotesOnSeparateLines</h4> +<b>__checkEricQuotesOnSeparateLines</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that leading and trailing quotes are on + a line by themselves. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkEricReturn" ID="Pep257Checker.__checkEricReturn"></a> +<h4>Pep257Checker.__checkEricReturn</h4> +<b>__checkEricReturn</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstrings contain an @return line + if they return anything and don't otherwise. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkFunctionDocstring" ID="Pep257Checker.__checkFunctionDocstring"></a> +<h4>Pep257Checker.__checkFunctionDocstring</h4> +<b>__checkFunctionDocstring</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all public functions and methods + have a docstring. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkImperativeMood" ID="Pep257Checker.__checkImperativeMood"></a> +<h4>Pep257Checker.__checkImperativeMood</h4> +<b>__checkImperativeMood</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries are in + imperative mood. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkIndent" ID="Pep257Checker.__checkIndent"></a> +<h4>Pep257Checker.__checkIndent</h4> +<b>__checkIndent</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstrings are properly indented. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkModulesDocstrings" ID="Pep257Checker.__checkModulesDocstrings"></a> +<h4>Pep257Checker.__checkModulesDocstrings</h4> +<b>__checkModulesDocstrings</b>(<i>docstringContext, context</i>) +<p> + Private method to check, if the module has a docstring. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkNoBlankLineBefore" ID="Pep257Checker.__checkNoBlankLineBefore"></a> +<h4>Pep257Checker.__checkNoBlankLineBefore</h4> +<b>__checkNoBlankLineBefore</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that function/method docstrings are not + preceded by a blank line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkNoSignature" ID="Pep257Checker.__checkNoSignature"></a> +<h4>Pep257Checker.__checkNoSignature</h4> +<b>__checkNoSignature</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstring summaries don't repeat + the function's signature. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkOneLiner" ID="Pep257Checker.__checkOneLiner"></a> +<h4>Pep257Checker.__checkOneLiner</h4> +<b>__checkOneLiner</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that one-liner docstrings fit on + one line with quotes. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkReturnType" ID="Pep257Checker.__checkReturnType"></a> +<h4>Pep257Checker.__checkReturnType</h4> +<b>__checkReturnType</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that docstrings mention the return value type. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkTripleDoubleQuotes" ID="Pep257Checker.__checkTripleDoubleQuotes"></a> +<h4>Pep257Checker.__checkTripleDoubleQuotes</h4> +<b>__checkTripleDoubleQuotes</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all docstrings are surrounded + by triple double quotes. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__checkUnicode" ID="Pep257Checker.__checkUnicode"></a> +<h4>Pep257Checker.__checkUnicode</h4> +<b>__checkUnicode</b>(<i>docstringContext, context</i>) +<p> + Private method to check, that all docstrings containing unicode + characters are surrounded by unicode triple double quotes. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd><dt><i>context</i></dt> +<dd> +context of the docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__error" ID="Pep257Checker.__error"></a> +<h4>Pep257Checker.__error</h4> +<b>__error</b>(<i>lineNumber, offset, code, *args</i>) +<p> + Private method to record an issue. +</p><dl> +<dt><i>lineNumber</i></dt> +<dd> +line number of the issue (integer) +</dd><dt><i>offset</i></dt> +<dd> +position within line of the issue (integer) +</dd><dt><i>code</i></dt> +<dd> +message code (string) +</dd><dt><i>args</i></dt> +<dd> +arguments for the message (list) +</dd> +</dl><a NAME="Pep257Checker.__getArgNames" ID="Pep257Checker.__getArgNames"></a> +<h4>Pep257Checker.__getArgNames</h4> +<b>__getArgNames</b>(<i>node</i>) +<a NAME="Pep257Checker.__getSummaryLine" ID="Pep257Checker.__getSummaryLine"></a> +<h4>Pep257Checker.__getSummaryLine</h4> +<b>__getSummaryLine</b>(<i>docstringContext</i>) +<p> + Private method to extract the summary line. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +summary line (string) and the line it was found on (integer) +</dd> +</dl><a NAME="Pep257Checker.__getSummaryLines" ID="Pep257Checker.__getSummaryLines"></a> +<h4>Pep257Checker.__getSummaryLines</h4> +<b>__getSummaryLines</b>(<i>docstringContext</i>) +<p> + Private method to extract the summary lines. +</p><dl> +<dt><i>docstringContext</i></dt> +<dd> +docstring context (Pep257Context) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +summary lines (list of string) and the line it was found on + (integer) +</dd> +</dl><a NAME="Pep257Checker.__ignoreCode" ID="Pep257Checker.__ignoreCode"></a> +<h4>Pep257Checker.__ignoreCode</h4> +<b>__ignoreCode</b>(<i>code</i>) +<p> + Private method to check if the error code should be ignored. +</p><dl> +<dt><i>code</i></dt> +<dd> +message code to check for (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating to ignore the given code (boolean) +</dd> +</dl><a NAME="Pep257Checker.__parseClasses" ID="Pep257Checker.__parseClasses"></a> +<h4>Pep257Checker.__parseClasses</h4> +<b>__parseClasses</b>(<i></i>) +<p> + Private method to extract top-level classes. +</p><dl> +<dt>Returns:</dt> +<dd> +extracted class contexts (list of Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseContexts" ID="Pep257Checker.__parseContexts"></a> +<h4>Pep257Checker.__parseContexts</h4> +<b>__parseContexts</b>(<i>kind</i>) +<p> + Private method to extract a context from the source. +</p><dl> +<dt><i>kind</i></dt> +<dd> +kind of context to extract (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +requested contexts (list of Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseDocstring" ID="Pep257Checker.__parseDocstring"></a> +<h4>Pep257Checker.__parseDocstring</h4> +<b>__parseDocstring</b>(<i>context, what=''</i>) +<p> + Private method to extract a docstring given `def` or `class` source. +</p><dl> +<dt><i>context</i></dt> +<dd> +context data to get the docstring from (Pep257Context) +</dd><dt><i>what</i></dt> +<dd> +string denoting what is being parsed (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +context of extracted docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseFunctions" ID="Pep257Checker.__parseFunctions"></a> +<h4>Pep257Checker.__parseFunctions</h4> +<b>__parseFunctions</b>(<i></i>) +<p> + Private method to extract top-level functions. +</p><dl> +<dt>Returns:</dt> +<dd> +extracted function contexts (list of Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseMethods" ID="Pep257Checker.__parseMethods"></a> +<h4>Pep257Checker.__parseMethods</h4> +<b>__parseMethods</b>(<i></i>) +<p> + Private method to extract methods of all classes. +</p><dl> +<dt>Returns:</dt> +<dd> +extracted method contexts (list of Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseModuleDocstring" ID="Pep257Checker.__parseModuleDocstring"></a> +<h4>Pep257Checker.__parseModuleDocstring</h4> +<b>__parseModuleDocstring</b>(<i>source</i>) +<p> + Private method to extract a docstring given a module source. +</p><dl> +<dt><i>source</i></dt> +<dd> +source to parse (list of string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +context of extracted docstring (Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__parseTopLevel" ID="Pep257Checker.__parseTopLevel"></a> +<h4>Pep257Checker.__parseTopLevel</h4> +<b>__parseTopLevel</b>(<i>keyword</i>) +<p> + Private method to extract top-level functions or classes. +</p><dl> +<dt><i>keyword</i></dt> +<dd> +keyword signaling what to extract (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +extracted function or class contexts (list of Pep257Context) +</dd> +</dl><a NAME="Pep257Checker.__readline" ID="Pep257Checker.__readline"></a> +<h4>Pep257Checker.__readline</h4> +<b>__readline</b>(<i></i>) +<p> + Private method to get the next line from the source. +</p><dl> +<dt>Returns:</dt> +<dd> +next line of source (string) +</dd> +</dl><a NAME="Pep257Checker.__resetReadline" ID="Pep257Checker.__resetReadline"></a> +<h4>Pep257Checker.__resetReadline</h4> +<b>__resetReadline</b>(<i></i>) +<p> + Private method to reset the internal readline function. +</p><a NAME="Pep257Checker.__skipIndentedBlock" ID="Pep257Checker.__skipIndentedBlock"></a> +<h4>Pep257Checker.__skipIndentedBlock</h4> +<b>__skipIndentedBlock</b>(<i>tokenGenerator</i>) +<p> + Private method to skip over an indented block of source code. +</p><dl> +<dt><i>tokenGenerator</i></dt> +<dd> +token generator +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +last token of the indented block +</dd> +</dl><a NAME="Pep257Checker.run" ID="Pep257Checker.run"></a> +<h4>Pep257Checker.run</h4> +<b>run</b>(<i></i>) +<p> + Public method to check the given source for violations of doc string + conventions according to PEP-257. +</p><a NAME="Pep257Checker.unpackArgs" ID="Pep257Checker.unpackArgs"></a> +<h4>Pep257Checker.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 /><hr /> +<a NAME="Pep257Context" ID="Pep257Context"></a> +<h2>Pep257Context</h2> +<p> + Class implementing the source context. +</p> +<h3>Derived from</h3> +object +<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="#Pep257Context.__init__">Pep257Context</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#Pep257Context.contextType">contextType</a></td> +<td>Public method to get the context type.</td> +</tr><tr> +<td><a href="#Pep257Context.end">end</a></td> +<td>Public method to get the end line number.</td> +</tr><tr> +<td><a href="#Pep257Context.indent">indent</a></td> +<td>Public method to get the indentation of the first line.</td> +</tr><tr> +<td><a href="#Pep257Context.source">source</a></td> +<td>Public method to get the source.</td> +</tr><tr> +<td><a href="#Pep257Context.ssource">ssource</a></td> +<td>Public method to get the joined source lines.</td> +</tr><tr> +<td><a href="#Pep257Context.start">start</a></td> +<td>Public method to get the start line number.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="Pep257Context.__init__" ID="Pep257Context.__init__"></a> +<h4>Pep257Context (Constructor)</h4> +<b>Pep257Context</b>(<i>source, startLine, contextType</i>) +<p> + Constructor +</p><dl> +<dt><i>source</i></dt> +<dd> +source code of the context (list of string or string) +</dd><dt><i>startLine</i></dt> +<dd> +line number the context starts in the source (integer) +</dd><dt><i>contextType</i></dt> +<dd> +type of the context object (string) +</dd> +</dl><a NAME="Pep257Context.contextType" ID="Pep257Context.contextType"></a> +<h4>Pep257Context.contextType</h4> +<b>contextType</b>(<i></i>) +<p> + Public method to get the context type. +</p><dl> +<dt>Returns:</dt> +<dd> +context type (string) +</dd> +</dl><a NAME="Pep257Context.end" ID="Pep257Context.end"></a> +<h4>Pep257Context.end</h4> +<b>end</b>(<i></i>) +<p> + Public method to get the end line number. +</p><dl> +<dt>Returns:</dt> +<dd> +end line number (integer) +</dd> +</dl><a NAME="Pep257Context.indent" ID="Pep257Context.indent"></a> +<h4>Pep257Context.indent</h4> +<b>indent</b>(<i></i>) +<p> + Public method to get the indentation of the first line. +</p><dl> +<dt>Returns:</dt> +<dd> +indentation string (string) +</dd> +</dl><a NAME="Pep257Context.source" ID="Pep257Context.source"></a> +<h4>Pep257Context.source</h4> +<b>source</b>(<i></i>) +<p> + Public method to get the source. +</p><dl> +<dt>Returns:</dt> +<dd> +source (list of string) +</dd> +</dl><a NAME="Pep257Context.ssource" ID="Pep257Context.ssource"></a> +<h4>Pep257Context.ssource</h4> +<b>ssource</b>(<i></i>) +<p> + Public method to get the joined source lines. +</p><dl> +<dt>Returns:</dt> +<dd> +source (string) +</dd> +</dl><a NAME="Pep257Context.start" ID="Pep257Context.start"></a> +<h4>Pep257Context.start</h4> +<b>start</b>(<i></i>) +<p> + Public method to get the start line number. +</p><dl> +<dt>Returns:</dt> +<dd> +start line number (integer) +</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/Documentation/Source/eric5.UtilitiesPython2.Pep8NamingCheckerPy2.html Tue Oct 15 22:03:54 2013 +0200 @@ -0,0 +1,396 @@ +<!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 'extended' 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).</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).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkFuntionName">__checkFuntionName</a></td> +<td>Private class to check the given node for function name conventions (N802).</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.__checkNameToBeAvoided">__checkNameToBeAvoided</a></td> +<td>Private class to check the given node for a name to be avoided (N831).</td> +</tr><tr> +<td><a href="#Pep8NamingChecker.__checkVariablesInFunction">__checkVariablesInFunction</a></td> +<td>Private method to check local variables in functions (N821).</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, options</i>) +<p> + Constructor (according to 'extended' 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><dt><i>options</i></dt> +<dd> +options as parsed by pep8.StyleGuide +</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). +</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). +</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). +</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.__checkNameToBeAvoided" ID="Pep8NamingChecker.__checkNameToBeAvoided"></a> +<h4>Pep8NamingChecker.__checkNameToBeAvoided</h4> +<b>__checkNameToBeAvoided</b>(<i>node, parents</i>) +<p> + Private class to check the given node for a name to be avoided (N831). +</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). +</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 Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Source/index-eric5.Plugins.CheckerPlugins.Pep8.html Tue Oct 15 22:03:54 2013 +0200 @@ -28,6 +28,12 @@ <h3>Modules</h3> <table> <tr> +<td><a href="eric5.Plugins.CheckerPlugins.Pep8.Pep257Checker.html">Pep257Checker</a></td> +<td>Module implementing a checker for PEP-257 documentation string conventions.</td> +</tr><tr> +<td><a href="eric5.Plugins.CheckerPlugins.Pep8.Pep8Checker.html">Pep8Checker</a></td> +<td>Module implementing the PEP 8 checker.</td> +</tr><tr> <td><a href="eric5.Plugins.CheckerPlugins.Pep8.Pep8CodeSelectionDialog.html">Pep8CodeSelectionDialog</a></td> <td>Module implementing a dialog to select PEP 8 message codes.</td> </tr><tr> @@ -35,10 +41,13 @@ <td>Module implementing a dialog to show the results of the PEP 8 check.</td> </tr><tr> <td><a href="eric5.Plugins.CheckerPlugins.Pep8.Pep8Fixer.html">Pep8Fixer</a></td> -<td>Module implementing a class to fix certain PEP 8 issues.</td> +<td>Module implementing a class to fix certain code style 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> +<td>Module implementing a dialog showing statistical data for the last code style checker run.</td> </tr><tr> <td><a href="eric5.Plugins.CheckerPlugins.Pep8.pep8.html">pep8</a></td> <td></td>
--- a/Documentation/Source/index-eric5.Preferences.ConfigurationPages.html Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Source/index-eric5.Preferences.ConfigurationPages.html Tue Oct 15 22:03:54 2013 +0200 @@ -163,9 +163,6 @@ <td><a href="eric5.Preferences.ConfigurationPages.ProjectPage.html">ProjectPage</a></td> <td>Module implementing the Project configuration page.</td> </tr><tr> -<td><a href="eric5.Preferences.ConfigurationPages.Py3FlakesPage.html">Py3FlakesPage</a></td> -<td>Module implementing the Py3Flakes configuration page.</td> -</tr><tr> <td><a href="eric5.Preferences.ConfigurationPages.PythonPage.html">PythonPage</a></td> <td>Module implementing the Python configuration page.</td> </tr><tr>
--- a/Documentation/Source/index.html Sun Sep 08 19:04:07 2013 +0200 +++ b/Documentation/Source/index.html Tue Oct 15 22:03:54 2013 +0200 @@ -30,4 +30,23 @@ </tr> </table> +<h3>Modules</h3> +<table> +<tr> +<td><a href="Pep257CheckerPy2.html">Pep257CheckerPy2</a></td> +<td>Module implementing a checker for PEP-257 documentation string conventions.</td> +</tr><tr> +<td><a href="Pep8Checker.html">Pep8Checker</a></td> +<td>Class implementing the PEP 8 checker for Python2.</td> +</tr><tr> +<td><a href="Pep8NamingCheckerPy2.html">Pep8NamingCheckerPy2</a></td> +<td>Module implementing a checker for PEP-8 naming conventions for Python2.</td> +</tr><tr> +<td><a href="Tools.html">Tools</a></td> +<td>Module implementing tool functions.</td> +</tr><tr> +<td><a href="pep8.html">pep8</a></td> +<td></td> +</tr> +</table> </body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/pep8.html Tue Oct 15 22:03:54 2013 +0200 @@ -0,0 +1,1258 @@ +<!DOCTYPE html> +<html><head> +<title>pep8</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>pep8</h1> + +<h3>Global Attributes</h3> +<table> +<tr><td>ARITHMETIC_OP</td></tr><tr><td>BENCHMARK_KEYS</td></tr><tr><td>COMMENT_WITH_NL</td></tr><tr><td>COMPARE_SINGLETON_REGEX</td></tr><tr><td>COMPARE_TYPE_REGEX</td></tr><tr><td>DEFAULT_EXCLUDE</td></tr><tr><td>DEFAULT_IGNORE</td></tr><tr><td>DOCSTRING_REGEX</td></tr><tr><td>ERRORCODE_REGEX</td></tr><tr><td>EXTRANEOUS_WHITESPACE_REGEX</td></tr><tr><td>HUNK_REGEX</td></tr><tr><td>INDENT_REGEX</td></tr><tr><td>KEYWORDS</td></tr><tr><td>KEYWORD_REGEX</td></tr><tr><td>LAMBDA_REGEX</td></tr><tr><td>MAX_LINE_LENGTH</td></tr><tr><td>OPERATOR_REGEX</td></tr><tr><td>PROJECT_CONFIG</td></tr><tr><td>PyCF_ONLY_AST</td></tr><tr><td>RAISE_COMMA_REGEX</td></tr><tr><td>REPORT_FORMAT</td></tr><tr><td>RERAISE_COMMA_REGEX</td></tr><tr><td>SINGLETONS</td></tr><tr><td>SKIP_TOKENS</td></tr><tr><td>TESTSUITE_PATH</td></tr><tr><td>UNARY_OPERATORS</td></tr><tr><td>WHITESPACE</td></tr><tr><td>WHITESPACE_AFTER_COMMA_REGEX</td></tr><tr><td>WS_NEEDED_OPERATORS</td></tr><tr><td>WS_OPTIONAL_OPERATORS</td></tr><tr><td>__version__</td></tr><tr><td>_checks</td></tr><tr><td>noqa</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#BaseReport">BaseReport</a></td> +<td>Collect the results of the checks.</td> +</tr><tr> +<td><a href="#Checker">Checker</a></td> +<td>Load a Python source file, tokenize it, check coding style.</td> +</tr><tr> +<td><a href="#DiffReport">DiffReport</a></td> +<td>Collect and print the results for the changed lines only.</td> +</tr><tr> +<td><a href="#FileReport">FileReport</a></td> +<td>Collect the results of the checks and print only the filenames.</td> +</tr><tr> +<td><a href="#StandardReport">StandardReport</a></td> +<td>Collect and print the results of the checks.</td> +</tr><tr> +<td><a href="#StyleGuide">StyleGuide</a></td> +<td>Initialize a PEP-8 instance with few options.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr> +<td><a href="#_add_check">_add_check</a></td> +<td></td> +</tr><tr> +<td><a href="#_main">_main</a></td> +<td>Parse options and run checks on Python source.</td> +</tr><tr> +<td><a href="#blank_lines">blank_lines</a></td> +<td>Separate top-level function and class definitions with two blank lines.</td> +</tr><tr> +<td><a href="#comparison_to_singleton">comparison_to_singleton</a></td> +<td>Comparisons to singletons like None should always be done with "is" or "is not", never the equality operators.</td> +</tr><tr> +<td><a href="#comparison_type">comparison_type</a></td> +<td>Object type comparisons should always use isinstance() instead of comparing types directly.</td> +</tr><tr> +<td><a href="#compound_statements">compound_statements</a></td> +<td>Compound statements (multiple statements on the same line) are generally discouraged.</td> +</tr><tr> +<td><a href="#continued_indentation">continued_indentation</a></td> +<td>Continuation lines should align wrapped elements either vertically using Python's implicit line joining inside parentheses, brackets and braces, or using a hanging indent.</td> +</tr><tr> +<td><a href="#expand_indent">expand_indent</a></td> +<td>Return the amount of indentation.</td> +</tr><tr> +<td><a href="#explicit_line_join">explicit_line_join</a></td> +<td>Avoid explicit line join between brackets.</td> +</tr><tr> +<td><a href="#extraneous_whitespace">extraneous_whitespace</a></td> +<td>Avoid extraneous whitespace in the following situations:</td> +</tr><tr> +<td><a href="#filename_match">filename_match</a></td> +<td>Check if patterns contains a pattern that matches filename.</td> +</tr><tr> +<td><a href="#get_parser">get_parser</a></td> +<td></td> +</tr><tr> +<td><a href="#imports_on_separate_lines">imports_on_separate_lines</a></td> +<td>Imports should usually be on separate lines.</td> +</tr><tr> +<td><a href="#indentation">indentation</a></td> +<td>Use 4 spaces per indentation level.</td> +</tr><tr> +<td><a href="#init_checks_registry">init_checks_registry</a></td> +<td>Register all globally visible functions where the first argument name is 'physical_line' or 'logical_line'.</td> +</tr><tr> +<td><a href="#maximum_line_length">maximum_line_length</a></td> +<td>Limit all lines to a maximum of 79 characters.</td> +</tr><tr> +<td><a href="#missing_newline">missing_newline</a></td> +<td>JCR: The last line should have a newline.</td> +</tr><tr> +<td><a href="#missing_whitespace">missing_whitespace</a></td> +<td>JCR: Each comma, semicolon or colon should be followed by whitespace.</td> +</tr><tr> +<td><a href="#missing_whitespace_around_operator">missing_whitespace_around_operator</a></td> +<td>- Always surround these binary operators with a single space on either side: assignment (=), augmented assignment (+=, -= etc.), comparisons (==, <, >, !=, <>, <=, >=, in, not in, is, is not), Booleans (and, or, not).</td> +</tr><tr> +<td><a href="#mute_string">mute_string</a></td> +<td>Replace contents with 'xxx' to prevent syntax matching.</td> +</tr><tr> +<td><a href="#parse_udiff">parse_udiff</a></td> +<td>Return a dictionary of matching lines.</td> +</tr><tr> +<td><a href="#process_options">process_options</a></td> +<td>Process options passed either via arglist or via command line args.</td> +</tr><tr> +<td><a href="#python_3000_backticks">python_3000_backticks</a></td> +<td>Backticks are removed in Python 3.</td> +</tr><tr> +<td><a href="#python_3000_has_key">python_3000_has_key</a></td> +<td>The {}.has_key() method is removed in the Python 3.</td> +</tr><tr> +<td><a href="#python_3000_not_equal">python_3000_not_equal</a></td> +<td>!= can also be written <>, but this is an obsolete usage kept for backwards compatibility only.</td> +</tr><tr> +<td><a href="#python_3000_raise_comma">python_3000_raise_comma</a></td> +<td>When raising an exception, use "raise ValueError('message')" instead of the older form "raise ValueError, 'message'".</td> +</tr><tr> +<td><a href="#read_config">read_config</a></td> +<td>Read both user configuration and local configuration.</td> +</tr><tr> +<td><a href="#readlines">readlines</a></td> +<td></td> +</tr><tr> +<td><a href="#readlines_1">readlines</a></td> +<td></td> +</tr><tr> +<td><a href="#register_check">register_check</a></td> +<td>Register a new check object.</td> +</tr><tr> +<td><a href="#stdin_get_value">stdin_get_value</a></td> +<td></td> +</tr><tr> +<td><a href="#tabs_obsolete">tabs_obsolete</a></td> +<td>For new projects, spaces-only are strongly recommended over tabs.</td> +</tr><tr> +<td><a href="#tabs_or_spaces">tabs_or_spaces</a></td> +<td>Never mix tabs and spaces.</td> +</tr><tr> +<td><a href="#trailing_blank_lines">trailing_blank_lines</a></td> +<td>JCR: Trailing blank lines are superfluous.</td> +</tr><tr> +<td><a href="#trailing_whitespace">trailing_whitespace</a></td> +<td>JCR: Trailing whitespace is superfluous.</td> +</tr><tr> +<td><a href="#whitespace_around_comma">whitespace_around_comma</a></td> +<td>Avoid extraneous whitespace in the following situations:</td> +</tr><tr> +<td><a href="#whitespace_around_keywords">whitespace_around_keywords</a></td> +<td>Avoid extraneous whitespace around keywords.</td> +</tr><tr> +<td><a href="#whitespace_around_named_parameter_equals">whitespace_around_named_parameter_equals</a></td> +<td>Don't use spaces around the '=' sign when used to indicate a keyword argument or a default parameter value.</td> +</tr><tr> +<td><a href="#whitespace_around_operator">whitespace_around_operator</a></td> +<td>Avoid extraneous whitespace in the following situations:</td> +</tr><tr> +<td><a href="#whitespace_before_inline_comment">whitespace_before_inline_comment</a></td> +<td>Separate inline comments by at least two spaces.</td> +</tr><tr> +<td><a href="#whitespace_before_parameters">whitespace_before_parameters</a></td> +<td>Avoid extraneous whitespace in the following situations:</td> +</tr> +</table> +<hr /><hr /> +<a NAME="BaseReport" ID="BaseReport"></a> +<h2>BaseReport</h2> +<p> +Collect the results of the checks. +</p> +<h3>Derived from</h3> +object +<h3>Class Attributes</h3> +<table> +<tr><td>print_filename</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#BaseReport.__init__">BaseReport</a></td> +<td></td> +</tr><tr> +<td><a href="#BaseReport.error">error</a></td> +<td>Report an error, according to options.</td> +</tr><tr> +<td><a href="#BaseReport.error_args">error_args</a></td> +<td>Report an error, according to options.</td> +</tr><tr> +<td><a href="#BaseReport.get_count">get_count</a></td> +<td>Return the total count of errors and warnings.</td> +</tr><tr> +<td><a href="#BaseReport.get_file_results">get_file_results</a></td> +<td>Return the count of errors and warnings for this file.</td> +</tr><tr> +<td><a href="#BaseReport.get_statistics">get_statistics</a></td> +<td>Get statistics for message codes that start with the prefix.</td> +</tr><tr> +<td><a href="#BaseReport.increment_logical_line">increment_logical_line</a></td> +<td>Signal a new logical line.</td> +</tr><tr> +<td><a href="#BaseReport.init_file">init_file</a></td> +<td>Signal a new file.</td> +</tr><tr> +<td><a href="#BaseReport.print_benchmark">print_benchmark</a></td> +<td>Print benchmark numbers.</td> +</tr><tr> +<td><a href="#BaseReport.print_statistics">print_statistics</a></td> +<td>Print overall statistics (number of errors and warnings).</td> +</tr><tr> +<td><a href="#BaseReport.start">start</a></td> +<td>Start the timer.</td> +</tr><tr> +<td><a href="#BaseReport.stop">stop</a></td> +<td>Stop the timer.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="BaseReport.__init__" ID="BaseReport.__init__"></a> +<h4>BaseReport (Constructor)</h4> +<b>BaseReport</b>(<i>options</i>) +<a NAME="BaseReport.error" ID="BaseReport.error"></a> +<h4>BaseReport.error</h4> +<b>error</b>(<i>line_number, offset, text, check</i>) +<p> +Report an error, according to options. +</p><a NAME="BaseReport.error_args" ID="BaseReport.error_args"></a> +<h4>BaseReport.error_args</h4> +<b>error_args</b>(<i>line_number, offset, code, check, *args</i>) +<p> +Report an error, according to options. +</p><a NAME="BaseReport.get_count" ID="BaseReport.get_count"></a> +<h4>BaseReport.get_count</h4> +<b>get_count</b>(<i>prefix=''</i>) +<p> +Return the total count of errors and warnings. +</p><a NAME="BaseReport.get_file_results" ID="BaseReport.get_file_results"></a> +<h4>BaseReport.get_file_results</h4> +<b>get_file_results</b>(<i></i>) +<p> +Return the count of errors and warnings for this file. +</p><a NAME="BaseReport.get_statistics" ID="BaseReport.get_statistics"></a> +<h4>BaseReport.get_statistics</h4> +<b>get_statistics</b>(<i>prefix=''</i>) +<p> + Get statistics for message codes that start with the prefix. +</p><p> + prefix='' matches all errors and warnings + prefix='E' matches all errors + prefix='W' matches all warnings + prefix='E4' matches all errors that have to do with imports +</p><a NAME="BaseReport.increment_logical_line" ID="BaseReport.increment_logical_line"></a> +<h4>BaseReport.increment_logical_line</h4> +<b>increment_logical_line</b>(<i></i>) +<p> +Signal a new logical line. +</p><a NAME="BaseReport.init_file" ID="BaseReport.init_file"></a> +<h4>BaseReport.init_file</h4> +<b>init_file</b>(<i>filename, lines, expected, line_offset</i>) +<p> +Signal a new file. +</p><a NAME="BaseReport.print_benchmark" ID="BaseReport.print_benchmark"></a> +<h4>BaseReport.print_benchmark</h4> +<b>print_benchmark</b>(<i></i>) +<p> +Print benchmark numbers. +</p><a NAME="BaseReport.print_statistics" ID="BaseReport.print_statistics"></a> +<h4>BaseReport.print_statistics</h4> +<b>print_statistics</b>(<i>prefix=''</i>) +<p> +Print overall statistics (number of errors and warnings). +</p><a NAME="BaseReport.start" ID="BaseReport.start"></a> +<h4>BaseReport.start</h4> +<b>start</b>(<i></i>) +<p> +Start the timer. +</p><a NAME="BaseReport.stop" ID="BaseReport.stop"></a> +<h4>BaseReport.stop</h4> +<b>stop</b>(<i></i>) +<p> +Stop the timer. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="Checker" ID="Checker"></a> +<h2>Checker</h2> +<p> + Load a Python source file, tokenize it, check coding style. +</p> +<h3>Derived from</h3> +object +<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="#Checker.__init__">Checker</a></td> +<td></td> +</tr><tr> +<td><a href="#Checker.build_tokens_line">build_tokens_line</a></td> +<td>Build a logical line from tokens.</td> +</tr><tr> +<td><a href="#Checker.check_all">check_all</a></td> +<td>Run all checks on the input file.</td> +</tr><tr> +<td><a href="#Checker.check_ast">check_ast</a></td> +<td></td> +</tr><tr> +<td><a href="#Checker.check_logical">check_logical</a></td> +<td>Build a line from tokens and run all logical checks on it.</td> +</tr><tr> +<td><a href="#Checker.check_physical">check_physical</a></td> +<td>Run all physical checks on a raw input line.</td> +</tr><tr> +<td><a href="#Checker.generate_tokens">generate_tokens</a></td> +<td></td> +</tr><tr> +<td><a href="#Checker.readline">readline</a></td> +<td>Get the next line from the input buffer.</td> +</tr><tr> +<td><a href="#Checker.readline_check_physical">readline_check_physical</a></td> +<td>Check and return the next physical line.</td> +</tr><tr> +<td><a href="#Checker.report_invalid_syntax">report_invalid_syntax</a></td> +<td></td> +</tr><tr> +<td><a href="#Checker.run_check">run_check</a></td> +<td>Run a check plugin.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="Checker.__init__" ID="Checker.__init__"></a> +<h4>Checker (Constructor)</h4> +<b>Checker</b>(<i>filename=None, lines=None, options=None, report=None, **kwargs</i>) +<a NAME="Checker.build_tokens_line" ID="Checker.build_tokens_line"></a> +<h4>Checker.build_tokens_line</h4> +<b>build_tokens_line</b>(<i></i>) +<p> + Build a logical line from tokens. +</p><a NAME="Checker.check_all" ID="Checker.check_all"></a> +<h4>Checker.check_all</h4> +<b>check_all</b>(<i>expected=None, line_offset=0</i>) +<p> + Run all checks on the input file. +</p><a NAME="Checker.check_ast" ID="Checker.check_ast"></a> +<h4>Checker.check_ast</h4> +<b>check_ast</b>(<i></i>) +<a NAME="Checker.check_logical" ID="Checker.check_logical"></a> +<h4>Checker.check_logical</h4> +<b>check_logical</b>(<i></i>) +<p> + Build a line from tokens and run all logical checks on it. +</p><a NAME="Checker.check_physical" ID="Checker.check_physical"></a> +<h4>Checker.check_physical</h4> +<b>check_physical</b>(<i>line</i>) +<p> + Run all physical checks on a raw input line. +</p><a NAME="Checker.generate_tokens" ID="Checker.generate_tokens"></a> +<h4>Checker.generate_tokens</h4> +<b>generate_tokens</b>(<i></i>) +<a NAME="Checker.readline" ID="Checker.readline"></a> +<h4>Checker.readline</h4> +<b>readline</b>(<i></i>) +<p> + Get the next line from the input buffer. +</p><a NAME="Checker.readline_check_physical" ID="Checker.readline_check_physical"></a> +<h4>Checker.readline_check_physical</h4> +<b>readline_check_physical</b>(<i></i>) +<p> + Check and return the next physical line. This method can be + used to feed tokenize.generate_tokens. +</p><a NAME="Checker.report_invalid_syntax" ID="Checker.report_invalid_syntax"></a> +<h4>Checker.report_invalid_syntax</h4> +<b>report_invalid_syntax</b>(<i></i>) +<a NAME="Checker.run_check" ID="Checker.run_check"></a> +<h4>Checker.run_check</h4> +<b>run_check</b>(<i>check, argument_names</i>) +<p> + Run a check plugin. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="DiffReport" ID="DiffReport"></a> +<h2>DiffReport</h2> +<p> +Collect and print the results for the changed lines only. +</p> +<h3>Derived from</h3> +StandardReport +<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="#DiffReport.__init__">DiffReport</a></td> +<td></td> +</tr><tr> +<td><a href="#DiffReport.error">error</a></td> +<td></td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="DiffReport.__init__" ID="DiffReport.__init__"></a> +<h4>DiffReport (Constructor)</h4> +<b>DiffReport</b>(<i>options</i>) +<a NAME="DiffReport.error" ID="DiffReport.error"></a> +<h4>DiffReport.error</h4> +<b>error</b>(<i>line_number, offset, text, check</i>) + +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="FileReport" ID="FileReport"></a> +<h2>FileReport</h2> +<p> +Collect the results of the checks and print only the filenames. +</p> +<h3>Derived from</h3> +BaseReport +<h3>Class Attributes</h3> +<table> +<tr><td>print_filename</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 /><hr /> +<a NAME="StandardReport" ID="StandardReport"></a> +<h2>StandardReport</h2> +<p> +Collect and print the results of the checks. +</p> +<h3>Derived from</h3> +BaseReport +<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="#StandardReport.__init__">StandardReport</a></td> +<td></td> +</tr><tr> +<td><a href="#StandardReport.error">error</a></td> +<td>Report an error, according to options.</td> +</tr><tr> +<td><a href="#StandardReport.error_args">error_args</a></td> +<td>Report an error, according to options.</td> +</tr><tr> +<td><a href="#StandardReport.get_file_results">get_file_results</a></td> +<td>Print the result and return the overall count for this file.</td> +</tr><tr> +<td><a href="#StandardReport.init_file">init_file</a></td> +<td>Signal a new file.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="StandardReport.__init__" ID="StandardReport.__init__"></a> +<h4>StandardReport (Constructor)</h4> +<b>StandardReport</b>(<i>options</i>) +<a NAME="StandardReport.error" ID="StandardReport.error"></a> +<h4>StandardReport.error</h4> +<b>error</b>(<i>line_number, offset, text, check</i>) +<p> +Report an error, according to options. +</p><a NAME="StandardReport.error_args" ID="StandardReport.error_args"></a> +<h4>StandardReport.error_args</h4> +<b>error_args</b>(<i>line_number, offset, code, check, *args</i>) +<p> +Report an error, according to options. +</p><a NAME="StandardReport.get_file_results" ID="StandardReport.get_file_results"></a> +<h4>StandardReport.get_file_results</h4> +<b>get_file_results</b>(<i></i>) +<p> +Print the result and return the overall count for this file. +</p><a NAME="StandardReport.init_file" ID="StandardReport.init_file"></a> +<h4>StandardReport.init_file</h4> +<b>init_file</b>(<i>filename, lines, expected, line_offset</i>) +<p> +Signal a new file. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="StyleGuide" ID="StyleGuide"></a> +<h2>StyleGuide</h2> +<p> +Initialize a PEP-8 instance with few options. +</p> +<h3>Derived from</h3> +object +<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="#StyleGuide.__init__">StyleGuide</a></td> +<td></td> +</tr><tr> +<td><a href="#StyleGuide.check_files">check_files</a></td> +<td>Run all checks on the paths.</td> +</tr><tr> +<td><a href="#StyleGuide.excluded">excluded</a></td> +<td>Check if options.exclude contains a pattern that matches filename.</td> +</tr><tr> +<td><a href="#StyleGuide.get_checks">get_checks</a></td> +<td>Find all globally visible functions where the first argument name starts with argument_name and which contain selected tests.</td> +</tr><tr> +<td><a href="#StyleGuide.ignore_code">ignore_code</a></td> +<td>Check if the error code should be ignored.</td> +</tr><tr> +<td><a href="#StyleGuide.init_report">init_report</a></td> +<td>Initialize the report instance.</td> +</tr><tr> +<td><a href="#StyleGuide.input_dir">input_dir</a></td> +<td>Check all files in this directory and all subdirectories.</td> +</tr><tr> +<td><a href="#StyleGuide.input_file">input_file</a></td> +<td>Run all checks on a Python source file.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="StyleGuide.__init__" ID="StyleGuide.__init__"></a> +<h4>StyleGuide (Constructor)</h4> +<b>StyleGuide</b>(<i>*args, **kwargs</i>) +<a NAME="StyleGuide.check_files" ID="StyleGuide.check_files"></a> +<h4>StyleGuide.check_files</h4> +<b>check_files</b>(<i>paths=None</i>) +<p> +Run all checks on the paths. +</p><a NAME="StyleGuide.excluded" ID="StyleGuide.excluded"></a> +<h4>StyleGuide.excluded</h4> +<b>excluded</b>(<i>filename, parent=None</i>) +<p> + Check if options.exclude contains a pattern that matches filename. +</p><a NAME="StyleGuide.get_checks" ID="StyleGuide.get_checks"></a> +<h4>StyleGuide.get_checks</h4> +<b>get_checks</b>(<i>argument_name</i>) +<p> + Find all globally visible functions where the first argument name + starts with argument_name and which contain selected tests. +</p><a NAME="StyleGuide.ignore_code" ID="StyleGuide.ignore_code"></a> +<h4>StyleGuide.ignore_code</h4> +<b>ignore_code</b>(<i>code</i>) +<p> + Check if the error code should be ignored. +</p><p> + If 'options.select' contains a prefix of the error code, + return False. Else, if 'options.ignore' contains a prefix of + the error code, return True. +</p><a NAME="StyleGuide.init_report" ID="StyleGuide.init_report"></a> +<h4>StyleGuide.init_report</h4> +<b>init_report</b>(<i>reporter=None</i>) +<p> +Initialize the report instance. +</p><a NAME="StyleGuide.input_dir" ID="StyleGuide.input_dir"></a> +<h4>StyleGuide.input_dir</h4> +<b>input_dir</b>(<i>dirname</i>) +<p> +Check all files in this directory and all subdirectories. +</p><a NAME="StyleGuide.input_file" ID="StyleGuide.input_file"></a> +<h4>StyleGuide.input_file</h4> +<b>input_file</b>(<i>filename, lines=None, expected=None, line_offset=0</i>) +<p> +Run all checks on a Python source file. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="_add_check" ID="_add_check"></a> +<h2>_add_check</h2> +<b>_add_check</b>(<i>check, kind, codes, args</i>) + +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="_main" ID="_main"></a> +<h2>_main</h2> +<b>_main</b>(<i></i>) +<p> +Parse options and run checks on Python source. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="blank_lines" ID="blank_lines"></a> +<h2>blank_lines</h2> +<b>blank_lines</b>(<i>logical_line, blank_lines, indent_level, line_number, previous_logical, previous_indent_level</i>) +<p> + Separate top-level function and class definitions with two blank lines. +</p><p> + Method definitions inside a class are separated by a single blank line. +</p><p> + Extra blank lines may be used (sparingly) to separate groups of related + functions. Blank lines may be omitted between a bunch of related + one-liners (e.g. a set of dummy implementations). +</p><p> + Use blank lines in functions, sparingly, to indicate logical sections. +</p><p> + Okay: def a():\n pass\n\n\ndef b():\n pass + Okay: def a():\n pass\n\n\n# Foo\n# Bar\n\ndef b():\n pass +</p><p> + E301: class Foo:\n b = 0\n def bar():\n pass + E302: def a():\n pass\n\ndef b(n):\n pass + E303: def a():\n pass\n\n\n\ndef b(n):\n pass + E303: def a():\n\n\n\n pass + E304: @decorator\n\ndef a():\n pass +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="comparison_to_singleton" ID="comparison_to_singleton"></a> +<h2>comparison_to_singleton</h2> +<b>comparison_to_singleton</b>(<i>logical_line, noqa</i>) +<p> + Comparisons to singletons like None should always be done + with "is" or "is not", never the equality operators. +</p><p> + Okay: if arg is not None: + E711: if arg != None: + E712: if arg == True: +</p><p> + Also, beware of writing if x when you really mean if x is not None -- + e.g. when testing whether a variable or argument that defaults to None was + set to some other value. The other value might have a type (such as a + container) that could be false in a boolean context! +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="comparison_type" ID="comparison_type"></a> +<h2>comparison_type</h2> +<b>comparison_type</b>(<i>logical_line</i>) +<p> + Object type comparisons should always use isinstance() instead of + comparing types directly. +</p><p> + Okay: if isinstance(obj, int): + E721: if type(obj) is type(1): +</p><p> + When checking if an object is a string, keep in mind that it might be a + unicode string too! In Python 2.3, str and unicode have a common base + class, basestring, so you can do: +</p><p> + Okay: if isinstance(obj, basestring): + Okay: if type(a1) is type(b1): +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="compound_statements" ID="compound_statements"></a> +<h2>compound_statements</h2> +<b>compound_statements</b>(<i>logical_line</i>) +<p> + Compound statements (multiple statements on the same line) are + generally discouraged. +</p><p> + While sometimes it's okay to put an if/for/while with a small body + on the same line, never do this for multi-clause statements. Also + avoid folding such long lines! +</p><p> + Okay: if foo == 'blah':\n do_blah_thing() + Okay: do_one() + Okay: do_two() + Okay: do_three() +</p><p> + E701: if foo == 'blah': do_blah_thing() + E701: for x in lst: total += x + E701: while t < 10: t = delay() + E701: if foo == 'blah': do_blah_thing() + E701: else: do_non_blah_thing() + E701: try: something() + E701: finally: cleanup() + E701: if foo == 'blah': one(); two(); three() +</p><p> + E702: do_one(); do_two(); do_three() + E703: do_four(); # useless semicolon +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="continued_indentation" ID="continued_indentation"></a> +<h2>continued_indentation</h2> +<b>continued_indentation</b>(<i>logical_line, tokens, indent_level, hang_closing, noqa, verbose</i>) +<p> + Continuation lines should align wrapped elements either vertically using + Python's implicit line joining inside parentheses, brackets and braces, or + using a hanging indent. +</p><p> + When using a hanging indent the following considerations should be applied: +</p><p> + - there should be no arguments on the first line, and +</p><p> + - further indentation should be used to clearly distinguish itself as a + continuation line. +</p><p> + Okay: a = (\n) + E123: a = (\n ) +</p><p> + Okay: a = (\n 42) + E121: a = (\n 42) + E122: a = (\n42) + E123: a = (\n 42\n ) + E124: a = (24,\n 42\n) + E125: if (a or\n b):\n pass + E126: a = (\n 42) + E127: a = (24,\n 42) + E128: a = (24,\n 42) +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="expand_indent" ID="expand_indent"></a> +<h2>expand_indent</h2> +<b>expand_indent</b>(<i>line</i>) +<p> + Return the amount of indentation. + Tabs are expanded to the next multiple of 8. +</p><p> + >>> expand_indent(' ') + 4 + >>> expand_indent('\t') + 8 + >>> expand_indent(' \t') + 8 + >>> expand_indent(' \t') + 8 + >>> expand_indent(' \t') + 16 +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="explicit_line_join" ID="explicit_line_join"></a> +<h2>explicit_line_join</h2> +<b>explicit_line_join</b>(<i>logical_line, tokens</i>) +<p> + Avoid explicit line join between brackets. +</p><p> + The preferred way of wrapping long lines is by using Python's implied line + continuation inside parentheses, brackets and braces. Long lines can be + broken over multiple lines by wrapping expressions in parentheses. These + should be used in preference to using a backslash for line continuation. +</p><p> + E502: aaa = [123, \\n 123] + E502: aaa = ("bbb " \\n "ccc") +</p><p> + Okay: aaa = [123,\n 123] + Okay: aaa = ("bbb "\n "ccc") + Okay: aaa = "bbb " \\n "ccc" +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="extraneous_whitespace" ID="extraneous_whitespace"></a> +<h2>extraneous_whitespace</h2> +<b>extraneous_whitespace</b>(<i>logical_line</i>) +<p> + Avoid extraneous whitespace in the following situations: +</p><p> + - Immediately inside parentheses, brackets or braces. +</p><p> + - Immediately before a comma, semicolon, or colon. +</p><p> + Okay: spam(ham[1], {eggs: 2}) + E201: spam( ham[1], {eggs: 2}) + E201: spam(ham[ 1], {eggs: 2}) + E201: spam(ham[1], { eggs: 2}) + E202: spam(ham[1], {eggs: 2} ) + E202: spam(ham[1 ], {eggs: 2}) + E202: spam(ham[1], {eggs: 2 }) +</p><p> + E203: if x == 4: print x, y; x, y = y , x + E203: if x == 4: print x, y ; x, y = y, x + E203: if x == 4 : print x, y; x, y = y, x +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="filename_match" ID="filename_match"></a> +<h2>filename_match</h2> +<b>filename_match</b>(<i>filename, patterns, default=True</i>) +<p> + Check if patterns contains a pattern that matches filename. + If patterns is unspecified, this always returns True. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="get_parser" ID="get_parser"></a> +<h2>get_parser</h2> +<b>get_parser</b>(<i>prog='pep8', version=__version__</i>) + +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="imports_on_separate_lines" ID="imports_on_separate_lines"></a> +<h2>imports_on_separate_lines</h2> +<b>imports_on_separate_lines</b>(<i>logical_line</i>) +<p> + Imports should usually be on separate lines. +</p><p> + Okay: import os\nimport sys + E401: import sys, os +</p><p> + Okay: from subprocess import Popen, PIPE + Okay: from myclas import MyClass + Okay: from foo.bar.yourclass import YourClass + Okay: import myclass + Okay: import foo.bar.yourclass +</p> +<div align="right"><a