sphinx.ext.autodoc.type_comment

module documentation
(source)

Update annotations info of living objects using type_comments.

Function get_type_comment Get type_comment'ed FunctionDef object from living object.
Function not_suppressed Check given *argtypes* is suppressed type_comment or not.
Function setup Undocumented
Function signature_from_ast Return a Signature object for the given *node*.
Function update_annotations_using_type_comments Update annotations info of *obj* using type_comments.
Variable logger Undocumented
def get_type_comment(obj, bound_method=False): (source)

Get type_comment'ed FunctionDef object from living object. This tries to parse original code for living object and returns Signature for given *obj*.

Parameters
obj:AnyUndocumented
bound_method:boolUndocumented
Returns
Signature|NoneUndocumented
def not_suppressed(argtypes=[]): (source)

Check given *argtypes* is suppressed type_comment or not.

Parameters
argtypes:list[ast.AST]Undocumented
Returns
boolUndocumented
def setup(app): (source)

Undocumented

Parameters
app:SphinxUndocumented
Returns
dict[str, Any]Undocumented
def signature_from_ast(node, bound_method, type_comment): (source)

Return a Signature object for the given *node*. :param bound_method: Specify *node* is a bound method or not

Parameters
node:ast.FunctionDefUndocumented
bound_method:boolUndocumented
type_comment:ast.FunctionDefUndocumented
Returns
SignatureUndocumented
def update_annotations_using_type_comments(app, obj, bound_method): (source)

Update annotations info of *obj* using type_comments.

Parameters
app:SphinxUndocumented
obj:AnyUndocumented
bound_method:boolUndocumented
logger = (source)

Undocumented