class documentation
class DocStringChecker(_BasicChecker): (source)
Undocumented
Method | open |
Called before visiting project (i.e. set of modules). |
Method | visit |
Undocumented |
Method | visit |
Undocumented |
Method | visit |
Undocumented |
Class Variable | msgs |
Undocumented |
Class Variable | options |
Options provided by this provider. |
Method | _check |
Check if the node has a non-empty docstring. |
Inherited from _BasicChecker
:
Class Variable | name |
Name of the provider. |
Inherited from BaseChecker
(via _BasicChecker
):
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 |
Undocumented |
Method | check |
Check the consistency of msgid. |
Method | close |
Called after visiting project (i.e set of modules). |
Method | create |
Undocumented |
Method | get |
Undocumented |
Method | get |
Undocumented |
Method | get |
Undocumented |
Method | reduce |
Undocumented |
Class Variable | enabled |
Undocumented |
Class Variable | reports |
Undocumented |
Instance Variable | linter |
Undocumented |
Property | messages |
Undocumented |
Inherited from _ArgumentsProvider
(via _BasicChecker
, BaseChecker
):
Method | get |
DEPRECATED: Return the dictionary defining an option given its name. |
Method | level |
Undocumented |
Method | load |
DEPRECATED: Initialize the provider using default values. |
Method | option |
DEPRECATED: Get the config attribute corresponding to opt. |
Method | option |
DEPRECATED: Get the current value for the given option. |
Method | options |
DEPRECATED. |
Method | options |
DEPRECATED: Return an iterator on options grouped by section. |
Method | set |
DEPRECATED: Method called to set an option (registered in the options list). |
Class Variable | option |
Option groups of this provider and their descriptions. |
Property | config |
Undocumented |
Property | level |
Undocumented |
Instance Variable | _arguments |
The manager that will parse and register any options provided. |
Instance Variable | _level |
Undocumented |
@utils.only_required_for_messages( 'missing-class-docstring', 'empty-docstring')
def visit_classdef(self, node:
def visit_classdef(self, node:
nodes.ClassDef
):
(source)
¶
Undocumented
@utils.only_required_for_messages( 'missing-function-docstring', 'empty-docstring')
def visit_functiondef(self, node:
def visit_functiondef(self, node:
nodes.FunctionDef
):
(source)
¶
Undocumented
@utils.only_required_for_messages( 'missing-module-docstring', 'empty-docstring')
def visit_module(self, node:
def visit_module(self, node:
nodes.Module
):
(source)
¶
Undocumented
def _check_docstring(self, node_type:
Literal[ 'class', 'function', 'method', 'module']
, node: (nodes.Module|nodes.ClassDef)|nodes.FunctionDef
, report_missing: bool
= True, confidence: interfaces.Confidence
= interfaces.HIGH):
(source)
¶
Check if the node has a non-empty docstring.