class documentation

class LinterStats: (source)

View In Hierarchy

Class used to linter stats.

Method __init__ Undocumented
Method __repr__ Undocumented
Method __str__ Undocumented
Method get_bad_names Get a bad names node count.
Method get_code_count Get a code type count.
Method get_global_message_count Get a global message count.
Method get_module_message_count Get a module message count.
Method get_node_count Get a node count while handling some extra conditions.
Method get_undocumented Get a undocumented node count.
Method increase_bad_name Increase a bad names node count.
Method increase_single_message_count Increase the message type count of an individual message type.
Method increase_single_module_message_count Increase the message type count of an individual message type of a module.
Method init_single_module Use through PyLinter.set_current_module so PyLinter.current_name is consistent.
Method reset_bad_names Resets the bad_names attribute.
Method reset_code_count Resets the code_type_count attribute.
Method reset_duplicated_lines Resets the duplicated_lines attribute.
Method reset_message_count Resets the message type count of the stats object.
Method reset_node_count Resets the node count attribute.
Method reset_undocumented Resets the undocumented attribute.
Instance Variable bad_names Undocumented
Instance Variable by_module Undocumented
Instance Variable by_msg Undocumented
Instance Variable code_type_count Undocumented
Instance Variable convention Undocumented
Instance Variable dependencies Undocumented
Instance Variable duplicated_lines Undocumented
Instance Variable error Undocumented
Instance Variable fatal Undocumented
Instance Variable global_note Undocumented
Instance Variable info Undocumented
Instance Variable nb_duplicated_lines Undocumented
Instance Variable node_count Undocumented
Instance Variable percent_duplicated_lines Undocumented
Instance Variable refactor Undocumented
Instance Variable statement Undocumented
Instance Variable undocumented Undocumented
Instance Variable warning Undocumented
def __init__(self, bad_names: BadNames|None = None, by_module: dict[str, ModuleStats]|None = None, by_msg: dict[str, int]|None = None, code_type_count: CodeTypeCount|None = None, dependencies: dict[str, set[str]]|None = None, duplicated_lines: DuplicatedLines|None = None, node_count: NodeCount|None = None, undocumented: UndocumentedNodes|None = None): (source)

Undocumented

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

Undocumented

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

Undocumented

def get_bad_names(self, node_name: Literal['argument', 'attr', 'class', 'class_attribute', 'class_const', 'const', 'inlinevar', 'function', 'method', 'module', 'variable', 'typevar', 'typealias']) -> int: (source)

Get a bad names node count.

def get_code_count(self, type_name: Literal['code', 'comment', 'docstring', 'empty', 'total']) -> int: (source)

Get a code type count.

def get_global_message_count(self, type_name: str) -> int: (source)

Get a global message count.

def get_module_message_count(self, modname: str, type_name: str) -> int: (source)

Get a module message count.

def get_node_count(self, node_name: Literal['function', 'class', 'method', 'module']) -> int: (source)

Get a node count while handling some extra conditions.

def get_undocumented(self, node_name: Literal['function', 'class', 'method', 'module']) -> float: (source)

Get a undocumented node count.

def increase_bad_name(self, node_name: str, increase: int): (source)

Increase a bad names node count.

def increase_single_message_count(self, type_name: str, increase: int): (source)

Increase the message type count of an individual message type.

def increase_single_module_message_count(self, modname: str, type_name: MessageTypesFullName, increase: int): (source)

Increase the message type count of an individual message type of a module.

def init_single_module(self, module_name: str): (source)

Use through PyLinter.set_current_module so PyLinter.current_name is consistent.

def reset_bad_names(self): (source)

Resets the bad_names attribute.

def reset_code_count(self): (source)

Resets the code_type_count attribute.

def reset_duplicated_lines(self): (source)

Resets the duplicated_lines attribute.

def reset_message_count(self): (source)

Resets the message type count of the stats object.

def reset_node_count(self): (source)

Resets the node count attribute.

def reset_undocumented(self): (source)

Resets the undocumented attribute.

bad_names = (source)

Undocumented

Undocumented

Undocumented

code_type_count = (source)

Undocumented

convention: int = (source)

Undocumented

dependencies: dict[str, set[str]] = (source)

Undocumented

duplicated_lines = (source)

Undocumented

Undocumented

Undocumented

global_note: int = (source)

Undocumented

Undocumented

nb_duplicated_lines: int = (source)

Undocumented

node_count = (source)

Undocumented

percent_duplicated_lines: float = (source)

Undocumented

refactor: int = (source)

Undocumented

statement: int = (source)

Undocumented

undocumented = (source)

Undocumented

Undocumented