pylint.checkers.spelling.SpellingChecker

class documentation

class SpellingChecker(BaseTokenChecker): (source)

View In Hierarchy

Check spelling in comments and docstrings.

Method open Called before visiting project (i.e. set of modules).
Method process_tokens Should be overridden by subclasses.
Method visit_classdef Undocumented
Method visit_functiondef Undocumented
Method visit_module Undocumented
Class Variable msgs Undocumented
Class Variable name Name of the provider.
Class Variable options Options provided by this provider.
Instance Variable ignore_comment_directive_list Undocumented
Instance Variable ignore_list Undocumented
Instance Variable initialized Undocumented
Instance Variable spelling_dict Undocumented
Instance Variable tokenizer Undocumented
Instance Variable unknown_words Undocumented
Method _check_docstring Check if the node has any spelling errors.
Method _check_spelling Undocumented

Inherited from BaseChecker (via BaseTokenChecker):

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 reduce_map_data Undocumented
Class Variable enabled Undocumented
Class Variable reports Undocumented
Instance Variable linter Undocumented
Property messages Undocumented

Inherited from _ArgumentsProvider (via BaseTokenChecker, BaseChecker):

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 open(self): (source)
overrides pylint.checkers.BaseChecker.open

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

def process_tokens(self, tokens: list[tokenize.TokenInfo]): (source)
overrides pylint.checkers.BaseTokenChecker.process_tokens

Should be overridden by subclasses.

@only_required_for_messages('wrong-spelling-in-docstring')
def visit_classdef(self, node: nodes.ClassDef): (source)

Undocumented

@only_required_for_messages('wrong-spelling-in-docstring')
def visit_functiondef(self, node: nodes.FunctionDef|nodes.AsyncFunctionDef): (source)

Undocumented

@only_required_for_messages('wrong-spelling-in-docstring')
def visit_module(self, node: nodes.Module): (source)

Undocumented

msgs: dict = (source)
overrides pylint.checkers.BaseChecker.msgs

Undocumented

name: str = (source)
overrides pylint.checkers.BaseChecker.name

Name of the provider.

options = (source)
overrides pylint.checkers.BaseChecker.options

Options provided by this provider.

ignore_comment_directive_list = (source)

Undocumented

ignore_list = (source)

Undocumented

initialized: bool = (source)

Undocumented

spelling_dict = (source)

Undocumented

tokenizer = (source)

Undocumented

unknown_words: set[str] = (source)

Undocumented

def _check_docstring(self, node: ((nodes.FunctionDef|nodes.AsyncFunctionDef)|nodes.ClassDef)|nodes.Module): (source)

Check if the node has any spelling errors.

def _check_spelling(self, msgid: str, line: str, line_num: int): (source)

Undocumented