pylint.checkers.strings.StringFormatChecker

class documentation

class StringFormatChecker(BaseChecker): (source)

View In Hierarchy

Checks string formatting operations to ensure that the format string is valid and the arguments match the format string.

Method visit_binop Undocumented
Method visit_call Undocumented
Method visit_joinedstr Undocumented
Class Variable name Name of the provider.
Method _check_interpolation Undocumented
Method _check_new_format Check the new string formatting.
Method _check_new_format_specifiers Check attribute and index access in the format string ("{0.a}" and "{0[a]}").
Method _detect_vacuous_formatting Undocumented

Inherited from BaseChecker:

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
Property messages Undocumented

Inherited from _ArgumentsProvider (via 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
@only_required_for_messages('bad-format-character', 'truncated-format-string', 'mixed-format-string', 'bad-format-string-key', 'missing-format-string-key', 'unused-format-string-key', 'bad-string-format-type', 'format-needs-mapping', 'too-many-format-args', 'too-few-format-args', 'format-string-without-interpolation')
def visit_binop(self, node: nodes.BinOp): (source)

Undocumented

def visit_call(self, node: nodes.Call): (source)

Undocumented

@only_required_for_messages('f-string-without-interpolation')
def visit_joinedstr(self, node: nodes.JoinedStr): (source)

Undocumented

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

Name of the provider.

def _check_interpolation(self, node: nodes.JoinedStr): (source)

Undocumented

def _check_new_format(self, node: nodes.Call, func: bases.BoundMethod): (source)

Check the new string formatting.

def _check_new_format_specifiers(self, node: nodes.Call, fields: list[tuple[str, list[tuple[bool, str]]]], named: dict[str, SuccessfulInferenceResult]): (source)

Check attribute and index access in the format string ("{0.a}" and "{0[a]}").

def _detect_vacuous_formatting(self, node: nodes.Call, positional_arguments: list[SuccessfulInferenceResult]): (source)

Undocumented