sphinx.ext.autodoc.preserve_defaults

module documentation
(source)

Preserve function defaults. Preserve the default argument values of function signatures in source code and keep them not evaluated for readability.

Class DefaultValue Undocumented
Function get_default_value Undocumented
Function get_function_def Get FunctionDef object from living object. This tries to parse original code for living object and returns AST node for given *obj*.
Function setup Undocumented
Function update_defvalue Update defvalue info of *obj* using type_comments.
Variable logger Undocumented
def get_default_value(lines, position): (source)

Undocumented

Parameters
lines:list[str]Undocumented
position:ast.ASTUndocumented
Returns
str|NoneUndocumented
def get_function_def(obj): (source)

Get FunctionDef object from living object. This tries to parse original code for living object and returns AST node for given *obj*.

Parameters
obj:AnyUndocumented
Returns
ast.FunctionDef|NoneUndocumented
def setup(app): (source)

Undocumented

Parameters
app:SphinxUndocumented
Returns
dict[str, Any]Undocumented
def update_defvalue(app, obj, bound_method): (source)

Update defvalue info of *obj* using type_comments.

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

Undocumented