class documentation

class ConsiderUsingAnyOrAllChecker(BaseChecker): (source)

View In Hierarchy

Undocumented

Method visit_for Undocumented
Class Variable msgs Undocumented
Class Variable name Name of the provider.
Static Method _assigned_reassigned_returned Detect boolean-assign, for-loop, re-assign, return pattern:
Static Method _build_suggested_string When a nodes.For node can be rewritten as an any/all statement, return a suggestion for that statement.
Static Method _if_statement_returns_bool Detect for-loop, if-statement, return pattern:

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 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('consider-using-any-or-all')
def visit_for(self, node: nodes.For): (source)

Undocumented

Name of the provider.

@staticmethod
def _assigned_reassigned_returned(node: nodes.For, if_children: list[nodes.NodeNG], node_after_loop: nodes.NodeNG) -> bool: (source)

Detect boolean-assign, for-loop, re-assign, return pattern: Ex: def check_lines(lines, max_chars): long_line = False for line in lines: if len(line) > max_chars: long_line = True # no elif / else statement return long_line

@staticmethod
def _build_suggested_string(node: nodes.For, final_return_bool: bool) -> str: (source)

When a nodes.For node can be rewritten as an any/all statement, return a suggestion for that statement. 'final_return_bool' is the boolean literal returned after the for loop if all conditions fail.

@staticmethod
def _if_statement_returns_bool(if_children: list[nodes.NodeNG], node_after_loop: nodes.NodeNG) -> bool: (source)

Detect for-loop, if-statement, return pattern: Ex: def any_uneven(items): for item in items: if not item % 2 == 0: return True return False