Python получить документацию __doc__ для переменной экземпляра

Question

В Python я знаю, что должен задокументировать переменные экземпляра следующим образом:

self.x = 22
"""docstring for x"""

#: docstring for x
self.x = 22
self.x = 22 #: docstring for x

Но я не могу найти способ получить эту документацию в коде.MyClass.x.__doc__ дает мне документ фактического типа, который находится в x

Так что вопрос: как мне получить "docstring for x" из self.x?

Answer 1

Это особенность утилит документирования, таких как Sphinx и Epydoc, не стандартная функция Python.Я не верю, что существует какой-либо прямой способ получения переменных строк документации.

См. http://epydoc.sourceforge.net/manual-docstring.html#variable-docstrings

Answer 2

Согласно PEP 257 переменные экземпляра должны документироваться в строке документации класса:

Строка документации для класса должна обобщать его поведение и перечислять открытые методы и переменные экземпляра.

Простое написание строки документации после инициализации переменной экземпляра не даст вам никакого доступа к ней.