2017-05-06 17 views
1

在Python的獅身人面像中,我如何記錄歸功於__getattr__的可用屬性?在獅身人面像中,通過__getattr__提供的文檔屬性

我有一些配置管理器的實例,允許通過屬性匹配部分名稱,即config_manager.<section_name>訪問配置的任何部分。

現在我這個文件裏面.rst文件(但在代碼寧願)像這樣的東西:

.. autoclass:: ConfigManager 
    :members: 
    :var .<section_name>: Access any section of the configuration by its name. 

但這並不在這個文檔也突出顯示,即使提供這種訪問是該類的主要目的之一。

+0

你是什麼意思「這不顯得太顯眼」?有什麼出現嗎? – mzjn

+0

方法出現我會稱之爲顯着。這個我用':var'註解的東西出現在類描述下面,就像「Variables:bullet list」一樣。我希望他們也能以方法出現。 – jbasko

+0

爲什麼你希望他們出現「作爲方法」?他們不是方法。我錯過了什麼嗎? – mzjn

回答

1

你可以使用.. attribute::指令,像這樣:

.. autoclass:: ConfigManager 
    :members: 

    .. attribute:: <section_name> 

     Access any section of the configuration by its name. 

的屬性將方法之前出現(並提出類似的方法)輸出。

+1

這是完美的。謝謝!當我將它移動到課程的文檔字符串中時,它甚至可以工作。 – jbasko