mypy.plugin.CheckerPluginInterface

class documentation

class CheckerPluginInterface: (source)

Known subclasses: mypy.checker.TypeChecker

View In Hierarchy

Interface for accessing type checker functionality in plugins.

Methods docstrings contain only basic info. Look for corresponding implementation docstrings in checker.py for more details.

Method fail Emit an error message at given location.
Method named​_generic​_type Construct an instance of a builtin type with given type arguments.
Class Variable msg Undocumented
Class Variable options Undocumented
Class Variable path Undocumented
Property type​_context Return the type context of the plugin
@abstractmethod
def fail(self, msg, ctx, *, code=None): (source)
overridden in mypy.checker.TypeChecker
Emit an error message at given location.
Parameters
msg:Union[str, ErrorMessage]Undocumented
ctx:ContextUndocumented
code:Optional[ErrorCode]Undocumented
@abstractmethod
def named_generic_type(self, name, args): (source)
overridden in mypy.checker.TypeChecker
Construct an instance of a builtin type with given type arguments.
Parameters
name:strUndocumented
args:List[Type]Undocumented
Returns
InstanceUndocumented
msg: MessageBuilder = (source)
overridden in mypy.checker.TypeChecker

Undocumented

options: Options = (source)
overridden in mypy.checker.TypeChecker

Undocumented

path: str = (source)
overridden in mypy.checker.TypeChecker

Undocumented

@property
@abstractmethod
type_context: List[Optional[Type]] = (source)
overridden in mypy.checker.TypeChecker
Return the type context of the plugin