sphinx.pycode.parser

module documentation

Utilities parsing and analyzing Python code.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.

Variable	`comment_re`	Undocumented
Variable	`emptyline_re`	Undocumented
Variable	`indent_re`	Undocumented
Class	`AfterCommentParser`	Python source code parser to pick up comments after assignments.
Class	`DefinitionFinder`	Python source code parser to detect location of functions, classes and methods.
Class	`Parser`	Python source code parser to pick up variable comments.
Class	`Token`	Better token wrapper for tokenize module.
Class	`TokenProcessor`	No class docstring; 0/4 instance variable, 3/4 methods documented
Class	`VariableCommentPicker`	Python source code parser to pick up variable comments.
Function	`dedent_docstring`	Remove common leading indentation from docstring.
Function	`filter_whitespace`	Undocumented
Function	`get_assign_targets`	Get list of targets from Assign and AnnAssign node.
Function	`get_lvar_names`	Convert assignment-AST to variable names.

comment_re =

Undocumented

emptyline_re =

Undocumented

indent_re =

Undocumented

def dedent_docstring(s):

Remove common leading indentation from docstring.

def filter_whitespace(code):

Undocumented

def get_assign_targets(node):

Get list of targets from Assign and AnnAssign node.

def get_lvar_names(node, self=None):

Convert assignment-AST to variable names.

This raises TypeError if the assignment does not create new variable:

ary[0] = 'foo'
dic["bar"] = 'baz'
# => TypeError