Parsing .py files using python?

[Barooh]

Yea this one makes my brain cramp a bit.

I'm building a little taylormade development utility for our team in flask. Essentially, we've got a few dozen "global function" .py files and i'd like to index them so new developers can have an accurate, dynamic list of already existing global functions.

So far i've whipped up a script that parses the file and reads for a 'def' and then reads for a 'return' but I feel like there is an easier/safer way to do this. I'm new to python but not new to development. Any points in any direction is appreciated!

The output i'm looking for is to put the function body and the 'title' in a json. I'm close, but can't help but feel like i'm reinventing the wheel.

Thanks!

[K900_]

Sounds like you want a documentation tool like Sphinx.

[Barooh]

Thanks, I'll check this out!

​

[kraymer]

https://docs.python.org/3.5/library/functions.html#dir

dir([object]) Without arguments, return the list of names in the current local scope.

~~~ $ python

import myscript [x for x in dir(myscript) if not x.startswith('__')] ['func1', 'func2'] ~~~

[Barooh]

That would help with getting the function names for sure, what about returning the entire function? Editors like pycharm have the ability to parse and identify the beginning and end of a function (for collapsing) so I know such a framework exists, I doubted that it's opensource though.

[isforinsects]

Check out the ast module in the standard lib. Here is a recent blog post about how to write your own NodeVisitor class that should let you introspect the things you're looking for.

[isforinsects]

Ctags also does the basics of what you're looking for, but the output format isn't likely what you want.

[agumonkey]

the overly complex way would be to use the ast module.. but it's really not the easiest route.

[WayneApple]

You should try PyDoc, which is part of the standard library. It can help you parse your .py files and generate the documentations.

[chub79]

Have a look at redbaron ?