autoclass和實例屬性

Question

根據sphinx documentation，.. autoattribute指令應該能夠記錄實例屬性。但是，如果我當建設做::

.. currentmodule:: xml.etree.ElementTree 

.. autoclass:: ElementTree 

    .. autoattribute:: ElementTree._root 

然後我得到一個AttributeError：

Traceback (most recent call last):etree.ElementTree.ElementTree     
    File "/Volumes/Raptor/Library/Python/2.7/lib/python/site-packages/sphinx/ext/autodoc.py", line 326, in import_object 
    obj = self.get_attr(obj, part) 
    File "/Volumes/Raptor/Library/Python/2.7/lib/python/site-packages/sphinx/ext/autodoc.py", line 232, in get_attr 
    return safe_getattr(obj, name, *defargs) 
    File "/Volumes/Raptor/Library/Python/2.7/lib/python/site-packages/sphinx/util/inspect.py", line 70, in safe_getattr 
    raise AttributeError(name) 
AttributeError: _root 

即使如果我實例ElementTree，並嘗試訪問_root屬性，它工作正常::

>>> from xml.etree.ElementTree import ElementTree 
>>> e = ElementTree() 
>>> hasattr(e, '_root') 
True 

我在做什麼錯？

（實際上，我有我自己的一個類這個問題，但我只是用了ElementTree類爲例，因爲它是在標準庫）

Answer 1

這看起來像的方式中的錯誤不公共實例屬性被處理。獅身人面像應該能夠識別instance attributes defined in __init__。

我不能說這應該如何解決。有一個開放的錯誤報告似乎是相關的：Non-public instance attributes are not documented without __slots__。

如果下面的行被添加到ElementTree.py的ElementTree類的定義，

__slots__ = ["_root"] 

那麼你得到的AttributeError消失。