Python文档字符串解析（通常在Python中解析语言）

Question

我想为用Python编写的REST API生成有用的文档。

我想它应该是这样的：

''' 
/kittens/ 
This method creates kittens in the browser 

HTTP Params: 
    format(default=json): The format in which kittens will be generated. 
    count(default=10): The number of kittens to generate. 

Returns: 
    A list of kittens. 
''' 

我的语法显然是：

program = dict 
dict = repeated(name:string | name:dict) 

我想解析这种格式，并得到（例如）Python字典，最好不使用正则表达式。

是否有解析器可用于这种语法？
如果不是，那么在Python中定义和解析DSL的最简单方法是什么？

请注意，我希望而不是使用reStructuredText或任何格式不同于我所描述的。

Answer 1

我不知道我知道你想要什么，但新结构化可以用来捕捉你的信息。例如：

.. method:: kittens(format="json", count=10) 

    Creates kittens in the browser. 

    :param format: The format in which kittens will be generated. 
    :param count: The number of kittens to generate. 
    :return: A list of kittens 

Sphinx明白这句法，这是基本的reST标记的延伸由Docutils定义。

Answer 2

http://sphinx.pocoo.org/

它是一个在线文档工具。它的真棒，它会做你想要的。