typedargs.lint module

A pylint plugin that checks for errors in typedargs declarations.

This should be run using pylint in the following way:

` pylint --load-plugins typedargs.lint <path to source files> `

It will return errors if there are problems with annotated functions or if the docstring for an @docannotate function is not correctly formatted.

Summary

Classes:

AnnotatedFunctionChecker
AnnotationList
DocannotationChecker

Functions:

register

Reference

class typedargs.lint.AnnotationList(params, returns, use_doc)

Bases: tuple

params

Alias for field number 0

returns

Alias for field number 1

use_doc

Alias for field number 2

class typedargs.lint.AnnotatedFunctionChecker(linter=None)

Bases: pylint.checkers.base_checker.BaseChecker

priority = -1

classmethod process_param(param)

Process an @param decorator into a ParameterInfo.

classmethod process_return_type(return_type)

Process an @return_type decorator.

classmethod extract_annotations(node)

class typedargs.lint.DocannotationChecker(linter=None)

Bases: typedargs.lint.AnnotatedFunctionChecker

name = 'typedargs-annotation'

msgs = {'W6701': ('Doc-annotation parameter or return does not correspond to a known type', 'typedargs-unknown-type', 'All types annotated using typedargs should resolve to known types.')}

visit_functiondef(node)

typedargs.lint.register(linter)