Login Register

ast.get_docstring()

ast.get_docstring(node, clean=True)

Return the docstring of the given node (which must be a FunctionDef, ClassDef or Module node), or None if it has no docstring. If clean is true, clean up the docstring’s indentation with inspect.cleandoc().

Links:

https://docs.python.org/3.5/library/ast.html#ast.get_docstring

doc_python

2016-10-07 17:26:20

Comments

Leave a Comment

Please login to continue.

Popular Articles

ast.AST class ast.AST This is the base of all AST node classes. The actual node classes are derived from the Parser/Python.asdl file, which is reproduced

ast.AST._fields _fields Each concrete class has an attribute _fields which gives the names of all child nodes. Each instance of a concrete class has one attribute

ast.AST.lineno lineno col_offset Instances of ast.expr and ast.stmt subclasses have lineno and col_offset attributes. The lineno is the line number of source text

ast.AST.col_offset col_offset Instances of ast.expr and ast.stmt subclasses have lineno and col_offset attributes. The lineno is the line number of source text (1-in

doctest.DocTest.docstring docstring The string that the test was extracted from, or ‘None’ if the string is unavailable, or if the test was not extracted from a string.