Example ast code to parse Python source to extract docstring after global variables

Question

While Python does not officially support docstrings for global variables, it is common to add them anyway:

debug = False
'''Set debug to True to see lots of intermediate results'''

Docstring for variable explains that Python does not directly offer access, but Sphinx is able to pull these out of a module. For something I am working on, I would like to access them as well. I think the ast module can do this. Anyone have any example code (using ast or other standard libraries) that can provide docstrings for variables defined in a module?

possible duplicate of Docstring for variable

ILostMySpoon
– ILostMySpoon

2015-07-31 03:16:52 +00:00
Commented Jul 31, 2015 at 3:16 — ILostMySpoon
– ILostMySpoon, Commented Jul 31, 2015 at 3:16

Patrick Maupin · Accepted Answer · 2015-07-31 03:49:17Z

1

The astor library parses the entire AST and will reconstitute Python. The version on github is well ahead of the Pypi version, so you should clone it from there.

The tree processing is fairly easy to follow -- you should be able to modify it to only give you the docstrings.

answered Jul 31, 2015 at 3:49

Patrick Maupin

8,1672 gold badges25 silver badges44 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Example ast code to parse Python source to extract docstring after global variables

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related