如何以编程方式报告类的 API？

Question

我的目标是解析一个类并返回一个描述类中包含的方法和相关参数的数据结构（对象、字典等）。类型和返回的奖励积分...

要求：必须是 Python

例如下面的类：

class Foo:
    def bar(hello=None):
         return hello

    def baz(world=None):
         return baz

会被解析返回

result = {class:"Foo", 
          methods: [{name: "bar", params:["hello"]}, 
                    {name: "baz", params:["world"]}]}

所以这只是我在想的一个例子......我在数据结构上非常灵活。

关于如何实现这一点的任何想法/示例？

Answer 1

您可能想查看 Python 的 inspect 模块。它会带你去那里的大部分路：

>>> class Foo:
...     def bar(hello=None):
...          return hello
...     def baz(world=None):
...          return baz
...
>>> import inspect
>>> members = inspect.getmembers(Foo)
>>> print members
[('__doc__', None), ('__module__', '__main__'), ('bar', <unbound method Foo.bar>
), ('baz', <unbound method Foo.baz>)]
>>> inspect.getargspec(members[2][1])
(['hello'], None, None, (None,))
>>> inspect.getargspec(members[3][1])
(['world'], None, None, (None,))

这不是您想要的语法，但是当您阅读文档时，这部分应该相当简单。