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/

它是一個在線文檔工具。它的真棒，它會做你想要的。