pylint.checkers.misc.EncodingChecker

class documentation

class EncodingChecker(BaseTokenChecker, BaseRawFileChecker): (source)

View In Hierarchy

BaseChecker for encoding issues. Checks for: * warning notes in the code like FIXME, XXX * encoding issues.

Method open Called before visiting project (i.e. set of modules).
Method process_module Inspect the source file to find encoding problem.
Method process_tokens Inspect the source to find fixme problems.
Class Variable msgs Undocumented
Class Variable name Name of the provider.
Class Variable options Options provided by this provider.
Method _check_encoding Undocumented
Instance Variable _fixme_pattern Undocumented

Inherited from BaseChecker (via BaseTokenChecker, BaseRawFileChecker):

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, BaseRawFileChecker, 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_module(self, node: nodes.Module): (source)
overrides pylint.checkers.BaseRawFileChecker.process_module

Inspect the source file to find encoding problem.

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

Inspect the source to find fixme problems.

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

Undocumented

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

Name of the provider.

options: tuple[tuple, ...] = (source)
overrides pylint.checkers.BaseChecker.options

Options provided by this provider.

def _check_encoding(self, lineno: int, line: bytes, file_encoding: str) -> str|None: (source)

Undocumented

_fixme_pattern = (source)

Undocumented