..function::get_docstring(node, clean=True)

Return the docstring of the given *node* (which must be a

:class:`FunctionDef`,:class:`ClassDef` or:class:`Module` node), or ``None``

if it has no docstring. If *clean* is true, clean up the docstring's

indentation with:func:`inspect.cleandoc`.

:class:`FunctionDef`,:class:`AsyncFunctionDef`,:class:`ClassDef`,

or:class:`Module` node), or ``None`` if it has no docstring.

If *clean* is true, clean up the docstring's indentation with

:func:`inspect.cleandoc`.

..versionchanged::3.5

:class:`AsyncFunctionDef` is now supported.

..versionchanged::3.7

The docstring is now exported from the node docstring field, instead of

the first body statement.

..function::fix_missing_locations(node)

Use the:meth:`~http.cookies.Morsel.set` method for setting them.

(Contributed by Serhiy Storchaka in:issue:`29192`.)

* ``Module``, ``FunctionDef``, ``AsyncFunctionDef``, and

``ClassDef`` AST nodes now have a new ``docstring`` field.

The first statement in their body is not considered as a docstring

anymore. ``co_firstlineno`` and ``co_lnotab`` of code object for class

and module are affected by this change.

(Contributed by INADA Naoki and Eugene Toder in:issue:`29463`.)

CPython bytecode changes

union {

struct {

asdl_seq*body;

stringdocstring;

}Module;

struct {

asdl_seq*body;

asdl_seq*decorator_list;

expr_tyreturns;

stringdocstring;

}FunctionDef;

struct {

asdl_seq*body;

asdl_seq*decorator_list;

expr_tyreturns;

stringdocstring;

}AsyncFunctionDef;

struct {

asdl_seq*keywords;

asdl_seq*body;

asdl_seq*decorator_list;

stringdocstring;

}ClassDef;

struct {

};

#defineModule(a0,a1) _Py_Module(a0, a1)

mod_ty_Py_Module(asdl_seq*body,PyArena*arena);

#defineModule(a0,a1,a2) _Py_Module(a0, a1, a2)

mod_ty_Py_Module(asdl_seq*body,stringdocstring,PyArena*arena);

#defineInteractive(a0,a1) _Py_Interactive(a0, a1)

mod_ty_Py_Interactive(asdl_seq*body,PyArena*arena);

#defineExpression(a0,a1) _Py_Expression(a0, a1)

mod_ty_Py_Expression(expr_tybody,PyArena*arena);

#defineSuite(a0,a1) _Py_Suite(a0, a1)

mod_ty_Py_Suite(asdl_seq*body,PyArena*arena);

#defineFunctionDef(a0,a1,a2,a3,a4,a5,a6,a7) _Py_FunctionDef(a0, a1, a2, a3, a4, a5, a6, a7)

#defineFunctionDef(a0,a1,a2,a3,a4,a5,a6,a7,a8) _Py_FunctionDef(a0, a1, a2, a3, a4, a5, a6, a7, a8)

stmt_ty_Py_FunctionDef(identifiername,arguments_tyargs,asdl_seq*body,

asdl_seq*decorator_list,expr_tyreturns,intlineno,

intcol_offset,PyArena*arena);

#defineAsyncFunctionDef(a0,a1,a2,a3,a4,a5,a6,a7) _Py_AsyncFunctionDef(a0, a1, a2, a3, a4, a5, a6, a7)

asdl_seq*decorator_list,expr_tyreturns,string

docstring,intlineno,intcol_offset,PyArena*arena);

#defineAsyncFunctionDef(a0,a1,a2,a3,a4,a5,a6,a7,a8) _Py_AsyncFunctionDef(a0, a1, a2, a3, a4, a5, a6, a7, a8)

stmt_ty_Py_AsyncFunctionDef(identifiername,arguments_tyargs,asdl_seq*

body,asdl_seq*decorator_list,expr_tyreturns,

intlineno,intcol_offset,PyArena*arena);

#defineClassDef(a0,a1,a2,a3,a4,a5,a6,a7) _Py_ClassDef(a0, a1, a2, a3, a4, a5, a6, a7)

stringdocstring,intlineno,intcol_offset,

PyArena*arena);

#defineClassDef(a0,a1,a2,a3,a4,a5,a6,a7,a8) _Py_ClassDef(a0, a1, a2, a3, a4, a5, a6, a7, a8)

stmt_ty_Py_ClassDef(identifiername,asdl_seq*bases,asdl_seq*keywords,

asdl_seq*body,asdl_seq*decorator_list,intlineno,

intcol_offset,PyArena*arena);

asdl_seq*body,asdl_seq*decorator_list,string

docstring,intlineno,intcol_offset,PyArena*arena);

#defineReturn(a0,a1,a2,a3) _Py_Return(a0, a1, a2, a3)

stmt_ty_Py_Return(expr_tyvalue,intlineno,intcol_offset,PyArena*arena);

#defineDelete(a0,a1,a2,a3) _Py_Delete(a0, a1, a2, a3)

ifnotisinstance(node, (AsyncFunctionDef,FunctionDef,ClassDef,Module)):

raiseTypeError("%r can't have docstrings"%node.__class__.__name__)

ifnot(node.bodyandisinstance(node.body[0],Expr)):

node=node.body[0].value

ifisinstance(node,Str):

text=node.s

elifisinstance(node,Constant)andisinstance(node.value,str):

text=node.value

else:

text=node.docstring

ifclean:

text=inspect.cleandoc(text)