pylint.checkers.BaseChecker

class documentation

class BaseChecker(_ArgumentsProvider): (source)

Known subclasses: pylint.checkers.async.AsyncChecker, pylint.checkers.bad_chained_comparison.BadChainedComparisonChecker, pylint.checkers.BaseRawFileChecker, pylint.checkers.BaseTokenChecker, pylint.checkers.classes.class_checker.ClassChecker, pylint.checkers.classes.special_methods_checker.SpecialMethodsChecker, pylint.checkers.DeprecatedMixin, pylint.checkers.design_analysis.MisdesignChecker, pylint.checkers.dunder_methods.DunderCallChecker, pylint.checkers.ellipsis_checker.EllipsisChecker, pylint.checkers.exceptions.ExceptionsChecker, pylint.checkers.imports.ImportsChecker, pylint.checkers.lambda_expressions.LambdaExpressionChecker, pylint.checkers.logging.LoggingChecker, pylint.checkers.method_args.MethodArgsChecker, pylint.checkers.modified_iterating_checker.ModifiedIterationChecker, pylint.checkers.nested_min_max.NestedMinMaxChecker, pylint.checkers.newstyle.NewStyleConflictChecker, pylint.checkers.non_ascii_names.NonAsciiNameChecker, pylint.checkers.refactoring.ImplicitBooleanessChecker, pylint.checkers.refactoring.NotChecker, pylint.checkers.refactoring.RecommendationChecker, pylint.checkers.stdlib.StdlibChecker, pylint.checkers.strings.StringFormatChecker, pylint.checkers.threading_checker.ThreadingChecker, pylint.checkers.typecheck.IterableChecker, pylint.checkers.typecheck.TypeChecker, pylint.checkers.unsupported_version.UnsupportedVersionChecker, pylint.checkers.variables.VariablesChecker, pylint.extensions.bad_builtin.BadBuiltinChecker, pylint.extensions.broad_try_clause.BroadTryClauseChecker, pylint.extensions.code_style.CodeStyleChecker, pylint.extensions.comparetozero.CompareToZeroChecker, pylint.extensions.comparison_placement.MisplacedComparisonConstantChecker, pylint.extensions.confusing_elif.ConfusingConsecutiveElifChecker, pylint.extensions.consider_refactoring_into_while_condition.ConsiderRefactorIntoWhileConditionChecker, pylint.extensions.consider_ternary_expression.ConsiderTernaryExpressionChecker, pylint.extensions.dict_init_mutate.DictInitMutateChecker, pylint.extensions.docparams.DocstringParameterChecker, pylint.extensions.docstyle.DocStringStyleChecker, pylint.extensions.dunder.DunderChecker, pylint.extensions.emptystring.CompareToEmptyStringChecker, pylint.extensions.eq_without_hash.EqWithoutHash, pylint.extensions.for_any_all.ConsiderUsingAnyOrAllChecker, pylint.extensions.magic_value.MagicValueChecker, pylint.extensions.mccabe.McCabeMethodChecker, pylint.extensions.no_self_use.NoSelfUseChecker, pylint.extensions.overlapping_exceptions.OverlappingExceptionsChecker, pylint.extensions.private_import.PrivateImportChecker, pylint.extensions.redefined_loop_name.RedefinedLoopNameChecker, pylint.extensions.redefined_variable_type.MultipleTypesChecker, pylint.extensions.set_membership.SetMembershipChecker, pylint.extensions.typing.TypingChecker, pylint.extensions.while_used.WhileChecker, pylint.checkers.base.basic_checker._BasicChecker

View In Hierarchy

Undocumented

Method __eq__ Permit to assert Checkers are equal.
Method __gt__ Sorting of checkers.
Method __hash__ Make Checker hashable.
Method __init__ Checker instances should have the linter as argument.
Method __repr__ Undocumented
Method __str__ This might be incomplete because multiple classes inheriting BaseChecker can have the same name.
Method add_message Undocumented
Method check_consistency Check the consistency of msgid.
Method close Called after visiting project (i.e set of modules).
Method create_message_definition_from_tuple Undocumented
Method get_full_documentation Undocumented
Method get_map_data Undocumented
Method get_message_definition Undocumented
Method open Called before visiting project (i.e. set of modules).
Method reduce_map_data Undocumented
Class Variable enabled Undocumented
Class Variable msgs Undocumented
Class Variable options Options provided by this provider.
Class Variable reports Undocumented
Instance Variable linter Undocumented
Instance Variable name Name of the provider.
Property messages Undocumented

Inherited from _ArgumentsProvider:

Method get_option_def DEPRECATED: Return the dictionary defining an option given its name.
Method level.setter Undocumented
Method load_defaults DEPRECATED: Initialize the provider using default values.
Method option_attrname DEPRECATED: Get the config attribute corresponding to opt.
Method option_value DEPRECATED: Get the current value for the given option.
Method options_and_values DEPRECATED.
Method options_by_section DEPRECATED: Return an iterator on options grouped by section.
Method set_option DEPRECATED: Method called to set an option (registered in the options list).
Class Variable option_groups_descs Option groups of this provider and their descriptions.
Property config Undocumented
Property level Undocumented
Instance Variable _arguments_manager The manager that will parse and register any options provided.
Instance Variable _level Undocumented
def __eq__(self, other: Any) -> bool: (source)

Permit to assert Checkers are equal.

def __gt__(self, other: Any) -> bool: (source)

Sorting of checkers.

def __hash__(self) -> int: (source)

Make Checker hashable.

def __init__(self, linter: PyLinter): (source)
overrides pylint.config.arguments_provider._ArgumentsProvider.__init__
overridden in pylint.checkers.base.basic_checker.BasicChecker, pylint.checkers.base.NameChecker, pylint.checkers.classes.class_checker.ClassChecker, pylint.checkers.classes.special_methods_checker.SpecialMethodsChecker, pylint.checkers.design_analysis.MisdesignChecker, pylint.checkers.format.FormatChecker, pylint.checkers.format.FormatChecker, pylint.checkers.imports.ImportsChecker, pylint.checkers.imports.ImportsChecker, pylint.checkers.refactoring.RefactoringChecker, pylint.checkers.similar.SimilarChecker, pylint.checkers.stdlib.StdlibChecker, pylint.checkers.stdlib.StdlibChecker, pylint.checkers.strings.StringConstantChecker, pylint.checkers.strings.StringConstantChecker, pylint.checkers.variables.VariablesChecker, pylint.extensions.check_elif.ElseifUsedChecker, pylint.extensions.magic_value.MagicValueChecker, pylint.extensions.no_self_use.NoSelfUseChecker, pylint.extensions.private_import.PrivateImportChecker, pylint.extensions.redefined_loop_name.RedefinedLoopNameChecker, pylint.extensions.set_membership.SetMembershipChecker, pylint.extensions.typing.TypingChecker

Checker instances should have the linter as argument.

def __repr__(self) -> str: (source)

Undocumented

def __str__(self) -> str: (source)

This might be incomplete because multiple classes inheriting BaseChecker can have the same name. See: MessageHandlerMixIn.get_full_documentation()

def add_message(self, msgid: str, line: int|None = None, node: nodes.NodeNG|None = None, args: Any = None, confidence: Confidence|None = None, col_offset: int|None = None, end_lineno: int|None = None, end_col_offset: int|None = None): (source)

Undocumented

def check_consistency(self): (source)

Check the consistency of msgid. msg ids for a checker should be a string of len 4, where the two first characters are the checker id and the two last the msg id in this checker. :raises InvalidMessageError: If the checker id in the messages are not always the same.

def close(self): (source)
overridden in pylint.checkers.imports.ImportsChecker, pylint.checkers.imports.ImportsChecker, pylint.checkers.similar.SimilarChecker

Called after visiting project (i.e set of modules).

def create_message_definition_from_tuple(self, msgid: str, msg_tuple: MessageDefinitionTuple) -> MessageDefinition: (source)

Undocumented

def get_full_documentation(self, msgs: dict[str, MessageDefinitionTuple], options: Iterable[tuple[str, OptionDict, Any]], reports: Sequence[tuple[str, str, ReportsCallable]], doc: str|None = None, module: str|None = None, show_options: bool = True) -> str: (source)

Undocumented

def get_map_data(self) -> Any: (source)
overridden in pylint.checkers.similar.SimilarChecker

Undocumented

def get_message_definition(self, msgid: str) -> MessageDefinition: (source)

Undocumented

def open(self): (source)
overridden in pylint.checkers.async.AsyncChecker, pylint.checkers.base.basic_checker.BasicChecker, pylint.checkers.base.basic_error_checker.BasicErrorChecker, pylint.checkers.base.docstring_checker.DocStringChecker, pylint.checkers.base.NameChecker, pylint.checkers.classes.class_checker.ClassChecker, pylint.checkers.design_analysis.MisdesignChecker, pylint.checkers.dunder_methods.DunderCallChecker, pylint.checkers.exceptions.ExceptionsChecker, pylint.checkers.imports.ImportsChecker, pylint.checkers.imports.ImportsChecker, pylint.checkers.misc.EncodingChecker, pylint.checkers.misc.EncodingChecker, pylint.checkers.raw_metrics.RawMetricsChecker, pylint.checkers.refactoring.RecommendationChecker, pylint.checkers.refactoring.RefactoringChecker, pylint.checkers.similar.SimilarChecker, pylint.checkers.spelling.SpellingChecker, pylint.checkers.typecheck.TypeChecker, pylint.checkers.unsupported_version.UnsupportedVersionChecker, pylint.extensions.code_style.CodeStyleChecker, pylint.extensions.dunder.DunderChecker, pylint.extensions.magic_value.MagicValueChecker, pylint.extensions.typing.TypingChecker

Called before visiting project (i.e. set of modules).

def reduce_map_data(self, linter: PyLinter, data: list[Any]): (source)
overridden in pylint.checkers.similar.SimilarChecker

Undocumented

enabled: bool = (source)

Undocumented

msgs: dict[str, MessageDefinitionTuple] = (source)
overridden in pylint.checkers.async.AsyncChecker, pylint.checkers.bad_chained_comparison.BadChainedComparisonChecker, pylint.checkers.base.basic_checker.BasicChecker, pylint.checkers.base.basic_error_checker.BasicErrorChecker, pylint.checkers.base.comparison_checker.ComparisonChecker, pylint.checkers.base.docstring_checker.DocStringChecker, pylint.checkers.base.NameChecker, pylint.checkers.base.pass_checker.PassChecker, pylint.checkers.classes.special_methods_checker.SpecialMethodsChecker, pylint.checkers.dunder_methods.DunderCallChecker, pylint.checkers.ellipsis_checker.EllipsisChecker, pylint.checkers.imports.ImportsChecker, pylint.checkers.imports.ImportsChecker, pylint.checkers.lambda_expressions.LambdaExpressionChecker, pylint.checkers.method_args.MethodArgsChecker, pylint.checkers.misc.ByIdManagedMessagesChecker, pylint.checkers.misc.EncodingChecker, pylint.checkers.misc.EncodingChecker, pylint.checkers.modified_iterating_checker.ModifiedIterationChecker, pylint.checkers.nested_min_max.NestedMinMaxChecker, pylint.checkers.non_ascii_names.NonAsciiNameChecker, pylint.checkers.raw_metrics.RawMetricsChecker, pylint.checkers.refactoring.ImplicitBooleanessChecker, pylint.checkers.refactoring.NotChecker, pylint.checkers.refactoring.RecommendationChecker, pylint.checkers.refactoring.RefactoringChecker, pylint.checkers.spelling.SpellingChecker, pylint.checkers.stdlib.StdlibChecker, pylint.checkers.stdlib.StdlibChecker, pylint.checkers.strings.StringConstantChecker, pylint.checkers.strings.StringConstantChecker, pylint.checkers.threading_checker.ThreadingChecker, pylint.checkers.typecheck.IterableChecker, pylint.checkers.unicode.UnicodeChecker, pylint.checkers.unsupported_version.UnsupportedVersionChecker, pylint.extensions.bad_builtin.BadBuiltinChecker, pylint.extensions.broad_try_clause.BroadTryClauseChecker, pylint.extensions.check_elif.ElseifUsedChecker, pylint.extensions.code_style.CodeStyleChecker, pylint.extensions.comparetozero.CompareToZeroChecker, pylint.extensions.comparison_placement.MisplacedComparisonConstantChecker, pylint.extensions.confusing_elif.ConfusingConsecutiveElifChecker, pylint.extensions.consider_refactoring_into_while_condition.ConsiderRefactorIntoWhileConditionChecker, pylint.extensions.consider_ternary_expression.ConsiderTernaryExpressionChecker, pylint.extensions.dict_init_mutate.DictInitMutateChecker, pylint.extensions.docparams.DocstringParameterChecker, pylint.extensions.docstyle.DocStringStyleChecker, pylint.extensions.dunder.DunderChecker, pylint.extensions.empty_comment.CommentChecker, pylint.extensions.emptystring.CompareToEmptyStringChecker, pylint.extensions.eq_without_hash.EqWithoutHash, pylint.extensions.for_any_all.ConsiderUsingAnyOrAllChecker, pylint.extensions.magic_value.MagicValueChecker, pylint.extensions.mccabe.McCabeMethodChecker, pylint.extensions.no_self_use.NoSelfUseChecker, pylint.extensions.overlapping_exceptions.OverlappingExceptionsChecker, pylint.extensions.private_import.PrivateImportChecker, pylint.extensions.redefined_loop_name.RedefinedLoopNameChecker, pylint.extensions.redefined_variable_type.MultipleTypesChecker, pylint.extensions.set_membership.SetMembershipChecker, pylint.extensions.typing.TypingChecker, pylint.extensions.while_used.WhileChecker

Undocumented

options: Options = (source)
overrides pylint.config.arguments_provider._ArgumentsProvider.options
overridden in pylint.checkers.base.docstring_checker.DocStringChecker, pylint.checkers.base.NameChecker, pylint.checkers.classes.class_checker.ClassChecker, pylint.checkers.design_analysis.MisdesignChecker, pylint.checkers.dunder_methods.DunderCallChecker, pylint.checkers.exceptions.ExceptionsChecker, pylint.checkers.format.FormatChecker, pylint.checkers.format.FormatChecker, pylint.checkers.imports.ImportsChecker, pylint.checkers.imports.ImportsChecker, pylint.checkers.lambda_expressions.LambdaExpressionChecker, pylint.checkers.logging.LoggingChecker, pylint.checkers.method_args.MethodArgsChecker, pylint.checkers.misc.ByIdManagedMessagesChecker, pylint.checkers.misc.EncodingChecker, pylint.checkers.misc.EncodingChecker, pylint.checkers.modified_iterating_checker.ModifiedIterationChecker, pylint.checkers.newstyle.NewStyleConflictChecker, pylint.checkers.raw_metrics.RawMetricsChecker, pylint.checkers.refactoring.ImplicitBooleanessChecker, pylint.checkers.refactoring.RefactoringChecker, pylint.checkers.similar.SimilarChecker, pylint.checkers.spelling.SpellingChecker, pylint.checkers.strings.StringConstantChecker, pylint.checkers.strings.StringConstantChecker, pylint.checkers.typecheck.TypeChecker, pylint.checkers.variables.VariablesChecker, pylint.extensions.bad_builtin.BadBuiltinChecker, pylint.extensions.broad_try_clause.BroadTryClauseChecker, pylint.extensions.code_style.CodeStyleChecker, pylint.extensions.comparetozero.CompareToZeroChecker, pylint.extensions.comparison_placement.MisplacedComparisonConstantChecker, pylint.extensions.docparams.DocstringParameterChecker, pylint.extensions.dunder.DunderChecker, pylint.extensions.empty_comment.CommentChecker, pylint.extensions.emptystring.CompareToEmptyStringChecker, pylint.extensions.magic_value.MagicValueChecker, pylint.extensions.mccabe.McCabeMethodChecker, pylint.extensions.overlapping_exceptions.OverlappingExceptionsChecker, pylint.extensions.typing.TypingChecker

Options provided by this provider.

reports: tuple[tuple[str, str, ReportsCallable], ...] = (source)
overridden in pylint.checkers.base.basic_checker.BasicChecker, pylint.checkers.imports.ImportsChecker, pylint.checkers.imports.ImportsChecker, pylint.checkers.raw_metrics.RawMetricsChecker, pylint.checkers.similar.SimilarChecker

Undocumented

linter = (source)

Undocumented

name = (source)
overrides pylint.config.arguments_provider._ArgumentsProvider.name
overridden in pylint.checkers.async.AsyncChecker, pylint.checkers.bad_chained_comparison.BadChainedComparisonChecker, pylint.checkers.classes.class_checker.ClassChecker, pylint.checkers.classes.special_methods_checker.SpecialMethodsChecker, pylint.checkers.design_analysis.MisdesignChecker, pylint.checkers.dunder_methods.DunderCallChecker, pylint.checkers.ellipsis_checker.EllipsisChecker, pylint.checkers.exceptions.ExceptionsChecker, pylint.checkers.format.FormatChecker, pylint.checkers.format.FormatChecker, pylint.checkers.imports.ImportsChecker, pylint.checkers.imports.ImportsChecker, pylint.checkers.lambda_expressions.LambdaExpressionChecker, pylint.checkers.logging.LoggingChecker, pylint.checkers.method_args.MethodArgsChecker, pylint.checkers.misc.ByIdManagedMessagesChecker, pylint.checkers.misc.EncodingChecker, pylint.checkers.misc.EncodingChecker, pylint.checkers.modified_iterating_checker.ModifiedIterationChecker, pylint.checkers.nested_min_max.NestedMinMaxChecker, pylint.checkers.newstyle.NewStyleConflictChecker, pylint.checkers.non_ascii_names.NonAsciiNameChecker, pylint.checkers.raw_metrics.RawMetricsChecker, pylint.checkers.refactoring.ImplicitBooleanessChecker, pylint.checkers.refactoring.NotChecker, pylint.checkers.refactoring.RecommendationChecker, pylint.checkers.refactoring.RefactoringChecker, pylint.checkers.similar.SimilarChecker, pylint.checkers.spelling.SpellingChecker, pylint.checkers.stdlib.StdlibChecker, pylint.checkers.stdlib.StdlibChecker, pylint.checkers.strings.StringConstantChecker, pylint.checkers.strings.StringConstantChecker, pylint.checkers.strings.StringFormatChecker, pylint.checkers.threading_checker.ThreadingChecker, pylint.checkers.typecheck.IterableChecker, pylint.checkers.typecheck.TypeChecker, pylint.checkers.unicode.UnicodeChecker, pylint.checkers.unsupported_version.UnsupportedVersionChecker, pylint.checkers.variables.VariablesChecker, pylint.extensions.bad_builtin.BadBuiltinChecker, pylint.extensions.broad_try_clause.BroadTryClauseChecker, pylint.extensions.check_elif.ElseifUsedChecker, pylint.extensions.code_style.CodeStyleChecker, pylint.extensions.comparetozero.CompareToZeroChecker, pylint.extensions.comparison_placement.MisplacedComparisonConstantChecker, pylint.extensions.confusing_elif.ConfusingConsecutiveElifChecker, pylint.extensions.consider_refactoring_into_while_condition.ConsiderRefactorIntoWhileConditionChecker, pylint.extensions.consider_ternary_expression.ConsiderTernaryExpressionChecker, pylint.extensions.dict_init_mutate.DictInitMutateChecker, pylint.extensions.docparams.DocstringParameterChecker, pylint.extensions.docstyle.DocStringStyleChecker, pylint.extensions.dunder.DunderChecker, pylint.extensions.empty_comment.CommentChecker, pylint.extensions.emptystring.CompareToEmptyStringChecker, pylint.extensions.eq_without_hash.EqWithoutHash, pylint.extensions.for_any_all.ConsiderUsingAnyOrAllChecker, pylint.extensions.magic_value.MagicValueChecker, pylint.extensions.mccabe.McCabeMethodChecker, pylint.extensions.no_self_use.NoSelfUseChecker, pylint.extensions.overlapping_exceptions.OverlappingExceptionsChecker, pylint.extensions.private_import.PrivateImportChecker, pylint.extensions.redefined_loop_name.RedefinedLoopNameChecker, pylint.extensions.redefined_variable_type.MultipleTypesChecker, pylint.extensions.set_membership.SetMembershipChecker, pylint.extensions.typing.TypingChecker, pylint.extensions.while_used.WhileChecker, pylint.checkers.base.basic_checker._BasicChecker

Name of the provider.

@property
messages: list[MessageDefinition] = (source)

Undocumented