brk-code

pylint の API リファレンス

pylint (pylint-dev/pylint) の公開 API 398 件 —— クラス 115、関数 80、メソッド 203。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

リポジトリ: pylint-dev/pylint

種別件数
クラス115
関数80
メソッド203

API 一覧

funcpylint.__pkginfo__.get_numversion_from_version(v:str) -> tuple[int, int, int]
Kept for compatibility reason.
classpylint.checkers.base.basic_checker.BasicChecker
Basic checker.
methodpylint.checkers.base.basic_checker.BasicChecker.leave_try(_:nodes.Try) -> None
Update try block flag.
methodpylint.checkers.base.basic_checker.BasicChecker.open() -> None
Initialize visit variables and statistics.
methodpylint.checkers.base.basic_checker.BasicChecker.visit_assert(node:nodes.Assert) -> None
Check whether assert is used on a tuple or string literal.
methodpylint.checkers.base.basic_checker.BasicChecker.visit_break(node:nodes.Break) -> None
Break node visitor.
methodpylint.checkers.base.basic_checker.BasicChecker.visit_call(node:nodes.Call) -> None
Visit a Call node.
methodpylint.checkers.base.basic_checker.BasicChecker.visit_dict(node:nodes.Dict) -> None
Check duplicate key in dictionary.
methodpylint.checkers.base.basic_checker.BasicChecker.visit_expr(node:nodes.Expr) -> None
Check for various kind of statements without effect.
methodpylint.checkers.base.basic_checker.BasicChecker.visit_lambda(node:nodes.Lambda) -> None
Check whether the lambda is suspicious.
methodpylint.checkers.base.basic_checker.BasicChecker.visit_module(_:nodes.Module) -> None
Check module name, docstring and required arguments.
methodpylint.checkers.base.basic_checker.BasicChecker.visit_return(node:nodes.Return) -> None
Return node visitor.
methodpylint.checkers.base.basic_checker.BasicChecker.visit_set(node:nodes.Set) -> None
Check duplicate value in set.
methodpylint.checkers.base.basic_checker.BasicChecker.visit_try(node:nodes.Try) -> None
Update try block flag.
funcpylint.checkers.base.basic_checker.report_by_type_stats(sect:reporter_nodes.Section, stats:LinterStats, old_stats:LinterStats | None) -> None
Make a report of.
classpylint.checkers.base.comparison_checker.ComparisonChecker
Checks for comparisons.
classpylint.checkers.base.name_checker.naming_style.CamelCaseStyle
Regex rules for camelCase naming style.
classpylint.checkers.base.name_checker.naming_style.PascalCaseStyle
Regex rules for PascalCase naming style.
classpylint.checkers.base.name_checker.naming_style.SnakeCaseStyle
Regex rules for snake_case naming style.
classpylint.checkers.base.name_checker.naming_style.UpperCaseStyle
Regex rules for UPPER_CASE naming style.
classpylint.checkers.base.pass_checker.PassChecker
Check if the pass statement is really necessary.
methodpylint.checkers.base_checker.BaseChecker.check_consistency() -> None
Check the consistency of msgid.
methodpylint.checkers.base_checker.BaseChecker.close() -> None
Called after visiting project (i.e set of modules).
methodpylint.checkers.base_checker.BaseChecker.open() -> None
Called before visiting project (i.e.
classpylint.checkers.base_checker.BaseRawFileChecker
Base class for checkers which need to parse the raw file.
methodpylint.checkers.base_checker.BaseRawFileChecker.process_module(node:nodes.Module) -> None
Process a module.
classpylint.checkers.classes.class_checker.ClassChecker
Checker for class nodes.
methodpylint.checkers.classes.class_checker.ClassChecker.leave_classdef(node:nodes.ClassDef) -> None
Checker for Class nodes.
methodpylint.checkers.classes.class_checker.ClassChecker.visit_classdef(node:nodes.ClassDef) -> None
Init visit variable _accessed.
methodpylint.checkers.classes.class_checker.ClassChecker.visit_functiondef(node:nodes.FunctionDef) -> None
Check method arguments, overriding.
classpylint.checkers.classes.class_checker.ScopeAccessMap
Store the accessed variables per scope.
methodpylint.checkers.classes.class_checker.ScopeAccessMap.accessed(scope:nodes.ClassDef) -> dict[str, list[_AccessNodes]]
Get the accessed variables for the given scope.
methodpylint.checkers.classes.class_checker.ScopeAccessMap.set_accessed(node:_AccessNodes) -> None
Set the given node as accessed.
funcpylint.checkers.clear_lru_cache.clear_lru_caches() -> None
Clear caches holding references to AST nodes.
methodpylint.checkers.deprecated.DeprecatedMixin.check_deprecated_attribute(node:nodes.Attribute) -> None
Checks if the attribute is deprecated.
methodpylint.checkers.deprecated.DeprecatedMixin.check_deprecated_class(node:nodes.NodeNG, mod_name:str, class_names:Iterable[str]) -> None
Checks if the class is deprecated.
methodpylint.checkers.deprecated.DeprecatedMixin.check_deprecated_class_in_call(node:nodes.Call) -> None
Checks if call the deprecated class.
methodpylint.checkers.deprecated.DeprecatedMixin.check_deprecated_method(node:nodes.Call, inferred:nodes.NodeNG) -> None
Executes the checker for the given node.
methodpylint.checkers.deprecated.DeprecatedMixin.check_deprecated_module(node:nodes.Import, mod_path:str | None) -> None
Checks if the module is deprecated.
methodpylint.checkers.deprecated.DeprecatedMixin.deprecated_attributes() -> Iterable[str]
Callback returning the deprecated attributes.
methodpylint.checkers.deprecated.DeprecatedMixin.deprecated_classes(module:str) -> Iterable[str]
Callback returning the deprecated classes of module.
methodpylint.checkers.deprecated.DeprecatedMixin.deprecated_decorators() -> Iterable[str]
Callback returning the deprecated decorators.
methodpylint.checkers.deprecated.DeprecatedMixin.deprecated_modules() -> Iterable[str]
Callback returning the deprecated modules.
methodpylint.checkers.deprecated.DeprecatedMixin.visit_attribute(node:nodes.Attribute) -> None
Called when an `Attribute` node is visited.
methodpylint.checkers.deprecated.DeprecatedMixin.visit_call(node:nodes.Call) -> None
Called when a :class:`nodes.Call` node is visited.
methodpylint.checkers.deprecated.DeprecatedMixin.visit_decorators(node:nodes.Decorators) -> None
Triggered when a decorator statement is seen.
methodpylint.checkers.deprecated.DeprecatedMixin.visit_import(node:nodes.Import) -> None
Triggered when an import statement is seen.
methodpylint.checkers.deprecated.DeprecatedMixin.visit_importfrom(node:nodes.ImportFrom) -> None
Triggered when a from statement is seen.
classpylint.checkers.design_analysis.MisdesignChecker
Checker of potential misdesigns.
methodpylint.checkers.design_analysis.MisdesignChecker.leave_classdef(node:nodes.ClassDef) -> None
Check number of public methods.
methodpylint.checkers.design_analysis.MisdesignChecker.open() -> None
Initialize visit variables.
methodpylint.checkers.design_analysis.MisdesignChecker.visit_match(node:nodes.Match) -> None
Increments the branches counter.
methodpylint.checkers.design_analysis.MisdesignChecker.visit_return(_:nodes.Return) -> None
Count number of returns.
methodpylint.checkers.design_analysis.MisdesignChecker.visit_try(node:nodes.Try) -> None
Increments the branches counter.
methodpylint.checkers.design_analysis.MisdesignChecker.visit_while(node:nodes.While) -> None
Increments the branches counter.
classpylint.checkers.dunder_methods.DunderCallChecker
Check for unnecessary dunder method calls.
classpylint.checkers.exceptions.BaseVisitor
Base class for visitors defined in this module.
methodpylint.checkers.exceptions.BaseVisitor.visit_default(_:nodes.NodeNG) -> None
Default implementation for all the nodes.
classpylint.checkers.exceptions.ExceptionRaiseLeafVisitor
Visitor for handling leaf kinds of a raise value.
classpylint.checkers.exceptions.ExceptionRaiseRefVisitor
Visit references (anything that is not an AST leaf).
classpylint.checkers.exceptions.ExceptionsChecker
Exception related checks.
methodpylint.checkers.exceptions.ExceptionsChecker.visit_try(node:nodes.Try) -> None
Check for empty except.
methodpylint.checkers.exceptions.ExceptionsChecker.visit_trystar(node:nodes.TryStar) -> None
Check for empty except*.
classpylint.checkers.format.FormatChecker
Formatting checker.
methodpylint.checkers.format.FormatChecker.check_indent_level(string:str, expected:int, line_num:int) -> None
Return the indent level of the string.
methodpylint.checkers.format.FormatChecker.check_lines(tokens:TokenWrapper, line_start:int, lines:str, lineno:int) -> None
Check given lines for potential messages.
methodpylint.checkers.format.FormatChecker.check_trailing_whitespace_ending(line:str, i:int) -> None
Check that there is no trailing white-space.
methodpylint.checkers.format.FormatChecker.is_line_length_check_activated(pylint_pattern_match_object:Match[str]) -> bool
Return True if the line length check is activated.
methodpylint.checkers.format.FormatChecker.new_line(tokens:TokenWrapper, line_end:int, line_start:int) -> None
A new line has been encountered, process it if necessary.
methodpylint.checkers.format.FormatChecker.process_tokens(tokens:list[tokenize.TokenInfo]) -> None
Process tokens and search for: - too long lines (i.e.
methodpylint.checkers.format.FormatChecker.remove_pylint_option_from_lines(options_pattern_obj:Match[str]) -> str
Remove the `# pylint ...` pattern from lines.
methodpylint.checkers.format.FormatChecker.visit_default(node:nodes.NodeNG) -> None
Check the node line number and check it if not yet done.
classpylint.checkers.format.TokenWrapper
A wrapper for readable access to token information.
classpylint.checkers.imports.ImportsChecker
BaseChecker for import statements.
methodpylint.checkers.imports.ImportsChecker.close() -> None
Called before visiting project (i.e set of modules).
methodpylint.checkers.imports.ImportsChecker.deprecated_modules() -> set[str]
Callback returning the deprecated modules.
methodpylint.checkers.imports.ImportsChecker.open() -> None
Called before visiting project (i.e set of modules).
methodpylint.checkers.imports.ImportsChecker.visit_import(node:nodes.Import) -> None
Triggered when an import statement is seen.
methodpylint.checkers.imports.ImportsChecker.visit_importfrom(node:nodes.ImportFrom) -> None
Triggered when a from statement is seen.
methodpylint.checkers.imports.ImportsChecker.visit_module(node:nodes.Module) -> None
Store if current module is a package, i.e.
funcpylint.checkers.initialize(linter:PyLinter) -> None
Initialize linter with checkers in this package.
classpylint.checkers.lambda_expressions.LambdaExpressionChecker
Check for unnecessary usage of lambda expressions.
methodpylint.checkers.lambda_expressions.LambdaExpressionChecker.visit_assign(node:nodes.Assign) -> None
Check if lambda expression is assigned to a variable.
methodpylint.checkers.lambda_expressions.LambdaExpressionChecker.visit_call(node:nodes.Call) -> None
Check if lambda expression is called directly.
classpylint.checkers.logging.LoggingChecker
Checks use of the logging module.
methodpylint.checkers.logging.LoggingChecker.visit_call(node:nodes.Call) -> None
Checks calls to logging methods.
methodpylint.checkers.logging.LoggingChecker.visit_import(node:nodes.Import) -> None
Checks to see if this module uses Python's built-in logging.
methodpylint.checkers.logging.LoggingChecker.visit_importfrom(node:nodes.ImportFrom) -> None
Checks to see if a module uses a non-Python logging module.
methodpylint.checkers.logging.LoggingChecker.visit_module(_:nodes.Module) -> None
Clears any state left in this checker from last module checked.
classpylint.checkers.method_args.MethodArgsChecker
BaseChecker for method_args.
classpylint.checkers.misc.EncodingChecker
BaseChecker for encoding issues and fixme notes.
methodpylint.checkers.misc.EncodingChecker.process_module(node:nodes.Module) -> None
Inspect the source file to find encoding problem.
methodpylint.checkers.misc.EncodingChecker.process_tokens(tokens:list[tokenize.TokenInfo]) -> None
Inspect the source to find fixme problems.
classpylint.checkers.non_ascii_names.NonAsciiNameChecker
A strict name checker only allowing ASCII.
methodpylint.checkers.non_ascii_names.NonAsciiNameChecker.visit_assignname(node:nodes.AssignName) -> None
Check module level assigned names.
methodpylint.checkers.non_ascii_names.NonAsciiNameChecker.visit_call(node:nodes.Call) -> None
Check if the used keyword args are correct.
funcpylint.checkers.raw_metrics.report_raw_stats(sect:Section, stats:LinterStats, old_stats:LinterStats | None) -> None
Calculate percentage of code / doc / comment / empty.
classpylint.checkers.refactoring.not_checker.NotChecker
Checks for too many not in comparison expressions.
classpylint.checkers.refactoring.refactoring_checker.RefactoringChecker
Looks for code which can be refactored.
funcpylint.checkers.refactoring.refactoring_checker.RefactoringChecker.get_node_name(node:nodes.NodeNG) -> str
Obtain simplest representation of a node as a string.
classpylint.checkers.spelling.CamelCasedWord
Filter skipping over camelCasedWords.
classpylint.checkers.spelling.RegExFilter
Parent class for filters using regular expressions.
classpylint.checkers.spelling.SpellingChecker
Check spelling in comments and docstrings.
classpylint.checkers.spelling.SphinxDirectives
Filter skipping over Sphinx Directives.
classpylint.checkers.spelling.WordsWithDigitsFilter
Skips words with digits.
classpylint.checkers.spelling.WordsWithUnderscores
Skips words with underscores.
classpylint.checkers.strings.StringConstantChecker
Check string literals.
methodpylint.checkers.strings.StringConstantChecker.process_non_raw_string_token(prefix:str, string_body:str, start_row:int, string_start_col:int) -> None
Check for bad escapes in a non-raw string.
classpylint.checkers.symilar.LineSet
Holds and indexes all the lines of a single source file.
funcpylint.checkers.symilar.Run(argv:Sequence[str] | None=None) -> NoReturn
Standalone command line access point.
classpylint.checkers.symilar.SimilaritiesChecker
Checks for similarities and duplicated code.
methodpylint.checkers.symilar.SimilaritiesChecker.close() -> None
Compute and display similarities on closing (i.e.
methodpylint.checkers.symilar.SimilaritiesChecker.get_map_data() -> list[LineSet]
Passthru override.
methodpylint.checkers.symilar.SimilaritiesChecker.process_module(node:nodes.Module) -> None
Process a module.
classpylint.checkers.symilar.Symilar
Finds copy-pasted lines of code in a project.
methodpylint.checkers.symilar.Symilar.append_stream(streamid:str, stream:STREAM_TYPES, encoding:str | None=None, tree:nodes.Module | None=None) -> None
Append a file to search for similarities.
methodpylint.checkers.symilar.Symilar.get_map_data() -> list[LineSet]
Returns the data we can use for a map/reduce process.
methodpylint.checkers.symilar.Symilar.run() -> None
Start looking for similarities and display results on stdout.
funcpylint.checkers.symilar.hash_lineset(lineset:LineSet, min_common_lines:int=DEFAULT_MIN_SIMILARITY_LINE) -> LineSetHashResult
Return pre-computed hash data for a lineset.
funcpylint.checkers.symilar.remove_successive(all_couples:CplIndexToCplLines_T) -> None
Removes all successive entries in the dictionary in argument.
funcpylint.checkers.symilar.report_similarities(sect:Section, stats:LinterStats, old_stats:LinterStats | None) -> None
Make a layout with some stats about duplication.
classpylint.checkers.threading_checker.ThreadingChecker
Checks for threading module.
classpylint.checkers.typecheck.IterableChecker
Checks for non-iterables used in an iterable context.
classpylint.checkers.typecheck.TypeChecker
Try to find bugs in the code using type inference.
methodpylint.checkers.typecheck.TypeChecker.visit_assign(node:nodes.Assign) -> None
Process assignments in the AST.
methodpylint.checkers.typecheck.TypeChecker.visit_attribute(node:nodes.Attribute | nodes.AssignAttr | nodes.DelAttr) -> None
Check that the accessed attribute exists.
methodpylint.checkers.typecheck.TypeChecker.visit_unaryop(node:nodes.UnaryOp) -> None
Detect TypeErrors for unary operands.
funcpylint.checkers.unicode.extract_codec_from_bom(first_line:bytes) -> str
Try to extract the codec (unicode only) by checking for the BOM.
funcpylint.checkers.utils.decorated_with_property(node:nodes.FunctionDef) -> bool
Detect if the given function node is decorated with a property.
funcpylint.checkers.utils.get_all_elements(node:nodes.NodeNG) -> Iterable[nodes.NodeNG]
Recursively returns all atoms in nested lists and tuples.
funcpylint.checkers.utils.get_argument_from_call(call_node:nodes.Call, position:int | None=None, keyword:str | None=None) -> nodes.Name
Returns the specified argument from a function call.
funcpylint.checkers.utils.get_import_name(importnode:ImportNode, modname:str | None) -> str | None
Get a prepared module name from the given import node.
funcpylint.checkers.utils.get_inverse_comparator(op:str) -> str
Returns the inverse comparator given a comparator.
funcpylint.checkers.utils.get_node_last_lineno(node:nodes.NodeNG) -> int
Get the last lineno of the given node.
funcpylint.checkers.utils.get_subscript_const_value(node:nodes.Subscript) -> nodes.Const
Returns the value 'subscript.slice' of a Subscript node.
funcpylint.checkers.utils.in_type_checking_block(node:nodes.NodeNG) -> bool
Check if a node is guarded by a TYPE_CHECKING guard.
funcpylint.checkers.utils.infer_kwarg_from_call(call_node:nodes.Call, keyword:str) -> nodes.Name | None
Returns the specified argument from a function's kwargs.
funcpylint.checkers.utils.is_assign_name_annotated_with(node:nodes.AssignName, typing_name:str) -> bool
Test if AssignName node has `typing_name` annotation.
funcpylint.checkers.utils.is_being_called(node:nodes.NodeNG) -> bool
Return True if node is the function being called in a Call node.
funcpylint.checkers.utils.is_call_of_name(node:nodes.NodeNG, name:str) -> bool
Checks if node is a function call with the given name.
funcpylint.checkers.utils.is_classdef_type(node:nodes.ClassDef) -> bool
Test if ClassDef node is Type.
funcpylint.checkers.utils.is_defined_before(var_node:nodes.Name) -> bool
Check if the given variable node is defined before.
funcpylint.checkers.utils.is_error(node:nodes.FunctionDef) -> bool
Return true if the given function node only raises an exception.
funcpylint.checkers.utils.is_from_fallback_block(node:nodes.NodeNG) -> bool
Check if the given node is from a fallback import block.
funcpylint.checkers.utils.is_func_decorator(node:nodes.NodeNG) -> bool
Return true if the name is used in function decorator.
funcpylint.checkers.utils.is_hashable(node:nodes.NodeNG) -> bool
Return whether any inferred value of `node` is hashable.
funcpylint.checkers.utils.is_node_in_type_annotation_context(node:nodes.NodeNG) -> bool
Check if node is in type annotation context.
funcpylint.checkers.utils.is_overload_stub(node:nodes.NodeNG) -> bool
Check if a node is a function stub decorated with typing.overload.
funcpylint.checkers.utils.is_postponed_evaluation_enabled(node:nodes.NodeNG) -> bool
Check if the postponed evaluation of annotations is enabled.
funcpylint.checkers.utils.is_property_deleter(node:nodes.NodeNG) -> bool
Check if the given node is a property deleter.
funcpylint.checkers.utils.is_property_setter(node:nodes.NodeNG) -> bool
Check if the given node is a property setter.
funcpylint.checkers.utils.is_protocol_class(cls:nodes.NodeNG) -> bool
Check if the given node represents a protocol class.
funcpylint.checkers.utils.is_subclass_of(child:nodes.ClassDef, parent:nodes.ClassDef) -> bool
Check if first node is a subclass of second node.
funcpylint.checkers.utils.is_super(node:nodes.NodeNG) -> bool
Return True if the node is referencing the "super" builtin function.
funcpylint.checkers.utils.is_sys_guard(node:nodes.If) -> bool
Return True if IF stmt is a sys.version_info guard.
funcpylint.checkers.utils.node_frame_class(node:nodes.NodeNG) -> nodes.ClassDef | None
Return the class that is wrapping the given node.
funcpylint.checkers.utils.node_type(node:nodes.NodeNG) -> SuccessfulInferenceResult | None
Return the inferred type for `node`.
funcpylint.checkers.utils.overridden_method(klass:nodes.LocalsDictNodeNG, name:str | None) -> nodes.FunctionDef | None
Get overridden method if any.
funcpylint.checkers.utils.safe_infer(node:nodes.NodeNG, context:InferenceContext | None=None, *compare_constants:bool=False, *compare_constructors:bool=False) -> InferenceResult | None
Return the inferred value for the given node.
funcpylint.checkers.utils.truncated_dict_suggestion(elements:Iterable[str]) -> str
Build a truncated dict literal suggestion from string elements.
classpylint.checkers.variables.VariablesChecker
BaseChecker for variables.
methodpylint.checkers.variables.VariablesChecker.leave_classdef(node:nodes.ClassDef) -> None
Leave class: update consumption analysis variable.
methodpylint.checkers.variables.VariablesChecker.leave_dictcomp(_:nodes.DictComp) -> None
Leave dictcomp: update consumption analysis variable.
methodpylint.checkers.variables.VariablesChecker.leave_functiondef(node:nodes.FunctionDef) -> None
Leave function: check function's locals are consumed.
methodpylint.checkers.variables.VariablesChecker.leave_generatorexp(_:nodes.GeneratorExp) -> None
Leave genexpr: update consumption analysis variable.
methodpylint.checkers.variables.VariablesChecker.leave_lambda(_:nodes.Lambda) -> None
Leave lambda: update consumption analysis variable.
methodpylint.checkers.variables.VariablesChecker.leave_listcomp(_:nodes.ListComp) -> None
Leave listcomp: update consumption analysis variable.
methodpylint.checkers.variables.VariablesChecker.leave_module(node:nodes.Module) -> None
Leave module: check globals.
methodpylint.checkers.variables.VariablesChecker.leave_setcomp(_:nodes.SetComp) -> None
Leave setcomp: update consumption analysis variable.
methodpylint.checkers.variables.VariablesChecker.visit_classdef(node:nodes.ClassDef) -> None
Visit class: update consumption analysis variable.
methodpylint.checkers.variables.VariablesChecker.visit_dictcomp(node:nodes.DictComp) -> None
Visit dictcomp: update consumption analysis variable.
methodpylint.checkers.variables.VariablesChecker.visit_generatorexp(node:nodes.GeneratorExp) -> None
Visit genexpr: update consumption analysis variable.
methodpylint.checkers.variables.VariablesChecker.visit_global(node:nodes.Global) -> None
Check names imported exists in the global scope.
methodpylint.checkers.variables.VariablesChecker.visit_import(node:nodes.Import) -> None
Check modules attribute accesses.
methodpylint.checkers.variables.VariablesChecker.visit_importfrom(node:nodes.ImportFrom) -> None
Check modules attribute accesses.
methodpylint.checkers.variables.VariablesChecker.visit_lambda(node:nodes.Lambda) -> None
Visit lambda: update consumption analysis variable.
methodpylint.checkers.variables.VariablesChecker.visit_listcomp(node:nodes.ListComp) -> None
Visit listcomp: update consumption analysis variable.
methodpylint.checkers.variables.VariablesChecker.visit_setcomp(node:nodes.SetComp) -> None
Visit setcomp: update consumption analysis variable.
funcpylint.config._pylint_config.generate_command.handle_generate_command(linter:PyLinter) -> int
Handle 'pylint-config generate'.
funcpylint.config._pylint_config.help_message.get_help(parser:argparse.ArgumentParser) -> str
Get the help message for the main 'pylint-config' command.
funcpylint.config._pylint_config.help_message.get_subparser_help(linter:PyLinter, command:str) -> str
Get the help message for one of the subcommands.
classpylint.config._pylint_config.utils.InvalidUserInput
Raised whenever a user input is invalid.
funcpylint.config._pylint_config.utils.get_and_validate_output_file() -> tuple[bool, Path]
Make sure that the output file is correct.
funcpylint.config._pylint_config.utils.validate_yes_no(question:str, default:Literal['yes', 'no'] | None) -> bool
Validate that a yes or no answer is correct.
funcpylint.config.find_default_config_files.find_default_config_files() -> Iterator[Path]
Find all possible config files.
classpylint.constants.MessageDisableReason
Why a message was filtered out or disabled.
classpylint.exceptions.EmptyReportError
Raised when a report is empty and so should not be displayed.
classpylint.exceptions.InvalidReporterError
Raised when selected reporter is invalid (e.g.
classpylint.exceptions.UnknownMessageError
Raised when an unregistered message id is encountered.
methodpylint.extensions._check_docs_utils.Docstring.matching_sections() -> int
Returns the number of matching docstring sections.
classpylint.extensions._check_docs_utils.EpytextDocstring
Epytext is similar to Sphinx.
funcpylint.extensions._check_docs_utils.get_setters_property(node:nodes.FunctionDef) -> nodes.FunctionDef | None
Get the property node for the given setter node.
funcpylint.extensions._check_docs_utils.returns_something(return_node:nodes.Return) -> bool
Check if a return node returns a value other than None.
funcpylint.extensions._check_docs_utils.space_indentation(s:str) -> int
The number of leading spaces in a string.
classpylint.extensions.broad_try_clause.BroadTryClauseChecker
Checks for try clauses with too many lines.
methodpylint.extensions.check_elif.ElseifUsedChecker.process_tokens(tokens:list[TokenInfo]) -> None
Process tokens and look for 'if' or 'elif'.
methodpylint.extensions.check_elif.ElseifUsedChecker.visit_if(node:nodes.If) -> None
Current if node must directly follow an 'else'.
classpylint.extensions.code_style.CodeStyleChecker
Checkers that can improve code consistency.
methodpylint.extensions.docparams.DocstringParameterChecker.visit_functiondef(node:nodes.FunctionDef) -> None
Called for function and method definitions (def).
classpylint.extensions.docstyle.DocStringStyleChecker
Checks format of docstrings based on PEP 0257.
classpylint.extensions.dunder.DunderChecker
Checks related to dunder methods.
funcpylint.extensions.empty_comment.comment_part_of_string(line:bytes, comment_idx:int) -> bool
Checks if the symbol at comment_idx is part of a string.
funcpylint.extensions.initialize(linter:PyLinter) -> None
Initialize linter with checkers in the extensions' directory.
classpylint.extensions.magic_value.MagicValueChecker
Checks for constants in comparisons.
classpylint.extensions.typing.TypingChecker
Find issue specifically related to type annotations.
classpylint.graph.DotBackend
Dot File back-end.
methodpylint.graph.DotBackend.emit(line:str) -> None
Adds <line> to final output.
methodpylint.graph.DotBackend.emit_edge(name1:str, name2:str, **props:Any) -> None
Emit an edge from <name1> to <name2>.
methodpylint.graph.DotBackend.emit_node(name:str, **props:Any) -> None
Emit a node with given properties.
methodpylint.graph.DotBackend.generate(outputfile:str | None=None, mapfile:str | None=None) -> str
Generates a graph file.
methodpylint.graph.DotBackend.get_source() -> str
Returns self._source.
funcpylint.graph.normalize_node_id(nid:str) -> str
Returns a suitable DOT node id for `nid`.
classpylint.lint.pylinter.PyLinter
Lint Python modules using external checkers.
methodpylint.lint.pylinter.PyLinter.check_single_file_item(file:FileItem) -> None
Check single file item.
methodpylint.lint.pylinter.PyLinter.disable_reporters() -> None
Disable all reporters.
methodpylint.lint.pylinter.PyLinter.enable_fail_on_messages() -> None
Enable 'fail on' msgs.
methodpylint.lint.pylinter.PyLinter.generate_reports(verbose:bool=False) -> int | None
Close the whole package /module, it's time to make reports !
methodpylint.lint.pylinter.PyLinter.get_checkers() -> list[BaseChecker]
Return all available checkers as an ordered list.
methodpylint.lint.pylinter.PyLinter.initialize() -> None
Initialize linter for linting.
methodpylint.lint.pylinter.PyLinter.load_plugin_configuration() -> None
Call the configuration hook for plugins.
methodpylint.lint.pylinter.PyLinter.open() -> None
Initialize counters.
methodpylint.lint.pylinter.PyLinter.register_checker(checker:checkers.BaseChecker) -> None
This method auto registers the checker.
methodpylint.lint.pylinter.PyLinter.register_reporter(reporter_class:type[reporters.BaseReporter]) -> None
Registers a reporter class on the _reporters attribute.
methodpylint.lint.pylinter.PyLinter.set_reporter(reporter:reporters.BaseReporter | reporters.MultiReporter) -> None
Set the reporter used to display messages and reports.
methodpylint.lint.pylinter.PyLinter.should_analyze_file(modname:str, path:str, is_argument:bool=False) -> bool
Returns whether a module should be checked.
funcpylint.lint.report_functions.report_messages_by_module_stats(sect:Section, stats:LinterStats, _:LinterStats | None) -> None
Make errors / warnings by modules report.
funcpylint.lint.report_functions.report_messages_stats(sect:Section, stats:LinterStats, _:LinterStats | None) -> None
Make messages type report.
funcpylint.lint.report_functions.report_total_messages_stats(sect:Section, stats:LinterStats, previous_stats:LinterStats | None) -> None
Make total errors / warnings report.
classpylint.lint.run.Run
Helper class to use as main for pylint with 'run(*sys.argv[1:])'.
funcpylint.message._deleted_message_ids.is_deleted_msgid(msgid:str) -> str | None
Return the explanation for removal if the message was removed.
funcpylint.message._deleted_message_ids.is_deleted_symbol(symbol:str) -> str | None
Return the explanation for removal if the message was removed.
classpylint.message.message.Message
This class represent a message to be issued by the reporters.
methodpylint.message.message.Message.format(template:str) -> str
Format the message according to the given template.
funcpylint.modify_sys_path() -> None
Modify sys path for execution as Python module.
classpylint.pyreverse.diadefslib.DiaDefGenerator
Handle diagram generation options.
methodpylint.pyreverse.diadefslib.DiaDefGenerator.add_class(node:nodes.ClassDef) -> None
Visit one class and add it to diagram.
methodpylint.pyreverse.diadefslib.DiaDefGenerator.extract_classes(klass_node:nodes.ClassDef, anc_level:int, association_level:int) -> None
Extract recursively classes related to klass_node.
methodpylint.pyreverse.diadefslib.DiaDefGenerator.get_ancestors(node:nodes.ClassDef, level:int) -> Generator[nodes.ClassDef]
Return ancestor nodes of a class node.
methodpylint.pyreverse.diadefslib.DiaDefGenerator.get_associated(klass_node:nodes.ClassDef, level:int) -> Generator[nodes.ClassDef]
Return associated nodes of a class node.
methodpylint.pyreverse.diadefslib.DiaDefGenerator.get_title(node:nodes.ClassDef) -> str
Get title for objects.
methodpylint.pyreverse.diadefslib.DiaDefGenerator.show_node(node:nodes.ClassDef) -> bool
Determine if node should be shown based on config.
classpylint.pyreverse.diadefslib.DiadefsHandler
Get diagram definitions from user (i.e.
methodpylint.pyreverse.diadefslib.DiadefsHandler.get_diadefs(project:Project, linker:Linker) -> list[ClassDiagram]
Get the diagram's configuration data.
classpylint.pyreverse.diagrams.ClassDiagram
Main class diagram handling.
methodpylint.pyreverse.diagrams.ClassDiagram.add_object(title:str, node:nodes.ClassDef) -> None
Create a diagram object.
methodpylint.pyreverse.diagrams.ClassDiagram.add_relationship(from_object:DiagramEntity, to_object:DiagramEntity, relation_type:str, name:str | None=None) -> None
Create a relationship.
methodpylint.pyreverse.diagrams.ClassDiagram.class_names(nodes_lst:Iterable[nodes.NodeNG]) -> list[str]
Return class names if needed in diagram.
methodpylint.pyreverse.diagrams.ClassDiagram.classe(name:str) -> ClassEntity
Return a class by its name, raise KeyError if not found.
methodpylint.pyreverse.diagrams.ClassDiagram.classes() -> list[ClassEntity]
Return all class nodes in the diagram.
methodpylint.pyreverse.diagrams.ClassDiagram.extract_relationships() -> None
Extract relationships between nodes in the diagram.
methodpylint.pyreverse.diagrams.ClassDiagram.get_attrs(node:nodes.ClassDef) -> list[str]
Return visible attributes, possibly with class name.
methodpylint.pyreverse.diagrams.ClassDiagram.get_methods(node:nodes.ClassDef) -> list[nodes.FunctionDef]
Return visible methods.
methodpylint.pyreverse.diagrams.ClassDiagram.get_relationship(from_object:DiagramEntity, relation_type:str) -> Relationship
Return a relationship or None.
methodpylint.pyreverse.diagrams.ClassDiagram.has_node(node:nodes.NodeNG) -> bool
Return true if the given node is included in the diagram.
methodpylint.pyreverse.diagrams.ClassDiagram.object_from_node(node:nodes.NodeNG) -> DiagramEntity
Return the diagram object mapped to node.
classpylint.pyreverse.diagrams.ClassEntity
A diagram object representing a class.
classpylint.pyreverse.diagrams.DiagramEntity
A diagram object, i.e.
classpylint.pyreverse.diagrams.Figure
Base class for counter handling.
classpylint.pyreverse.diagrams.PackageDiagram
Package diagram handling.
methodpylint.pyreverse.diagrams.PackageDiagram.add_from_depend(node:nodes.ImportFrom, from_module:str) -> None
Add dependencies created by from-imports.
methodpylint.pyreverse.diagrams.PackageDiagram.add_object(title:str, node:nodes.Module) -> None
Create a diagram object.
methodpylint.pyreverse.diagrams.PackageDiagram.module(name:str) -> PackageEntity
Return a module by its name, raise KeyError if not found.
methodpylint.pyreverse.diagrams.PackageDiagram.modules() -> list[PackageEntity]
Return all module nodes in the diagram.
classpylint.pyreverse.diagrams.PackageEntity
A diagram object representing a package.
classpylint.pyreverse.diagrams.Relationship
A relationship from an object in the diagram to another.
classpylint.pyreverse.inspector.AssociationsHandler
Handle regular association relationships.
classpylint.pyreverse.inspector.IdGeneratorMixIn
Mixin adding the ability to generate integer uid.
methodpylint.pyreverse.inspector.IdGeneratorMixIn.generate_id() -> int
Generate a new identifier.
methodpylint.pyreverse.inspector.IdGeneratorMixIn.init_counter(start_value:int=0) -> None
Init the id counter.
classpylint.pyreverse.inspector.Linker
Walk on the project tree and resolve relationships.
methodpylint.pyreverse.inspector.Linker.compute_module(context_name:str, mod_path:str) -> bool
Should the module be added to dependencies ?
methodpylint.pyreverse.inspector.Linker.handle_assignattr_type(node:nodes.AssignAttr, info:ClassInfo) -> None
Handle an astroid.assignattr node.
methodpylint.pyreverse.inspector.Linker.visit_assignname(node:nodes.AssignName) -> None
Visit an AssignName node and update locals_type for its frame.
methodpylint.pyreverse.inspector.Linker.visit_classdef(node:nodes.ClassDef) -> None
Visit an nodes.Class node and optionally assign a unique id.
methodpylint.pyreverse.inspector.Linker.visit_import(node:nodes.Import) -> None
Visit an nodes.Import node.
methodpylint.pyreverse.inspector.Linker.visit_importfrom(node:nodes.ImportFrom) -> None
Visit an nodes.ImportFrom node.
methodpylint.pyreverse.inspector.Linker.visit_module(node:nodes.Module) -> None
Visit an nodes.Module node and optionally assign a unique id.
classpylint.pyreverse.inspector.Project
A project handle a set of modules / packages.
funcpylint.pyreverse.inspector.resolve_to_class_def(types:set[nodes.NodeNG]) -> set[nodes.ClassDef]
Resolve a set of nodes to ClassDef nodes.
methodpylint.pyreverse.main.Run.run() -> int
Checking arguments and run project.
classpylint.pyreverse.mermaidjs_printer.MermaidJSPrinter
Printer for MermaidJS diagrams.
methodpylint.pyreverse.mermaidjs_printer.MermaidJSPrinter.emit_node(name:str, type_:NodeType, properties:NodeProperties | None=None) -> None
Create a new node.
classpylint.pyreverse.node_info.ClassInfo
Analysis info for ClassDef nodes.
classpylint.pyreverse.node_info.FunctionInfo
Analysis info for FunctionDef nodes.
classpylint.pyreverse.node_info.ModuleInfo
Analysis info for Module nodes.
classpylint.pyreverse.plantuml_printer.PlantUmlPrinter
Printer for PlantUML diagrams.
methodpylint.pyreverse.plantuml_printer.PlantUmlPrinter.emit_node(name:str, type_:NodeType, properties:NodeProperties | None=None) -> None
Create a new node.
classpylint.pyreverse.printer.Printer
Base class defining the interface for a printer.
methodpylint.pyreverse.printer.Printer.emit_node(name:str, type_:NodeType, properties:NodeProperties | None=None) -> None
Create a new node.
methodpylint.pyreverse.printer.Printer.generate(outputfile:str) -> None
Generate and save the final outputfile.
classpylint.pyreverse.utils.FilterMixIn
Filter nodes according to a mode and nodes' visibility.
methodpylint.pyreverse.utils.FilterMixIn.show_attr(node:nodes.NodeNG | str) -> bool
Return true if the node should be treated.
classpylint.pyreverse.utils.LocalsVisitor
Visit a project by traversing the locals dictionary.
methodpylint.pyreverse.utils.LocalsVisitor.get_callbacks(node:nodes.NodeNG) -> _CallbackTupleT
Get callbacks from handler for the visited node.
methodpylint.pyreverse.utils.LocalsVisitor.visit(node:nodes.NodeNG) -> Any
Launch the visit starting from the given node.
funcpylint.pyreverse.utils.get_annotation(node:nodes.AssignAttr | nodes.AssignName) -> nodes.Name | nodes.Subscript | None
Return the annotation for `node`.
funcpylint.pyreverse.utils.get_default_options() -> list[str]
Read config file and return list of options.
funcpylint.pyreverse.utils.get_visibility(name:str) -> str
Return the visibility from a name: public, protected, private or special.
funcpylint.pyreverse.utils.insert_default_options() -> None
Insert default options to sys.argv.
classpylint.pyreverse.writer.DiagramWriter
Base class for writing project diagrams.
methodpylint.pyreverse.writer.DiagramWriter.get_class_properties(obj:ClassEntity) -> NodeProperties
Get label and shape for classes.
methodpylint.pyreverse.writer.DiagramWriter.get_package_properties(obj:PackageEntity) -> NodeProperties
Get label and shape for packages.
methodpylint.pyreverse.writer.DiagramWriter.get_shape_color(obj:DiagramEntity) -> str
Get shape color.
methodpylint.pyreverse.writer.DiagramWriter.save() -> None
Write to disk.
methodpylint.pyreverse.writer.DiagramWriter.set_printer(file_name:str, basename:str) -> None
Set printer.
methodpylint.pyreverse.writer.DiagramWriter.write(diadefs:Iterable[ClassDiagram | PackageDiagram]) -> None
Write files for <project> according to <diadefs>.
methodpylint.pyreverse.writer.DiagramWriter.write_classes(diagram:ClassDiagram) -> None
Write a class diagram.
methodpylint.pyreverse.writer.DiagramWriter.write_packages(diagram:PackageDiagram) -> None
Write a package diagram.
classpylint.reporters.base_reporter.BaseReporter
Base class for reporters.
methodpylint.reporters.base_reporter.BaseReporter.display_messages(layout:Section | None) -> None
Hook for displaying the messages of the reporter.
methodpylint.reporters.base_reporter.BaseReporter.display_reports(layout:Section) -> None
Display results encapsulated in the layout tree.
methodpylint.reporters.base_reporter.BaseReporter.handle_message(msg:Message) -> None
Handle a new message triggered on the current file.
methodpylint.reporters.base_reporter.BaseReporter.on_close(stats:LinterStats, previous_stats:LinterStats | None) -> None
Hook called when a module finished analyzing.
methodpylint.reporters.base_reporter.BaseReporter.on_set_current_module(module:str, filepath:str | None) -> None
Hook called when a module starts to be analysed.
methodpylint.reporters.base_reporter.BaseReporter.writeln(string:str='') -> None
Write a line in the output buffer.
classpylint.reporters.collecting_reporter.CollectingReporter
Collects messages.
funcpylint.reporters.initialize(linter:PyLinter) -> None
Initialize linter with reporters in this package.
classpylint.reporters.json_reporter.JSONReporter
Report messages and layouts in JSON.
methodpylint.reporters.json_reporter.JSONReporter.display_messages(layout:Section | None) -> None
Launch layouts display.
methodpylint.reporters.json_reporter.JSONReporter.display_reports(layout:Section) -> None
Don't do anything in this reporter.
classpylint.reporters.multi_reporter.MultiReporter
Reports messages and layouts in plain text.
methodpylint.reporters.multi_reporter.MultiReporter.display_messages(layout:Section | None) -> None
Hook for displaying the messages of the reporter.
methodpylint.reporters.multi_reporter.MultiReporter.display_reports(layout:Section) -> None
Display results encapsulated in the layout tree.
methodpylint.reporters.multi_reporter.MultiReporter.handle_message(msg:Message) -> None
Handle a new message triggered on the current file.
methodpylint.reporters.multi_reporter.MultiReporter.on_close(stats:LinterStats, previous_stats:LinterStats | None) -> None
Hook called when a module finished analyzing.
methodpylint.reporters.multi_reporter.MultiReporter.on_set_current_module(module:str, filepath:str | None) -> None
Hook called when a module starts to be analysed.
methodpylint.reporters.multi_reporter.MultiReporter.writeln(string:str='') -> None
Write a line in the output buffer.
classpylint.reporters.progress_reporters.ProgressReporter
Progress reporter.
classpylint.reporters.text.ColorizedTextReporter
Simple TextReporter that colorizes text output.
methodpylint.reporters.text.ColorizedTextReporter.set_fail_on_symbols(fail_on_symbols:list[str]) -> None
Sets the list of configured fail-on symbols.
classpylint.reporters.text.MessageStyle
Styling of a message.
classpylint.reporters.text.TextReporter
Reports messages and layouts in plain text.
methodpylint.reporters.text.TextReporter.handle_message(msg:Message) -> None
Manage message of different type and in the context of path.
classpylint.reporters.text.VSTextReporter
Visual studio text reporter.
funcpylint.reporters.text.colorize_ansi(msg:str, msg_style:MessageStyle) -> str
Colorize message by wrapping it with ANSI escape codes.
classpylint.reporters.ureports.base_writer.BaseWriter
Base class for ureport writers.
methodpylint.reporters.ureports.base_writer.BaseWriter.begin_format() -> None
Begin to format a layout.
methodpylint.reporters.ureports.base_writer.BaseWriter.end_format() -> None
Finished formatting a layout.
methodpylint.reporters.ureports.base_writer.BaseWriter.get_table_content(table:Table) -> list[list[str]]
Trick to get table content without actually writing it.
methodpylint.reporters.ureports.base_writer.BaseWriter.write(string:str) -> None
Write a string in the output buffer.
methodpylint.reporters.ureports.base_writer.BaseWriter.writeln(string:str='') -> None
Write a line in the output buffer.
classpylint.reporters.ureports.nodes.BaseLayout
Base container node.
methodpylint.reporters.ureports.nodes.BaseLayout.add_text(text:str) -> None
Shortcut to add text data.
methodpylint.reporters.ureports.nodes.BaseLayout.append(child:VNode) -> None
Add a node to children.
methodpylint.reporters.ureports.nodes.BaseLayout.insert(index:int, child:VNode) -> None
Insert a child node.
methodpylint.reporters.ureports.nodes.BaseLayout.parents() -> list[BaseLayout]
Return the ancestor nodes.
classpylint.reporters.ureports.nodes.Paragraph
A simple text paragraph.
classpylint.reporters.ureports.nodes.Section
A section.
classpylint.reporters.ureports.nodes.Table
Some tabular data.
classpylint.reporters.ureports.nodes.Text
A text portion.
classpylint.reporters.ureports.nodes.Title
A title.
classpylint.reporters.ureports.nodes.VerbatimText
A verbatim text, display the raw data.
funcpylint.run_pylint(argv:Sequence[str] | None=None) -> None
Run pylint.
funcpylint.run_pyreverse(argv:Sequence[str] | None=None) -> NoReturn
Run pyreverse.
funcpylint.run_symilar(argv:Sequence[str] | None=None) -> NoReturn
Run symilar.
funcpylint.testutils._primer.comparator.format_span(msg:JSONMessage) -> str
Format a message's location as ``line:col to endLine:endCol``.
classpylint.testutils._primer.package_to_lint.DirtyPrimerDirectoryException
We can't pull if there's local changes.
classpylint.testutils._primer.primer.Primer
Main class to handle priming of packages.
classpylint.testutils._primer.primer_command.PrimerCommand
Generic primer action with required arguments.
funcpylint.testutils.decorator.set_config(**kwargs:Any) -> Callable[[Callable[..., None]], Callable[..., None]]
Decorator for setting an option on the linter.
classpylint.testutils.functional.lint_module_output_update.LintModuleOutputUpdate.TestDialect
Dialect used by the csv writer.
classpylint.testutils.pyreverse.PyreverseConfig
Holds the configuration options for Pyreverse.
classpylint.testutils.reporter_for_tests.GenericTestReporter
Reporter storing plain text messages.
methodpylint.testutils.reporter_for_tests.GenericTestReporter.display_reports(layout:Section) -> None
Ignore layouts.
methodpylint.testutils.reporter_for_tests.GenericTestReporter.handle_message(msg:Message) -> None
Append messages to the list of messages of the reporter.
classpylint.testutils.unittest_linter.UnittestLinter
A fake linter class to capture checker messages.
funcpylint.testutils.utils.create_files(paths:list[str], chroot:str='.') -> None
Creates directories and files found in <path>.
classpylint.typing.FileItem
Represents data about a file handled by pylint.
classpylint.typing.ManagedMessage
Tuple with information about a managed message of the linter.
classpylint.typing.ModuleDescriptionDict
Represents data about a checked module.
funcpylint.utils.docs.print_full_documentation(linter:PyLinter, stream:TextIO=sys.stdout, show_options:bool=True) -> None
Output a full documentation in ReST format.
classpylint.utils.file_state.FileState
Hold internal state specific to the currently analyzed file.
methodpylint.utils.file_state.FileState.handle_ignored_message(state_scope:MessageDisableReason | None, msgid:str, line:int | None) -> None
Report an ignored message.
classpylint.utils.linterstats.BadNames
TypedDict to store counts of node types with bad names.
classpylint.utils.linterstats.CodeTypeCount
TypedDict to store counts of lines of code types.
classpylint.utils.linterstats.DuplicatedLines
TypedDict to store counts of lines of duplicated code.
classpylint.utils.linterstats.LinterStats
Class used to linter stats.
methodpylint.utils.linterstats.LinterStats.get_code_count(type_name:Literal['code', 'comment', 'docstring', 'empty', 'total']) -> int
Get a code type count.
methodpylint.utils.linterstats.LinterStats.get_global_message_count(type_name:str) -> int
Get a global message count.
methodpylint.utils.linterstats.LinterStats.get_module_message_count(modname:str, type_name:MessageTypesFullName) -> int
Get a module message count.
methodpylint.utils.linterstats.LinterStats.get_undocumented(node_name:Literal['function', 'class', 'method', 'module']) -> float
Get a undocumented node count.
methodpylint.utils.linterstats.LinterStats.increase_bad_name(node_name:str, increase:int) -> None
Increase a bad names node count.
methodpylint.utils.linterstats.LinterStats.reset_bad_names() -> None
Resets the bad_names attribute.
methodpylint.utils.linterstats.LinterStats.reset_code_count() -> None
Resets the code_type_count attribute.
methodpylint.utils.linterstats.LinterStats.reset_duplicated_lines() -> None
Resets the duplicated_lines attribute.
methodpylint.utils.linterstats.LinterStats.reset_message_count() -> None
Resets the message type count of the stats object.
methodpylint.utils.linterstats.LinterStats.reset_node_count() -> None
Resets the node count attribute.
methodpylint.utils.linterstats.LinterStats.reset_undocumented() -> None
Resets the undocumented attribute.
classpylint.utils.linterstats.NodeCount
TypedDict to store counts of different types of nodes.
classpylint.utils.linterstats.UndocumentedNodes
TypedDict to store counts of undocumented node types.
classpylint.utils.pragma_parser.InvalidPragmaError
Thrown in case the pragma is invalid.
classpylint.utils.pragma_parser.PragmaParserError
A class for exceptions thrown by pragma_parser module.
classpylint.utils.pragma_parser.UnRecognizedOptionError
Thrown in case the of a valid but unrecognized option.
funcpylint.utils.utils.format_section(stream:TextIO, section:str, options:list[tuple[str, OptionDict, Any]], doc:str | None=None) -> None
Format an option's section using the INI format.
funcpylint.utils.utils.get_module_and_frameid(node:nodes.NodeNG) -> tuple[str, str]
Return the module name and the frame id in the module.
funcpylint.utils.utils.normalize_text(text:str, line_len:int=DEFAULT_LINE_LENGTH, indent:str='') -> str
Wrap the text on the given line length.
funcscript.check_newsfragments.check_file(file:Path, verbose:bool) -> bool
Check that a file contains a valid changelog entry.
funcscript.get_unused_message_id_category.register_all_checkers_and_plugins(linter:PyLinter) -> None
Registers all checkers and plugins.

この情報について

掲載しているシグネチャは pylint-dev/pylint の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・ 型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。 詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る