Tue, 13 Oct 2020 19:02:26 +0200
Finished refactoring the code style checker.
--- a/eric6.e4p Tue Oct 13 18:23:53 2020 +0200 +++ b/eric6.e4p Tue Oct 13 19:02:26 2020 +0200 @@ -320,9 +320,15 @@ <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/Complexity/ComplexityChecker.py</Source> <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/Complexity/__init__.py</Source> <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/Complexity/translations.py</Source> - <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/DocStyleChecker.py</Source> - <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/MiscellaneousChecker.py</Source> - <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/NamingStyleChecker.py</Source> + <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/DocStyle/DocStyleChecker.py</Source> + <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/DocStyle/__init__.py</Source> + <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/DocStyle/translations.py</Source> + <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/Miscellaneous/MiscellaneousChecker.py</Source> + <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/Miscellaneous/__init__.py</Source> + <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/Miscellaneous/translations.py</Source> + <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/Naming/NamingStyleChecker.py</Source> + <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/Naming/__init__.py</Source> + <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/Naming/translations.py</Source> <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/Security/Checks/__init__.py</Source> <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/Security/Checks/assert.py</Source> <Source>eric6/Plugins/CheckerPlugins/CodeStyleChecker/Security/Checks/awsHardcodedPassword.py</Source>
--- a/eric6/APIs/Python3/eric6.api Tue Oct 13 18:23:53 2020 +0200 +++ b/eric6/APIs/Python3/eric6.api Tue Oct 13 19:02:26 2020 +0200 @@ -2912,15 +2912,17 @@ eric6.Plugins.AboutPlugin.AboutDialog.licenseText?7 eric6.Plugins.AboutPlugin.AboutDialog.thanksText?7 eric6.Plugins.AboutPlugin.AboutDialog.titleText?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.AnnotationsChecker.Codes?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.AnnotationsChecker.run?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.AnnotationsChecker?1(source, filename, select, ignore, expected, repeat, args) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.FunctionVisitor.visit_AsyncFunctionDef?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.FunctionVisitor.visit_ClassDef?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.FunctionVisitor.visit_FunctionDef?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.FunctionVisitor?1(sourceLines) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.getAnnotationComplexity?4(annotationNode) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.hasTypeAnnotations?4(funcNode) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.AnnotationsChecker.Codes?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.AnnotationsChecker.run?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.AnnotationsChecker?1(source, filename, select, ignore, expected, repeat, args) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.FunctionVisitor.visit_AsyncFunctionDef?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.FunctionVisitor.visit_ClassDef?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.FunctionVisitor.visit_FunctionDef?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.FunctionVisitor?1(sourceLines) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.getAnnotationComplexity?4(annotationNode) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.hasTypeAnnotations?4(funcNode) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.translations._annotationsMessages?8 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.translations._annotationsMessagesSampleArgs?8 eric6.Plugins.CheckerPlugins.CodeStyleChecker.AstUtilities.getValue?4(node) eric6.Plugins.CheckerPlugins.CodeStyleChecker.AstUtilities.isBaseString?4(node) eric6.Plugins.CheckerPlugins.CodeStyleChecker.AstUtilities.isBytes?4(node) @@ -2998,91 +3000,98 @@ eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.Reindenter.run?4() eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.Reindenter?1(sourceLines) eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleStatisticsDialog.CodeStyleStatisticsDialog?1(statistics, parent=None) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.ComplexityChecker.Codes?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.ComplexityChecker.run?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.ComplexityChecker?1(source, filename, select, ignore, args) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.LineComplexityVisitor.score?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.LineComplexityVisitor.sortedList?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.LineComplexityVisitor.visit?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.LineComplexityVisitor?1() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.DocStyleChecker.Codes?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.DocStyleChecker.run?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.DocStyleChecker?1(source, filename, select, ignore, expected, repeat, maxLineLength=79, docType="pep257") -eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.DocStyleContext.contextType?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.DocStyleContext.end?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.DocStyleContext.indent?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.DocStyleContext.setSpecial?4(special) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.DocStyleContext.source?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.DocStyleContext.special?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.DocStyleContext.ssource?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.DocStyleContext.start?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.DocStyleContext?1(source, startLine, contextType) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.BugBearVisitor.NodeWindowSize?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.BugBearVisitor.visit?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.BugBearVisitor.visit_Assert?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.BugBearVisitor.visit_Assign?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.BugBearVisitor.visit_AsyncFor?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.BugBearVisitor.visit_Attribute?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.BugBearVisitor.visit_Call?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.BugBearVisitor.visit_For?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.BugBearVisitor.visit_JoinedStr?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.BugBearVisitor.visit_UAdd?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.BugBearVisitor?1() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.DateTimeVisitor.visit_Call?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.DateTimeVisitor?1() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.LoggingVisitor.LoggingLevels?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.LoggingVisitor.visit_BinOp?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.LoggingVisitor.visit_Call?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.LoggingVisitor.visit_JoinedStr?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.LoggingVisitor?1() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.MiscellaneousChecker.BuiltinsWhiteList?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.MiscellaneousChecker.Codes?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.MiscellaneousChecker.FormatFieldRegex?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.MiscellaneousChecker.Formatter?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.MiscellaneousChecker.run?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.MiscellaneousChecker?1(source, filename, select, ignore, expected, repeat, args) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.NameFinder.getNames?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.NameFinder.visit?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.NameFinder.visit_Name?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.NameFinder?1() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.ReturnVisitor.Assigns?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.ReturnVisitor.Refs?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.ReturnVisitor.Returns?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.ReturnVisitor.assigns?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.ReturnVisitor.refs?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.ReturnVisitor.returns?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.ReturnVisitor.visit_Assign?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.ReturnVisitor.visit_AsyncFor?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.ReturnVisitor.visit_AsyncFunctionDef?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.ReturnVisitor.visit_For?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.ReturnVisitor.visit_FunctionDef?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.ReturnVisitor.visit_Name?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.ReturnVisitor.visit_Return?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.ReturnVisitor.visit_While?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.ReturnVisitor?1() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.SysVersionVisitor.visit_Attribute?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.SysVersionVisitor.visit_Compare?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.SysVersionVisitor.visit_ImportFrom?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.SysVersionVisitor.visit_Name?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.SysVersionVisitor.visit_Subscript?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.SysVersionVisitor?1() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.TextVisitor.visit_AsyncFunctionDef?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.TextVisitor.visit_Bytes?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.TextVisitor.visit_Call?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.TextVisitor.visit_ClassDef?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.TextVisitor.visit_Constant?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.TextVisitor.visit_FunctionDef?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.TextVisitor.visit_Module?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.TextVisitor.visit_Str?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.TextVisitor?1() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.composeCallPath?4(node) -eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.NamingStyleChecker.CamelcaseRegexp?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.NamingStyleChecker.Codes?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.NamingStyleChecker.LowercaseRegex?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.NamingStyleChecker.MixedcaseRegexp?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.NamingStyleChecker.UppercaseRegexp?7 -eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.NamingStyleChecker.run?4() -eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.NamingStyleChecker?1(tree, filename, options) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.ComplexityChecker.Codes?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.ComplexityChecker.run?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.ComplexityChecker?1(source, filename, select, ignore, args) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.LineComplexityVisitor.score?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.LineComplexityVisitor.sortedList?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.LineComplexityVisitor.visit?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.LineComplexityVisitor?1() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.translations._complexityMessages?8 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.translations._complexityMessagesSampleArgs?8 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.DocStyleChecker.Codes?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.DocStyleChecker.run?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.DocStyleChecker?1(source, filename, select, ignore, expected, repeat, maxLineLength=79, docType="pep257") +eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.DocStyleContext.contextType?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.DocStyleContext.end?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.DocStyleContext.indent?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.DocStyleContext.setSpecial?4(special) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.DocStyleContext.source?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.DocStyleContext.special?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.DocStyleContext.ssource?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.DocStyleContext.start?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.DocStyleContext?1(source, startLine, contextType) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.translations._docStyleMessages?8 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.translations._docStyleMessagesSampleArgs?8 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.BugBearVisitor.NodeWindowSize?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.BugBearVisitor.visit?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.BugBearVisitor.visit_Assert?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.BugBearVisitor.visit_Assign?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.BugBearVisitor.visit_AsyncFor?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.BugBearVisitor.visit_Attribute?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.BugBearVisitor.visit_Call?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.BugBearVisitor.visit_For?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.BugBearVisitor.visit_JoinedStr?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.BugBearVisitor.visit_UAdd?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.BugBearVisitor?1() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.DateTimeVisitor.visit_Call?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.DateTimeVisitor?1() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.LoggingVisitor.LoggingLevels?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.LoggingVisitor.visit_BinOp?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.LoggingVisitor.visit_Call?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.LoggingVisitor.visit_JoinedStr?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.LoggingVisitor?1() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.MiscellaneousChecker.BuiltinsWhiteList?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.MiscellaneousChecker.Codes?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.MiscellaneousChecker.FormatFieldRegex?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.MiscellaneousChecker.Formatter?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.MiscellaneousChecker.run?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.MiscellaneousChecker?1(source, filename, select, ignore, expected, repeat, args) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.NameFinder.getNames?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.NameFinder.visit?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.NameFinder.visit_Name?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.NameFinder?1() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.ReturnVisitor.Assigns?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.ReturnVisitor.Refs?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.ReturnVisitor.Returns?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.ReturnVisitor.assigns?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.ReturnVisitor.refs?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.ReturnVisitor.returns?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.ReturnVisitor.visit_Assign?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.ReturnVisitor.visit_AsyncFor?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.ReturnVisitor.visit_AsyncFunctionDef?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.ReturnVisitor.visit_For?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.ReturnVisitor.visit_FunctionDef?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.ReturnVisitor.visit_Name?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.ReturnVisitor.visit_Return?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.ReturnVisitor.visit_While?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.ReturnVisitor?1() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.SysVersionVisitor.visit_Attribute?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.SysVersionVisitor.visit_Compare?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.SysVersionVisitor.visit_ImportFrom?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.SysVersionVisitor.visit_Name?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.SysVersionVisitor.visit_Subscript?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.SysVersionVisitor?1() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.TextVisitor.visit_AsyncFunctionDef?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.TextVisitor.visit_Bytes?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.TextVisitor.visit_Call?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.TextVisitor.visit_ClassDef?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.TextVisitor.visit_Constant?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.TextVisitor.visit_FunctionDef?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.TextVisitor.visit_Module?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.TextVisitor.visit_Str?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.TextVisitor?1() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.composeCallPath?4(node) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.translations._miscellaneousMessages?8 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.translations._miscellaneousMessagesSampleArgs?8 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.NamingStyleChecker.CamelcaseRegexp?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.NamingStyleChecker.Codes?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.NamingStyleChecker.LowercaseRegex?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.NamingStyleChecker.MixedcaseRegexp?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.NamingStyleChecker.UppercaseRegexp?7 +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.NamingStyleChecker.run?4() +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.NamingStyleChecker?1(tree, filename, options) +eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.translations._namingStyleMessages?8 eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.assert.checkAssertUsed?4(reportError, context, config) eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.assert.getChecks?4() eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.awsHardcodedPassword.AWS_ACCESS_KEY_ID_MAX_ENTROPY?7
--- a/eric6/Documentation/Help/source.qhp Tue Oct 13 18:23:53 2020 +0200 +++ b/eric6/Documentation/Help/source.qhp Tue Oct 13 19:02:26 2020 +0200 @@ -292,6 +292,26 @@ </section> <section title="eric6.Plugins.CheckerPlugins" ref="index-eric6.Plugins.CheckerPlugins.html"> <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker" ref="index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.html"> + <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations" ref="index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.html"> + <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html" /> + <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.translations" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.translations.html" /> + </section> + <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity" ref="index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.html"> + <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html" /> + <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.translations" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.translations.html" /> + </section> + <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle" ref="index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.html"> + <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html" /> + <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.translations" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.translations.html" /> + </section> + <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous" ref="index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.html"> + <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html" /> + <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.translations" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.translations.html" /> + </section> + <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming" ref="index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.html"> + <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html" /> + <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.translations" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.translations.html" /> + </section> <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security" ref="index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.html"> <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks" ref="index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.html"> <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.__init__" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.__init__.html" /> @@ -328,7 +348,6 @@ <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityUtils" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityUtils.html" /> <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.translations" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.translations.html" /> </section> - <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html" /> <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AstUtilities" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AstUtilities.html" /> <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleAddBuiltinIgnoreDialog" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleAddBuiltinIgnoreDialog.html" /> <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html" /> @@ -336,10 +355,6 @@ <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCodeSelectionDialog" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCodeSelectionDialog.html" /> <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html" /> <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleStatisticsDialog" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleStatisticsDialog.html" /> - <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html" /> - <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html" /> - <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html" /> - <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html" /> <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.eradicate" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.eradicate.html" /> <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.mccabe" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.mccabe.html" /> <section title="eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html" /> @@ -1691,17 +1706,18 @@ <keyword name="AddProjectDialog.getData" id="AddProjectDialog.getData" ref="eric6.MultiProject.AddProjectDialog.html#AddProjectDialog.getData" /> <keyword name="AddProjectDialog.on_filenamePicker_textChanged" id="AddProjectDialog.on_filenamePicker_textChanged" ref="eric6.MultiProject.AddProjectDialog.html#AddProjectDialog.on_filenamePicker_textChanged" /> <keyword name="AddProjectDialog.on_nameEdit_textChanged" id="AddProjectDialog.on_nameEdit_textChanged" ref="eric6.MultiProject.AddProjectDialog.html#AddProjectDialog.on_nameEdit_textChanged" /> - <keyword name="AnnotationsChecker" id="AnnotationsChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#AnnotationsChecker" /> - <keyword name="AnnotationsChecker (Constructor)" id="AnnotationsChecker (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#AnnotationsChecker.__init__" /> - <keyword name="AnnotationsChecker (Module)" id="AnnotationsChecker (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html" /> - <keyword name="AnnotationsChecker.__checkAnnotationComplexity" id="AnnotationsChecker.__checkAnnotationComplexity" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#AnnotationsChecker.__checkAnnotationComplexity" /> - <keyword name="AnnotationsChecker.__checkAnnotationsCoverage" id="AnnotationsChecker.__checkAnnotationsCoverage" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#AnnotationsChecker.__checkAnnotationsCoverage" /> - <keyword name="AnnotationsChecker.__checkFunctionAnnotations" id="AnnotationsChecker.__checkFunctionAnnotations" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#AnnotationsChecker.__checkFunctionAnnotations" /> - <keyword name="AnnotationsChecker.__error" id="AnnotationsChecker.__error" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#AnnotationsChecker.__error" /> - <keyword name="AnnotationsChecker.__generateTree" id="AnnotationsChecker.__generateTree" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#AnnotationsChecker.__generateTree" /> - <keyword name="AnnotationsChecker.__ignoreCode" id="AnnotationsChecker.__ignoreCode" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#AnnotationsChecker.__ignoreCode" /> - <keyword name="AnnotationsChecker.__reportInvalidSyntax" id="AnnotationsChecker.__reportInvalidSyntax" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#AnnotationsChecker.__reportInvalidSyntax" /> - <keyword name="AnnotationsChecker.run" id="AnnotationsChecker.run" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#AnnotationsChecker.run" /> + <keyword name="Annotations (Package)" id="Annotations (Package)" ref="index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.html" /> + <keyword name="AnnotationsChecker" id="AnnotationsChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#AnnotationsChecker" /> + <keyword name="AnnotationsChecker (Constructor)" id="AnnotationsChecker (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#AnnotationsChecker.__init__" /> + <keyword name="AnnotationsChecker (Module)" id="AnnotationsChecker (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html" /> + <keyword name="AnnotationsChecker.__checkAnnotationComplexity" id="AnnotationsChecker.__checkAnnotationComplexity" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#AnnotationsChecker.__checkAnnotationComplexity" /> + <keyword name="AnnotationsChecker.__checkAnnotationsCoverage" id="AnnotationsChecker.__checkAnnotationsCoverage" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#AnnotationsChecker.__checkAnnotationsCoverage" /> + <keyword name="AnnotationsChecker.__checkFunctionAnnotations" id="AnnotationsChecker.__checkFunctionAnnotations" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#AnnotationsChecker.__checkFunctionAnnotations" /> + <keyword name="AnnotationsChecker.__error" id="AnnotationsChecker.__error" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#AnnotationsChecker.__error" /> + <keyword name="AnnotationsChecker.__generateTree" id="AnnotationsChecker.__generateTree" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#AnnotationsChecker.__generateTree" /> + <keyword name="AnnotationsChecker.__ignoreCode" id="AnnotationsChecker.__ignoreCode" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#AnnotationsChecker.__ignoreCode" /> + <keyword name="AnnotationsChecker.__reportInvalidSyntax" id="AnnotationsChecker.__reportInvalidSyntax" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#AnnotationsChecker.__reportInvalidSyntax" /> + <keyword name="AnnotationsChecker.run" id="AnnotationsChecker.run" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#AnnotationsChecker.run" /> <keyword name="AppInfo (Module)" id="AppInfo (Module)" ref="eric6.Globals.AppInfo.html" /> <keyword name="ApplicationDiagramBuilder" id="ApplicationDiagramBuilder" ref="eric6.Graphics.ApplicationDiagramBuilder.html#ApplicationDiagramBuilder" /> <keyword name="ApplicationDiagramBuilder (Constructor)" id="ApplicationDiagramBuilder (Constructor)" ref="eric6.Graphics.ApplicationDiagramBuilder.html#ApplicationDiagramBuilder.__init__" /> @@ -2262,19 +2278,19 @@ <keyword name="BrowserSysPathItem" id="BrowserSysPathItem" ref="eric6.UI.BrowserModel.html#BrowserSysPathItem" /> <keyword name="BrowserSysPathItem (Constructor)" id="BrowserSysPathItem (Constructor)" ref="eric6.UI.BrowserModel.html#BrowserSysPathItem.__init__" /> <keyword name="BrowserSysPathItem.name" id="BrowserSysPathItem.name" ref="eric6.UI.BrowserModel.html#BrowserSysPathItem.name" /> - <keyword name="BugBearVisitor" id="BugBearVisitor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#BugBearVisitor" /> - <keyword name="BugBearVisitor (Constructor)" id="BugBearVisitor (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#BugBearVisitor.__init__" /> - <keyword name="BugBearVisitor.__checkForM502" id="BugBearVisitor.__checkForM502" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#BugBearVisitor.__checkForM502" /> - <keyword name="BugBearVisitor.__checkForM507" id="BugBearVisitor.__checkForM507" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#BugBearVisitor.__checkForM507" /> - <keyword name="BugBearVisitor.visit" id="BugBearVisitor.visit" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#BugBearVisitor.visit" /> - <keyword name="BugBearVisitor.visit_Assert" id="BugBearVisitor.visit_Assert" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#BugBearVisitor.visit_Assert" /> - <keyword name="BugBearVisitor.visit_Assign" id="BugBearVisitor.visit_Assign" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#BugBearVisitor.visit_Assign" /> - <keyword name="BugBearVisitor.visit_AsyncFor" id="BugBearVisitor.visit_AsyncFor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#BugBearVisitor.visit_AsyncFor" /> - <keyword name="BugBearVisitor.visit_Attribute" id="BugBearVisitor.visit_Attribute" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#BugBearVisitor.visit_Attribute" /> - <keyword name="BugBearVisitor.visit_Call" id="BugBearVisitor.visit_Call" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#BugBearVisitor.visit_Call" /> - <keyword name="BugBearVisitor.visit_For" id="BugBearVisitor.visit_For" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#BugBearVisitor.visit_For" /> - <keyword name="BugBearVisitor.visit_JoinedStr" id="BugBearVisitor.visit_JoinedStr" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#BugBearVisitor.visit_JoinedStr" /> - <keyword name="BugBearVisitor.visit_UAdd" id="BugBearVisitor.visit_UAdd" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#BugBearVisitor.visit_UAdd" /> + <keyword name="BugBearVisitor" id="BugBearVisitor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#BugBearVisitor" /> + <keyword name="BugBearVisitor (Constructor)" id="BugBearVisitor (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#BugBearVisitor.__init__" /> + <keyword name="BugBearVisitor.__checkForM502" id="BugBearVisitor.__checkForM502" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#BugBearVisitor.__checkForM502" /> + <keyword name="BugBearVisitor.__checkForM507" id="BugBearVisitor.__checkForM507" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#BugBearVisitor.__checkForM507" /> + <keyword name="BugBearVisitor.visit" id="BugBearVisitor.visit" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#BugBearVisitor.visit" /> + <keyword name="BugBearVisitor.visit_Assert" id="BugBearVisitor.visit_Assert" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#BugBearVisitor.visit_Assert" /> + <keyword name="BugBearVisitor.visit_Assign" id="BugBearVisitor.visit_Assign" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#BugBearVisitor.visit_Assign" /> + <keyword name="BugBearVisitor.visit_AsyncFor" id="BugBearVisitor.visit_AsyncFor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#BugBearVisitor.visit_AsyncFor" /> + <keyword name="BugBearVisitor.visit_Attribute" id="BugBearVisitor.visit_Attribute" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#BugBearVisitor.visit_Attribute" /> + <keyword name="BugBearVisitor.visit_Call" id="BugBearVisitor.visit_Call" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#BugBearVisitor.visit_Call" /> + <keyword name="BugBearVisitor.visit_For" id="BugBearVisitor.visit_For" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#BugBearVisitor.visit_For" /> + <keyword name="BugBearVisitor.visit_JoinedStr" id="BugBearVisitor.visit_JoinedStr" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#BugBearVisitor.visit_JoinedStr" /> + <keyword name="BugBearVisitor.visit_UAdd" id="BugBearVisitor.visit_UAdd" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#BugBearVisitor.visit_UAdd" /> <keyword name="CallStackViewer" id="CallStackViewer" ref="eric6.Debugger.CallStackViewer.html#CallStackViewer" /> <keyword name="CallStackViewer (Constructor)" id="CallStackViewer (Constructor)" ref="eric6.Debugger.CallStackViewer.html#CallStackViewer.__init__" /> <keyword name="CallStackViewer (Module)" id="CallStackViewer (Module)" ref="eric6.Debugger.CallStackViewer.html" /> @@ -2750,15 +2766,16 @@ <keyword name="CompleterYaml.__inComment" id="CompleterYaml.__inComment" ref="eric6.QScintilla.TypingCompleters.CompleterYaml.html#CompleterYaml.__inComment" /> <keyword name="CompleterYaml.charAdded" id="CompleterYaml.charAdded" ref="eric6.QScintilla.TypingCompleters.CompleterYaml.html#CompleterYaml.charAdded" /> <keyword name="CompleterYaml.readSettings" id="CompleterYaml.readSettings" ref="eric6.QScintilla.TypingCompleters.CompleterYaml.html#CompleterYaml.readSettings" /> - <keyword name="ComplexityChecker" id="ComplexityChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html#ComplexityChecker" /> - <keyword name="ComplexityChecker (Constructor)" id="ComplexityChecker (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html#ComplexityChecker.__init__" /> - <keyword name="ComplexityChecker (Module)" id="ComplexityChecker (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html" /> - <keyword name="ComplexityChecker.__checkLineComplexity" id="ComplexityChecker.__checkLineComplexity" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html#ComplexityChecker.__checkLineComplexity" /> - <keyword name="ComplexityChecker.__checkMcCabeComplexity" id="ComplexityChecker.__checkMcCabeComplexity" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html#ComplexityChecker.__checkMcCabeComplexity" /> - <keyword name="ComplexityChecker.__error" id="ComplexityChecker.__error" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html#ComplexityChecker.__error" /> - <keyword name="ComplexityChecker.__ignoreCode" id="ComplexityChecker.__ignoreCode" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html#ComplexityChecker.__ignoreCode" /> - <keyword name="ComplexityChecker.__reportInvalidSyntax" id="ComplexityChecker.__reportInvalidSyntax" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html#ComplexityChecker.__reportInvalidSyntax" /> - <keyword name="ComplexityChecker.run" id="ComplexityChecker.run" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html#ComplexityChecker.run" /> + <keyword name="Complexity (Package)" id="Complexity (Package)" ref="index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.html" /> + <keyword name="ComplexityChecker" id="ComplexityChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html#ComplexityChecker" /> + <keyword name="ComplexityChecker (Constructor)" id="ComplexityChecker (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html#ComplexityChecker.__init__" /> + <keyword name="ComplexityChecker (Module)" id="ComplexityChecker (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html" /> + <keyword name="ComplexityChecker.__checkLineComplexity" id="ComplexityChecker.__checkLineComplexity" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html#ComplexityChecker.__checkLineComplexity" /> + <keyword name="ComplexityChecker.__checkMcCabeComplexity" id="ComplexityChecker.__checkMcCabeComplexity" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html#ComplexityChecker.__checkMcCabeComplexity" /> + <keyword name="ComplexityChecker.__error" id="ComplexityChecker.__error" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html#ComplexityChecker.__error" /> + <keyword name="ComplexityChecker.__ignoreCode" id="ComplexityChecker.__ignoreCode" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html#ComplexityChecker.__ignoreCode" /> + <keyword name="ComplexityChecker.__reportInvalidSyntax" id="ComplexityChecker.__reportInvalidSyntax" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html#ComplexityChecker.__reportInvalidSyntax" /> + <keyword name="ComplexityChecker.run" id="ComplexityChecker.run" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html#ComplexityChecker.run" /> <keyword name="Conda" id="Conda" ref="eric6.CondaInterface.Conda.html#Conda" /> <keyword name="Conda (Constructor)" id="Conda (Constructor)" ref="eric6.CondaInterface.Conda.html#Conda.__init__" /> <keyword name="Conda (Module)" id="Conda (Module)" ref="eric6.CondaInterface.Conda.html" /> @@ -3097,10 +3114,10 @@ <keyword name="DCTestResult.startTest" id="DCTestResult.startTest" ref="eric6.DebugClients.Python.DCTestResult.html#DCTestResult.startTest" /> <keyword name="DCTestResult.stopTest" id="DCTestResult.stopTest" ref="eric6.DebugClients.Python.DCTestResult.html#DCTestResult.stopTest" /> <keyword name="DataViews (Package)" id="DataViews (Package)" ref="index-eric6.DataViews.html" /> - <keyword name="DateTimeVisitor" id="DateTimeVisitor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#DateTimeVisitor" /> - <keyword name="DateTimeVisitor (Constructor)" id="DateTimeVisitor (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#DateTimeVisitor.__init__" /> - <keyword name="DateTimeVisitor.__getFromKeywords" id="DateTimeVisitor.__getFromKeywords" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#DateTimeVisitor.__getFromKeywords" /> - <keyword name="DateTimeVisitor.visit_Call" id="DateTimeVisitor.visit_Call" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#DateTimeVisitor.visit_Call" /> + <keyword name="DateTimeVisitor" id="DateTimeVisitor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#DateTimeVisitor" /> + <keyword name="DateTimeVisitor (Constructor)" id="DateTimeVisitor (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#DateTimeVisitor.__init__" /> + <keyword name="DateTimeVisitor.__getFromKeywords" id="DateTimeVisitor.__getFromKeywords" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#DateTimeVisitor.__getFromKeywords" /> + <keyword name="DateTimeVisitor.visit_Call" id="DateTimeVisitor.visit_Call" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#DateTimeVisitor.visit_Call" /> <keyword name="DebugBase" id="DebugBase" ref="eric6.DebugClients.Python.DebugBase.html#DebugBase" /> <keyword name="DebugBase (Constructor)" id="DebugBase (Constructor)" ref="eric6.DebugClients.Python.DebugBase.html#DebugBase.__init__" /> <keyword name="DebugBase (Module)" id="DebugBase (Module)" ref="eric6.DebugClients.Python.DebugBase.html" /> @@ -3620,62 +3637,63 @@ <keyword name="DispositionParm" id="DispositionParm" ref="eric6.E5Network.E5RFC6266.html#DispositionParm" /> <keyword name="DispositionParmList" id="DispositionParmList" ref="eric6.E5Network.E5RFC6266.html#DispositionParmList" /> <keyword name="DispositionType" id="DispositionType" ref="eric6.E5Network.E5RFC6266.html#DispositionType" /> - <keyword name="DocStyleChecker" id="DocStyleChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker" /> - <keyword name="DocStyleChecker (Constructor)" id="DocStyleChecker (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__init__" /> - <keyword name="DocStyleChecker (Module)" id="DocStyleChecker (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html" /> - <keyword name="DocStyleChecker.__checkBackslashes" id="DocStyleChecker.__checkBackslashes" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkBackslashes" /> - <keyword name="DocStyleChecker.__checkBlankAfterLastParagraph" id="DocStyleChecker.__checkBlankAfterLastParagraph" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkBlankAfterLastParagraph" /> - <keyword name="DocStyleChecker.__checkBlankAfterSummary" id="DocStyleChecker.__checkBlankAfterSummary" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkBlankAfterSummary" /> - <keyword name="DocStyleChecker.__checkBlankBeforeAndAfterClass" id="DocStyleChecker.__checkBlankBeforeAndAfterClass" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkBlankBeforeAndAfterClass" /> - <keyword name="DocStyleChecker.__checkClassDocstring" id="DocStyleChecker.__checkClassDocstring" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkClassDocstring" /> - <keyword name="DocStyleChecker.__checkEndsWithPeriod" id="DocStyleChecker.__checkEndsWithPeriod" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkEndsWithPeriod" /> - <keyword name="DocStyleChecker.__checkEricBlankAfterSummary" id="DocStyleChecker.__checkEricBlankAfterSummary" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkEricBlankAfterSummary" /> - <keyword name="DocStyleChecker.__checkEricEndsWithPeriod" id="DocStyleChecker.__checkEricEndsWithPeriod" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkEricEndsWithPeriod" /> - <keyword name="DocStyleChecker.__checkEricException" id="DocStyleChecker.__checkEricException" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkEricException" /> - <keyword name="DocStyleChecker.__checkEricFunctionArguments" id="DocStyleChecker.__checkEricFunctionArguments" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkEricFunctionArguments" /> - <keyword name="DocStyleChecker.__checkEricNBlankAfterLastParagraph" id="DocStyleChecker.__checkEricNBlankAfterLastParagraph" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkEricNBlankAfterLastParagraph" /> - <keyword name="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" id="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" /> - <keyword name="DocStyleChecker.__checkEricQuotesOnSeparateLines" id="DocStyleChecker.__checkEricQuotesOnSeparateLines" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkEricQuotesOnSeparateLines" /> - <keyword name="DocStyleChecker.__checkEricReturn" id="DocStyleChecker.__checkEricReturn" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkEricReturn" /> - <keyword name="DocStyleChecker.__checkEricSignal" id="DocStyleChecker.__checkEricSignal" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkEricSignal" /> - <keyword name="DocStyleChecker.__checkEricSummary" id="DocStyleChecker.__checkEricSummary" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkEricSummary" /> - <keyword name="DocStyleChecker.__checkFunctionDocstring" id="DocStyleChecker.__checkFunctionDocstring" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkFunctionDocstring" /> - <keyword name="DocStyleChecker.__checkImperativeMood" id="DocStyleChecker.__checkImperativeMood" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkImperativeMood" /> - <keyword name="DocStyleChecker.__checkIndent" id="DocStyleChecker.__checkIndent" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkIndent" /> - <keyword name="DocStyleChecker.__checkModulesDocstrings" id="DocStyleChecker.__checkModulesDocstrings" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkModulesDocstrings" /> - <keyword name="DocStyleChecker.__checkNoBlankLineBefore" id="DocStyleChecker.__checkNoBlankLineBefore" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkNoBlankLineBefore" /> - <keyword name="DocStyleChecker.__checkNoSignature" id="DocStyleChecker.__checkNoSignature" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkNoSignature" /> - <keyword name="DocStyleChecker.__checkOneLiner" id="DocStyleChecker.__checkOneLiner" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkOneLiner" /> - <keyword name="DocStyleChecker.__checkReturnType" id="DocStyleChecker.__checkReturnType" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkReturnType" /> - <keyword name="DocStyleChecker.__checkSummary" id="DocStyleChecker.__checkSummary" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkSummary" /> - <keyword name="DocStyleChecker.__checkTripleDoubleQuotes" id="DocStyleChecker.__checkTripleDoubleQuotes" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__checkTripleDoubleQuotes" /> - <keyword name="DocStyleChecker.__error" id="DocStyleChecker.__error" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__error" /> - <keyword name="DocStyleChecker.__getArgNames" id="DocStyleChecker.__getArgNames" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__getArgNames" /> - <keyword name="DocStyleChecker.__getSummaryLine" id="DocStyleChecker.__getSummaryLine" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__getSummaryLine" /> - <keyword name="DocStyleChecker.__getSummaryLines" id="DocStyleChecker.__getSummaryLines" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__getSummaryLines" /> - <keyword name="DocStyleChecker.__ignoreCode" id="DocStyleChecker.__ignoreCode" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__ignoreCode" /> - <keyword name="DocStyleChecker.__parseClasses" id="DocStyleChecker.__parseClasses" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__parseClasses" /> - <keyword name="DocStyleChecker.__parseContexts" id="DocStyleChecker.__parseContexts" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__parseContexts" /> - <keyword name="DocStyleChecker.__parseDocstring" id="DocStyleChecker.__parseDocstring" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__parseDocstring" /> - <keyword name="DocStyleChecker.__parseFunctions" id="DocStyleChecker.__parseFunctions" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__parseFunctions" /> - <keyword name="DocStyleChecker.__parseMethods" id="DocStyleChecker.__parseMethods" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__parseMethods" /> - <keyword name="DocStyleChecker.__parseModuleDocstring" id="DocStyleChecker.__parseModuleDocstring" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__parseModuleDocstring" /> - <keyword name="DocStyleChecker.__parseTopLevel" id="DocStyleChecker.__parseTopLevel" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__parseTopLevel" /> - <keyword name="DocStyleChecker.__readline" id="DocStyleChecker.__readline" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__readline" /> - <keyword name="DocStyleChecker.__reportInvalidSyntax" id="DocStyleChecker.__reportInvalidSyntax" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__reportInvalidSyntax" /> - <keyword name="DocStyleChecker.__resetReadline" id="DocStyleChecker.__resetReadline" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__resetReadline" /> - <keyword name="DocStyleChecker.__skipIndentedBlock" id="DocStyleChecker.__skipIndentedBlock" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.__skipIndentedBlock" /> - <keyword name="DocStyleChecker.run" id="DocStyleChecker.run" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleChecker.run" /> - <keyword name="DocStyleContext" id="DocStyleContext" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleContext" /> - <keyword name="DocStyleContext (Constructor)" id="DocStyleContext (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleContext.__init__" /> - <keyword name="DocStyleContext.contextType" id="DocStyleContext.contextType" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleContext.contextType" /> - <keyword name="DocStyleContext.end" id="DocStyleContext.end" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleContext.end" /> - <keyword name="DocStyleContext.indent" id="DocStyleContext.indent" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleContext.indent" /> - <keyword name="DocStyleContext.setSpecial" id="DocStyleContext.setSpecial" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleContext.setSpecial" /> - <keyword name="DocStyleContext.source" id="DocStyleContext.source" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleContext.source" /> - <keyword name="DocStyleContext.special" id="DocStyleContext.special" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleContext.special" /> - <keyword name="DocStyleContext.ssource" id="DocStyleContext.ssource" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleContext.ssource" /> - <keyword name="DocStyleContext.start" id="DocStyleContext.start" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html#DocStyleContext.start" /> + <keyword name="DocStyle (Package)" id="DocStyle (Package)" ref="index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.html" /> + <keyword name="DocStyleChecker" id="DocStyleChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker" /> + <keyword name="DocStyleChecker (Constructor)" id="DocStyleChecker (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__init__" /> + <keyword name="DocStyleChecker (Module)" id="DocStyleChecker (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html" /> + <keyword name="DocStyleChecker.__checkBackslashes" id="DocStyleChecker.__checkBackslashes" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkBackslashes" /> + <keyword name="DocStyleChecker.__checkBlankAfterLastParagraph" id="DocStyleChecker.__checkBlankAfterLastParagraph" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkBlankAfterLastParagraph" /> + <keyword name="DocStyleChecker.__checkBlankAfterSummary" id="DocStyleChecker.__checkBlankAfterSummary" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkBlankAfterSummary" /> + <keyword name="DocStyleChecker.__checkBlankBeforeAndAfterClass" id="DocStyleChecker.__checkBlankBeforeAndAfterClass" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkBlankBeforeAndAfterClass" /> + <keyword name="DocStyleChecker.__checkClassDocstring" id="DocStyleChecker.__checkClassDocstring" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkClassDocstring" /> + <keyword name="DocStyleChecker.__checkEndsWithPeriod" id="DocStyleChecker.__checkEndsWithPeriod" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkEndsWithPeriod" /> + <keyword name="DocStyleChecker.__checkEricBlankAfterSummary" id="DocStyleChecker.__checkEricBlankAfterSummary" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkEricBlankAfterSummary" /> + <keyword name="DocStyleChecker.__checkEricEndsWithPeriod" id="DocStyleChecker.__checkEricEndsWithPeriod" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkEricEndsWithPeriod" /> + <keyword name="DocStyleChecker.__checkEricException" id="DocStyleChecker.__checkEricException" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkEricException" /> + <keyword name="DocStyleChecker.__checkEricFunctionArguments" id="DocStyleChecker.__checkEricFunctionArguments" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkEricFunctionArguments" /> + <keyword name="DocStyleChecker.__checkEricNBlankAfterLastParagraph" id="DocStyleChecker.__checkEricNBlankAfterLastParagraph" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkEricNBlankAfterLastParagraph" /> + <keyword name="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" id="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" /> + <keyword name="DocStyleChecker.__checkEricQuotesOnSeparateLines" id="DocStyleChecker.__checkEricQuotesOnSeparateLines" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkEricQuotesOnSeparateLines" /> + <keyword name="DocStyleChecker.__checkEricReturn" id="DocStyleChecker.__checkEricReturn" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkEricReturn" /> + <keyword name="DocStyleChecker.__checkEricSignal" id="DocStyleChecker.__checkEricSignal" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkEricSignal" /> + <keyword name="DocStyleChecker.__checkEricSummary" id="DocStyleChecker.__checkEricSummary" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkEricSummary" /> + <keyword name="DocStyleChecker.__checkFunctionDocstring" id="DocStyleChecker.__checkFunctionDocstring" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkFunctionDocstring" /> + <keyword name="DocStyleChecker.__checkImperativeMood" id="DocStyleChecker.__checkImperativeMood" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkImperativeMood" /> + <keyword name="DocStyleChecker.__checkIndent" id="DocStyleChecker.__checkIndent" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkIndent" /> + <keyword name="DocStyleChecker.__checkModulesDocstrings" id="DocStyleChecker.__checkModulesDocstrings" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkModulesDocstrings" /> + <keyword name="DocStyleChecker.__checkNoBlankLineBefore" id="DocStyleChecker.__checkNoBlankLineBefore" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkNoBlankLineBefore" /> + <keyword name="DocStyleChecker.__checkNoSignature" id="DocStyleChecker.__checkNoSignature" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkNoSignature" /> + <keyword name="DocStyleChecker.__checkOneLiner" id="DocStyleChecker.__checkOneLiner" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkOneLiner" /> + <keyword name="DocStyleChecker.__checkReturnType" id="DocStyleChecker.__checkReturnType" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkReturnType" /> + <keyword name="DocStyleChecker.__checkSummary" id="DocStyleChecker.__checkSummary" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkSummary" /> + <keyword name="DocStyleChecker.__checkTripleDoubleQuotes" id="DocStyleChecker.__checkTripleDoubleQuotes" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__checkTripleDoubleQuotes" /> + <keyword name="DocStyleChecker.__error" id="DocStyleChecker.__error" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__error" /> + <keyword name="DocStyleChecker.__getArgNames" id="DocStyleChecker.__getArgNames" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__getArgNames" /> + <keyword name="DocStyleChecker.__getSummaryLine" id="DocStyleChecker.__getSummaryLine" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__getSummaryLine" /> + <keyword name="DocStyleChecker.__getSummaryLines" id="DocStyleChecker.__getSummaryLines" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__getSummaryLines" /> + <keyword name="DocStyleChecker.__ignoreCode" id="DocStyleChecker.__ignoreCode" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__ignoreCode" /> + <keyword name="DocStyleChecker.__parseClasses" id="DocStyleChecker.__parseClasses" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__parseClasses" /> + <keyword name="DocStyleChecker.__parseContexts" id="DocStyleChecker.__parseContexts" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__parseContexts" /> + <keyword name="DocStyleChecker.__parseDocstring" id="DocStyleChecker.__parseDocstring" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__parseDocstring" /> + <keyword name="DocStyleChecker.__parseFunctions" id="DocStyleChecker.__parseFunctions" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__parseFunctions" /> + <keyword name="DocStyleChecker.__parseMethods" id="DocStyleChecker.__parseMethods" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__parseMethods" /> + <keyword name="DocStyleChecker.__parseModuleDocstring" id="DocStyleChecker.__parseModuleDocstring" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__parseModuleDocstring" /> + <keyword name="DocStyleChecker.__parseTopLevel" id="DocStyleChecker.__parseTopLevel" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__parseTopLevel" /> + <keyword name="DocStyleChecker.__readline" id="DocStyleChecker.__readline" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__readline" /> + <keyword name="DocStyleChecker.__reportInvalidSyntax" id="DocStyleChecker.__reportInvalidSyntax" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__reportInvalidSyntax" /> + <keyword name="DocStyleChecker.__resetReadline" id="DocStyleChecker.__resetReadline" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__resetReadline" /> + <keyword name="DocStyleChecker.__skipIndentedBlock" id="DocStyleChecker.__skipIndentedBlock" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.__skipIndentedBlock" /> + <keyword name="DocStyleChecker.run" id="DocStyleChecker.run" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleChecker.run" /> + <keyword name="DocStyleContext" id="DocStyleContext" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleContext" /> + <keyword name="DocStyleContext (Constructor)" id="DocStyleContext (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleContext.__init__" /> + <keyword name="DocStyleContext.contextType" id="DocStyleContext.contextType" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleContext.contextType" /> + <keyword name="DocStyleContext.end" id="DocStyleContext.end" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleContext.end" /> + <keyword name="DocStyleContext.indent" id="DocStyleContext.indent" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleContext.indent" /> + <keyword name="DocStyleContext.setSpecial" id="DocStyleContext.setSpecial" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleContext.setSpecial" /> + <keyword name="DocStyleContext.source" id="DocStyleContext.source" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleContext.source" /> + <keyword name="DocStyleContext.special" id="DocStyleContext.special" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleContext.special" /> + <keyword name="DocStyleContext.ssource" id="DocStyleContext.ssource" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleContext.ssource" /> + <keyword name="DocStyleContext.start" id="DocStyleContext.start" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html#DocStyleContext.start" /> <keyword name="DocumentationPlugins (Package)" id="DocumentationPlugins (Package)" ref="index-eric6.Plugins.DocumentationPlugins.html" /> <keyword name="DocumentationTools (Package)" id="DocumentationTools (Package)" ref="index-eric6.DocumentationTools.html" /> <keyword name="DocumentationViewerWidget" id="DocumentationViewerWidget" ref="eric6.UI.CodeDocumentationViewer.html#DocumentationViewerWidget" /> @@ -5878,14 +5896,14 @@ <keyword name="Function (Constructor)" id="Function (Constructor)" ref="eric6.Utilities.ModuleParser.html#Function.__init__" /> <keyword name="Function.addDescription" id="Function.addDescription" ref="eric6.Utilities.ModuleParser.html#Function.addDescription" /> <keyword name="Function.setEndLine" id="Function.setEndLine" ref="eric6.Utilities.ModuleParser.html#Function.setEndLine" /> - <keyword name="FunctionVisitor" id="FunctionVisitor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#FunctionVisitor" /> - <keyword name="FunctionVisitor (Constructor)" id="FunctionVisitor (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#FunctionVisitor.__init__" /> - <keyword name="FunctionVisitor.__checkFunctionNode" id="FunctionVisitor.__checkFunctionNode" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#FunctionVisitor.__checkFunctionNode" /> - <keyword name="FunctionVisitor.__classifyArgumentError" id="FunctionVisitor.__classifyArgumentError" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#FunctionVisitor.__classifyArgumentError" /> - <keyword name="FunctionVisitor.__classifyReturnError" id="FunctionVisitor.__classifyReturnError" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#FunctionVisitor.__classifyReturnError" /> - <keyword name="FunctionVisitor.visit_AsyncFunctionDef" id="FunctionVisitor.visit_AsyncFunctionDef" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#FunctionVisitor.visit_AsyncFunctionDef" /> - <keyword name="FunctionVisitor.visit_ClassDef" id="FunctionVisitor.visit_ClassDef" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#FunctionVisitor.visit_ClassDef" /> - <keyword name="FunctionVisitor.visit_FunctionDef" id="FunctionVisitor.visit_FunctionDef" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#FunctionVisitor.visit_FunctionDef" /> + <keyword name="FunctionVisitor" id="FunctionVisitor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#FunctionVisitor" /> + <keyword name="FunctionVisitor (Constructor)" id="FunctionVisitor (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#FunctionVisitor.__init__" /> + <keyword name="FunctionVisitor.__checkFunctionNode" id="FunctionVisitor.__checkFunctionNode" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#FunctionVisitor.__checkFunctionNode" /> + <keyword name="FunctionVisitor.__classifyArgumentError" id="FunctionVisitor.__classifyArgumentError" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#FunctionVisitor.__classifyArgumentError" /> + <keyword name="FunctionVisitor.__classifyReturnError" id="FunctionVisitor.__classifyReturnError" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#FunctionVisitor.__classifyReturnError" /> + <keyword name="FunctionVisitor.visit_AsyncFunctionDef" id="FunctionVisitor.visit_AsyncFunctionDef" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#FunctionVisitor.visit_AsyncFunctionDef" /> + <keyword name="FunctionVisitor.visit_ClassDef" id="FunctionVisitor.visit_ClassDef" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#FunctionVisitor.visit_ClassDef" /> + <keyword name="FunctionVisitor.visit_FunctionDef" id="FunctionVisitor.visit_FunctionDef" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#FunctionVisitor.visit_FunctionDef" /> <keyword name="GetSysPath (Module)" id="GetSysPath (Module)" ref="eric6.Utilities.GetSysPath.html" /> <keyword name="Git" id="Git" ref="eric6.Plugins.VcsPlugins.vcsGit.git.html#Git" /> <keyword name="Git (Constructor)" id="Git (Constructor)" ref="eric6.Plugins.VcsPlugins.vcsGit.git.html#Git.__init__" /> @@ -9414,11 +9432,11 @@ <keyword name="LfRevisionsInputDialog (Module)" id="LfRevisionsInputDialog (Module)" ref="eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.LfRevisionsInputDialog.html" /> <keyword name="LfRevisionsInputDialog.getRevisions" id="LfRevisionsInputDialog.getRevisions" ref="eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.LfRevisionsInputDialog.html#LfRevisionsInputDialog.getRevisions" /> <keyword name="LfRevisionsInputDialog.on_revisionsEdit_textChanged" id="LfRevisionsInputDialog.on_revisionsEdit_textChanged" ref="eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.LfRevisionsInputDialog.html#LfRevisionsInputDialog.on_revisionsEdit_textChanged" /> - <keyword name="LineComplexityVisitor" id="LineComplexityVisitor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html#LineComplexityVisitor" /> - <keyword name="LineComplexityVisitor (Constructor)" id="LineComplexityVisitor (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html#LineComplexityVisitor.__init__" /> - <keyword name="LineComplexityVisitor.score" id="LineComplexityVisitor.score" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html#LineComplexityVisitor.score" /> - <keyword name="LineComplexityVisitor.sortedList" id="LineComplexityVisitor.sortedList" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html#LineComplexityVisitor.sortedList" /> - <keyword name="LineComplexityVisitor.visit" id="LineComplexityVisitor.visit" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html#LineComplexityVisitor.visit" /> + <keyword name="LineComplexityVisitor" id="LineComplexityVisitor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html#LineComplexityVisitor" /> + <keyword name="LineComplexityVisitor (Constructor)" id="LineComplexityVisitor (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html#LineComplexityVisitor.__init__" /> + <keyword name="LineComplexityVisitor.score" id="LineComplexityVisitor.score" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html#LineComplexityVisitor.score" /> + <keyword name="LineComplexityVisitor.sortedList" id="LineComplexityVisitor.sortedList" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html#LineComplexityVisitor.sortedList" /> + <keyword name="LineComplexityVisitor.visit" id="LineComplexityVisitor.visit" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html#LineComplexityVisitor.visit" /> <keyword name="LineShortener" id="LineShortener" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html#LineShortener" /> <keyword name="LineShortener (Constructor)" id="LineShortener (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html#LineShortener.__init__" /> <keyword name="LineShortener.__breakMultiline" id="LineShortener.__breakMultiline" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html#LineShortener.__breakMultiline" /> @@ -9503,16 +9521,16 @@ <keyword name="LogViewerPage (Constructor)" id="LogViewerPage (Constructor)" ref="eric6.Preferences.ConfigurationPages.LogViewerPage.html#LogViewerPage.__init__" /> <keyword name="LogViewerPage (Module)" id="LogViewerPage (Module)" ref="eric6.Preferences.ConfigurationPages.LogViewerPage.html" /> <keyword name="LogViewerPage.save" id="LogViewerPage.save" ref="eric6.Preferences.ConfigurationPages.LogViewerPage.html#LogViewerPage.save" /> - <keyword name="LoggingVisitor" id="LoggingVisitor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#LoggingVisitor" /> - <keyword name="LoggingVisitor (Constructor)" id="LoggingVisitor (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#LoggingVisitor.__init__" /> - <keyword name="LoggingVisitor.__detectLoggingLevel" id="LoggingVisitor.__detectLoggingLevel" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#LoggingVisitor.__detectLoggingLevel" /> - <keyword name="LoggingVisitor.__isFormatCall" id="LoggingVisitor.__isFormatCall" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#LoggingVisitor.__isFormatCall" /> - <keyword name="LoggingVisitor.__withinExtraKeyword" id="LoggingVisitor.__withinExtraKeyword" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#LoggingVisitor.__withinExtraKeyword" /> - <keyword name="LoggingVisitor.__withinLoggingArgument" id="LoggingVisitor.__withinLoggingArgument" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#LoggingVisitor.__withinLoggingArgument" /> - <keyword name="LoggingVisitor.__withinLoggingStatement" id="LoggingVisitor.__withinLoggingStatement" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#LoggingVisitor.__withinLoggingStatement" /> - <keyword name="LoggingVisitor.visit_BinOp" id="LoggingVisitor.visit_BinOp" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#LoggingVisitor.visit_BinOp" /> - <keyword name="LoggingVisitor.visit_Call" id="LoggingVisitor.visit_Call" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#LoggingVisitor.visit_Call" /> - <keyword name="LoggingVisitor.visit_JoinedStr" id="LoggingVisitor.visit_JoinedStr" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#LoggingVisitor.visit_JoinedStr" /> + <keyword name="LoggingVisitor" id="LoggingVisitor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#LoggingVisitor" /> + <keyword name="LoggingVisitor (Constructor)" id="LoggingVisitor (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#LoggingVisitor.__init__" /> + <keyword name="LoggingVisitor.__detectLoggingLevel" id="LoggingVisitor.__detectLoggingLevel" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#LoggingVisitor.__detectLoggingLevel" /> + <keyword name="LoggingVisitor.__isFormatCall" id="LoggingVisitor.__isFormatCall" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#LoggingVisitor.__isFormatCall" /> + <keyword name="LoggingVisitor.__withinExtraKeyword" id="LoggingVisitor.__withinExtraKeyword" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#LoggingVisitor.__withinExtraKeyword" /> + <keyword name="LoggingVisitor.__withinLoggingArgument" id="LoggingVisitor.__withinLoggingArgument" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#LoggingVisitor.__withinLoggingArgument" /> + <keyword name="LoggingVisitor.__withinLoggingStatement" id="LoggingVisitor.__withinLoggingStatement" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#LoggingVisitor.__withinLoggingStatement" /> + <keyword name="LoggingVisitor.visit_BinOp" id="LoggingVisitor.visit_BinOp" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#LoggingVisitor.visit_BinOp" /> + <keyword name="LoggingVisitor.visit_Call" id="LoggingVisitor.visit_Call" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#LoggingVisitor.visit_Call" /> + <keyword name="LoggingVisitor.visit_JoinedStr" id="LoggingVisitor.visit_JoinedStr" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#LoggingVisitor.visit_JoinedStr" /> <keyword name="LoginForm" id="LoginForm" ref="eric6.WebBrowser.Passwords.LoginForm.html#LoginForm" /> <keyword name="LoginForm (Constructor)" id="LoginForm (Constructor)" ref="eric6.WebBrowser.Passwords.LoginForm.html#LoginForm.__init__" /> <keyword name="LoginForm (Module)" id="LoginForm (Module)" ref="eric6.WebBrowser.Passwords.LoginForm.html" /> @@ -9968,36 +9986,37 @@ <keyword name="MiniScintilla.focusOutEvent" id="MiniScintilla.focusOutEvent" ref="eric6.QScintilla.MiniEditor.html#MiniScintilla.focusOutEvent" /> <keyword name="MiniScintilla.getFileName" id="MiniScintilla.getFileName" ref="eric6.QScintilla.MiniEditor.html#MiniScintilla.getFileName" /> <keyword name="MiniScintilla.removeTrailingWhitespace" id="MiniScintilla.removeTrailingWhitespace" ref="eric6.QScintilla.MiniEditor.html#MiniScintilla.removeTrailingWhitespace" /> - <keyword name="MiscellaneousChecker" id="MiscellaneousChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker" /> - <keyword name="MiscellaneousChecker (Constructor)" id="MiscellaneousChecker (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__init__" /> - <keyword name="MiscellaneousChecker (Module)" id="MiscellaneousChecker (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html" /> - <keyword name="MiscellaneousChecker.__checkBugBear" id="MiscellaneousChecker.__checkBugBear" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkBugBear" /> - <keyword name="MiscellaneousChecker.__checkBuiltins" id="MiscellaneousChecker.__checkBuiltins" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkBuiltins" /> - <keyword name="MiscellaneousChecker.__checkCoding" id="MiscellaneousChecker.__checkCoding" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkCoding" /> - <keyword name="MiscellaneousChecker.__checkCommentedCode" id="MiscellaneousChecker.__checkCommentedCode" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkCommentedCode" /> - <keyword name="MiscellaneousChecker.__checkComprehensions" id="MiscellaneousChecker.__checkComprehensions" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkComprehensions" /> - <keyword name="MiscellaneousChecker.__checkCopyright" id="MiscellaneousChecker.__checkCopyright" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkCopyright" /> - <keyword name="MiscellaneousChecker.__checkDateTime" id="MiscellaneousChecker.__checkDateTime" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkDateTime" /> - <keyword name="MiscellaneousChecker.__checkDictWithSortedKeys" id="MiscellaneousChecker.__checkDictWithSortedKeys" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkDictWithSortedKeys" /> - <keyword name="MiscellaneousChecker.__checkFormatString" id="MiscellaneousChecker.__checkFormatString" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkFormatString" /> - <keyword name="MiscellaneousChecker.__checkFuture" id="MiscellaneousChecker.__checkFuture" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkFuture" /> - <keyword name="MiscellaneousChecker.__checkGettext" id="MiscellaneousChecker.__checkGettext" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkGettext" /> - <keyword name="MiscellaneousChecker.__checkLineContinuation" id="MiscellaneousChecker.__checkLineContinuation" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkLineContinuation" /> - <keyword name="MiscellaneousChecker.__checkLogging" id="MiscellaneousChecker.__checkLogging" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkLogging" /> - <keyword name="MiscellaneousChecker.__checkMutableDefault" id="MiscellaneousChecker.__checkMutableDefault" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkMutableDefault" /> - <keyword name="MiscellaneousChecker.__checkPep3101" id="MiscellaneousChecker.__checkPep3101" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkPep3101" /> - <keyword name="MiscellaneousChecker.__checkPrintStatements" id="MiscellaneousChecker.__checkPrintStatements" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkPrintStatements" /> - <keyword name="MiscellaneousChecker.__checkReturn" id="MiscellaneousChecker.__checkReturn" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkReturn" /> - <keyword name="MiscellaneousChecker.__checkSysVersion" id="MiscellaneousChecker.__checkSysVersion" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkSysVersion" /> - <keyword name="MiscellaneousChecker.__checkTuple" id="MiscellaneousChecker.__checkTuple" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__checkTuple" /> - <keyword name="MiscellaneousChecker.__dictShouldBeChecked" id="MiscellaneousChecker.__dictShouldBeChecked" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__dictShouldBeChecked" /> - <keyword name="MiscellaneousChecker.__error" id="MiscellaneousChecker.__error" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__error" /> - <keyword name="MiscellaneousChecker.__generateTree" id="MiscellaneousChecker.__generateTree" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__generateTree" /> - <keyword name="MiscellaneousChecker.__getCoding" id="MiscellaneousChecker.__getCoding" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__getCoding" /> - <keyword name="MiscellaneousChecker.__getFields" id="MiscellaneousChecker.__getFields" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__getFields" /> - <keyword name="MiscellaneousChecker.__ignoreCode" id="MiscellaneousChecker.__ignoreCode" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__ignoreCode" /> - <keyword name="MiscellaneousChecker.__reportInvalidSyntax" id="MiscellaneousChecker.__reportInvalidSyntax" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.__reportInvalidSyntax" /> - <keyword name="MiscellaneousChecker.run" id="MiscellaneousChecker.run" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#MiscellaneousChecker.run" /> + <keyword name="Miscellaneous (Package)" id="Miscellaneous (Package)" ref="index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.html" /> + <keyword name="MiscellaneousChecker" id="MiscellaneousChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker" /> + <keyword name="MiscellaneousChecker (Constructor)" id="MiscellaneousChecker (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__init__" /> + <keyword name="MiscellaneousChecker (Module)" id="MiscellaneousChecker (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html" /> + <keyword name="MiscellaneousChecker.__checkBugBear" id="MiscellaneousChecker.__checkBugBear" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkBugBear" /> + <keyword name="MiscellaneousChecker.__checkBuiltins" id="MiscellaneousChecker.__checkBuiltins" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkBuiltins" /> + <keyword name="MiscellaneousChecker.__checkCoding" id="MiscellaneousChecker.__checkCoding" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkCoding" /> + <keyword name="MiscellaneousChecker.__checkCommentedCode" id="MiscellaneousChecker.__checkCommentedCode" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkCommentedCode" /> + <keyword name="MiscellaneousChecker.__checkComprehensions" id="MiscellaneousChecker.__checkComprehensions" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkComprehensions" /> + <keyword name="MiscellaneousChecker.__checkCopyright" id="MiscellaneousChecker.__checkCopyright" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkCopyright" /> + <keyword name="MiscellaneousChecker.__checkDateTime" id="MiscellaneousChecker.__checkDateTime" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkDateTime" /> + <keyword name="MiscellaneousChecker.__checkDictWithSortedKeys" id="MiscellaneousChecker.__checkDictWithSortedKeys" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkDictWithSortedKeys" /> + <keyword name="MiscellaneousChecker.__checkFormatString" id="MiscellaneousChecker.__checkFormatString" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkFormatString" /> + <keyword name="MiscellaneousChecker.__checkFuture" id="MiscellaneousChecker.__checkFuture" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkFuture" /> + <keyword name="MiscellaneousChecker.__checkGettext" id="MiscellaneousChecker.__checkGettext" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkGettext" /> + <keyword name="MiscellaneousChecker.__checkLineContinuation" id="MiscellaneousChecker.__checkLineContinuation" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkLineContinuation" /> + <keyword name="MiscellaneousChecker.__checkLogging" id="MiscellaneousChecker.__checkLogging" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkLogging" /> + <keyword name="MiscellaneousChecker.__checkMutableDefault" id="MiscellaneousChecker.__checkMutableDefault" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkMutableDefault" /> + <keyword name="MiscellaneousChecker.__checkPep3101" id="MiscellaneousChecker.__checkPep3101" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkPep3101" /> + <keyword name="MiscellaneousChecker.__checkPrintStatements" id="MiscellaneousChecker.__checkPrintStatements" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkPrintStatements" /> + <keyword name="MiscellaneousChecker.__checkReturn" id="MiscellaneousChecker.__checkReturn" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkReturn" /> + <keyword name="MiscellaneousChecker.__checkSysVersion" id="MiscellaneousChecker.__checkSysVersion" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkSysVersion" /> + <keyword name="MiscellaneousChecker.__checkTuple" id="MiscellaneousChecker.__checkTuple" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__checkTuple" /> + <keyword name="MiscellaneousChecker.__dictShouldBeChecked" id="MiscellaneousChecker.__dictShouldBeChecked" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__dictShouldBeChecked" /> + <keyword name="MiscellaneousChecker.__error" id="MiscellaneousChecker.__error" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__error" /> + <keyword name="MiscellaneousChecker.__generateTree" id="MiscellaneousChecker.__generateTree" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__generateTree" /> + <keyword name="MiscellaneousChecker.__getCoding" id="MiscellaneousChecker.__getCoding" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__getCoding" /> + <keyword name="MiscellaneousChecker.__getFields" id="MiscellaneousChecker.__getFields" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__getFields" /> + <keyword name="MiscellaneousChecker.__ignoreCode" id="MiscellaneousChecker.__ignoreCode" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__ignoreCode" /> + <keyword name="MiscellaneousChecker.__reportInvalidSyntax" id="MiscellaneousChecker.__reportInvalidSyntax" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.__reportInvalidSyntax" /> + <keyword name="MiscellaneousChecker.run" id="MiscellaneousChecker.run" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#MiscellaneousChecker.run" /> <keyword name="Module" id="Module" ref="eric6.Utilities.ClassBrowsers.ClbrBaseClasses.html#Module" /> <keyword name="Module" id="Module" ref="eric6.Utilities.ClassBrowsers.idlclbr.html#Module" /> <keyword name="Module" id="Module" ref="eric6.Utilities.ClassBrowsers.rbclbr.html#Module" /> @@ -10172,29 +10191,30 @@ <keyword name="MyMemoryEngine.engineName" id="MyMemoryEngine.engineName" ref="eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.MyMemoryEngine.html#MyMemoryEngine.engineName" /> <keyword name="MyMemoryEngine.getTranslation" id="MyMemoryEngine.getTranslation" ref="eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.MyMemoryEngine.html#MyMemoryEngine.getTranslation" /> <keyword name="MyMemoryEngine.supportedLanguages" id="MyMemoryEngine.supportedLanguages" ref="eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.MyMemoryEngine.html#MyMemoryEngine.supportedLanguages" /> - <keyword name="NameFinder" id="NameFinder" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#NameFinder" /> - <keyword name="NameFinder (Constructor)" id="NameFinder (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#NameFinder.__init__" /> - <keyword name="NameFinder.getNames" id="NameFinder.getNames" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#NameFinder.getNames" /> - <keyword name="NameFinder.visit" id="NameFinder.visit" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#NameFinder.visit" /> - <keyword name="NameFinder.visit_Name" id="NameFinder.visit_Name" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#NameFinder.visit_Name" /> - <keyword name="NamingStyleChecker" id="NamingStyleChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker" /> - <keyword name="NamingStyleChecker (Constructor)" id="NamingStyleChecker (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker.__init__" /> - <keyword name="NamingStyleChecker (Module)" id="NamingStyleChecker (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html" /> - <keyword name="NamingStyleChecker.__checkClassName" id="NamingStyleChecker.__checkClassName" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker.__checkClassName" /> - <keyword name="NamingStyleChecker.__checkFunctionArgumentNames" id="NamingStyleChecker.__checkFunctionArgumentNames" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker.__checkFunctionArgumentNames" /> - <keyword name="NamingStyleChecker.__checkFunctionName" id="NamingStyleChecker.__checkFunctionName" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker.__checkFunctionName" /> - <keyword name="NamingStyleChecker.__checkImportAs" id="NamingStyleChecker.__checkImportAs" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker.__checkImportAs" /> - <keyword name="NamingStyleChecker.__checkModule" id="NamingStyleChecker.__checkModule" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker.__checkModule" /> - <keyword name="NamingStyleChecker.__checkNameToBeAvoided" id="NamingStyleChecker.__checkNameToBeAvoided" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker.__checkNameToBeAvoided" /> - <keyword name="NamingStyleChecker.__checkVariablesInFunction" id="NamingStyleChecker.__checkVariablesInFunction" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker.__checkVariablesInFunction" /> - <keyword name="NamingStyleChecker.__error" id="NamingStyleChecker.__error" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker.__error" /> - <keyword name="NamingStyleChecker.__findGlobalDefs" id="NamingStyleChecker.__findGlobalDefs" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker.__findGlobalDefs" /> - <keyword name="NamingStyleChecker.__getArgNames" id="NamingStyleChecker.__getArgNames" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker.__getArgNames" /> - <keyword name="NamingStyleChecker.__isNameToBeAvoided" id="NamingStyleChecker.__isNameToBeAvoided" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker.__isNameToBeAvoided" /> - <keyword name="NamingStyleChecker.__tagClassFunctions" id="NamingStyleChecker.__tagClassFunctions" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker.__tagClassFunctions" /> - <keyword name="NamingStyleChecker.__visitNode" id="NamingStyleChecker.__visitNode" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker.__visitNode" /> - <keyword name="NamingStyleChecker.__visitTree" id="NamingStyleChecker.__visitTree" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker.__visitTree" /> - <keyword name="NamingStyleChecker.run" id="NamingStyleChecker.run" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html#NamingStyleChecker.run" /> + <keyword name="NameFinder" id="NameFinder" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#NameFinder" /> + <keyword name="NameFinder (Constructor)" id="NameFinder (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#NameFinder.__init__" /> + <keyword name="NameFinder.getNames" id="NameFinder.getNames" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#NameFinder.getNames" /> + <keyword name="NameFinder.visit" id="NameFinder.visit" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#NameFinder.visit" /> + <keyword name="NameFinder.visit_Name" id="NameFinder.visit_Name" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#NameFinder.visit_Name" /> + <keyword name="Naming (Package)" id="Naming (Package)" ref="index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.html" /> + <keyword name="NamingStyleChecker" id="NamingStyleChecker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker" /> + <keyword name="NamingStyleChecker (Constructor)" id="NamingStyleChecker (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker.__init__" /> + <keyword name="NamingStyleChecker (Module)" id="NamingStyleChecker (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html" /> + <keyword name="NamingStyleChecker.__checkClassName" id="NamingStyleChecker.__checkClassName" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker.__checkClassName" /> + <keyword name="NamingStyleChecker.__checkFunctionArgumentNames" id="NamingStyleChecker.__checkFunctionArgumentNames" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker.__checkFunctionArgumentNames" /> + <keyword name="NamingStyleChecker.__checkFunctionName" id="NamingStyleChecker.__checkFunctionName" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker.__checkFunctionName" /> + <keyword name="NamingStyleChecker.__checkImportAs" id="NamingStyleChecker.__checkImportAs" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker.__checkImportAs" /> + <keyword name="NamingStyleChecker.__checkModule" id="NamingStyleChecker.__checkModule" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker.__checkModule" /> + <keyword name="NamingStyleChecker.__checkNameToBeAvoided" id="NamingStyleChecker.__checkNameToBeAvoided" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker.__checkNameToBeAvoided" /> + <keyword name="NamingStyleChecker.__checkVariablesInFunction" id="NamingStyleChecker.__checkVariablesInFunction" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker.__checkVariablesInFunction" /> + <keyword name="NamingStyleChecker.__error" id="NamingStyleChecker.__error" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker.__error" /> + <keyword name="NamingStyleChecker.__findGlobalDefs" id="NamingStyleChecker.__findGlobalDefs" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker.__findGlobalDefs" /> + <keyword name="NamingStyleChecker.__getArgNames" id="NamingStyleChecker.__getArgNames" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker.__getArgNames" /> + <keyword name="NamingStyleChecker.__isNameToBeAvoided" id="NamingStyleChecker.__isNameToBeAvoided" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker.__isNameToBeAvoided" /> + <keyword name="NamingStyleChecker.__tagClassFunctions" id="NamingStyleChecker.__tagClassFunctions" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker.__tagClassFunctions" /> + <keyword name="NamingStyleChecker.__visitNode" id="NamingStyleChecker.__visitNode" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker.__visitNode" /> + <keyword name="NamingStyleChecker.__visitTree" id="NamingStyleChecker.__visitTree" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker.__visitTree" /> + <keyword name="NamingStyleChecker.run" id="NamingStyleChecker.run" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html#NamingStyleChecker.run" /> <keyword name="Navigation (Package)" id="Navigation (Package)" ref="index-eric6.WebBrowser.Navigation.html" /> <keyword name="NavigationBar" id="NavigationBar" ref="eric6.WebBrowser.Navigation.NavigationBar.html#NavigationBar" /> <keyword name="NavigationBar (Constructor)" id="NavigationBar (Constructor)" ref="eric6.WebBrowser.Navigation.NavigationBar.html#NavigationBar.__init__" /> @@ -12406,31 +12426,31 @@ <keyword name="RestructuredTextProvider.line" id="RestructuredTextProvider.line" ref="eric6.QScintilla.MarkupProviders.RestructuredTextProvider.html#RestructuredTextProvider.line" /> <keyword name="RestructuredTextProvider.numberedList" id="RestructuredTextProvider.numberedList" ref="eric6.QScintilla.MarkupProviders.RestructuredTextProvider.html#RestructuredTextProvider.numberedList" /> <keyword name="RestructuredTextProvider.quote" id="RestructuredTextProvider.quote" ref="eric6.QScintilla.MarkupProviders.RestructuredTextProvider.html#RestructuredTextProvider.quote" /> - <keyword name="ReturnVisitor" id="ReturnVisitor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor" /> - <keyword name="ReturnVisitor (Constructor)" id="ReturnVisitor (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.__init__" /> - <keyword name="ReturnVisitor.__checkFunction" id="ReturnVisitor.__checkFunction" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.__checkFunction" /> - <keyword name="ReturnVisitor.__checkImplicitReturn" id="ReturnVisitor.__checkImplicitReturn" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.__checkImplicitReturn" /> - <keyword name="ReturnVisitor.__checkImplicitReturnValue" id="ReturnVisitor.__checkImplicitReturnValue" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.__checkImplicitReturnValue" /> - <keyword name="ReturnVisitor.__checkUnnecessaryAssign" id="ReturnVisitor.__checkUnnecessaryAssign" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.__checkUnnecessaryAssign" /> - <keyword name="ReturnVisitor.__checkUnnecessaryReturnNone" id="ReturnVisitor.__checkUnnecessaryReturnNone" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.__checkUnnecessaryReturnNone" /> - <keyword name="ReturnVisitor.__hasRefsBeforeNextAssign" id="ReturnVisitor.__hasRefsBeforeNextAssign" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.__hasRefsBeforeNextAssign" /> - <keyword name="ReturnVisitor.__isFalse" id="ReturnVisitor.__isFalse" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.__isFalse" /> - <keyword name="ReturnVisitor.__isNone" id="ReturnVisitor.__isNone" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.__isNone" /> - <keyword name="ReturnVisitor.__resultExists" id="ReturnVisitor.__resultExists" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.__resultExists" /> - <keyword name="ReturnVisitor.__visitAssignTarget" id="ReturnVisitor.__visitAssignTarget" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.__visitAssignTarget" /> - <keyword name="ReturnVisitor.__visitLoop" id="ReturnVisitor.__visitLoop" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.__visitLoop" /> - <keyword name="ReturnVisitor.__visitWithStack" id="ReturnVisitor.__visitWithStack" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.__visitWithStack" /> - <keyword name="ReturnVisitor.assigns" id="ReturnVisitor.assigns" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.assigns" /> - <keyword name="ReturnVisitor.refs" id="ReturnVisitor.refs" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.refs" /> - <keyword name="ReturnVisitor.returns" id="ReturnVisitor.returns" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.returns" /> - <keyword name="ReturnVisitor.visit_Assign" id="ReturnVisitor.visit_Assign" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.visit_Assign" /> - <keyword name="ReturnVisitor.visit_AsyncFor" id="ReturnVisitor.visit_AsyncFor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.visit_AsyncFor" /> - <keyword name="ReturnVisitor.visit_AsyncFunctionDef" id="ReturnVisitor.visit_AsyncFunctionDef" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.visit_AsyncFunctionDef" /> - <keyword name="ReturnVisitor.visit_For" id="ReturnVisitor.visit_For" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.visit_For" /> - <keyword name="ReturnVisitor.visit_FunctionDef" id="ReturnVisitor.visit_FunctionDef" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.visit_FunctionDef" /> - <keyword name="ReturnVisitor.visit_Name" id="ReturnVisitor.visit_Name" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.visit_Name" /> - <keyword name="ReturnVisitor.visit_Return" id="ReturnVisitor.visit_Return" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.visit_Return" /> - <keyword name="ReturnVisitor.visit_While" id="ReturnVisitor.visit_While" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#ReturnVisitor.visit_While" /> + <keyword name="ReturnVisitor" id="ReturnVisitor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor" /> + <keyword name="ReturnVisitor (Constructor)" id="ReturnVisitor (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.__init__" /> + <keyword name="ReturnVisitor.__checkFunction" id="ReturnVisitor.__checkFunction" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.__checkFunction" /> + <keyword name="ReturnVisitor.__checkImplicitReturn" id="ReturnVisitor.__checkImplicitReturn" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.__checkImplicitReturn" /> + <keyword name="ReturnVisitor.__checkImplicitReturnValue" id="ReturnVisitor.__checkImplicitReturnValue" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.__checkImplicitReturnValue" /> + <keyword name="ReturnVisitor.__checkUnnecessaryAssign" id="ReturnVisitor.__checkUnnecessaryAssign" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.__checkUnnecessaryAssign" /> + <keyword name="ReturnVisitor.__checkUnnecessaryReturnNone" id="ReturnVisitor.__checkUnnecessaryReturnNone" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.__checkUnnecessaryReturnNone" /> + <keyword name="ReturnVisitor.__hasRefsBeforeNextAssign" id="ReturnVisitor.__hasRefsBeforeNextAssign" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.__hasRefsBeforeNextAssign" /> + <keyword name="ReturnVisitor.__isFalse" id="ReturnVisitor.__isFalse" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.__isFalse" /> + <keyword name="ReturnVisitor.__isNone" id="ReturnVisitor.__isNone" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.__isNone" /> + <keyword name="ReturnVisitor.__resultExists" id="ReturnVisitor.__resultExists" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.__resultExists" /> + <keyword name="ReturnVisitor.__visitAssignTarget" id="ReturnVisitor.__visitAssignTarget" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.__visitAssignTarget" /> + <keyword name="ReturnVisitor.__visitLoop" id="ReturnVisitor.__visitLoop" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.__visitLoop" /> + <keyword name="ReturnVisitor.__visitWithStack" id="ReturnVisitor.__visitWithStack" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.__visitWithStack" /> + <keyword name="ReturnVisitor.assigns" id="ReturnVisitor.assigns" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.assigns" /> + <keyword name="ReturnVisitor.refs" id="ReturnVisitor.refs" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.refs" /> + <keyword name="ReturnVisitor.returns" id="ReturnVisitor.returns" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.returns" /> + <keyword name="ReturnVisitor.visit_Assign" id="ReturnVisitor.visit_Assign" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.visit_Assign" /> + <keyword name="ReturnVisitor.visit_AsyncFor" id="ReturnVisitor.visit_AsyncFor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.visit_AsyncFor" /> + <keyword name="ReturnVisitor.visit_AsyncFunctionDef" id="ReturnVisitor.visit_AsyncFunctionDef" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.visit_AsyncFunctionDef" /> + <keyword name="ReturnVisitor.visit_For" id="ReturnVisitor.visit_For" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.visit_For" /> + <keyword name="ReturnVisitor.visit_FunctionDef" id="ReturnVisitor.visit_FunctionDef" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.visit_FunctionDef" /> + <keyword name="ReturnVisitor.visit_Name" id="ReturnVisitor.visit_Name" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.visit_Name" /> + <keyword name="ReturnVisitor.visit_Return" id="ReturnVisitor.visit_Return" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.visit_Return" /> + <keyword name="ReturnVisitor.visit_While" id="ReturnVisitor.visit_While" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#ReturnVisitor.visit_While" /> <keyword name="SafariImporter" id="SafariImporter" ref="eric6.WebBrowser.Bookmarks.BookmarksImporters.SafariImporter.html#SafariImporter" /> <keyword name="SafariImporter (Constructor)" id="SafariImporter (Constructor)" ref="eric6.WebBrowser.Bookmarks.BookmarksImporters.SafariImporter.html#SafariImporter.__init__" /> <keyword name="SafariImporter (Module)" id="SafariImporter (Module)" ref="eric6.WebBrowser.Bookmarks.BookmarksImporters.SafariImporter.html" /> @@ -14463,15 +14483,15 @@ <keyword name="SyntaxCheckerPlugin.__translateSyntaxCheck" id="SyntaxCheckerPlugin.__translateSyntaxCheck" ref="eric6.Plugins.PluginSyntaxChecker.html#SyntaxCheckerPlugin.__translateSyntaxCheck" /> <keyword name="SyntaxCheckerPlugin.activate" id="SyntaxCheckerPlugin.activate" ref="eric6.Plugins.PluginSyntaxChecker.html#SyntaxCheckerPlugin.activate" /> <keyword name="SyntaxCheckerPlugin.deactivate" id="SyntaxCheckerPlugin.deactivate" ref="eric6.Plugins.PluginSyntaxChecker.html#SyntaxCheckerPlugin.deactivate" /> - <keyword name="SysVersionVisitor" id="SysVersionVisitor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#SysVersionVisitor" /> - <keyword name="SysVersionVisitor (Constructor)" id="SysVersionVisitor (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#SysVersionVisitor.__init__" /> - <keyword name="SysVersionVisitor.__isSys" id="SysVersionVisitor.__isSys" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#SysVersionVisitor.__isSys" /> - <keyword name="SysVersionVisitor.__isSysVersionUpperSlice" id="SysVersionVisitor.__isSysVersionUpperSlice" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#SysVersionVisitor.__isSysVersionUpperSlice" /> - <keyword name="SysVersionVisitor.visit_Attribute" id="SysVersionVisitor.visit_Attribute" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#SysVersionVisitor.visit_Attribute" /> - <keyword name="SysVersionVisitor.visit_Compare" id="SysVersionVisitor.visit_Compare" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#SysVersionVisitor.visit_Compare" /> - <keyword name="SysVersionVisitor.visit_ImportFrom" id="SysVersionVisitor.visit_ImportFrom" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#SysVersionVisitor.visit_ImportFrom" /> - <keyword name="SysVersionVisitor.visit_Name" id="SysVersionVisitor.visit_Name" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#SysVersionVisitor.visit_Name" /> - <keyword name="SysVersionVisitor.visit_Subscript" id="SysVersionVisitor.visit_Subscript" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#SysVersionVisitor.visit_Subscript" /> + <keyword name="SysVersionVisitor" id="SysVersionVisitor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#SysVersionVisitor" /> + <keyword name="SysVersionVisitor (Constructor)" id="SysVersionVisitor (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#SysVersionVisitor.__init__" /> + <keyword name="SysVersionVisitor.__isSys" id="SysVersionVisitor.__isSys" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#SysVersionVisitor.__isSys" /> + <keyword name="SysVersionVisitor.__isSysVersionUpperSlice" id="SysVersionVisitor.__isSysVersionUpperSlice" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#SysVersionVisitor.__isSysVersionUpperSlice" /> + <keyword name="SysVersionVisitor.visit_Attribute" id="SysVersionVisitor.visit_Attribute" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#SysVersionVisitor.visit_Attribute" /> + <keyword name="SysVersionVisitor.visit_Compare" id="SysVersionVisitor.visit_Compare" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#SysVersionVisitor.visit_Compare" /> + <keyword name="SysVersionVisitor.visit_ImportFrom" id="SysVersionVisitor.visit_ImportFrom" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#SysVersionVisitor.visit_ImportFrom" /> + <keyword name="SysVersionVisitor.visit_Name" id="SysVersionVisitor.visit_Name" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#SysVersionVisitor.visit_Name" /> + <keyword name="SysVersionVisitor.visit_Subscript" id="SysVersionVisitor.visit_Subscript" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#SysVersionVisitor.visit_Subscript" /> <keyword name="TERMINAL" id="TERMINAL" ref="eric6.E5Gui.E5GenericDiffHighlighter.html#TERMINAL" /> <keyword name="TRPreviewer" id="TRPreviewer" ref="eric6.Tools.TRPreviewer.html#TRPreviewer" /> <keyword name="TRPreviewer (Constructor)" id="TRPreviewer (Constructor)" ref="eric6.Tools.TRPreviewer.html#TRPreviewer.__init__" /> @@ -14782,19 +14802,19 @@ <keyword name="TemplatesWriter (Constructor)" id="TemplatesWriter (Constructor)" ref="eric6.E5XML.TemplatesWriter.html#TemplatesWriter.__init__" /> <keyword name="TemplatesWriter (Module)" id="TemplatesWriter (Module)" ref="eric6.E5XML.TemplatesWriter.html" /> <keyword name="TemplatesWriter.writeXML" id="TemplatesWriter.writeXML" ref="eric6.E5XML.TemplatesWriter.html#TemplatesWriter.writeXML" /> - <keyword name="TextVisitor" id="TextVisitor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#TextVisitor" /> - <keyword name="TextVisitor (Constructor)" id="TextVisitor (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#TextVisitor.__init__" /> - <keyword name="TextVisitor.__addNode" id="TextVisitor.__addNode" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#TextVisitor.__addNode" /> - <keyword name="TextVisitor.__visitBody" id="TextVisitor.__visitBody" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#TextVisitor.__visitBody" /> - <keyword name="TextVisitor.__visitDefinition" id="TextVisitor.__visitDefinition" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#TextVisitor.__visitDefinition" /> - <keyword name="TextVisitor.visit_AsyncFunctionDef" id="TextVisitor.visit_AsyncFunctionDef" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#TextVisitor.visit_AsyncFunctionDef" /> - <keyword name="TextVisitor.visit_Bytes" id="TextVisitor.visit_Bytes" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#TextVisitor.visit_Bytes" /> - <keyword name="TextVisitor.visit_Call" id="TextVisitor.visit_Call" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#TextVisitor.visit_Call" /> - <keyword name="TextVisitor.visit_ClassDef" id="TextVisitor.visit_ClassDef" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#TextVisitor.visit_ClassDef" /> - <keyword name="TextVisitor.visit_Constant" id="TextVisitor.visit_Constant" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#TextVisitor.visit_Constant" /> - <keyword name="TextVisitor.visit_FunctionDef" id="TextVisitor.visit_FunctionDef" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#TextVisitor.visit_FunctionDef" /> - <keyword name="TextVisitor.visit_Module" id="TextVisitor.visit_Module" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#TextVisitor.visit_Module" /> - <keyword name="TextVisitor.visit_Str" id="TextVisitor.visit_Str" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#TextVisitor.visit_Str" /> + <keyword name="TextVisitor" id="TextVisitor" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#TextVisitor" /> + <keyword name="TextVisitor (Constructor)" id="TextVisitor (Constructor)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#TextVisitor.__init__" /> + <keyword name="TextVisitor.__addNode" id="TextVisitor.__addNode" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#TextVisitor.__addNode" /> + <keyword name="TextVisitor.__visitBody" id="TextVisitor.__visitBody" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#TextVisitor.__visitBody" /> + <keyword name="TextVisitor.__visitDefinition" id="TextVisitor.__visitDefinition" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#TextVisitor.__visitDefinition" /> + <keyword name="TextVisitor.visit_AsyncFunctionDef" id="TextVisitor.visit_AsyncFunctionDef" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#TextVisitor.visit_AsyncFunctionDef" /> + <keyword name="TextVisitor.visit_Bytes" id="TextVisitor.visit_Bytes" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#TextVisitor.visit_Bytes" /> + <keyword name="TextVisitor.visit_Call" id="TextVisitor.visit_Call" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#TextVisitor.visit_Call" /> + <keyword name="TextVisitor.visit_ClassDef" id="TextVisitor.visit_ClassDef" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#TextVisitor.visit_ClassDef" /> + <keyword name="TextVisitor.visit_Constant" id="TextVisitor.visit_Constant" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#TextVisitor.visit_Constant" /> + <keyword name="TextVisitor.visit_FunctionDef" id="TextVisitor.visit_FunctionDef" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#TextVisitor.visit_FunctionDef" /> + <keyword name="TextVisitor.visit_Module" id="TextVisitor.visit_Module" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#TextVisitor.visit_Module" /> + <keyword name="TextVisitor.visit_Str" id="TextVisitor.visit_Str" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#TextVisitor.visit_Str" /> <keyword name="ThreadExtension" id="ThreadExtension" ref="eric6.DebugClients.Python.ThreadExtension.html#ThreadExtension" /> <keyword name="ThreadExtension (Constructor)" id="ThreadExtension (Constructor)" ref="eric6.DebugClients.Python.ThreadExtension.html#ThreadExtension.__init__" /> <keyword name="ThreadExtension (Module)" id="ThreadExtension (Module)" ref="eric6.DebugClients.Python.ThreadExtension.html" /> @@ -17070,7 +17090,7 @@ <keyword name="compileUiFiles" id="compileUiFiles" ref="setup.html#compileUiFiles" /> <keyword name="compileUiFiles (Module)" id="compileUiFiles (Module)" ref="compileUiFiles.html" /> <keyword name="completeFormData" id="completeFormData" ref="eric6.WebBrowser.Tools.Scripts.html#completeFormData" /> - <keyword name="composeCallPath" id="composeCallPath" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html#composeCallPath" /> + <keyword name="composeCallPath" id="composeCallPath" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html#composeCallPath" /> <keyword name="compound_statements" id="compound_statements" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#compound_statements" /> <keyword name="concatString" id="concatString" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityUtils.html#concatString" /> <keyword name="condaVersion" id="condaVersion" ref="eric6.CondaInterface.__init__.html#condaVersion" /> @@ -17310,7 +17330,7 @@ <keyword name="generateVersionInfo" id="generateVersionInfo" ref="eric6.Utilities.__init__.html#generateVersionInfo" /> <keyword name="getAllImages" id="getAllImages" ref="eric6.WebBrowser.Tools.Scripts.html#getAllImages" /> <keyword name="getAllMetaAttributes" id="getAllMetaAttributes" ref="eric6.WebBrowser.Tools.Scripts.html#getAllMetaAttributes" /> - <keyword name="getAnnotationComplexity" id="getAnnotationComplexity" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#getAnnotationComplexity" /> + <keyword name="getAnnotationComplexity" id="getAnnotationComplexity" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#getAnnotationComplexity" /> <keyword name="getAttrQualName" id="getAttrQualName" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityUtils.html#getAttrQualName" /> <keyword name="getBasicHelper" id="getBasicHelper" ref="eric6.VCS.__init__.html#getBasicHelper" /> <keyword name="getCallName" id="getCallName" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.SecurityUtils.html#getCallName" /> @@ -17512,7 +17532,7 @@ <keyword name="handleSingleApplication" id="handleSingleApplication" ref="eric6.eric6.html#handleSingleApplication" /> <keyword name="hasEnvironmentEntry" id="hasEnvironmentEntry" ref="eric6.Utilities.__init__.html#hasEnvironmentEntry" /> <keyword name="hasShell" id="hasShell" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.injectionShell.html#hasShell" /> - <keyword name="hasTypeAnnotations" id="hasTypeAnnotations" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html#hasTypeAnnotations" /> + <keyword name="hasTypeAnnotations" id="hasTypeAnnotations" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html#hasTypeAnnotations" /> <keyword name="hashPassword" id="hashPassword" ref="eric6.Utilities.crypto.py3PBKDF2.html#hashPassword" /> <keyword name="hashPasswordTuple" id="hashPasswordTuple" ref="eric6.Utilities.crypto.py3PBKDF2.html#hashPasswordTuple" /> <keyword name="hg (Module)" id="hg (Module)" ref="eric6.Plugins.VcsPlugins.vcsMercurial.hg.html" /> @@ -17905,6 +17925,11 @@ <keyword name="trailing_blank_lines" id="trailing_blank_lines" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#trailing_blank_lines" /> <keyword name="trailing_whitespace" id="trailing_whitespace" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#trailing_whitespace" /> <keyword name="transform2call" id="transform2call" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.djangoXssVulnerability.html#transform2call" /> + <keyword name="translations (Module)" id="translations (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.translations.html" /> + <keyword name="translations (Module)" id="translations (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.translations.html" /> + <keyword name="translations (Module)" id="translations (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.translations.html" /> + <keyword name="translations (Module)" id="translations (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.translations.html" /> + <keyword name="translations (Module)" id="translations (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.translations.html" /> <keyword name="translations (Module)" id="translations (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.translations.html" /> <keyword name="translations (Module)" id="translations (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.translations.html" /> <keyword name="tryExcept (Module)" id="tryExcept (Module)" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.tryExcept.html" /> @@ -18209,7 +18234,8 @@ <file>eric6.PluginManager.PluginRepositoryDialog.html</file> <file>eric6.PluginManager.PluginUninstallDialog.html</file> <file>eric6.Plugins.AboutPlugin.AboutDialog.html</file> - <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.AnnotationsChecker.html</file> + <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html</file> + <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.translations.html</file> <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.AstUtilities.html</file> <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleAddBuiltinIgnoreDialog.html</file> <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html</file> @@ -18217,10 +18243,14 @@ <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCodeSelectionDialog.html</file> <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html</file> <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleStatisticsDialog.html</file> - <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html</file> - <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html</file> - <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html</file> - <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.NamingStyleChecker.html</file> + <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html</file> + <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.translations.html</file> + <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html</file> + <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.translations.html</file> + <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html</file> + <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.translations.html</file> + <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.NamingStyleChecker.html</file> + <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.translations.html</file> <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.__init__.html</file> <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.assert.html</file> <file>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.awsHardcodedPassword.html</file> @@ -19077,6 +19107,11 @@ <file>index-eric6.PipInterface.html</file> <file>index-eric6.PluginManager.html</file> <file>index-eric6.Plugins.AboutPlugin.html</file> + <file>index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.html</file> + <file>index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.html</file> + <file>index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.html</file> + <file>index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.html</file> + <file>index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Naming.html</file> <file>index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.Checks.html</file> <file>index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.Security.html</file> <file>index-eric6.Plugins.CheckerPlugins.CodeStyleChecker.html</file>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker.html Tue Oct 13 19:02:26 2020 +0200 @@ -0,0 +1,516 @@ +<!DOCTYPE html> +<html><head> +<title>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker</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>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsChecker</h1> + +<p> +Module implementing a checker for function type annotations. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#AnnotationsChecker">AnnotationsChecker</a></td> +<td>Class implementing a checker for function type annotations.</td> +</tr> +<tr> +<td><a href="#FunctionVisitor">FunctionVisitor</a></td> +<td>Class implementing a node visitor to check function annotations.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#getAnnotationComplexity">getAnnotationComplexity</a></td> +<td>Function to determine the annotation complexity.</td> +</tr> +<tr> +<td><a href="#hasTypeAnnotations">hasTypeAnnotations</a></td> +<td>Function to check for type annotations.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="AnnotationsChecker" ID="AnnotationsChecker"></a> +<h2>AnnotationsChecker</h2> + +<p> + Class implementing a checker for function type annotations. +</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="#AnnotationsChecker.__init__">AnnotationsChecker</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#AnnotationsChecker.__checkAnnotationComplexity">__checkAnnotationComplexity</a></td> +<td>Private method to check the type annotation complexity.</td> +</tr> +<tr> +<td><a href="#AnnotationsChecker.__checkAnnotationsCoverage">__checkAnnotationsCoverage</a></td> +<td>Private method to check for function annotation coverage.</td> +</tr> +<tr> +<td><a href="#AnnotationsChecker.__checkFunctionAnnotations">__checkFunctionAnnotations</a></td> +<td>Private method to check for function annotation issues.</td> +</tr> +<tr> +<td><a href="#AnnotationsChecker.__error">__error</a></td> +<td>Private method to record an issue.</td> +</tr> +<tr> +<td><a href="#AnnotationsChecker.__generateTree">__generateTree</a></td> +<td>Private method to generate an AST for our source.</td> +</tr> +<tr> +<td><a href="#AnnotationsChecker.__ignoreCode">__ignoreCode</a></td> +<td>Private method to check if the message code should be ignored.</td> +</tr> +<tr> +<td><a href="#AnnotationsChecker.__reportInvalidSyntax">__reportInvalidSyntax</a></td> +<td>Private method to report a syntax error.</td> +</tr> +<tr> +<td><a href="#AnnotationsChecker.run">run</a></td> +<td>Public method to check the given source against annotation issues.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="AnnotationsChecker.__init__" ID="AnnotationsChecker.__init__"></a> +<h4>AnnotationsChecker (Constructor)</h4> +<b>AnnotationsChecker</b>(<i>source, filename, select, ignore, expected, repeat, args</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>source</i> (list of str)</dt> +<dd> +source code to be checked +</dd> +<dt><i>filename</i> (str)</dt> +<dd> +name of the source file +</dd> +<dt><i>select</i> (list of str)</dt> +<dd> +list of selected codes +</dd> +<dt><i>ignore</i> (list of str)</dt> +<dd> +list of codes to be ignored +</dd> +<dt><i>expected</i> (list of str)</dt> +<dd> +list of expected codes +</dd> +<dt><i>repeat</i> (bool)</dt> +<dd> +flag indicating to report each occurrence of a code +</dd> +<dt><i>args</i> (dict)</dt> +<dd> +dictionary of arguments for the annotation checks +</dd> +</dl> +<a NAME="AnnotationsChecker.__checkAnnotationComplexity" ID="AnnotationsChecker.__checkAnnotationComplexity"></a> +<h4>AnnotationsChecker.__checkAnnotationComplexity</h4> +<b>__checkAnnotationComplexity</b>(<i></i>) + +<p> + Private method to check the type annotation complexity. +</p> +<a NAME="AnnotationsChecker.__checkAnnotationsCoverage" ID="AnnotationsChecker.__checkAnnotationsCoverage"></a> +<h4>AnnotationsChecker.__checkAnnotationsCoverage</h4> +<b>__checkAnnotationsCoverage</b>(<i></i>) + +<p> + Private method to check for function annotation coverage. +</p> +<a NAME="AnnotationsChecker.__checkFunctionAnnotations" ID="AnnotationsChecker.__checkFunctionAnnotations"></a> +<h4>AnnotationsChecker.__checkFunctionAnnotations</h4> +<b>__checkFunctionAnnotations</b>(<i></i>) + +<p> + Private method to check for function annotation issues. +</p> +<a NAME="AnnotationsChecker.__error" ID="AnnotationsChecker.__error"></a> +<h4>AnnotationsChecker.__error</h4> +<b>__error</b>(<i>lineNumber, offset, code, *args</i>) + +<p> + Private method to record an issue. +</p> +<dl> + +<dt><i>lineNumber</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>offset</i> (int)</dt> +<dd> +position within line of the issue +</dd> +<dt><i>code</i> (str)</dt> +<dd> +message code +</dd> +<dt><i>args</i> (list)</dt> +<dd> +arguments for the message +</dd> +</dl> +<a NAME="AnnotationsChecker.__generateTree" ID="AnnotationsChecker.__generateTree"></a> +<h4>AnnotationsChecker.__generateTree</h4> +<b>__generateTree</b>(<i></i>) + +<p> + Private method to generate an AST for our source. +</p> +<dl> +<dt>Returns:</dt> +<dd> +generated AST +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +ast.Module +</dd> +</dl> +<a NAME="AnnotationsChecker.__ignoreCode" ID="AnnotationsChecker.__ignoreCode"></a> +<h4>AnnotationsChecker.__ignoreCode</h4> +<b>__ignoreCode</b>(<i>code</i>) + +<p> + Private method to check if the message code should be ignored. +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +message code to check for +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating to ignore the given code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="AnnotationsChecker.__reportInvalidSyntax" ID="AnnotationsChecker.__reportInvalidSyntax"></a> +<h4>AnnotationsChecker.__reportInvalidSyntax</h4> +<b>__reportInvalidSyntax</b>(<i></i>) + +<p> + Private method to report a syntax error. +</p> +<a NAME="AnnotationsChecker.run" ID="AnnotationsChecker.run"></a> +<h4>AnnotationsChecker.run</h4> +<b>run</b>(<i></i>) + +<p> + Public method to check the given source against annotation issues. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="FunctionVisitor" ID="FunctionVisitor"></a> +<h2>FunctionVisitor</h2> + +<p> + Class implementing a node visitor to check function annotations. +</p> +<p> + Note: this class is modelled after flake8-annotations checker. +</p> +<h3>Derived from</h3> +ast.NodeVisitor +<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="#FunctionVisitor.__init__">FunctionVisitor</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#FunctionVisitor.__checkFunctionNode">__checkFunctionNode</a></td> +<td>Private method to check an individual function definition node.</td> +</tr> +<tr> +<td><a href="#FunctionVisitor.__classifyArgumentError">__classifyArgumentError</a></td> +<td>Private method to classify and record an argument annotation issue.</td> +</tr> +<tr> +<td><a href="#FunctionVisitor.__classifyReturnError">__classifyReturnError</a></td> +<td>Private method to classify and record a return annotation issue.</td> +</tr> +<tr> +<td><a href="#FunctionVisitor.visit_AsyncFunctionDef">visit_AsyncFunctionDef</a></td> +<td>Public method to handle an async function or method definition.</td> +</tr> +<tr> +<td><a href="#FunctionVisitor.visit_ClassDef">visit_ClassDef</a></td> +<td>Public method to handle class definitions.</td> +</tr> +<tr> +<td><a href="#FunctionVisitor.visit_FunctionDef">visit_FunctionDef</a></td> +<td>Public method to handle a function or method definition.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="FunctionVisitor.__init__" ID="FunctionVisitor.__init__"></a> +<h4>FunctionVisitor (Constructor)</h4> +<b>FunctionVisitor</b>(<i>sourceLines</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>sourceLines</i> (list of str)</dt> +<dd> +lines of source code +</dd> +</dl> +<a NAME="FunctionVisitor.__checkFunctionNode" ID="FunctionVisitor.__checkFunctionNode"></a> +<h4>FunctionVisitor.__checkFunctionNode</h4> +<b>__checkFunctionNode</b>(<i>node, classMethod=False</i>) + +<p> + Private method to check an individual function definition node. +</p> +<dl> + +<dt><i>node</i> (ast.FunctionDef or ast.AsyncFunctionDef)</dt> +<dd> +reference to the node to be processed +</dd> +<dt><i>classMethod</i> (bool)</dt> +<dd> +flag indicating a class method +</dd> +</dl> +<a NAME="FunctionVisitor.__classifyArgumentError" ID="FunctionVisitor.__classifyArgumentError"></a> +<h4>FunctionVisitor.__classifyArgumentError</h4> +<b>__classifyArgumentError</b>(<i>argNode, argType, methodType</i>) + +<p> + Private method to classify and record an argument annotation issue. +</p> +<dl> + +<dt><i>argNode</i> (ast.arguments)</dt> +<dd> +reference to the argument node +</dd> +<dt><i>argType</i> (str)</dt> +<dd> +type of the argument node +</dd> +<dt><i>methodType</i> (str)</dt> +<dd> +type of method/function the argument belongs to +</dd> +</dl> +<a NAME="FunctionVisitor.__classifyReturnError" ID="FunctionVisitor.__classifyReturnError"></a> +<h4>FunctionVisitor.__classifyReturnError</h4> +<b>__classifyReturnError</b>(<i>methodType, visibilityType, lineno, colOffset</i>) + +<p> + Private method to classify and record a return annotation issue. +</p> +<dl> + +<dt><i>methodType</i> (str)</dt> +<dd> +type of method/function the argument belongs to +</dd> +<dt><i>visibilityType</i> (str)</dt> +<dd> +visibility of the function +</dd> +<dt><i>lineno</i> (int)</dt> +<dd> +line number +</dd> +<dt><i>colOffset</i> (int)</dt> +<dd> +column number +</dd> +</dl> +<a NAME="FunctionVisitor.visit_AsyncFunctionDef" ID="FunctionVisitor.visit_AsyncFunctionDef"></a> +<h4>FunctionVisitor.visit_AsyncFunctionDef</h4> +<b>visit_AsyncFunctionDef</b>(<i>node</i>) + +<p> + Public method to handle an async function or method definition. +</p> +<dl> + +<dt><i>node</i> (ast.AsyncFunctionDef)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="FunctionVisitor.visit_ClassDef" ID="FunctionVisitor.visit_ClassDef"></a> +<h4>FunctionVisitor.visit_ClassDef</h4> +<b>visit_ClassDef</b>(<i>node</i>) + +<p> + Public method to handle class definitions. +</p> +<dl> + +<dt><i>node</i> (ast.ClassDef)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="FunctionVisitor.visit_FunctionDef" ID="FunctionVisitor.visit_FunctionDef"></a> +<h4>FunctionVisitor.visit_FunctionDef</h4> +<b>visit_FunctionDef</b>(<i>node</i>) + +<p> + Public method to handle a function or method definition. +</p> +<dl> + +<dt><i>node</i> (ast.FunctionDef)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="getAnnotationComplexity" ID="getAnnotationComplexity"></a> +<h2>getAnnotationComplexity</h2> +<b>getAnnotationComplexity</b>(<i>annotationNode</i>) + +<p> + Function to determine the annotation complexity. +</p> +<dl> + +<dt><i>annotationNode</i> (ast.AST)</dt> +<dd> +reference to the node to determine the annotation + complexity for +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +annotation complexity +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> += int +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="hasTypeAnnotations" ID="hasTypeAnnotations"></a> +<h2>hasTypeAnnotations</h2> +<b>hasTypeAnnotations</b>(<i>funcNode</i>) + +<p> + Function to check for type annotations. +</p> +<dl> + +<dt><i>funcNode</i> (ast.AsyncFunctionDef or ast.FunctionDef)</dt> +<dd> +reference to the function definition node to be checked +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating the presence of type annotations +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</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/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.translations.html Tue Oct 13 19:02:26 2020 +0200 @@ -0,0 +1,45 @@ +<!DOCTYPE html> +<html><head> +<title>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.translations</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>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.translations</h1> + +<p> +Module implementing message translations for the code style plugin messages +(code annotations part). +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>_annotationsMessages</td></tr><tr><td>_annotationsMessagesSampleArgs</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker.html Tue Oct 13 19:02:26 2020 +0200 @@ -0,0 +1,336 @@ +<!DOCTYPE html> +<html><head> +<title>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker</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>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.ComplexityChecker</h1> + +<p> +Module implementing a checker for code complexity. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#ComplexityChecker">ComplexityChecker</a></td> +<td>Class implementing a checker for code complexity.</td> +</tr> +<tr> +<td><a href="#LineComplexityVisitor">LineComplexityVisitor</a></td> +<td>Class calculating the number of AST nodes per line of code and the median nodes/line score.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="ComplexityChecker" ID="ComplexityChecker"></a> +<h2>ComplexityChecker</h2> + +<p> + Class implementing a checker for code complexity. +</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="#ComplexityChecker.__init__">ComplexityChecker</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#ComplexityChecker.__checkLineComplexity">__checkLineComplexity</a></td> +<td>Private method to check the complexity of a single line of code and the median line complexity of the source code.</td> +</tr> +<tr> +<td><a href="#ComplexityChecker.__checkMcCabeComplexity">__checkMcCabeComplexity</a></td> +<td>Private method to check the McCabe code complexity.</td> +</tr> +<tr> +<td><a href="#ComplexityChecker.__error">__error</a></td> +<td>Private method to record an issue.</td> +</tr> +<tr> +<td><a href="#ComplexityChecker.__ignoreCode">__ignoreCode</a></td> +<td>Private method to check if the message code should be ignored.</td> +</tr> +<tr> +<td><a href="#ComplexityChecker.__reportInvalidSyntax">__reportInvalidSyntax</a></td> +<td>Private method to report a syntax error.</td> +</tr> +<tr> +<td><a href="#ComplexityChecker.run">run</a></td> +<td>Public method to check the given source for code complexity.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="ComplexityChecker.__init__" ID="ComplexityChecker.__init__"></a> +<h4>ComplexityChecker (Constructor)</h4> +<b>ComplexityChecker</b>(<i>source, filename, select, ignore, args</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>source</i> (list of str)</dt> +<dd> +source code to be checked +</dd> +<dt><i>filename</i> (str)</dt> +<dd> +name of the source file +</dd> +<dt><i>select</i> (list of str)</dt> +<dd> +list of selected codes +</dd> +<dt><i>ignore</i> (list of str)</dt> +<dd> +list of codes to be ignored +</dd> +<dt><i>args</i> (dict)</dt> +<dd> +dictionary of arguments for the miscellaneous checks +</dd> +</dl> +<a NAME="ComplexityChecker.__checkLineComplexity" ID="ComplexityChecker.__checkLineComplexity"></a> +<h4>ComplexityChecker.__checkLineComplexity</h4> +<b>__checkLineComplexity</b>(<i></i>) + +<p> + Private method to check the complexity of a single line of code and + the median line complexity of the source code. +</p> +<p> + Complexity is defined as the number of AST nodes produced by a line + of code. +</p> +<a NAME="ComplexityChecker.__checkMcCabeComplexity" ID="ComplexityChecker.__checkMcCabeComplexity"></a> +<h4>ComplexityChecker.__checkMcCabeComplexity</h4> +<b>__checkMcCabeComplexity</b>(<i></i>) + +<p> + Private method to check the McCabe code complexity. +</p> +<a NAME="ComplexityChecker.__error" ID="ComplexityChecker.__error"></a> +<h4>ComplexityChecker.__error</h4> +<b>__error</b>(<i>lineNumber, offset, code, *args</i>) + +<p> + Private method to record an issue. +</p> +<dl> + +<dt><i>lineNumber</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>offset</i> (int)</dt> +<dd> +position within line of the issue +</dd> +<dt><i>code</i> (str)</dt> +<dd> +message code +</dd> +<dt><i>args</i> (list)</dt> +<dd> +arguments for the message +</dd> +</dl> +<a NAME="ComplexityChecker.__ignoreCode" ID="ComplexityChecker.__ignoreCode"></a> +<h4>ComplexityChecker.__ignoreCode</h4> +<b>__ignoreCode</b>(<i>code</i>) + +<p> + Private method to check if the message code should be ignored. +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +message code to check for +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating to ignore the given code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="ComplexityChecker.__reportInvalidSyntax" ID="ComplexityChecker.__reportInvalidSyntax"></a> +<h4>ComplexityChecker.__reportInvalidSyntax</h4> +<b>__reportInvalidSyntax</b>(<i></i>) + +<p> + Private method to report a syntax error. +</p> +<a NAME="ComplexityChecker.run" ID="ComplexityChecker.run"></a> +<h4>ComplexityChecker.run</h4> +<b>run</b>(<i></i>) + +<p> + Public method to check the given source for code complexity. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="LineComplexityVisitor" ID="LineComplexityVisitor"></a> +<h2>LineComplexityVisitor</h2> + +<p> + Class calculating the number of AST nodes per line of code + and the median nodes/line score. +</p> +<h3>Derived from</h3> +ast.NodeVisitor +<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="#LineComplexityVisitor.__init__">LineComplexityVisitor</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#LineComplexityVisitor.score">score</a></td> +<td>Public method to calculate the median.</td> +</tr> +<tr> +<td><a href="#LineComplexityVisitor.sortedList">sortedList</a></td> +<td>Public method to get a sorted list of (line, nodes) tuples.</td> +</tr> +<tr> +<td><a href="#LineComplexityVisitor.visit">visit</a></td> +<td>Public method to recursively visit all the nodes and add up the instructions.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="LineComplexityVisitor.__init__" ID="LineComplexityVisitor.__init__"></a> +<h4>LineComplexityVisitor (Constructor)</h4> +<b>LineComplexityVisitor</b>(<i></i>) + +<p> + Constructor +</p> +<a NAME="LineComplexityVisitor.score" ID="LineComplexityVisitor.score"></a> +<h4>LineComplexityVisitor.score</h4> +<b>score</b>(<i></i>) + +<p> + Public method to calculate the median. +</p> +<dl> +<dt>Returns:</dt> +<dd> +median line complexity value +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +float +</dd> +</dl> +<a NAME="LineComplexityVisitor.sortedList" ID="LineComplexityVisitor.sortedList"></a> +<h4>LineComplexityVisitor.sortedList</h4> +<b>sortedList</b>(<i></i>) + +<p> + Public method to get a sorted list of (line, nodes) tuples. +</p> +<dl> +<dt>Returns:</dt> +<dd> +sorted list of (line, nodes) tuples +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of tuple of (int,int) +</dd> +</dl> +<a NAME="LineComplexityVisitor.visit" ID="LineComplexityVisitor.visit"></a> +<h4>LineComplexityVisitor.visit</h4> +<b>visit</b>(<i>node</i>) + +<p> + Public method to recursively visit all the nodes and add up the + instructions. +</p> +<dl> + +<dt><i>node</i> (ast.AST)</dt> +<dd> +reference to the node +</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/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.translations.html Tue Oct 13 19:02:26 2020 +0200 @@ -0,0 +1,45 @@ +<!DOCTYPE html> +<html><head> +<title>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.translations</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>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Complexity.translations</h1> + +<p> +Module implementing message translations for the code style plugin messages +(code complexity part). +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>_complexityMessages</td></tr><tr><td>_complexityMessagesSampleArgs</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +</body></html> \ No newline at end of file
--- a/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker.html Tue Oct 13 18:23:53 2020 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,336 +0,0 @@ -<!DOCTYPE html> -<html><head> -<title>eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker</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>eric6.Plugins.CheckerPlugins.CodeStyleChecker.ComplexityChecker</h1> - -<p> -Module implementing a checker for code complexity. -</p> -<h3>Global Attributes</h3> - -<table> -<tr><td>None</td></tr> -</table> -<h3>Classes</h3> - -<table> - -<tr> -<td><a href="#ComplexityChecker">ComplexityChecker</a></td> -<td>Class implementing a checker for code complexity.</td> -</tr> -<tr> -<td><a href="#LineComplexityVisitor">LineComplexityVisitor</a></td> -<td>Class calculating the number of AST nodes per line of code and the median nodes/line score.</td> -</tr> -</table> -<h3>Functions</h3> - -<table> -<tr><td>None</td></tr> -</table> -<hr /> -<hr /> -<a NAME="ComplexityChecker" ID="ComplexityChecker"></a> -<h2>ComplexityChecker</h2> - -<p> - Class implementing a checker for code complexity. -</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="#ComplexityChecker.__init__">ComplexityChecker</a></td> -<td>Constructor</td> -</tr> -<tr> -<td><a href="#ComplexityChecker.__checkLineComplexity">__checkLineComplexity</a></td> -<td>Private method to check the complexity of a single line of code and the median line complexity of the source code.</td> -</tr> -<tr> -<td><a href="#ComplexityChecker.__checkMcCabeComplexity">__checkMcCabeComplexity</a></td> -<td>Private method to check the McCabe code complexity.</td> -</tr> -<tr> -<td><a href="#ComplexityChecker.__error">__error</a></td> -<td>Private method to record an issue.</td> -</tr> -<tr> -<td><a href="#ComplexityChecker.__ignoreCode">__ignoreCode</a></td> -<td>Private method to check if the message code should be ignored.</td> -</tr> -<tr> -<td><a href="#ComplexityChecker.__reportInvalidSyntax">__reportInvalidSyntax</a></td> -<td>Private method to report a syntax error.</td> -</tr> -<tr> -<td><a href="#ComplexityChecker.run">run</a></td> -<td>Public method to check the given source for code complexity.</td> -</tr> -</table> -<h3>Static Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> - -<a NAME="ComplexityChecker.__init__" ID="ComplexityChecker.__init__"></a> -<h4>ComplexityChecker (Constructor)</h4> -<b>ComplexityChecker</b>(<i>source, filename, select, ignore, args</i>) - -<p> - Constructor -</p> -<dl> - -<dt><i>source</i> (list of str)</dt> -<dd> -source code to be checked -</dd> -<dt><i>filename</i> (str)</dt> -<dd> -name of the source file -</dd> -<dt><i>select</i> (list of str)</dt> -<dd> -list of selected codes -</dd> -<dt><i>ignore</i> (list of str)</dt> -<dd> -list of codes to be ignored -</dd> -<dt><i>args</i> (dict)</dt> -<dd> -dictionary of arguments for the miscellaneous checks -</dd> -</dl> -<a NAME="ComplexityChecker.__checkLineComplexity" ID="ComplexityChecker.__checkLineComplexity"></a> -<h4>ComplexityChecker.__checkLineComplexity</h4> -<b>__checkLineComplexity</b>(<i></i>) - -<p> - Private method to check the complexity of a single line of code and - the median line complexity of the source code. -</p> -<p> - Complexity is defined as the number of AST nodes produced by a line - of code. -</p> -<a NAME="ComplexityChecker.__checkMcCabeComplexity" ID="ComplexityChecker.__checkMcCabeComplexity"></a> -<h4>ComplexityChecker.__checkMcCabeComplexity</h4> -<b>__checkMcCabeComplexity</b>(<i></i>) - -<p> - Private method to check the McCabe code complexity. -</p> -<a NAME="ComplexityChecker.__error" ID="ComplexityChecker.__error"></a> -<h4>ComplexityChecker.__error</h4> -<b>__error</b>(<i>lineNumber, offset, code, *args</i>) - -<p> - Private method to record an issue. -</p> -<dl> - -<dt><i>lineNumber</i> (int)</dt> -<dd> -line number of the issue -</dd> -<dt><i>offset</i> (int)</dt> -<dd> -position within line of the issue -</dd> -<dt><i>code</i> (str)</dt> -<dd> -message code -</dd> -<dt><i>args</i> (list)</dt> -<dd> -arguments for the message -</dd> -</dl> -<a NAME="ComplexityChecker.__ignoreCode" ID="ComplexityChecker.__ignoreCode"></a> -<h4>ComplexityChecker.__ignoreCode</h4> -<b>__ignoreCode</b>(<i>code</i>) - -<p> - Private method to check if the message code should be ignored. -</p> -<dl> - -<dt><i>code</i> (str)</dt> -<dd> -message code to check for -</dd> -</dl> -<dl> -<dt>Returns:</dt> -<dd> -flag indicating to ignore the given code -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> -<a NAME="ComplexityChecker.__reportInvalidSyntax" ID="ComplexityChecker.__reportInvalidSyntax"></a> -<h4>ComplexityChecker.__reportInvalidSyntax</h4> -<b>__reportInvalidSyntax</b>(<i></i>) - -<p> - Private method to report a syntax error. -</p> -<a NAME="ComplexityChecker.run" ID="ComplexityChecker.run"></a> -<h4>ComplexityChecker.run</h4> -<b>run</b>(<i></i>) - -<p> - Public method to check the given source for code complexity. -</p> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="LineComplexityVisitor" ID="LineComplexityVisitor"></a> -<h2>LineComplexityVisitor</h2> - -<p> - Class calculating the number of AST nodes per line of code - and the median nodes/line score. -</p> -<h3>Derived from</h3> -ast.NodeVisitor -<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="#LineComplexityVisitor.__init__">LineComplexityVisitor</a></td> -<td>Constructor</td> -</tr> -<tr> -<td><a href="#LineComplexityVisitor.score">score</a></td> -<td>Public method to calculate the median.</td> -</tr> -<tr> -<td><a href="#LineComplexityVisitor.sortedList">sortedList</a></td> -<td>Public method to get a sorted list of (line, nodes) tuples.</td> -</tr> -<tr> -<td><a href="#LineComplexityVisitor.visit">visit</a></td> -<td>Public method to recursively visit all the nodes and add up the instructions.</td> -</tr> -</table> -<h3>Static Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> - -<a NAME="LineComplexityVisitor.__init__" ID="LineComplexityVisitor.__init__"></a> -<h4>LineComplexityVisitor (Constructor)</h4> -<b>LineComplexityVisitor</b>(<i></i>) - -<p> - Constructor -</p> -<a NAME="LineComplexityVisitor.score" ID="LineComplexityVisitor.score"></a> -<h4>LineComplexityVisitor.score</h4> -<b>score</b>(<i></i>) - -<p> - Public method to calculate the median. -</p> -<dl> -<dt>Returns:</dt> -<dd> -median line complexity value -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -float -</dd> -</dl> -<a NAME="LineComplexityVisitor.sortedList" ID="LineComplexityVisitor.sortedList"></a> -<h4>LineComplexityVisitor.sortedList</h4> -<b>sortedList</b>(<i></i>) - -<p> - Public method to get a sorted list of (line, nodes) tuples. -</p> -<dl> -<dt>Returns:</dt> -<dd> -sorted list of (line, nodes) tuples -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -list of tuple of (int,int) -</dd> -</dl> -<a NAME="LineComplexityVisitor.visit" ID="LineComplexityVisitor.visit"></a> -<h4>LineComplexityVisitor.visit</h4> -<b>visit</b>(<i>node</i>) - -<p> - Public method to recursively visit all the nodes and add up the - instructions. -</p> -<dl> - -<dt><i>node</i> (ast.AST)</dt> -<dd> -reference to the node -</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/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker.html Tue Oct 13 19:02:26 2020 +0200 @@ -0,0 +1,1289 @@ +<!DOCTYPE html> +<html><head> +<title>eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker</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>eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.DocStyleChecker</h1> + +<p> +Module implementing a checker for documentation string conventions. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#DocStyleChecker">DocStyleChecker</a></td> +<td>Class implementing a checker for documentation string conventions.</td> +</tr> +<tr> +<td><a href="#DocStyleContext">DocStyleContext</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="DocStyleChecker" ID="DocStyleChecker"></a> +<h2>DocStyleChecker</h2> + +<p> + Class implementing a checker for 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="#DocStyleChecker.__init__">DocStyleChecker</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__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="#DocStyleChecker.__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="#DocStyleChecker.__checkBlankAfterSummary">__checkBlankAfterSummary</a></td> +<td>Private method to check, that docstring summaries are followed by a blank line.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__checkBlankBeforeAndAfterClass">__checkBlankBeforeAndAfterClass</a></td> +<td>Private method to check, that class docstrings have one blank line around them.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__checkClassDocstring">__checkClassDocstring</a></td> +<td>Private method to check, that all public functions and methods have a docstring.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__checkEndsWithPeriod">__checkEndsWithPeriod</a></td> +<td>Private method to check, that docstring summaries end with a period.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__checkEricBlankAfterSummary">__checkEricBlankAfterSummary</a></td> +<td>Private method to check, that docstring summaries are followed by a blank line.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td> +<td>Private method to check, that docstring summaries end with a period.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__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="#DocStyleChecker.__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="#DocStyleChecker.__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="#DocStyleChecker.__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="#DocStyleChecker.__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="#DocStyleChecker.__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="#DocStyleChecker.__checkEricSignal">__checkEricSignal</a></td> +<td>Private method to check, that docstrings contain an @signal line if they define signals and don't otherwise.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__checkEricSummary">__checkEricSummary</a></td> +<td>Private method to check, that method docstring summaries start with specific words.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__checkFunctionDocstring">__checkFunctionDocstring</a></td> +<td>Private method to check, that all public functions and methods have a docstring.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__checkImperativeMood">__checkImperativeMood</a></td> +<td>Private method to check, that docstring summaries are in imperative mood.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__checkIndent">__checkIndent</a></td> +<td>Private method to check, that docstrings are properly indented.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__checkModulesDocstrings">__checkModulesDocstrings</a></td> +<td>Private method to check, if the module has a docstring.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__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="#DocStyleChecker.__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="#DocStyleChecker.__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="#DocStyleChecker.__checkReturnType">__checkReturnType</a></td> +<td>Private method to check, that docstrings mention the return value type.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__checkSummary">__checkSummary</a></td> +<td>Private method to check, that docstring summaries contain some text.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td> +<td>Private method to check, that all docstrings are surrounded by triple double quotes.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__error">__error</a></td> +<td>Private method to record an issue.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__getArgNames">__getArgNames</a></td> +<td>Private method to get the argument names of a function node.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__getSummaryLine">__getSummaryLine</a></td> +<td>Private method to extract the summary line.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__getSummaryLines">__getSummaryLines</a></td> +<td>Private method to extract the summary lines.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__ignoreCode">__ignoreCode</a></td> +<td>Private method to check if the error code should be ignored.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__parseClasses">__parseClasses</a></td> +<td>Private method to extract top-level classes.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__parseContexts">__parseContexts</a></td> +<td>Private method to extract a context from the source.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__parseDocstring">__parseDocstring</a></td> +<td>Private method to extract a docstring given `def` or `class` source.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__parseFunctions">__parseFunctions</a></td> +<td>Private method to extract top-level functions.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__parseMethods">__parseMethods</a></td> +<td>Private method to extract methods of all classes.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__parseModuleDocstring">__parseModuleDocstring</a></td> +<td>Private method to extract a docstring given a module source.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__parseTopLevel">__parseTopLevel</a></td> +<td>Private method to extract top-level functions or classes.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__readline">__readline</a></td> +<td>Private method to get the next line from the source.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__reportInvalidSyntax">__reportInvalidSyntax</a></td> +<td>Private method to report a syntax error.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__resetReadline">__resetReadline</a></td> +<td>Private method to reset the internal readline function.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.__skipIndentedBlock">__skipIndentedBlock</a></td> +<td>Private method to skip over an indented block of source code.</td> +</tr> +<tr> +<td><a href="#DocStyleChecker.run">run</a></td> +<td>Public method to check the given source for violations of doc string conventions.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="DocStyleChecker.__init__" ID="DocStyleChecker.__init__"></a> +<h4>DocStyleChecker (Constructor)</h4> +<b>DocStyleChecker</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="DocStyleChecker.__checkBackslashes" ID="DocStyleChecker.__checkBackslashes"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkBlankAfterLastParagraph" ID="DocStyleChecker.__checkBlankAfterLastParagraph"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkBlankAfterSummary" ID="DocStyleChecker.__checkBlankAfterSummary"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkBlankBeforeAndAfterClass" ID="DocStyleChecker.__checkBlankBeforeAndAfterClass"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkClassDocstring" ID="DocStyleChecker.__checkClassDocstring"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkEndsWithPeriod" ID="DocStyleChecker.__checkEndsWithPeriod"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkEricBlankAfterSummary" ID="DocStyleChecker.__checkEricBlankAfterSummary"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkEricEndsWithPeriod" ID="DocStyleChecker.__checkEricEndsWithPeriod"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkEricException" ID="DocStyleChecker.__checkEricException"></a> +<h4>DocStyleChecker.__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> +<p> + Note: This method also checks the raised and documented exceptions for + completeness (i.e. raised exceptions that are not documented or + documented exceptions that are not raised) +</p> +<dl> + +<dt><i>docstringContext</i></dt> +<dd> +docstring context (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkEricFunctionArguments" ID="DocStyleChecker.__checkEricFunctionArguments"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkEricNBlankAfterLastParagraph" ID="DocStyleChecker.__checkEricNBlankAfterLastParagraph"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkEricQuotesOnSeparateLines" ID="DocStyleChecker.__checkEricQuotesOnSeparateLines"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkEricReturn" ID="DocStyleChecker.__checkEricReturn"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkEricSignal" ID="DocStyleChecker.__checkEricSignal"></a> +<h4>DocStyleChecker.__checkEricSignal</h4> +<b>__checkEricSignal</b>(<i>docstringContext, context</i>) + +<p> + Private method to check, that docstrings contain an @signal line + if they define signals and don't otherwise. +</p> +<p> + Note: This method also checks the defined and documented signals for + completeness (i.e. defined signals that are not documented or + documented signals that are not defined) +</p> +<dl> + +<dt><i>docstringContext</i></dt> +<dd> +docstring context (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkEricSummary" ID="DocStyleChecker.__checkEricSummary"></a> +<h4>DocStyleChecker.__checkEricSummary</h4> +<b>__checkEricSummary</b>(<i>docstringContext, context</i>) + +<p> + Private method to check, that method docstring summaries start with + specific words. +</p> +<dl> + +<dt><i>docstringContext</i></dt> +<dd> +docstring context (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkFunctionDocstring" ID="DocStyleChecker.__checkFunctionDocstring"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkImperativeMood" ID="DocStyleChecker.__checkImperativeMood"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkIndent" ID="DocStyleChecker.__checkIndent"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkModulesDocstrings" ID="DocStyleChecker.__checkModulesDocstrings"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkNoBlankLineBefore" ID="DocStyleChecker.__checkNoBlankLineBefore"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkNoSignature" ID="DocStyleChecker.__checkNoSignature"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkOneLiner" ID="DocStyleChecker.__checkOneLiner"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkReturnType" ID="DocStyleChecker.__checkReturnType"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkSummary" ID="DocStyleChecker.__checkSummary"></a> +<h4>DocStyleChecker.__checkSummary</h4> +<b>__checkSummary</b>(<i>docstringContext, context</i>) + +<p> + Private method to check, that docstring summaries contain some text. +</p> +<dl> + +<dt><i>docstringContext</i></dt> +<dd> +docstring context (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__checkTripleDoubleQuotes" ID="DocStyleChecker.__checkTripleDoubleQuotes"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +<dt><i>context</i></dt> +<dd> +context of the docstring (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a> +<h4>DocStyleChecker.__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="DocStyleChecker.__getArgNames" ID="DocStyleChecker.__getArgNames"></a> +<h4>DocStyleChecker.__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> +tuple of two list of argument names, one for arguments + and one for keyword arguments (tuple of list of string) +</dd> +</dl> +<a NAME="DocStyleChecker.__getSummaryLine" ID="DocStyleChecker.__getSummaryLine"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +summary line (string) and the line it was found on (integer) +</dd> +</dl> +<a NAME="DocStyleChecker.__getSummaryLines" ID="DocStyleChecker.__getSummaryLines"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +summary lines (list of string) and the line it was found on + (integer) +</dd> +</dl> +<a NAME="DocStyleChecker.__ignoreCode" ID="DocStyleChecker.__ignoreCode"></a> +<h4>DocStyleChecker.__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="DocStyleChecker.__parseClasses" ID="DocStyleChecker.__parseClasses"></a> +<h4>DocStyleChecker.__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 DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__parseContexts" ID="DocStyleChecker.__parseContexts"></a> +<h4>DocStyleChecker.__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 DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__parseDocstring" ID="DocStyleChecker.__parseDocstring"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</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 (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__parseFunctions" ID="DocStyleChecker.__parseFunctions"></a> +<h4>DocStyleChecker.__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 DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__parseMethods" ID="DocStyleChecker.__parseMethods"></a> +<h4>DocStyleChecker.__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 DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__parseModuleDocstring" ID="DocStyleChecker.__parseModuleDocstring"></a> +<h4>DocStyleChecker.__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 (DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__parseTopLevel" ID="DocStyleChecker.__parseTopLevel"></a> +<h4>DocStyleChecker.__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 DocStyleContext) +</dd> +</dl> +<a NAME="DocStyleChecker.__readline" ID="DocStyleChecker.__readline"></a> +<h4>DocStyleChecker.__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="DocStyleChecker.__reportInvalidSyntax" ID="DocStyleChecker.__reportInvalidSyntax"></a> +<h4>DocStyleChecker.__reportInvalidSyntax</h4> +<b>__reportInvalidSyntax</b>(<i></i>) + +<p> + Private method to report a syntax error. +</p> +<a NAME="DocStyleChecker.__resetReadline" ID="DocStyleChecker.__resetReadline"></a> +<h4>DocStyleChecker.__resetReadline</h4> +<b>__resetReadline</b>(<i></i>) + +<p> + Private method to reset the internal readline function. +</p> +<a NAME="DocStyleChecker.__skipIndentedBlock" ID="DocStyleChecker.__skipIndentedBlock"></a> +<h4>DocStyleChecker.__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="DocStyleChecker.run" ID="DocStyleChecker.run"></a> +<h4>DocStyleChecker.run</h4> +<b>run</b>(<i></i>) + +<p> + Public method to check the given source for violations of doc string + conventions. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="DocStyleContext" ID="DocStyleContext"></a> +<h2>DocStyleContext</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="#DocStyleContext.__init__">DocStyleContext</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#DocStyleContext.contextType">contextType</a></td> +<td>Public method to get the context type.</td> +</tr> +<tr> +<td><a href="#DocStyleContext.end">end</a></td> +<td>Public method to get the end line number.</td> +</tr> +<tr> +<td><a href="#DocStyleContext.indent">indent</a></td> +<td>Public method to get the indentation of the first line.</td> +</tr> +<tr> +<td><a href="#DocStyleContext.setSpecial">setSpecial</a></td> +<td>Public method to set a special attribute for the context.</td> +</tr> +<tr> +<td><a href="#DocStyleContext.source">source</a></td> +<td>Public method to get the source.</td> +</tr> +<tr> +<td><a href="#DocStyleContext.special">special</a></td> +<td>Public method to get the special context attribute string.</td> +</tr> +<tr> +<td><a href="#DocStyleContext.ssource">ssource</a></td> +<td>Public method to get the joined source lines.</td> +</tr> +<tr> +<td><a href="#DocStyleContext.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="DocStyleContext.__init__" ID="DocStyleContext.__init__"></a> +<h4>DocStyleContext (Constructor)</h4> +<b>DocStyleContext</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="DocStyleContext.contextType" ID="DocStyleContext.contextType"></a> +<h4>DocStyleContext.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="DocStyleContext.end" ID="DocStyleContext.end"></a> +<h4>DocStyleContext.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="DocStyleContext.indent" ID="DocStyleContext.indent"></a> +<h4>DocStyleContext.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="DocStyleContext.setSpecial" ID="DocStyleContext.setSpecial"></a> +<h4>DocStyleContext.setSpecial</h4> +<b>setSpecial</b>(<i>special</i>) + +<p> + Public method to set a special attribute for the context. +</p> +<dl> + +<dt><i>special</i> (str)</dt> +<dd> +attribute string +</dd> +</dl> +<a NAME="DocStyleContext.source" ID="DocStyleContext.source"></a> +<h4>DocStyleContext.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="DocStyleContext.special" ID="DocStyleContext.special"></a> +<h4>DocStyleContext.special</h4> +<b>special</b>(<i></i>) + +<p> + Public method to get the special context attribute string. +</p> +<dl> +<dt>Returns:</dt> +<dd> +attribute string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<a NAME="DocStyleContext.ssource" ID="DocStyleContext.ssource"></a> +<h4>DocStyleContext.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="DocStyleContext.start" ID="DocStyleContext.start"></a> +<h4>DocStyleContext.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/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.translations.html Tue Oct 13 19:02:26 2020 +0200 @@ -0,0 +1,45 @@ +<!DOCTYPE html> +<html><head> +<title>eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.translations</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>eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyle.translations</h1> + +<p> +Module implementing message translations for the code style plugin messages +(code documentation part). +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>_docStyleMessages</td></tr><tr><td>_docStyleMessagesSampleArgs</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +</body></html> \ No newline at end of file
--- a/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker.html Tue Oct 13 18:23:53 2020 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1289 +0,0 @@ -<!DOCTYPE html> -<html><head> -<title>eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker</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>eric6.Plugins.CheckerPlugins.CodeStyleChecker.DocStyleChecker</h1> - -<p> -Module implementing a checker for documentation string conventions. -</p> -<h3>Global Attributes</h3> - -<table> -<tr><td>None</td></tr> -</table> -<h3>Classes</h3> - -<table> - -<tr> -<td><a href="#DocStyleChecker">DocStyleChecker</a></td> -<td>Class implementing a checker for documentation string conventions.</td> -</tr> -<tr> -<td><a href="#DocStyleContext">DocStyleContext</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="DocStyleChecker" ID="DocStyleChecker"></a> -<h2>DocStyleChecker</h2> - -<p> - Class implementing a checker for 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="#DocStyleChecker.__init__">DocStyleChecker</a></td> -<td>Constructor</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__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="#DocStyleChecker.__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="#DocStyleChecker.__checkBlankAfterSummary">__checkBlankAfterSummary</a></td> -<td>Private method to check, that docstring summaries are followed by a blank line.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__checkBlankBeforeAndAfterClass">__checkBlankBeforeAndAfterClass</a></td> -<td>Private method to check, that class docstrings have one blank line around them.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__checkClassDocstring">__checkClassDocstring</a></td> -<td>Private method to check, that all public functions and methods have a docstring.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__checkEndsWithPeriod">__checkEndsWithPeriod</a></td> -<td>Private method to check, that docstring summaries end with a period.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__checkEricBlankAfterSummary">__checkEricBlankAfterSummary</a></td> -<td>Private method to check, that docstring summaries are followed by a blank line.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__checkEricEndsWithPeriod">__checkEricEndsWithPeriod</a></td> -<td>Private method to check, that docstring summaries end with a period.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__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="#DocStyleChecker.__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="#DocStyleChecker.__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="#DocStyleChecker.__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="#DocStyleChecker.__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="#DocStyleChecker.__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="#DocStyleChecker.__checkEricSignal">__checkEricSignal</a></td> -<td>Private method to check, that docstrings contain an @signal line if they define signals and don't otherwise.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__checkEricSummary">__checkEricSummary</a></td> -<td>Private method to check, that method docstring summaries start with specific words.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__checkFunctionDocstring">__checkFunctionDocstring</a></td> -<td>Private method to check, that all public functions and methods have a docstring.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__checkImperativeMood">__checkImperativeMood</a></td> -<td>Private method to check, that docstring summaries are in imperative mood.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__checkIndent">__checkIndent</a></td> -<td>Private method to check, that docstrings are properly indented.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__checkModulesDocstrings">__checkModulesDocstrings</a></td> -<td>Private method to check, if the module has a docstring.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__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="#DocStyleChecker.__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="#DocStyleChecker.__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="#DocStyleChecker.__checkReturnType">__checkReturnType</a></td> -<td>Private method to check, that docstrings mention the return value type.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__checkSummary">__checkSummary</a></td> -<td>Private method to check, that docstring summaries contain some text.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__checkTripleDoubleQuotes">__checkTripleDoubleQuotes</a></td> -<td>Private method to check, that all docstrings are surrounded by triple double quotes.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__error">__error</a></td> -<td>Private method to record an issue.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__getArgNames">__getArgNames</a></td> -<td>Private method to get the argument names of a function node.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__getSummaryLine">__getSummaryLine</a></td> -<td>Private method to extract the summary line.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__getSummaryLines">__getSummaryLines</a></td> -<td>Private method to extract the summary lines.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__ignoreCode">__ignoreCode</a></td> -<td>Private method to check if the error code should be ignored.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__parseClasses">__parseClasses</a></td> -<td>Private method to extract top-level classes.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__parseContexts">__parseContexts</a></td> -<td>Private method to extract a context from the source.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__parseDocstring">__parseDocstring</a></td> -<td>Private method to extract a docstring given `def` or `class` source.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__parseFunctions">__parseFunctions</a></td> -<td>Private method to extract top-level functions.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__parseMethods">__parseMethods</a></td> -<td>Private method to extract methods of all classes.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__parseModuleDocstring">__parseModuleDocstring</a></td> -<td>Private method to extract a docstring given a module source.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__parseTopLevel">__parseTopLevel</a></td> -<td>Private method to extract top-level functions or classes.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__readline">__readline</a></td> -<td>Private method to get the next line from the source.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__reportInvalidSyntax">__reportInvalidSyntax</a></td> -<td>Private method to report a syntax error.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__resetReadline">__resetReadline</a></td> -<td>Private method to reset the internal readline function.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.__skipIndentedBlock">__skipIndentedBlock</a></td> -<td>Private method to skip over an indented block of source code.</td> -</tr> -<tr> -<td><a href="#DocStyleChecker.run">run</a></td> -<td>Public method to check the given source for violations of doc string conventions.</td> -</tr> -</table> -<h3>Static Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> - -<a NAME="DocStyleChecker.__init__" ID="DocStyleChecker.__init__"></a> -<h4>DocStyleChecker (Constructor)</h4> -<b>DocStyleChecker</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="DocStyleChecker.__checkBackslashes" ID="DocStyleChecker.__checkBackslashes"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkBlankAfterLastParagraph" ID="DocStyleChecker.__checkBlankAfterLastParagraph"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkBlankAfterSummary" ID="DocStyleChecker.__checkBlankAfterSummary"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkBlankBeforeAndAfterClass" ID="DocStyleChecker.__checkBlankBeforeAndAfterClass"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkClassDocstring" ID="DocStyleChecker.__checkClassDocstring"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkEndsWithPeriod" ID="DocStyleChecker.__checkEndsWithPeriod"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkEricBlankAfterSummary" ID="DocStyleChecker.__checkEricBlankAfterSummary"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkEricEndsWithPeriod" ID="DocStyleChecker.__checkEricEndsWithPeriod"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkEricException" ID="DocStyleChecker.__checkEricException"></a> -<h4>DocStyleChecker.__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> -<p> - Note: This method also checks the raised and documented exceptions for - completeness (i.e. raised exceptions that are not documented or - documented exceptions that are not raised) -</p> -<dl> - -<dt><i>docstringContext</i></dt> -<dd> -docstring context (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkEricFunctionArguments" ID="DocStyleChecker.__checkEricFunctionArguments"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkEricNBlankAfterLastParagraph" ID="DocStyleChecker.__checkEricNBlankAfterLastParagraph"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction" ID="DocStyleChecker.__checkEricNoBlankBeforeAndAfterClassOrFunction"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkEricQuotesOnSeparateLines" ID="DocStyleChecker.__checkEricQuotesOnSeparateLines"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkEricReturn" ID="DocStyleChecker.__checkEricReturn"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkEricSignal" ID="DocStyleChecker.__checkEricSignal"></a> -<h4>DocStyleChecker.__checkEricSignal</h4> -<b>__checkEricSignal</b>(<i>docstringContext, context</i>) - -<p> - Private method to check, that docstrings contain an @signal line - if they define signals and don't otherwise. -</p> -<p> - Note: This method also checks the defined and documented signals for - completeness (i.e. defined signals that are not documented or - documented signals that are not defined) -</p> -<dl> - -<dt><i>docstringContext</i></dt> -<dd> -docstring context (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkEricSummary" ID="DocStyleChecker.__checkEricSummary"></a> -<h4>DocStyleChecker.__checkEricSummary</h4> -<b>__checkEricSummary</b>(<i>docstringContext, context</i>) - -<p> - Private method to check, that method docstring summaries start with - specific words. -</p> -<dl> - -<dt><i>docstringContext</i></dt> -<dd> -docstring context (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkFunctionDocstring" ID="DocStyleChecker.__checkFunctionDocstring"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkImperativeMood" ID="DocStyleChecker.__checkImperativeMood"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkIndent" ID="DocStyleChecker.__checkIndent"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkModulesDocstrings" ID="DocStyleChecker.__checkModulesDocstrings"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkNoBlankLineBefore" ID="DocStyleChecker.__checkNoBlankLineBefore"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkNoSignature" ID="DocStyleChecker.__checkNoSignature"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkOneLiner" ID="DocStyleChecker.__checkOneLiner"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkReturnType" ID="DocStyleChecker.__checkReturnType"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkSummary" ID="DocStyleChecker.__checkSummary"></a> -<h4>DocStyleChecker.__checkSummary</h4> -<b>__checkSummary</b>(<i>docstringContext, context</i>) - -<p> - Private method to check, that docstring summaries contain some text. -</p> -<dl> - -<dt><i>docstringContext</i></dt> -<dd> -docstring context (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__checkTripleDoubleQuotes" ID="DocStyleChecker.__checkTripleDoubleQuotes"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -<dt><i>context</i></dt> -<dd> -context of the docstring (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__error" ID="DocStyleChecker.__error"></a> -<h4>DocStyleChecker.__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="DocStyleChecker.__getArgNames" ID="DocStyleChecker.__getArgNames"></a> -<h4>DocStyleChecker.__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> -tuple of two list of argument names, one for arguments - and one for keyword arguments (tuple of list of string) -</dd> -</dl> -<a NAME="DocStyleChecker.__getSummaryLine" ID="DocStyleChecker.__getSummaryLine"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -</dl> -<dl> -<dt>Returns:</dt> -<dd> -summary line (string) and the line it was found on (integer) -</dd> -</dl> -<a NAME="DocStyleChecker.__getSummaryLines" ID="DocStyleChecker.__getSummaryLines"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -</dl> -<dl> -<dt>Returns:</dt> -<dd> -summary lines (list of string) and the line it was found on - (integer) -</dd> -</dl> -<a NAME="DocStyleChecker.__ignoreCode" ID="DocStyleChecker.__ignoreCode"></a> -<h4>DocStyleChecker.__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="DocStyleChecker.__parseClasses" ID="DocStyleChecker.__parseClasses"></a> -<h4>DocStyleChecker.__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 DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__parseContexts" ID="DocStyleChecker.__parseContexts"></a> -<h4>DocStyleChecker.__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 DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__parseDocstring" ID="DocStyleChecker.__parseDocstring"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</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 (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__parseFunctions" ID="DocStyleChecker.__parseFunctions"></a> -<h4>DocStyleChecker.__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 DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__parseMethods" ID="DocStyleChecker.__parseMethods"></a> -<h4>DocStyleChecker.__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 DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__parseModuleDocstring" ID="DocStyleChecker.__parseModuleDocstring"></a> -<h4>DocStyleChecker.__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 (DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__parseTopLevel" ID="DocStyleChecker.__parseTopLevel"></a> -<h4>DocStyleChecker.__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 DocStyleContext) -</dd> -</dl> -<a NAME="DocStyleChecker.__readline" ID="DocStyleChecker.__readline"></a> -<h4>DocStyleChecker.__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="DocStyleChecker.__reportInvalidSyntax" ID="DocStyleChecker.__reportInvalidSyntax"></a> -<h4>DocStyleChecker.__reportInvalidSyntax</h4> -<b>__reportInvalidSyntax</b>(<i></i>) - -<p> - Private method to report a syntax error. -</p> -<a NAME="DocStyleChecker.__resetReadline" ID="DocStyleChecker.__resetReadline"></a> -<h4>DocStyleChecker.__resetReadline</h4> -<b>__resetReadline</b>(<i></i>) - -<p> - Private method to reset the internal readline function. -</p> -<a NAME="DocStyleChecker.__skipIndentedBlock" ID="DocStyleChecker.__skipIndentedBlock"></a> -<h4>DocStyleChecker.__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="DocStyleChecker.run" ID="DocStyleChecker.run"></a> -<h4>DocStyleChecker.run</h4> -<b>run</b>(<i></i>) - -<p> - Public method to check the given source for violations of doc string - conventions. -</p> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="DocStyleContext" ID="DocStyleContext"></a> -<h2>DocStyleContext</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="#DocStyleContext.__init__">DocStyleContext</a></td> -<td>Constructor</td> -</tr> -<tr> -<td><a href="#DocStyleContext.contextType">contextType</a></td> -<td>Public method to get the context type.</td> -</tr> -<tr> -<td><a href="#DocStyleContext.end">end</a></td> -<td>Public method to get the end line number.</td> -</tr> -<tr> -<td><a href="#DocStyleContext.indent">indent</a></td> -<td>Public method to get the indentation of the first line.</td> -</tr> -<tr> -<td><a href="#DocStyleContext.setSpecial">setSpecial</a></td> -<td>Public method to set a special attribute for the context.</td> -</tr> -<tr> -<td><a href="#DocStyleContext.source">source</a></td> -<td>Public method to get the source.</td> -</tr> -<tr> -<td><a href="#DocStyleContext.special">special</a></td> -<td>Public method to get the special context attribute string.</td> -</tr> -<tr> -<td><a href="#DocStyleContext.ssource">ssource</a></td> -<td>Public method to get the joined source lines.</td> -</tr> -<tr> -<td><a href="#DocStyleContext.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="DocStyleContext.__init__" ID="DocStyleContext.__init__"></a> -<h4>DocStyleContext (Constructor)</h4> -<b>DocStyleContext</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="DocStyleContext.contextType" ID="DocStyleContext.contextType"></a> -<h4>DocStyleContext.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="DocStyleContext.end" ID="DocStyleContext.end"></a> -<h4>DocStyleContext.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="DocStyleContext.indent" ID="DocStyleContext.indent"></a> -<h4>DocStyleContext.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="DocStyleContext.setSpecial" ID="DocStyleContext.setSpecial"></a> -<h4>DocStyleContext.setSpecial</h4> -<b>setSpecial</b>(<i>special</i>) - -<p> - Public method to set a special attribute for the context. -</p> -<dl> - -<dt><i>special</i> (str)</dt> -<dd> -attribute string -</dd> -</dl> -<a NAME="DocStyleContext.source" ID="DocStyleContext.source"></a> -<h4>DocStyleContext.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="DocStyleContext.special" ID="DocStyleContext.special"></a> -<h4>DocStyleContext.special</h4> -<b>special</b>(<i></i>) - -<p> - Public method to get the special context attribute string. -</p> -<dl> -<dt>Returns:</dt> -<dd> -attribute string -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl> -<a NAME="DocStyleContext.ssource" ID="DocStyleContext.ssource"></a> -<h4>DocStyleContext.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="DocStyleContext.start" ID="DocStyleContext.start"></a> -<h4>DocStyleContext.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/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker.html Tue Oct 13 19:02:26 2020 +0200 @@ -0,0 +1,2227 @@ +<!DOCTYPE html> +<html><head> +<title>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker</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>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.MiscellaneousChecker</h1> + +<p> +Module implementing a checker for miscellaneous checks. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#BugBearVisitor">BugBearVisitor</a></td> +<td>Class implementing a node visitor to check for various topics.</td> +</tr> +<tr> +<td><a href="#DateTimeVisitor">DateTimeVisitor</a></td> +<td>Class implementing a node visitor to check datetime function calls.</td> +</tr> +<tr> +<td><a href="#LoggingVisitor">LoggingVisitor</a></td> +<td>Class implementing a node visitor to check logging statements.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker">MiscellaneousChecker</a></td> +<td>Class implementing a checker for miscellaneous checks.</td> +</tr> +<tr> +<td><a href="#NameFinder">NameFinder</a></td> +<td>Class to extract a name out of a tree of nodes.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor">ReturnVisitor</a></td> +<td>Class implementing a node visitor to check return statements.</td> +</tr> +<tr> +<td><a href="#SysVersionVisitor">SysVersionVisitor</a></td> +<td>Class implementing a node visitor to check the use of sys.version and sys.version_info.</td> +</tr> +<tr> +<td><a href="#TextVisitor">TextVisitor</a></td> +<td>Class implementing a node visitor for bytes and str instances.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#composeCallPath">composeCallPath</a></td> +<td>Generator function to assemble the call path of a given node.</td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="BugBearVisitor" ID="BugBearVisitor"></a> +<h2>BugBearVisitor</h2> + +<p> + Class implementing a node visitor to check for various topics. +</p> +<h3>Derived from</h3> +ast.NodeVisitor +<h3>Class Attributes</h3> + +<table> +<tr><td>NodeWindowSize</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#BugBearVisitor.__init__">BugBearVisitor</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#BugBearVisitor.__checkForM502">__checkForM502</a></td> +<td>Private method to check the use of *strip().</td> +</tr> +<tr> +<td><a href="#BugBearVisitor.__checkForM507">__checkForM507</a></td> +<td>Private method to check for unused loop variables.</td> +</tr> +<tr> +<td><a href="#BugBearVisitor.visit">visit</a></td> +<td>Public method to traverse a given AST node.</td> +</tr> +<tr> +<td><a href="#BugBearVisitor.visit_Assert">visit_Assert</a></td> +<td>Public method to handle 'assert' statements.</td> +</tr> +<tr> +<td><a href="#BugBearVisitor.visit_Assign">visit_Assign</a></td> +<td>Public method to handle assignments.</td> +</tr> +<tr> +<td><a href="#BugBearVisitor.visit_AsyncFor">visit_AsyncFor</a></td> +<td>Public method to handle 'for' statements.</td> +</tr> +<tr> +<td><a href="#BugBearVisitor.visit_Attribute">visit_Attribute</a></td> +<td>Public method to handle attributes.</td> +</tr> +<tr> +<td><a href="#BugBearVisitor.visit_Call">visit_Call</a></td> +<td>Public method to handle a function call.</td> +</tr> +<tr> +<td><a href="#BugBearVisitor.visit_For">visit_For</a></td> +<td>Public method to handle 'for' statements.</td> +</tr> +<tr> +<td><a href="#BugBearVisitor.visit_JoinedStr">visit_JoinedStr</a></td> +<td>Public method to handle f-string arguments.</td> +</tr> +<tr> +<td><a href="#BugBearVisitor.visit_UAdd">visit_UAdd</a></td> +<td>Public method to handle unary additions.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="BugBearVisitor.__init__" ID="BugBearVisitor.__init__"></a> +<h4>BugBearVisitor (Constructor)</h4> +<b>BugBearVisitor</b>(<i></i>) + +<p> + Constructor +</p> +<a NAME="BugBearVisitor.__checkForM502" ID="BugBearVisitor.__checkForM502"></a> +<h4>BugBearVisitor.__checkForM502</h4> +<b>__checkForM502</b>(<i>node</i>) + +<p> + Private method to check the use of *strip(). +</p> +<dl> + +<dt><i>node</i> (ast.Call)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="BugBearVisitor.__checkForM507" ID="BugBearVisitor.__checkForM507"></a> +<h4>BugBearVisitor.__checkForM507</h4> +<b>__checkForM507</b>(<i>node</i>) + +<p> + Private method to check for unused loop variables. +</p> +<dl> + +<dt><i>node</i> (ast.For)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="BugBearVisitor.visit" ID="BugBearVisitor.visit"></a> +<h4>BugBearVisitor.visit</h4> +<b>visit</b>(<i>node</i>) + +<p> + Public method to traverse a given AST node. +</p> +<dl> + +<dt><i>node</i> (ast.Node)</dt> +<dd> +AST node to be traversed +</dd> +</dl> +<a NAME="BugBearVisitor.visit_Assert" ID="BugBearVisitor.visit_Assert"></a> +<h4>BugBearVisitor.visit_Assert</h4> +<b>visit_Assert</b>(<i>node</i>) + +<p> + Public method to handle 'assert' statements. +</p> +<dl> + +<dt><i>node</i> (ast.Assert)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="BugBearVisitor.visit_Assign" ID="BugBearVisitor.visit_Assign"></a> +<h4>BugBearVisitor.visit_Assign</h4> +<b>visit_Assign</b>(<i>node</i>) + +<p> + Public method to handle assignments. +</p> +<dl> + +<dt><i>node</i> (ast.Assign)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="BugBearVisitor.visit_AsyncFor" ID="BugBearVisitor.visit_AsyncFor"></a> +<h4>BugBearVisitor.visit_AsyncFor</h4> +<b>visit_AsyncFor</b>(<i>node</i>) + +<p> + Public method to handle 'for' statements. +</p> +<dl> + +<dt><i>node</i> (ast.AsyncFor)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="BugBearVisitor.visit_Attribute" ID="BugBearVisitor.visit_Attribute"></a> +<h4>BugBearVisitor.visit_Attribute</h4> +<b>visit_Attribute</b>(<i>node</i>) + +<p> + Public method to handle attributes. +</p> +<dl> + +<dt><i>node</i> (ast.Attribute)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="BugBearVisitor.visit_Call" ID="BugBearVisitor.visit_Call"></a> +<h4>BugBearVisitor.visit_Call</h4> +<b>visit_Call</b>(<i>node</i>) + +<p> + Public method to handle a function call. +</p> +<dl> + +<dt><i>node</i> (ast.Call)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="BugBearVisitor.visit_For" ID="BugBearVisitor.visit_For"></a> +<h4>BugBearVisitor.visit_For</h4> +<b>visit_For</b>(<i>node</i>) + +<p> + Public method to handle 'for' statements. +</p> +<dl> + +<dt><i>node</i> (ast.For)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="BugBearVisitor.visit_JoinedStr" ID="BugBearVisitor.visit_JoinedStr"></a> +<h4>BugBearVisitor.visit_JoinedStr</h4> +<b>visit_JoinedStr</b>(<i>node</i>) + +<p> + Public method to handle f-string arguments. +</p> +<dl> + +<dt><i>node</i> (ast.JoinedStr)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="BugBearVisitor.visit_UAdd" ID="BugBearVisitor.visit_UAdd"></a> +<h4>BugBearVisitor.visit_UAdd</h4> +<b>visit_UAdd</b>(<i>node</i>) + +<p> + Public method to handle unary additions. +</p> +<dl> + +<dt><i>node</i> (ast.UAdd)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="DateTimeVisitor" ID="DateTimeVisitor"></a> +<h2>DateTimeVisitor</h2> + +<p> + Class implementing a node visitor to check datetime function calls. +</p> +<p> + Note: This class is modelled after flake8_datetimez checker. +</p> +<h3>Derived from</h3> +ast.NodeVisitor +<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="#DateTimeVisitor.__init__">DateTimeVisitor</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#DateTimeVisitor.__getFromKeywords">__getFromKeywords</a></td> +<td>Private method to get a keyword node given its name.</td> +</tr> +<tr> +<td><a href="#DateTimeVisitor.visit_Call">visit_Call</a></td> +<td>Public method to handle a function call.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="DateTimeVisitor.__init__" ID="DateTimeVisitor.__init__"></a> +<h4>DateTimeVisitor (Constructor)</h4> +<b>DateTimeVisitor</b>(<i></i>) + +<p> + Constructor +</p> +<a NAME="DateTimeVisitor.__getFromKeywords" ID="DateTimeVisitor.__getFromKeywords"></a> +<h4>DateTimeVisitor.__getFromKeywords</h4> +<b>__getFromKeywords</b>(<i>keywords, name</i>) + +<p> + Private method to get a keyword node given its name. +</p> +<dl> + +<dt><i>keywords</i> (list of ast.AST)</dt> +<dd> +list of keyword argument nodes +</dd> +<dt><i>name</i> (str)</dt> +<dd> +name of the keyword node +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +keyword node +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +ast.AST +</dd> +</dl> +<a NAME="DateTimeVisitor.visit_Call" ID="DateTimeVisitor.visit_Call"></a> +<h4>DateTimeVisitor.visit_Call</h4> +<b>visit_Call</b>(<i>node</i>) + +<p> + Public method to handle a function call. +</p> +<p> + Every datetime related function call is check for use of the naive + variant (i.e. use without TZ info). +</p> +<dl> + +<dt><i>node</i> (ast.Call)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="LoggingVisitor" ID="LoggingVisitor"></a> +<h2>LoggingVisitor</h2> + +<p> + Class implementing a node visitor to check logging statements. +</p> +<h3>Derived from</h3> +ast.NodeVisitor +<h3>Class Attributes</h3> + +<table> +<tr><td>LoggingLevels</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#LoggingVisitor.__init__">LoggingVisitor</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#LoggingVisitor.__detectLoggingLevel">__detectLoggingLevel</a></td> +<td>Private method to decide whether an AST Call is a logging call.</td> +</tr> +<tr> +<td><a href="#LoggingVisitor.__isFormatCall">__isFormatCall</a></td> +<td>Private method to check if a function call uses format.</td> +</tr> +<tr> +<td><a href="#LoggingVisitor.__withinExtraKeyword">__withinExtraKeyword</a></td> +<td>Private method to check, if we are inside the extra keyword.</td> +</tr> +<tr> +<td><a href="#LoggingVisitor.__withinLoggingArgument">__withinLoggingArgument</a></td> +<td>Private method to check, if we are inside a logging argument.</td> +</tr> +<tr> +<td><a href="#LoggingVisitor.__withinLoggingStatement">__withinLoggingStatement</a></td> +<td>Private method to check, if we are inside a logging statement.</td> +</tr> +<tr> +<td><a href="#LoggingVisitor.visit_BinOp">visit_BinOp</a></td> +<td>Public method to handle binary operations while processing the first logging argument.</td> +</tr> +<tr> +<td><a href="#LoggingVisitor.visit_Call">visit_Call</a></td> +<td>Public method to handle a function call.</td> +</tr> +<tr> +<td><a href="#LoggingVisitor.visit_JoinedStr">visit_JoinedStr</a></td> +<td>Public method to handle f-string arguments.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="LoggingVisitor.__init__" ID="LoggingVisitor.__init__"></a> +<h4>LoggingVisitor (Constructor)</h4> +<b>LoggingVisitor</b>(<i></i>) + +<p> + Constructor +</p> +<a NAME="LoggingVisitor.__detectLoggingLevel" ID="LoggingVisitor.__detectLoggingLevel"></a> +<h4>LoggingVisitor.__detectLoggingLevel</h4> +<b>__detectLoggingLevel</b>(<i>node</i>) + +<p> + Private method to decide whether an AST Call is a logging call. +</p> +<dl> + +<dt><i>node</i> (ast.Call)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +logging level +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str or None +</dd> +</dl> +<a NAME="LoggingVisitor.__isFormatCall" ID="LoggingVisitor.__isFormatCall"></a> +<h4>LoggingVisitor.__isFormatCall</h4> +<b>__isFormatCall</b>(<i>node</i>) + +<p> + Private method to check if a function call uses format. +</p> +<dl> + +<dt><i>node</i> (ast.Call)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating the function call uses format +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="LoggingVisitor.__withinExtraKeyword" ID="LoggingVisitor.__withinExtraKeyword"></a> +<h4>LoggingVisitor.__withinExtraKeyword</h4> +<b>__withinExtraKeyword</b>(<i>node</i>) + +<p> + Private method to check, if we are inside the extra keyword. +</p> +<dl> + +<dt><i>node</i> (ast.keyword)</dt> +<dd> +reference to the node to be checked +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating we are inside the extra keyword +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="LoggingVisitor.__withinLoggingArgument" ID="LoggingVisitor.__withinLoggingArgument"></a> +<h4>LoggingVisitor.__withinLoggingArgument</h4> +<b>__withinLoggingArgument</b>(<i></i>) + +<p> + Private method to check, if we are inside a logging argument. +</p> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating we are inside a logging argument +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="LoggingVisitor.__withinLoggingStatement" ID="LoggingVisitor.__withinLoggingStatement"></a> +<h4>LoggingVisitor.__withinLoggingStatement</h4> +<b>__withinLoggingStatement</b>(<i></i>) + +<p> + Private method to check, if we are inside a logging statement. +</p> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating we are inside a logging statement +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="LoggingVisitor.visit_BinOp" ID="LoggingVisitor.visit_BinOp"></a> +<h4>LoggingVisitor.visit_BinOp</h4> +<b>visit_BinOp</b>(<i>node</i>) + +<p> + Public method to handle binary operations while processing the first + logging argument. +</p> +<dl> + +<dt><i>node</i> (ast.BinOp)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="LoggingVisitor.visit_Call" ID="LoggingVisitor.visit_Call"></a> +<h4>LoggingVisitor.visit_Call</h4> +<b>visit_Call</b>(<i>node</i>) + +<p> + Public method to handle a function call. +</p> +<p> + Every logging statement and string format is expected to be a function + call. +</p> +<dl> + +<dt><i>node</i> (ast.Call)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="LoggingVisitor.visit_JoinedStr" ID="LoggingVisitor.visit_JoinedStr"></a> +<h4>LoggingVisitor.visit_JoinedStr</h4> +<b>visit_JoinedStr</b>(<i>node</i>) + +<p> + Public method to handle f-string arguments. +</p> +<dl> + +<dt><i>node</i> (ast.JoinedStr)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="MiscellaneousChecker" ID="MiscellaneousChecker"></a> +<h2>MiscellaneousChecker</h2> + +<p> + Class implementing a checker for miscellaneous checks. +</p> +<h3>Derived from</h3> +object +<h3>Class Attributes</h3> + +<table> +<tr><td>BuiltinsWhiteList</td></tr><tr><td>Codes</td></tr><tr><td>FormatFieldRegex</td></tr><tr><td>Formatter</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#MiscellaneousChecker.__init__">MiscellaneousChecker</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkBugBear">__checkBugBear</a></td> +<td>Private method for bugbear checks.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkBuiltins">__checkBuiltins</a></td> +<td>Private method to check, if built-ins are shadowed.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkCoding">__checkCoding</a></td> +<td>Private method to check the presence of a coding line and valid encodings.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkCommentedCode">__checkCommentedCode</a></td> +<td>Private method to check for commented code.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkComprehensions">__checkComprehensions</a></td> +<td>Private method to check some comprehension related things.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkCopyright">__checkCopyright</a></td> +<td>Private method to check the presence of a copyright statement.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkDateTime">__checkDateTime</a></td> +<td>Private method to check use of naive datetime functions.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkDictWithSortedKeys">__checkDictWithSortedKeys</a></td> +<td>Private method to check, if dictionary keys appear in sorted order.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkFormatString">__checkFormatString</a></td> +<td>Private method to check string format strings.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkFuture">__checkFuture</a></td> +<td>Private method to check the __future__ imports.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkGettext">__checkGettext</a></td> +<td>Private method to check the 'gettext' import statement.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkLineContinuation">__checkLineContinuation</a></td> +<td>Private method to check line continuation using backslash.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkLogging">__checkLogging</a></td> +<td>Private method to check logging statements.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkMutableDefault">__checkMutableDefault</a></td> +<td>Private method to check for use of mutable types as default arguments.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkPep3101">__checkPep3101</a></td> +<td>Private method to check for old style string formatting.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkPrintStatements">__checkPrintStatements</a></td> +<td>Private method to check for print statements.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkReturn">__checkReturn</a></td> +<td>Private method to check return statements.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkSysVersion">__checkSysVersion</a></td> +<td>Private method to check the use of sys.version and sys.version_info.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__checkTuple">__checkTuple</a></td> +<td>Private method to check for one element tuples.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__dictShouldBeChecked">__dictShouldBeChecked</a></td> +<td>Private function to test, if the node should be checked.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__error">__error</a></td> +<td>Private method to record an issue.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__generateTree">__generateTree</a></td> +<td>Private method to generate an AST for our source.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__getCoding">__getCoding</a></td> +<td>Private method to get the defined coding of the source.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__getFields">__getFields</a></td> +<td>Private method to extract the format field information.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__ignoreCode">__ignoreCode</a></td> +<td>Private method to check if the message code should be ignored.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.__reportInvalidSyntax">__reportInvalidSyntax</a></td> +<td>Private method to report a syntax error.</td> +</tr> +<tr> +<td><a href="#MiscellaneousChecker.run">run</a></td> +<td>Public method to check the given source against miscellaneous conditions.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="MiscellaneousChecker.__init__" ID="MiscellaneousChecker.__init__"></a> +<h4>MiscellaneousChecker (Constructor)</h4> +<b>MiscellaneousChecker</b>(<i>source, filename, select, ignore, expected, repeat, args</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>source</i> (list of str)</dt> +<dd> +source code to be checked +</dd> +<dt><i>filename</i> (str)</dt> +<dd> +name of the source file +</dd> +<dt><i>select</i> (list of str)</dt> +<dd> +list of selected codes +</dd> +<dt><i>ignore</i> (list of str)</dt> +<dd> +list of codes to be ignored +</dd> +<dt><i>expected</i> (list of str)</dt> +<dd> +list of expected codes +</dd> +<dt><i>repeat</i> (bool)</dt> +<dd> +flag indicating to report each occurrence of a code +</dd> +<dt><i>args</i> (dict)</dt> +<dd> +dictionary of arguments for the miscellaneous checks +</dd> +</dl> +<a NAME="MiscellaneousChecker.__checkBugBear" ID="MiscellaneousChecker.__checkBugBear"></a> +<h4>MiscellaneousChecker.__checkBugBear</h4> +<b>__checkBugBear</b>(<i></i>) + +<p> + Private method for bugbear checks. +</p> +<a NAME="MiscellaneousChecker.__checkBuiltins" ID="MiscellaneousChecker.__checkBuiltins"></a> +<h4>MiscellaneousChecker.__checkBuiltins</h4> +<b>__checkBuiltins</b>(<i></i>) + +<p> + Private method to check, if built-ins are shadowed. +</p> +<a NAME="MiscellaneousChecker.__checkCoding" ID="MiscellaneousChecker.__checkCoding"></a> +<h4>MiscellaneousChecker.__checkCoding</h4> +<b>__checkCoding</b>(<i></i>) + +<p> + Private method to check the presence of a coding line and valid + encodings. +</p> +<a NAME="MiscellaneousChecker.__checkCommentedCode" ID="MiscellaneousChecker.__checkCommentedCode"></a> +<h4>MiscellaneousChecker.__checkCommentedCode</h4> +<b>__checkCommentedCode</b>(<i></i>) + +<p> + Private method to check for commented code. +</p> +<a NAME="MiscellaneousChecker.__checkComprehensions" ID="MiscellaneousChecker.__checkComprehensions"></a> +<h4>MiscellaneousChecker.__checkComprehensions</h4> +<b>__checkComprehensions</b>(<i></i>) + +<p> + Private method to check some comprehension related things. +</p> +<a NAME="MiscellaneousChecker.__checkCopyright" ID="MiscellaneousChecker.__checkCopyright"></a> +<h4>MiscellaneousChecker.__checkCopyright</h4> +<b>__checkCopyright</b>(<i></i>) + +<p> + Private method to check the presence of a copyright statement. +</p> +<a NAME="MiscellaneousChecker.__checkDateTime" ID="MiscellaneousChecker.__checkDateTime"></a> +<h4>MiscellaneousChecker.__checkDateTime</h4> +<b>__checkDateTime</b>(<i></i>) + +<p> + Private method to check use of naive datetime functions. +</p> +<a NAME="MiscellaneousChecker.__checkDictWithSortedKeys" ID="MiscellaneousChecker.__checkDictWithSortedKeys"></a> +<h4>MiscellaneousChecker.__checkDictWithSortedKeys</h4> +<b>__checkDictWithSortedKeys</b>(<i></i>) + +<p> + Private method to check, if dictionary keys appear in sorted order. +</p> +<a NAME="MiscellaneousChecker.__checkFormatString" ID="MiscellaneousChecker.__checkFormatString"></a> +<h4>MiscellaneousChecker.__checkFormatString</h4> +<b>__checkFormatString</b>(<i></i>) + +<p> + Private method to check string format strings. +</p> +<a NAME="MiscellaneousChecker.__checkFuture" ID="MiscellaneousChecker.__checkFuture"></a> +<h4>MiscellaneousChecker.__checkFuture</h4> +<b>__checkFuture</b>(<i></i>) + +<p> + Private method to check the __future__ imports. +</p> +<a NAME="MiscellaneousChecker.__checkGettext" ID="MiscellaneousChecker.__checkGettext"></a> +<h4>MiscellaneousChecker.__checkGettext</h4> +<b>__checkGettext</b>(<i></i>) + +<p> + Private method to check the 'gettext' import statement. +</p> +<a NAME="MiscellaneousChecker.__checkLineContinuation" ID="MiscellaneousChecker.__checkLineContinuation"></a> +<h4>MiscellaneousChecker.__checkLineContinuation</h4> +<b>__checkLineContinuation</b>(<i></i>) + +<p> + Private method to check line continuation using backslash. +</p> +<a NAME="MiscellaneousChecker.__checkLogging" ID="MiscellaneousChecker.__checkLogging"></a> +<h4>MiscellaneousChecker.__checkLogging</h4> +<b>__checkLogging</b>(<i></i>) + +<p> + Private method to check logging statements. +</p> +<a NAME="MiscellaneousChecker.__checkMutableDefault" ID="MiscellaneousChecker.__checkMutableDefault"></a> +<h4>MiscellaneousChecker.__checkMutableDefault</h4> +<b>__checkMutableDefault</b>(<i></i>) + +<p> + Private method to check for use of mutable types as default arguments. +</p> +<a NAME="MiscellaneousChecker.__checkPep3101" ID="MiscellaneousChecker.__checkPep3101"></a> +<h4>MiscellaneousChecker.__checkPep3101</h4> +<b>__checkPep3101</b>(<i></i>) + +<p> + Private method to check for old style string formatting. +</p> +<a NAME="MiscellaneousChecker.__checkPrintStatements" ID="MiscellaneousChecker.__checkPrintStatements"></a> +<h4>MiscellaneousChecker.__checkPrintStatements</h4> +<b>__checkPrintStatements</b>(<i></i>) + +<p> + Private method to check for print statements. +</p> +<a NAME="MiscellaneousChecker.__checkReturn" ID="MiscellaneousChecker.__checkReturn"></a> +<h4>MiscellaneousChecker.__checkReturn</h4> +<b>__checkReturn</b>(<i></i>) + +<p> + Private method to check return statements. +</p> +<a NAME="MiscellaneousChecker.__checkSysVersion" ID="MiscellaneousChecker.__checkSysVersion"></a> +<h4>MiscellaneousChecker.__checkSysVersion</h4> +<b>__checkSysVersion</b>(<i></i>) + +<p> + Private method to check the use of sys.version and sys.version_info. +</p> +<a NAME="MiscellaneousChecker.__checkTuple" ID="MiscellaneousChecker.__checkTuple"></a> +<h4>MiscellaneousChecker.__checkTuple</h4> +<b>__checkTuple</b>(<i></i>) + +<p> + Private method to check for one element tuples. +</p> +<a NAME="MiscellaneousChecker.__dictShouldBeChecked" ID="MiscellaneousChecker.__dictShouldBeChecked"></a> +<h4>MiscellaneousChecker.__dictShouldBeChecked</h4> +<b>__dictShouldBeChecked</b>(<i>node</i>) + +<p> + Private function to test, if the node should be checked. +</p> +<dl> + +<dt><i>node</i></dt> +<dd> +reference to the AST node +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating to check the node +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="MiscellaneousChecker.__error" ID="MiscellaneousChecker.__error"></a> +<h4>MiscellaneousChecker.__error</h4> +<b>__error</b>(<i>lineNumber, offset, code, *args</i>) + +<p> + Private method to record an issue. +</p> +<dl> + +<dt><i>lineNumber</i> (int)</dt> +<dd> +line number of the issue +</dd> +<dt><i>offset</i> (int)</dt> +<dd> +position within line of the issue +</dd> +<dt><i>code</i> (str)</dt> +<dd> +message code +</dd> +<dt><i>args</i> (list)</dt> +<dd> +arguments for the message +</dd> +</dl> +<a NAME="MiscellaneousChecker.__generateTree" ID="MiscellaneousChecker.__generateTree"></a> +<h4>MiscellaneousChecker.__generateTree</h4> +<b>__generateTree</b>(<i></i>) + +<p> + Private method to generate an AST for our source. +</p> +<dl> +<dt>Returns:</dt> +<dd> +generated AST +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +ast.AST +</dd> +</dl> +<a NAME="MiscellaneousChecker.__getCoding" ID="MiscellaneousChecker.__getCoding"></a> +<h4>MiscellaneousChecker.__getCoding</h4> +<b>__getCoding</b>(<i></i>) + +<p> + Private method to get the defined coding of the source. +</p> +<dl> +<dt>Returns:</dt> +<dd> +tuple containing the line number and the coding +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of int and str +</dd> +</dl> +<a NAME="MiscellaneousChecker.__getFields" ID="MiscellaneousChecker.__getFields"></a> +<h4>MiscellaneousChecker.__getFields</h4> +<b>__getFields</b>(<i>string</i>) + +<p> + Private method to extract the format field information. +</p> +<dl> + +<dt><i>string</i> (str)</dt> +<dd> +format string to be parsed +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +format field information as a tuple with fields, implicit + field definitions present and explicit field definitions present +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of set of str, bool, bool +</dd> +</dl> +<a NAME="MiscellaneousChecker.__ignoreCode" ID="MiscellaneousChecker.__ignoreCode"></a> +<h4>MiscellaneousChecker.__ignoreCode</h4> +<b>__ignoreCode</b>(<i>code</i>) + +<p> + Private method to check if the message code should be ignored. +</p> +<dl> + +<dt><i>code</i> (str)</dt> +<dd> +message code to check for +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating to ignore the given code +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="MiscellaneousChecker.__reportInvalidSyntax" ID="MiscellaneousChecker.__reportInvalidSyntax"></a> +<h4>MiscellaneousChecker.__reportInvalidSyntax</h4> +<b>__reportInvalidSyntax</b>(<i></i>) + +<p> + Private method to report a syntax error. +</p> +<a NAME="MiscellaneousChecker.run" ID="MiscellaneousChecker.run"></a> +<h4>MiscellaneousChecker.run</h4> +<b>run</b>(<i></i>) + +<p> + Public method to check the given source against miscellaneous + conditions. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="NameFinder" ID="NameFinder"></a> +<h2>NameFinder</h2> + +<p> + Class to extract a name out of a tree of nodes. +</p> +<h3>Derived from</h3> +ast.NodeVisitor +<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="#NameFinder.__init__">NameFinder</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#NameFinder.getNames">getNames</a></td> +<td>Public method to return the extracted names and Name nodes.</td> +</tr> +<tr> +<td><a href="#NameFinder.visit">visit</a></td> +<td>Public method to traverse a given AST node.</td> +</tr> +<tr> +<td><a href="#NameFinder.visit_Name">visit_Name</a></td> +<td>Public method to handle 'Name' nodes.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="NameFinder.__init__" ID="NameFinder.__init__"></a> +<h4>NameFinder (Constructor)</h4> +<b>NameFinder</b>(<i></i>) + +<p> + Constructor +</p> +<a NAME="NameFinder.getNames" ID="NameFinder.getNames"></a> +<h4>NameFinder.getNames</h4> +<b>getNames</b>(<i></i>) + +<p> + Public method to return the extracted names and Name nodes. +</p> +<dl> +<dt>Returns:</dt> +<dd> +dictionary containing the names as keys and the list of nodes +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<a NAME="NameFinder.visit" ID="NameFinder.visit"></a> +<h4>NameFinder.visit</h4> +<b>visit</b>(<i>node</i>) + +<p> + Public method to traverse a given AST node. +</p> +<dl> + +<dt><i>node</i> (ast.Node)</dt> +<dd> +AST node to be traversed +</dd> +</dl> +<a NAME="NameFinder.visit_Name" ID="NameFinder.visit_Name"></a> +<h4>NameFinder.visit_Name</h4> +<b>visit_Name</b>(<i>node</i>) + +<p> + Public method to handle 'Name' nodes. +</p> +<dl> + +<dt><i>node</i> (ast.Name)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="ReturnVisitor" ID="ReturnVisitor"></a> +<h2>ReturnVisitor</h2> + +<p> + Class implementing a node visitor to check return statements. +</p> +<h3>Derived from</h3> +ast.NodeVisitor +<h3>Class Attributes</h3> + +<table> +<tr><td>Assigns</td></tr><tr><td>Refs</td></tr><tr><td>Returns</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#ReturnVisitor.__init__">ReturnVisitor</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.__checkFunction">__checkFunction</a></td> +<td>Private method to check a function definition node.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.__checkImplicitReturn">__checkImplicitReturn</a></td> +<td>Private method to check for an implicit return statement.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.__checkImplicitReturnValue">__checkImplicitReturnValue</a></td> +<td>Private method to check for implicit return values.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.__checkUnnecessaryAssign">__checkUnnecessaryAssign</a></td> +<td>Private method to check for an unnecessary assign statement.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.__checkUnnecessaryReturnNone">__checkUnnecessaryReturnNone</a></td> +<td>Private method to check for an unnecessary 'return None' statement.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.__hasRefsBeforeNextAssign">__hasRefsBeforeNextAssign</a></td> +<td>Private method to check for references before a following assign statement.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.__isFalse">__isFalse</a></td> +<td>Private method to check, if a node value is False.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.__isNone">__isNone</a></td> +<td>Private method to check, if a node value is None.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.__resultExists">__resultExists</a></td> +<td>Private method to check the existance of a return result.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.__visitAssignTarget">__visitAssignTarget</a></td> +<td>Private method to handle an assign target node.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.__visitLoop">__visitLoop</a></td> +<td>Private method to handle loop nodes.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.__visitWithStack">__visitWithStack</a></td> +<td>Private method to traverse a given function node using a stack.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.assigns">assigns</a></td> +<td>Public method to get the Assign nodes.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.refs">refs</a></td> +<td>Public method to get the References nodes.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.returns">returns</a></td> +<td>Public method to get the Return nodes.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.visit_Assign">visit_Assign</a></td> +<td>Public method to handle an assign node.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.visit_AsyncFor">visit_AsyncFor</a></td> +<td>Public method to handle an async for loop.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.visit_AsyncFunctionDef">visit_AsyncFunctionDef</a></td> +<td>Public method to handle a function definition.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.visit_For">visit_For</a></td> +<td>Public method to handle a for loop.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.visit_FunctionDef">visit_FunctionDef</a></td> +<td>Public method to handle a function definition.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.visit_Name">visit_Name</a></td> +<td>Public method to handle a name node.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.visit_Return">visit_Return</a></td> +<td>Public method to handle a return node.</td> +</tr> +<tr> +<td><a href="#ReturnVisitor.visit_While">visit_While</a></td> +<td>Public method to handle a while loop.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="ReturnVisitor.__init__" ID="ReturnVisitor.__init__"></a> +<h4>ReturnVisitor (Constructor)</h4> +<b>ReturnVisitor</b>(<i></i>) + +<p> + Constructor +</p> +<a NAME="ReturnVisitor.__checkFunction" ID="ReturnVisitor.__checkFunction"></a> +<h4>ReturnVisitor.__checkFunction</h4> +<b>__checkFunction</b>(<i>node</i>) + +<p> + Private method to check a function definition node. +</p> +<dl> + +<dt><i>node</i> (ast.AsyncFunctionDef or ast.FunctionDef)</dt> +<dd> +reference to the node to check +</dd> +</dl> +<a NAME="ReturnVisitor.__checkImplicitReturn" ID="ReturnVisitor.__checkImplicitReturn"></a> +<h4>ReturnVisitor.__checkImplicitReturn</h4> +<b>__checkImplicitReturn</b>(<i>node</i>) + +<p> + Private method to check for an implicit return statement. +</p> +<dl> + +<dt><i>node</i> (ast.AST)</dt> +<dd> +reference to the node to check +</dd> +</dl> +<a NAME="ReturnVisitor.__checkImplicitReturnValue" ID="ReturnVisitor.__checkImplicitReturnValue"></a> +<h4>ReturnVisitor.__checkImplicitReturnValue</h4> +<b>__checkImplicitReturnValue</b>(<i></i>) + +<p> + Private method to check for implicit return values. +</p> +<a NAME="ReturnVisitor.__checkUnnecessaryAssign" ID="ReturnVisitor.__checkUnnecessaryAssign"></a> +<h4>ReturnVisitor.__checkUnnecessaryAssign</h4> +<b>__checkUnnecessaryAssign</b>(<i>node</i>) + +<p> + Private method to check for an unnecessary assign statement. +</p> +<dl> + +<dt><i>node</i> (ast.AST)</dt> +<dd> +reference to the node to check +</dd> +</dl> +<a NAME="ReturnVisitor.__checkUnnecessaryReturnNone" ID="ReturnVisitor.__checkUnnecessaryReturnNone"></a> +<h4>ReturnVisitor.__checkUnnecessaryReturnNone</h4> +<b>__checkUnnecessaryReturnNone</b>(<i></i>) + +<p> + Private method to check for an unnecessary 'return None' statement. +</p> +<a NAME="ReturnVisitor.__hasRefsBeforeNextAssign" ID="ReturnVisitor.__hasRefsBeforeNextAssign"></a> +<h4>ReturnVisitor.__hasRefsBeforeNextAssign</h4> +<b>__hasRefsBeforeNextAssign</b>(<i>varname, returnLineno</i>) + +<p> + Private method to check for references before a following assign + statement. +</p> +<dl> + +<dt><i>varname</i> (str)</dt> +<dd> +variable name to check for +</dd> +<dt><i>returnLineno</i> (int)</dt> +<dd> +line number of the return statement +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating the existence of references +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="ReturnVisitor.__isFalse" ID="ReturnVisitor.__isFalse"></a> +<h4>ReturnVisitor.__isFalse</h4> +<b>__isFalse</b>(<i>node</i>) + +<p> + Private method to check, if a node value is False. +</p> +<dl> + +<dt><i>node</i> (ast.AST)</dt> +<dd> +reference to the node to check +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating the node contains a False value +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="ReturnVisitor.__isNone" ID="ReturnVisitor.__isNone"></a> +<h4>ReturnVisitor.__isNone</h4> +<b>__isNone</b>(<i>node</i>) + +<p> + Private method to check, if a node value is None. +</p> +<dl> + +<dt><i>node</i> (ast.AST)</dt> +<dd> +reference to the node to check +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating the node contains a None value +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="ReturnVisitor.__resultExists" ID="ReturnVisitor.__resultExists"></a> +<h4>ReturnVisitor.__resultExists</h4> +<b>__resultExists</b>(<i></i>) + +<p> + Private method to check the existance of a return result. +</p> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating the existence of a return result +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="ReturnVisitor.__visitAssignTarget" ID="ReturnVisitor.__visitAssignTarget"></a> +<h4>ReturnVisitor.__visitAssignTarget</h4> +<b>__visitAssignTarget</b>(<i>node</i>) + +<p> + Private method to handle an assign target node. +</p> +<dl> + +<dt><i>node</i> (ast.AST)</dt> +<dd> +reference to the node to handle +</dd> +</dl> +<a NAME="ReturnVisitor.__visitLoop" ID="ReturnVisitor.__visitLoop"></a> +<h4>ReturnVisitor.__visitLoop</h4> +<b>__visitLoop</b>(<i>node</i>) + +<p> + Private method to handle loop nodes. +</p> +<dl> + +<dt><i>node</i> (ast.For, ast.AsyncFor or ast.While)</dt> +<dd> +reference to the loop node to handle +</dd> +</dl> +<a NAME="ReturnVisitor.__visitWithStack" ID="ReturnVisitor.__visitWithStack"></a> +<h4>ReturnVisitor.__visitWithStack</h4> +<b>__visitWithStack</b>(<i>node</i>) + +<p> + Private method to traverse a given function node using a stack. +</p> +<dl> + +<dt><i>node</i> (ast.FunctionDef or ast.AsyncFunctionDef)</dt> +<dd> +AST node to be traversed +</dd> +</dl> +<a NAME="ReturnVisitor.assigns" ID="ReturnVisitor.assigns"></a> +<h4>ReturnVisitor.assigns</h4> +<b>assigns</b>(<i></i>) + +<p> + Public method to get the Assign nodes. +</p> +<dl> +<dt>Returns:</dt> +<dd> +dictionary containing the node name as key and line number + as value +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<a NAME="ReturnVisitor.refs" ID="ReturnVisitor.refs"></a> +<h4>ReturnVisitor.refs</h4> +<b>refs</b>(<i></i>) + +<p> + Public method to get the References nodes. +</p> +<dl> +<dt>Returns:</dt> +<dd> +dictionary containing the node name as key and line number + as value +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<a NAME="ReturnVisitor.returns" ID="ReturnVisitor.returns"></a> +<h4>ReturnVisitor.returns</h4> +<b>returns</b>(<i></i>) + +<p> + Public method to get the Return nodes. +</p> +<dl> +<dt>Returns:</dt> +<dd> +dictionary containing the node name as key and line number + as value +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<a NAME="ReturnVisitor.visit_Assign" ID="ReturnVisitor.visit_Assign"></a> +<h4>ReturnVisitor.visit_Assign</h4> +<b>visit_Assign</b>(<i>node</i>) + +<p> + Public method to handle an assign node. +</p> +<dl> + +<dt><i>node</i> (ast.Assign)</dt> +<dd> +reference to the node to handle +</dd> +</dl> +<a NAME="ReturnVisitor.visit_AsyncFor" ID="ReturnVisitor.visit_AsyncFor"></a> +<h4>ReturnVisitor.visit_AsyncFor</h4> +<b>visit_AsyncFor</b>(<i>node</i>) + +<p> + Public method to handle an async for loop. +</p> +<dl> + +<dt><i>node</i> (ast.AsyncFor)</dt> +<dd> +reference to the async for node to handle +</dd> +</dl> +<a NAME="ReturnVisitor.visit_AsyncFunctionDef" ID="ReturnVisitor.visit_AsyncFunctionDef"></a> +<h4>ReturnVisitor.visit_AsyncFunctionDef</h4> +<b>visit_AsyncFunctionDef</b>(<i>node</i>) + +<p> + Public method to handle a function definition. +</p> +<dl> + +<dt><i>node</i> (ast.AsyncFunctionDef)</dt> +<dd> +reference to the node to handle +</dd> +</dl> +<a NAME="ReturnVisitor.visit_For" ID="ReturnVisitor.visit_For"></a> +<h4>ReturnVisitor.visit_For</h4> +<b>visit_For</b>(<i>node</i>) + +<p> + Public method to handle a for loop. +</p> +<dl> + +<dt><i>node</i> (ast.For)</dt> +<dd> +reference to the for node to handle +</dd> +</dl> +<a NAME="ReturnVisitor.visit_FunctionDef" ID="ReturnVisitor.visit_FunctionDef"></a> +<h4>ReturnVisitor.visit_FunctionDef</h4> +<b>visit_FunctionDef</b>(<i>node</i>) + +<p> + Public method to handle a function definition. +</p> +<dl> + +<dt><i>node</i> (ast.FunctionDef)</dt> +<dd> +reference to the node to handle +</dd> +</dl> +<a NAME="ReturnVisitor.visit_Name" ID="ReturnVisitor.visit_Name"></a> +<h4>ReturnVisitor.visit_Name</h4> +<b>visit_Name</b>(<i>node</i>) + +<p> + Public method to handle a name node. +</p> +<dl> + +<dt><i>node</i> (ast.Name)</dt> +<dd> +reference to the node to handle +</dd> +</dl> +<a NAME="ReturnVisitor.visit_Return" ID="ReturnVisitor.visit_Return"></a> +<h4>ReturnVisitor.visit_Return</h4> +<b>visit_Return</b>(<i>node</i>) + +<p> + Public method to handle a return node. +</p> +<dl> + +<dt><i>node</i> (ast.Return)</dt> +<dd> +reference to the node to handle +</dd> +</dl> +<a NAME="ReturnVisitor.visit_While" ID="ReturnVisitor.visit_While"></a> +<h4>ReturnVisitor.visit_While</h4> +<b>visit_While</b>(<i>node</i>) + +<p> + Public method to handle a while loop. +</p> +<dl> + +<dt><i>node</i> (ast.While)</dt> +<dd> +reference to the while node to handle +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="SysVersionVisitor" ID="SysVersionVisitor"></a> +<h2>SysVersionVisitor</h2> + +<p> + Class implementing a node visitor to check the use of sys.version and + sys.version_info. +</p> +<p> + Note: This class is modelled after flake8-2020 checker. +</p> +<h3>Derived from</h3> +ast.NodeVisitor +<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="#SysVersionVisitor.__init__">SysVersionVisitor</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#SysVersionVisitor.__isSys">__isSys</a></td> +<td>Private method to check for a reference to sys attribute.</td> +</tr> +<tr> +<td><a href="#SysVersionVisitor.__isSysVersionUpperSlice">__isSysVersionUpperSlice</a></td> +<td>Private method to check the upper slice of sys.version.</td> +</tr> +<tr> +<td><a href="#SysVersionVisitor.visit_Attribute">visit_Attribute</a></td> +<td>Public method to handle an attribute.</td> +</tr> +<tr> +<td><a href="#SysVersionVisitor.visit_Compare">visit_Compare</a></td> +<td>Public method to handle a comparison.</td> +</tr> +<tr> +<td><a href="#SysVersionVisitor.visit_ImportFrom">visit_ImportFrom</a></td> +<td>Public method to handle a from ...</td> +</tr> +<tr> +<td><a href="#SysVersionVisitor.visit_Name">visit_Name</a></td> +<td>Public method to handle an name.</td> +</tr> +<tr> +<td><a href="#SysVersionVisitor.visit_Subscript">visit_Subscript</a></td> +<td>Public method to handle a subscript.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="SysVersionVisitor.__init__" ID="SysVersionVisitor.__init__"></a> +<h4>SysVersionVisitor (Constructor)</h4> +<b>SysVersionVisitor</b>(<i></i>) + +<p> + Constructor +</p> +<a NAME="SysVersionVisitor.__isSys" ID="SysVersionVisitor.__isSys"></a> +<h4>SysVersionVisitor.__isSys</h4> +<b>__isSys</b>(<i>attr, node</i>) + +<p> + Private method to check for a reference to sys attribute. +</p> +<dl> + +<dt><i>attr</i> (str)</dt> +<dd> +attribute name +</dd> +<dt><i>node</i> (ast.Node)</dt> +<dd> +reference to the node to be checked +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating a match +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="SysVersionVisitor.__isSysVersionUpperSlice" ID="SysVersionVisitor.__isSysVersionUpperSlice"></a> +<h4>SysVersionVisitor.__isSysVersionUpperSlice</h4> +<b>__isSysVersionUpperSlice</b>(<i>node, n</i>) + +<p> + Private method to check the upper slice of sys.version. +</p> +<dl> + +<dt><i>node</i> (ast.Node)</dt> +<dd> +reference to the node to be checked +</dd> +<dt><i>n</i> (int)</dt> +<dd> +slice value to check against +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating a match +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="SysVersionVisitor.visit_Attribute" ID="SysVersionVisitor.visit_Attribute"></a> +<h4>SysVersionVisitor.visit_Attribute</h4> +<b>visit_Attribute</b>(<i>node</i>) + +<p> + Public method to handle an attribute. +</p> +<dl> + +<dt><i>node</i> (ast.Attribute)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="SysVersionVisitor.visit_Compare" ID="SysVersionVisitor.visit_Compare"></a> +<h4>SysVersionVisitor.visit_Compare</h4> +<b>visit_Compare</b>(<i>node</i>) + +<p> + Public method to handle a comparison. +</p> +<dl> + +<dt><i>node</i> (ast.Compare)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="SysVersionVisitor.visit_ImportFrom" ID="SysVersionVisitor.visit_ImportFrom"></a> +<h4>SysVersionVisitor.visit_ImportFrom</h4> +<b>visit_ImportFrom</b>(<i>node</i>) + +<p> + Public method to handle a from ... import ... statement. +</p> +<dl> + +<dt><i>node</i> (ast.ImportFrom)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="SysVersionVisitor.visit_Name" ID="SysVersionVisitor.visit_Name"></a> +<h4>SysVersionVisitor.visit_Name</h4> +<b>visit_Name</b>(<i>node</i>) + +<p> + Public method to handle an name. +</p> +<dl> + +<dt><i>node</i> (ast.Name)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<a NAME="SysVersionVisitor.visit_Subscript" ID="SysVersionVisitor.visit_Subscript"></a> +<h4>SysVersionVisitor.visit_Subscript</h4> +<b>visit_Subscript</b>(<i>node</i>) + +<p> + Public method to handle a subscript. +</p> +<dl> + +<dt><i>node</i> (ast.Subscript)</dt> +<dd> +reference to the node to be processed +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="TextVisitor" ID="TextVisitor"></a> +<h2>TextVisitor</h2> + +<p> + Class implementing a node visitor for bytes and str instances. +</p> +<p> + It tries to detect docstrings as string of the first expression of each + module, class or function. +</p> +<h3>Derived from</h3> +ast.NodeVisitor +<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="#TextVisitor.__init__">TextVisitor</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#TextVisitor.__addNode">__addNode</a></td> +<td>Private method to add a node to our list of nodes.</td> +</tr> +<tr> +<td><a href="#TextVisitor.__visitBody">__visitBody</a></td> +<td>Private method to traverse the body of the node manually.</td> +</tr> +<tr> +<td><a href="#TextVisitor.__visitDefinition">__visitDefinition</a></td> +<td>Private method handling class and function definitions.</td> +</tr> +<tr> +<td><a href="#TextVisitor.visit_AsyncFunctionDef">visit_AsyncFunctionDef</a></td> +<td>Public method to handle an asynchronous function definition.</td> +</tr> +<tr> +<td><a href="#TextVisitor.visit_Bytes">visit_Bytes</a></td> +<td>Public method to record a bytes node.</td> +</tr> +<tr> +<td><a href="#TextVisitor.visit_Call">visit_Call</a></td> +<td>Public method to handle a function call.</td> +</tr> +<tr> +<td><a href="#TextVisitor.visit_ClassDef">visit_ClassDef</a></td> +<td>Public method to handle a class definition.</td> +</tr> +<tr> +<td><a href="#TextVisitor.visit_Constant">visit_Constant</a></td> +<td>Public method to handle constant nodes.</td> +</tr> +<tr> +<td><a href="#TextVisitor.visit_FunctionDef">visit_FunctionDef</a></td> +<td>Public method to handle a function definition.</td> +</tr> +<tr> +<td><a href="#TextVisitor.visit_Module">visit_Module</a></td> +<td>Public method to handle a module.</td> +</tr> +<tr> +<td><a href="#TextVisitor.visit_Str">visit_Str</a></td> +<td>Public method to record a string node.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="TextVisitor.__init__" ID="TextVisitor.__init__"></a> +<h4>TextVisitor (Constructor)</h4> +<b>TextVisitor</b>(<i></i>) + +<p> + Constructor +</p> +<a NAME="TextVisitor.__addNode" ID="TextVisitor.__addNode"></a> +<h4>TextVisitor.__addNode</h4> +<b>__addNode</b>(<i>node</i>) + +<p> + Private method to add a node to our list of nodes. +</p> +<dl> + +<dt><i>node</i> (ast.AST)</dt> +<dd> +reference to the node to add +</dd> +</dl> +<a NAME="TextVisitor.__visitBody" ID="TextVisitor.__visitBody"></a> +<h4>TextVisitor.__visitBody</h4> +<b>__visitBody</b>(<i>node</i>) + +<p> + Private method to traverse the body of the node manually. +</p> +<p> + If the first node is an expression which contains a string or bytes it + marks that as a docstring. +</p> +<dl> + +<dt><i>node</i> (ast.AST)</dt> +<dd> +reference to the node to traverse +</dd> +</dl> +<a NAME="TextVisitor.__visitDefinition" ID="TextVisitor.__visitDefinition"></a> +<h4>TextVisitor.__visitDefinition</h4> +<b>__visitDefinition</b>(<i>node</i>) + +<p> + Private method handling class and function definitions. +</p> +<dl> + +<dt><i>node</i> (ast.FunctionDef, ast.AsyncFunctionDef or ast.ClassDef)</dt> +<dd> +reference to the node to handle +</dd> +</dl> +<a NAME="TextVisitor.visit_AsyncFunctionDef" ID="TextVisitor.visit_AsyncFunctionDef"></a> +<h4>TextVisitor.visit_AsyncFunctionDef</h4> +<b>visit_AsyncFunctionDef</b>(<i>node</i>) + +<p> + Public method to handle an asynchronous function definition. +</p> +<dl> + +<dt><i>node</i> (ast.AsyncFunctionDef)</dt> +<dd> +reference to the node to handle +</dd> +</dl> +<a NAME="TextVisitor.visit_Bytes" ID="TextVisitor.visit_Bytes"></a> +<h4>TextVisitor.visit_Bytes</h4> +<b>visit_Bytes</b>(<i>node</i>) + +<p> + Public method to record a bytes node. +</p> +<dl> + +<dt><i>node</i> (ast.Bytes)</dt> +<dd> +reference to the bytes node +</dd> +</dl> +<a NAME="TextVisitor.visit_Call" ID="TextVisitor.visit_Call"></a> +<h4>TextVisitor.visit_Call</h4> +<b>visit_Call</b>(<i>node</i>) + +<p> + Public method to handle a function call. +</p> +<dl> + +<dt><i>node</i> (ast.Call)</dt> +<dd> +reference to the node to handle +</dd> +</dl> +<a NAME="TextVisitor.visit_ClassDef" ID="TextVisitor.visit_ClassDef"></a> +<h4>TextVisitor.visit_ClassDef</h4> +<b>visit_ClassDef</b>(<i>node</i>) + +<p> + Public method to handle a class definition. +</p> +<dl> + +<dt><i>node</i> (ast.ClassDef)</dt> +<dd> +reference to the node to handle +</dd> +</dl> +<a NAME="TextVisitor.visit_Constant" ID="TextVisitor.visit_Constant"></a> +<h4>TextVisitor.visit_Constant</h4> +<b>visit_Constant</b>(<i>node</i>) + +<p> + Public method to handle constant nodes. +</p> +<dl> + +<dt><i>node</i> (ast.Constant)</dt> +<dd> +reference to the bytes node +</dd> +</dl> +<a NAME="TextVisitor.visit_FunctionDef" ID="TextVisitor.visit_FunctionDef"></a> +<h4>TextVisitor.visit_FunctionDef</h4> +<b>visit_FunctionDef</b>(<i>node</i>) + +<p> + Public method to handle a function definition. +</p> +<dl> + +<dt><i>node</i> (ast.FunctionDef)</dt> +<dd> +reference to the node to handle +</dd> +</dl> +<a NAME="TextVisitor.visit_Module" ID="TextVisitor.visit_Module"></a> +<h4>TextVisitor.visit_Module</h4> +<b>visit_Module</b>(<i>node</i>) + +<p> + Public method to handle a module. +</p> +<dl> + +<dt><i>node</i> (ast.Module)</dt> +<dd> +reference to the node to handle +</dd> +</dl> +<a NAME="TextVisitor.visit_Str" ID="TextVisitor.visit_Str"></a> +<h4>TextVisitor.visit_Str</h4> +<b>visit_Str</b>(<i>node</i>) + +<p> + Public method to record a string node. +</p> +<dl> + +<dt><i>node</i> (ast.Str)</dt> +<dd> +reference to the string node +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="composeCallPath" ID="composeCallPath"></a> +<h2>composeCallPath</h2> +<b>composeCallPath</b>(<i>node</i>) + +<p> + Generator function to assemble the call path of a given node. +</p> +<dl> + +<dt><i>node</i> (ast.Node)</dt> +<dd> +node to assemble call path for +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +call path components +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</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/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.translations.html Tue Oct 13 19:02:26 2020 +0200 @@ -0,0 +1,45 @@ +<!DOCTYPE html> +<html><head> +<title>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.translations</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>eric6.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.translations</h1> + +<p> +Module implementing message translations for the code style plugin messages +(miscellaneous part). +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>_miscellaneousMessages</td></tr><tr><td>_miscellaneousMessagesSampleArgs</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +</body></html> \ No newline at end of file
--- a/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker.html Tue Oct 13 18:23:53 2020 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,2227 +0,0 @@ -<!DOCTYPE html> -<html><head> -<title>eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker</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>eric6.Plugins.CheckerPlugins.CodeStyleChecker.MiscellaneousChecker</h1> - -<p> -Module implementing a checker for miscellaneous checks. -</p> -<h3>Global Attributes</h3> - -<table> -<tr><td>None</td></tr> -</table> -<h3>Classes</h3> - -<table> - -<tr> -<td><a href="#BugBearVisitor">BugBearVisitor</a></td> -<td>Class implementing a node visitor to check for various topics.</td> -</tr> -<tr> -<td><a href="#DateTimeVisitor">DateTimeVisitor</a></td> -<td>Class implementing a node visitor to check datetime function calls.</td> -</tr> -<tr> -<td><a href="#LoggingVisitor">LoggingVisitor</a></td> -<td>Class implementing a node visitor to check logging statements.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker">MiscellaneousChecker</a></td> -<td>Class implementing a checker for miscellaneous checks.</td> -</tr> -<tr> -<td><a href="#NameFinder">NameFinder</a></td> -<td>Class to extract a name out of a tree of nodes.</td> -</tr> -<tr> -<td><a href="#ReturnVisitor">ReturnVisitor</a></td> -<td>Class implementing a node visitor to check return statements.</td> -</tr> -<tr> -<td><a href="#SysVersionVisitor">SysVersionVisitor</a></td> -<td>Class implementing a node visitor to check the use of sys.version and sys.version_info.</td> -</tr> -<tr> -<td><a href="#TextVisitor">TextVisitor</a></td> -<td>Class implementing a node visitor for bytes and str instances.</td> -</tr> -</table> -<h3>Functions</h3> - -<table> - -<tr> -<td><a href="#composeCallPath">composeCallPath</a></td> -<td>Generator function to assemble the call path of a given node.</td> -</tr> -</table> -<hr /> -<hr /> -<a NAME="BugBearVisitor" ID="BugBearVisitor"></a> -<h2>BugBearVisitor</h2> - -<p> - Class implementing a node visitor to check for various topics. -</p> -<h3>Derived from</h3> -ast.NodeVisitor -<h3>Class Attributes</h3> - -<table> -<tr><td>NodeWindowSize</td></tr> -</table> -<h3>Class Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> -<h3>Methods</h3> - -<table> - -<tr> -<td><a href="#BugBearVisitor.__init__">BugBearVisitor</a></td> -<td>Constructor</td> -</tr> -<tr> -<td><a href="#BugBearVisitor.__checkForM502">__checkForM502</a></td> -<td>Private method to check the use of *strip().</td> -</tr> -<tr> -<td><a href="#BugBearVisitor.__checkForM507">__checkForM507</a></td> -<td>Private method to check for unused loop variables.</td> -</tr> -<tr> -<td><a href="#BugBearVisitor.visit">visit</a></td> -<td>Public method to traverse a given AST node.</td> -</tr> -<tr> -<td><a href="#BugBearVisitor.visit_Assert">visit_Assert</a></td> -<td>Public method to handle 'assert' statements.</td> -</tr> -<tr> -<td><a href="#BugBearVisitor.visit_Assign">visit_Assign</a></td> -<td>Public method to handle assignments.</td> -</tr> -<tr> -<td><a href="#BugBearVisitor.visit_AsyncFor">visit_AsyncFor</a></td> -<td>Public method to handle 'for' statements.</td> -</tr> -<tr> -<td><a href="#BugBearVisitor.visit_Attribute">visit_Attribute</a></td> -<td>Public method to handle attributes.</td> -</tr> -<tr> -<td><a href="#BugBearVisitor.visit_Call">visit_Call</a></td> -<td>Public method to handle a function call.</td> -</tr> -<tr> -<td><a href="#BugBearVisitor.visit_For">visit_For</a></td> -<td>Public method to handle 'for' statements.</td> -</tr> -<tr> -<td><a href="#BugBearVisitor.visit_JoinedStr">visit_JoinedStr</a></td> -<td>Public method to handle f-string arguments.</td> -</tr> -<tr> -<td><a href="#BugBearVisitor.visit_UAdd">visit_UAdd</a></td> -<td>Public method to handle unary additions.</td> -</tr> -</table> -<h3>Static Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> - -<a NAME="BugBearVisitor.__init__" ID="BugBearVisitor.__init__"></a> -<h4>BugBearVisitor (Constructor)</h4> -<b>BugBearVisitor</b>(<i></i>) - -<p> - Constructor -</p> -<a NAME="BugBearVisitor.__checkForM502" ID="BugBearVisitor.__checkForM502"></a> -<h4>BugBearVisitor.__checkForM502</h4> -<b>__checkForM502</b>(<i>node</i>) - -<p> - Private method to check the use of *strip(). -</p> -<dl> - -<dt><i>node</i> (ast.Call)</dt> -<dd> -reference to the node to be processed -</dd> -</dl> -<a NAME="BugBearVisitor.__checkForM507" ID="BugBearVisitor.__checkForM507"></a> -<h4>BugBearVisitor.__checkForM507</h4> -<b>__checkForM507</b>(<i>node</i>) - -<p> - Private method to check for unused loop variables. -</p> -<dl> - -<dt><i>node</i> (ast.For)</dt> -<dd> -reference to the node to be processed -</dd> -</dl> -<a NAME="BugBearVisitor.visit" ID="BugBearVisitor.visit"></a> -<h4>BugBearVisitor.visit</h4> -<b>visit</b>(<i>node</i>) - -<p> - Public method to traverse a given AST node. -</p> -<dl> - -<dt><i>node</i> (ast.Node)</dt> -<dd> -AST node to be traversed -</dd> -</dl> -<a NAME="BugBearVisitor.visit_Assert" ID="BugBearVisitor.visit_Assert"></a> -<h4>BugBearVisitor.visit_Assert</h4> -<b>visit_Assert</b>(<i>node</i>) - -<p> - Public method to handle 'assert' statements. -</p> -<dl> - -<dt><i>node</i> (ast.Assert)</dt> -<dd> -reference to the node to be processed -</dd> -</dl> -<a NAME="BugBearVisitor.visit_Assign" ID="BugBearVisitor.visit_Assign"></a> -<h4>BugBearVisitor.visit_Assign</h4> -<b>visit_Assign</b>(<i>node</i>) - -<p> - Public method to handle assignments. -</p> -<dl> - -<dt><i>node</i> (ast.Assign)</dt> -<dd> -reference to the node to be processed -</dd> -</dl> -<a NAME="BugBearVisitor.visit_AsyncFor" ID="BugBearVisitor.visit_AsyncFor"></a> -<h4>BugBearVisitor.visit_AsyncFor</h4> -<b>visit_AsyncFor</b>(<i>node</i>) - -<p> - Public method to handle 'for' statements. -</p> -<dl> - -<dt><i>node</i> (ast.AsyncFor)</dt> -<dd> -reference to the node to be processed -</dd> -</dl> -<a NAME="BugBearVisitor.visit_Attribute" ID="BugBearVisitor.visit_Attribute"></a> -<h4>BugBearVisitor.visit_Attribute</h4> -<b>visit_Attribute</b>(<i>node</i>) - -<p> - Public method to handle attributes. -</p> -<dl> - -<dt><i>node</i> (ast.Attribute)</dt> -<dd> -reference to the node to be processed -</dd> -</dl> -<a NAME="BugBearVisitor.visit_Call" ID="BugBearVisitor.visit_Call"></a> -<h4>BugBearVisitor.visit_Call</h4> -<b>visit_Call</b>(<i>node</i>) - -<p> - Public method to handle a function call. -</p> -<dl> - -<dt><i>node</i> (ast.Call)</dt> -<dd> -reference to the node to be processed -</dd> -</dl> -<a NAME="BugBearVisitor.visit_For" ID="BugBearVisitor.visit_For"></a> -<h4>BugBearVisitor.visit_For</h4> -<b>visit_For</b>(<i>node</i>) - -<p> - Public method to handle 'for' statements. -</p> -<dl> - -<dt><i>node</i> (ast.For)</dt> -<dd> -reference to the node to be processed -</dd> -</dl> -<a NAME="BugBearVisitor.visit_JoinedStr" ID="BugBearVisitor.visit_JoinedStr"></a> -<h4>BugBearVisitor.visit_JoinedStr</h4> -<b>visit_JoinedStr</b>(<i>node</i>) - -<p> - Public method to handle f-string arguments. -</p> -<dl> - -<dt><i>node</i> (ast.JoinedStr)</dt> -<dd> -reference to the node to be processed -</dd> -</dl> -<a NAME="BugBearVisitor.visit_UAdd" ID="BugBearVisitor.visit_UAdd"></a> -<h4>BugBearVisitor.visit_UAdd</h4> -<b>visit_UAdd</b>(<i>node</i>) - -<p> - Public method to handle unary additions. -</p> -<dl> - -<dt><i>node</i> (ast.UAdd)</dt> -<dd> -reference to the node to be processed -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="DateTimeVisitor" ID="DateTimeVisitor"></a> -<h2>DateTimeVisitor</h2> - -<p> - Class implementing a node visitor to check datetime function calls. -</p> -<p> - Note: This class is modelled after flake8_datetimez checker. -</p> -<h3>Derived from</h3> -ast.NodeVisitor -<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="#DateTimeVisitor.__init__">DateTimeVisitor</a></td> -<td>Constructor</td> -</tr> -<tr> -<td><a href="#DateTimeVisitor.__getFromKeywords">__getFromKeywords</a></td> -<td>Private method to get a keyword node given its name.</td> -</tr> -<tr> -<td><a href="#DateTimeVisitor.visit_Call">visit_Call</a></td> -<td>Public method to handle a function call.</td> -</tr> -</table> -<h3>Static Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> - -<a NAME="DateTimeVisitor.__init__" ID="DateTimeVisitor.__init__"></a> -<h4>DateTimeVisitor (Constructor)</h4> -<b>DateTimeVisitor</b>(<i></i>) - -<p> - Constructor -</p> -<a NAME="DateTimeVisitor.__getFromKeywords" ID="DateTimeVisitor.__getFromKeywords"></a> -<h4>DateTimeVisitor.__getFromKeywords</h4> -<b>__getFromKeywords</b>(<i>keywords, name</i>) - -<p> - Private method to get a keyword node given its name. -</p> -<dl> - -<dt><i>keywords</i> (list of ast.AST)</dt> -<dd> -list of keyword argument nodes -</dd> -<dt><i>name</i> (str)</dt> -<dd> -name of the keyword node -</dd> -</dl> -<dl> -<dt>Returns:</dt> -<dd> -keyword node -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -ast.AST -</dd> -</dl> -<a NAME="DateTimeVisitor.visit_Call" ID="DateTimeVisitor.visit_Call"></a> -<h4>DateTimeVisitor.visit_Call</h4> -<b>visit_Call</b>(<i>node</i>) - -<p> - Public method to handle a function call. -</p> -<p> - Every datetime related function call is check for use of the naive - variant (i.e. use without TZ info). -</p> -<dl> - -<dt><i>node</i> (ast.Call)</dt> -<dd> -reference to the node to be processed -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="LoggingVisitor" ID="LoggingVisitor"></a> -<h2>LoggingVisitor</h2> - -<p> - Class implementing a node visitor to check logging statements. -</p> -<h3>Derived from</h3> -ast.NodeVisitor -<h3>Class Attributes</h3> - -<table> -<tr><td>LoggingLevels</td></tr> -</table> -<h3>Class Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> -<h3>Methods</h3> - -<table> - -<tr> -<td><a href="#LoggingVisitor.__init__">LoggingVisitor</a></td> -<td>Constructor</td> -</tr> -<tr> -<td><a href="#LoggingVisitor.__detectLoggingLevel">__detectLoggingLevel</a></td> -<td>Private method to decide whether an AST Call is a logging call.</td> -</tr> -<tr> -<td><a href="#LoggingVisitor.__isFormatCall">__isFormatCall</a></td> -<td>Private method to check if a function call uses format.</td> -</tr> -<tr> -<td><a href="#LoggingVisitor.__withinExtraKeyword">__withinExtraKeyword</a></td> -<td>Private method to check, if we are inside the extra keyword.</td> -</tr> -<tr> -<td><a href="#LoggingVisitor.__withinLoggingArgument">__withinLoggingArgument</a></td> -<td>Private method to check, if we are inside a logging argument.</td> -</tr> -<tr> -<td><a href="#LoggingVisitor.__withinLoggingStatement">__withinLoggingStatement</a></td> -<td>Private method to check, if we are inside a logging statement.</td> -</tr> -<tr> -<td><a href="#LoggingVisitor.visit_BinOp">visit_BinOp</a></td> -<td>Public method to handle binary operations while processing the first logging argument.</td> -</tr> -<tr> -<td><a href="#LoggingVisitor.visit_Call">visit_Call</a></td> -<td>Public method to handle a function call.</td> -</tr> -<tr> -<td><a href="#LoggingVisitor.visit_JoinedStr">visit_JoinedStr</a></td> -<td>Public method to handle f-string arguments.</td> -</tr> -</table> -<h3>Static Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> - -<a NAME="LoggingVisitor.__init__" ID="LoggingVisitor.__init__"></a> -<h4>LoggingVisitor (Constructor)</h4> -<b>LoggingVisitor</b>(<i></i>) - -<p> - Constructor -</p> -<a NAME="LoggingVisitor.__detectLoggingLevel" ID="LoggingVisitor.__detectLoggingLevel"></a> -<h4>LoggingVisitor.__detectLoggingLevel</h4> -<b>__detectLoggingLevel</b>(<i>node</i>) - -<p> - Private method to decide whether an AST Call is a logging call. -</p> -<dl> - -<dt><i>node</i> (ast.Call)</dt> -<dd> -reference to the node to be processed -</dd> -</dl> -<dl> -<dt>Returns:</dt> -<dd> -logging level -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -str or None -</dd> -</dl> -<a NAME="LoggingVisitor.__isFormatCall" ID="LoggingVisitor.__isFormatCall"></a> -<h4>LoggingVisitor.__isFormatCall</h4> -<b>__isFormatCall</b>(<i>node</i>) - -<p> - Private method to check if a function call uses format. -</p> -<dl> - -<dt><i>node</i> (ast.Call)</dt> -<dd> -reference to the node to be processed -</dd> -</dl> -<dl> -<dt>Returns:</dt> -<dd> -flag indicating the function call uses format -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> -<a NAME="LoggingVisitor.__withinExtraKeyword" ID="LoggingVisitor.__withinExtraKeyword"></a> -<h4>LoggingVisitor.__withinExtraKeyword</h4> -<b>__withinExtraKeyword</b>(<i>node</i>) - -<p> - Private method to check, if we are inside the extra keyword. -</p> -<dl> - -<dt><i>node</i> (ast.keyword)</dt> -<dd> -reference to the node to be checked -</dd> -</dl> -<dl> -<dt>Returns:</dt> -<dd> -flag indicating we are inside the extra keyword -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> -<a NAME="LoggingVisitor.__withinLoggingArgument" ID="LoggingVisitor.__withinLoggingArgument"></a> -<h4>LoggingVisitor.__withinLoggingArgument</h4> -<b>__withinLoggingArgument</b>(<i></i>) - -<p> - Private method to check, if we are inside a logging argument. -</p> -<dl> -<dt>Returns:</dt> -<dd> -flag indicating we are inside a logging argument -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> -<a NAME="LoggingVisitor.__withinLoggingStatement" ID="LoggingVisitor.__withinLoggingStatement"></a> -<h4>LoggingVisitor.__withinLoggingStatement</h4> -<b>__withinLoggingStatement</b>(<i></i>) - -<p> - Private method to check, if we are inside a logging statement. -</p> -<dl> -<dt>Returns:</dt> -<dd> -flag indicating we are inside a logging statement -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> -<a NAME="LoggingVisitor.visit_BinOp" ID="LoggingVisitor.visit_BinOp"></a> -<h4>LoggingVisitor.visit_BinOp</h4> -<b>visit_BinOp</b>(<i>node</i>) - -<p> - Public method to handle binary operations while processing the first - logging argument. -</p> -<dl> - -<dt><i>node</i> (ast.BinOp)</dt> -<dd> -reference to the node to be processed -</dd> -</dl> -<a NAME="LoggingVisitor.visit_Call" ID="LoggingVisitor.visit_Call"></a> -<h4>LoggingVisitor.visit_Call</h4> -<b>visit_Call</b>(<i>node</i>) - -<p> - Public method to handle a function call. -</p> -<p> - Every logging statement and string format is expected to be a function - call. -</p> -<dl> - -<dt><i>node</i> (ast.Call)</dt> -<dd> -reference to the node to be processed -</dd> -</dl> -<a NAME="LoggingVisitor.visit_JoinedStr" ID="LoggingVisitor.visit_JoinedStr"></a> -<h4>LoggingVisitor.visit_JoinedStr</h4> -<b>visit_JoinedStr</b>(<i>node</i>) - -<p> - Public method to handle f-string arguments. -</p> -<dl> - -<dt><i>node</i> (ast.JoinedStr)</dt> -<dd> -reference to the node to be processed -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="MiscellaneousChecker" ID="MiscellaneousChecker"></a> -<h2>MiscellaneousChecker</h2> - -<p> - Class implementing a checker for miscellaneous checks. -</p> -<h3>Derived from</h3> -object -<h3>Class Attributes</h3> - -<table> -<tr><td>BuiltinsWhiteList</td></tr><tr><td>Codes</td></tr><tr><td>FormatFieldRegex</td></tr><tr><td>Formatter</td></tr> -</table> -<h3>Class Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> -<h3>Methods</h3> - -<table> - -<tr> -<td><a href="#MiscellaneousChecker.__init__">MiscellaneousChecker</a></td> -<td>Constructor</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkBugBear">__checkBugBear</a></td> -<td>Private method for bugbear checks.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkBuiltins">__checkBuiltins</a></td> -<td>Private method to check, if built-ins are shadowed.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkCoding">__checkCoding</a></td> -<td>Private method to check the presence of a coding line and valid encodings.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkCommentedCode">__checkCommentedCode</a></td> -<td>Private method to check for commented code.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkComprehensions">__checkComprehensions</a></td> -<td>Private method to check some comprehension related things.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkCopyright">__checkCopyright</a></td> -<td>Private method to check the presence of a copyright statement.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkDateTime">__checkDateTime</a></td> -<td>Private method to check use of naive datetime functions.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkDictWithSortedKeys">__checkDictWithSortedKeys</a></td> -<td>Private method to check, if dictionary keys appear in sorted order.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkFormatString">__checkFormatString</a></td> -<td>Private method to check string format strings.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkFuture">__checkFuture</a></td> -<td>Private method to check the __future__ imports.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkGettext">__checkGettext</a></td> -<td>Private method to check the 'gettext' import statement.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkLineContinuation">__checkLineContinuation</a></td> -<td>Private method to check line continuation using backslash.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkLogging">__checkLogging</a></td> -<td>Private method to check logging statements.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkMutableDefault">__checkMutableDefault</a></td> -<td>Private method to check for use of mutable types as default arguments.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkPep3101">__checkPep3101</a></td> -<td>Private method to check for old style string formatting.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkPrintStatements">__checkPrintStatements</a></td> -<td>Private method to check for print statements.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkReturn">__checkReturn</a></td> -<td>Private method to check return statements.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkSysVersion">__checkSysVersion</a></td> -<td>Private method to check the use of sys.version and sys.version_info.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__checkTuple">__checkTuple</a></td> -<td>Private method to check for one element tuples.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__dictShouldBeChecked">__dictShouldBeChecked</a></td> -<td>Private function to test, if the node should be checked.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__error">__error</a></td> -<td>Private method to record an issue.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__generateTree">__generateTree</a></td> -<td>Private method to generate an AST for our source.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__getCoding">__getCoding</a></td> -<td>Private method to get the defined coding of the source.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__getFields">__getFields</a></td> -<td>Private method to extract the format field information.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__ignoreCode">__ignoreCode</a></td> -<td>Private method to check if the message code should be ignored.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.__reportInvalidSyntax">__reportInvalidSyntax</a></td> -<td>Private method to report a syntax error.</td> -</tr> -<tr> -<td><a href="#MiscellaneousChecker.run">run</a></td> -<td>Public method to check the given source against miscellaneous conditions.</td> -</tr> -</table> -<h3>Static Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> - -<a NAME="MiscellaneousChecker.__init__" ID="MiscellaneousChecker.__init__"></a> -<h4>MiscellaneousChecker (Constructor)</h4> -<b>MiscellaneousChecker</b>(<i>source, filename, select, ignore, expected, repeat, args</i>) - -<p> - Constructor -</p> -<dl> - -<dt><i>source</i> (list of str)</dt> -<dd> -source code to be checked -</dd> -<dt><i>filename</i> (str)</dt> -<dd> -name of the source file -</dd> -<dt><i>select</i> (list of str)</dt> -<dd> -list of selected codes -</dd> -<dt><i>ignore</i> (list of str)</dt> -<dd> -list of codes to be ignored -</dd> -<dt><i>expected</i> (list of str)</dt> -<dd> -list of expected codes -</dd> -<dt><i>repeat</i> (bool)</dt> -<dd> -flag indicating to report each occurrence of a code -</dd> -<dt><i>args</i> (dict)</dt> -<dd> -dictionary of arguments for the miscellaneous checks -</dd> -</dl> -<a NAME="MiscellaneousChecker.__checkBugBear" ID="MiscellaneousChecker.__checkBugBear"></a> -<h4>MiscellaneousChecker.__checkBugBear</h4> -<b>__checkBugBear</b>(<i></i>) - -<p> - Private method for bugbear checks. -</p> -<a NAME="MiscellaneousChecker.__checkBuiltins" ID="MiscellaneousChecker.__checkBuiltins"></a> -<h4>MiscellaneousChecker.__checkBuiltins</h4> -<b>__checkBuiltins</b>(<i></i>) - -<p> - Private method to check, if built-ins are shadowed. -</p> -<a NAME="MiscellaneousChecker.__checkCoding" ID="MiscellaneousChecker.__checkCoding"></a> -<h4>MiscellaneousChecker.__checkCoding</h4> -<b>__checkCoding</b>(<i></i>) - -<p> - Private method to check the presence of a coding line and valid - encodings. -</p> -<a NAME="MiscellaneousChecker.__checkCommentedCode" ID="MiscellaneousChecker.__checkCommentedCode"></a> -<h4>MiscellaneousChecker.__checkCommentedCode</h4> -<b>__checkCommentedCode</b>(<i></i>) - -<p> - Private method to check for commented code. -</p> -<a NAME="MiscellaneousChecker.__checkComprehensions" ID="MiscellaneousChecker.__checkComprehensions"></a> -<h4>MiscellaneousChecker.__checkComprehensions</h4> -<b>__checkComprehensions</b>(<i></i>) - -<p> - Private method to check some comprehension related things. -</p> -<a NAME="MiscellaneousChecker.__checkCopyright" ID="MiscellaneousChecker.__checkCopyright"></a> -<h4>MiscellaneousChecker.__checkCopyright</h4> -<b>__checkCopyright</b>(<i></i>) - -<p> - Private method to check the presence of a copyright statement. -</p> -<a NAME="MiscellaneousChecker.__checkDateTime" ID="MiscellaneousChecker.__checkDateTime"></a> -<h4>MiscellaneousChecker.__checkDateTime</h4> -<b>__checkDateTime</b>(<i></i>) - -<p> - Private method to check use of naive datetime functions. -</p> -<a NAME="MiscellaneousChecker.__checkDictWithSortedKeys" ID="MiscellaneousChecker.__checkDictWithSortedKeys"></a> -<h4>MiscellaneousChecker.__checkDictWithSortedKeys</h4> -<b>__checkDictWithSortedKeys</b>(<i></i>) - -<p> - Private method to check, if dictionary keys appear in sorted order. -</p> -<a NAME="MiscellaneousChecker.__checkFormatString" ID="MiscellaneousChecker.__checkFormatString"></a> -<h4>MiscellaneousChecker.__checkFormatString</h4> -<b>__checkFormatString</b>(<i></i>) - -<p> - Private method to check string format strings. -</p> -<a NAME="MiscellaneousChecker.__checkFuture" ID="MiscellaneousChecker.__checkFuture"></a> -<h4>MiscellaneousChecker.__checkFuture</h4> -<b>__checkFuture</b>(<i></i>) - -<p> - Private method to check the __future__ imports. -</p> -<a NAME="MiscellaneousChecker.__checkGettext" ID="MiscellaneousChecker.__checkGettext"></a> -<h4>MiscellaneousChecker.__checkGettext</h4> -<b>__checkGettext</b>(<i></i>) - -<p> - Private method to check the 'gettext' import statement. -</p> -<a NAME="MiscellaneousChecker.__checkLineContinuation" ID="MiscellaneousChecker.__checkLineContinuation"></a> -<h4>MiscellaneousChecker.__checkLineContinuation</h4> -<b>__checkLineContinuation</b>(<i></i>) - -<p> - Private method to check line continuation using backslash. -</p> -<a NAME="MiscellaneousChecker.__checkLogging" ID="MiscellaneousChecker.__checkLogging"></a> -<h4>MiscellaneousChecker.__checkLogging</h4> -<b>__checkLogging</b>(<i></i>) - -<p> - Private method to check logging statements. -</p> -<a NAME="MiscellaneousChecker.__checkMutableDefault" ID="MiscellaneousChecker.__checkMutableDefault"></a> -<h4>MiscellaneousChecker.__checkMutableDefault</h4> -<b>__checkMutableDefault</b>(<i></i>) - -<p> - Private method to check for use of mutable types as default arguments. -</p> -<a NAME="MiscellaneousChecker.__checkPep3101" ID="MiscellaneousChecker.__checkPep3101"></a> -<h4>MiscellaneousChecker.__checkPep3101</h4> -<b>__checkPep3101</b>(<i></i>) - -<p> - Private method to check for old style string formatting. -</p> -<a NAME="MiscellaneousChecker.__checkPrintStatements" ID="MiscellaneousChecker.__checkPrintStatements"></a> -<h4>MiscellaneousChecker.__checkPrintStatements</h4> -<b>__checkPrintStatements</b>(<i></i>) - -<p> - Private method to check for print statements. -</p> -<a NAME="MiscellaneousChecker.__checkReturn" ID="MiscellaneousChecker.__checkReturn"></a> -<h4>MiscellaneousChecker.__checkReturn</h4> -<b>__checkReturn</b>(<i></i>) - -<p> - Private method to check return statements. -</p> -<a NAME="MiscellaneousChecker.__checkSysVersion" ID="MiscellaneousChecker.__checkSysVersion"></a> -<h4>MiscellaneousChecker.__checkSysVersion</h4> -<b>__checkSysVersion</b>(<i></i>) - -<p> - Private method to check the use of sys.version and sys.version_info. -</p> -<a NAME="MiscellaneousChecker.__checkTuple" ID="MiscellaneousChecker.__checkTuple"></a> -<h4>MiscellaneousChecker.__checkTuple</h4> -<b>__checkTuple</b>(<i></i>) - -<p> - Private method to check for one element tuples. -</p> -<a NAME="MiscellaneousChecker.__dictShouldBeChecked" ID="MiscellaneousChecker.__dictShouldBeChecked"></a> -<h4>MiscellaneousChecker.__dictShouldBeChecked</h4> -<b>__dictShouldBeChecked</b>(<i>node</i>) - -<p> - Private function to test, if the node should be checked. -</p> -<dl> - -<dt><i>node</i></dt> -<dd> -reference to the AST node -</dd> -</dl> -<dl> -<dt>Returns:</dt> -<dd> -flag indicating to check the node -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> -<a NAME="MiscellaneousChecker.__error" ID="MiscellaneousChecker.__error"></a> -<h4>MiscellaneousChecker.__error</h4> -<b>__error</b>(<i>lineNumber, offset, code, *args</i>) - -<p> - Private method to record an issue. -</p> -<dl> - -<dt><i>lineNumber</i> (int)</dt> -<dd> -line number of the issue -</dd> -<dt><i>offset</i> (int)</dt> -<dd> -position within line of the issue -</dd> -<dt><i>code</i> (str)</dt> -<dd> -message code -</dd> -<dt><i>args</i> (list)</dt> -<dd> -arguments for the message -</dd> -</dl> -<a NAME="MiscellaneousChecker.__generateTree" ID="MiscellaneousChecker.__generateTree"></a> -<h4>MiscellaneousChecker.__generateTree</h4> -<b>__generateTree</b>(<i></i>) - -<p> - Private method to generate an AST for our source. -</p> -<dl> -<dt>Returns:</dt> -<dd> -generated AST -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -ast.AST -</dd> -</dl> -<a NAME="MiscellaneousChecker.__getCoding" ID="MiscellaneousChecker.__getCoding"></a> -<h4>MiscellaneousChecker.__getCoding</h4> -<b>__getCoding</b>(<i></i>) - -<p> - Private method to get the defined coding of the source. -</p> -<dl> -<dt>Returns:</dt> -<dd> -tuple containing the line number and the coding -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -tuple of int and str -</dd> -</dl> -<a NAME="MiscellaneousChecker.__getFields" ID="MiscellaneousChecker.__getFields"></a> -<h4>MiscellaneousChecker.__getFields</h4> -<b>__getFields</b>(<i>string</i>) - -<p> - Private method to extract the format field information. -</p> -<dl> - -<dt><i>string</i> (str)</dt> -<dd> -format string to be parsed -</dd> -</dl> -<dl> -<dt>Returns:</dt> -<dd> -format field information as a tuple with fields, implicit - field definitions present and explicit field definitions present -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -tuple of set of str, bool, bool -</dd> -</dl> -<a NAME="MiscellaneousChecker.__ignoreCode" ID="MiscellaneousChecker.__ignoreCode"></a> -<h4>MiscellaneousChecker.__ignoreCode</h4> -<b>__ignoreCode</b>(<i>code</i>) - -<p> - Private method to check if the message code should be ignored. -</p> -<dl> - -<dt><i>code</i> (str)</dt> -<dd> -message code to check for -</dd> -</dl> -<dl> -<dt>Returns:</dt> -<dd> -flag indicating to ignore the given code -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -bool -</dd> -</dl> -<a NAME="MiscellaneousChecker.__reportInvalidSyntax" ID="MiscellaneousChecker.__reportInvalidSyntax"></a> -<h4>MiscellaneousChecker.__reportInvalidSyntax</h4> -<b>__reportInvalidSyntax</b>(<i></i>) - -<p> - Private method to report a syntax error. -</p> -<a NAME="MiscellaneousChecker.run" ID="MiscellaneousChecker.run"></a> -<h4>MiscellaneousChecker.run</h4> -<b>run</b>(<i></i>) - -<p> - Public method to check the given source against miscellaneous - conditions. -</p> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="NameFinder" ID="NameFinder"></a> -<h2>NameFinder</h2> - -<p> - Class to extract a name out of a tree of nodes. -</p> -<h3>Derived from</h3> -ast.NodeVisitor -<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="#NameFinder.__init__">NameFinder</a></td> -<td>Constructor</td> -</tr> -<tr> -<td><a href="#NameFinder.getNames">getNames</a></td> -<td>Public method to return the extracted names and Name nodes.</td> -</tr> -<tr> -<td><a href="#NameFinder.visit">visit</a></td> -<td>Public method to traverse a given AST node.</td> -</tr> -<tr> -<td><a href="#NameFinder.visit_Name">visit_Name</a></td> -<td>Public method to handle 'Name' nodes.</td> -</tr> -</table> -<h3>Static Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> - -<a NAME="NameFinder.__init__" ID="NameFinder.__init__"></a> -<h4>NameFinder (Constructor)</h4> -<b>NameFinder</b>(<i></i>) - -<p> - Constructor -</p> -<a NAME="NameFinder.getNames" ID="NameFinder.getNames"></a> -<h4>NameFinder.getNames</h4> -<b>getNames</b>(<i></i>) - -<p> - Public method to return the extracted names and Name nodes. -</p> -<dl> -<dt>Returns:</dt> -<dd> -dictionary containing the names as keys and the list of nodes -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -dict -</dd>