Как напечатать строку документации для атрибута / элемента класса? - PullRequest
4 голосов
/ 23 января 2020

У меня есть класс:

class Holiday(ActivitiesBaseClass):
    """Holiday is an activity that involves taking time off work"""

    Hotel = models.CharField(max_length=255)
    """ Name of hotel """

Я могу напечатать строку документации класса, набрав:

print(Holiday.__doc__)

Это выводит как:

Holiday is an activity that involves taking time off work 

Как можно Я печатаю строку документации для отеля, которая является атрибутом / элементом класса?

То, что я пробовал

print(Holiday.Hotel.__doc__)

возвращает:

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

Я также пробовал функцию help() безрезультатно.

NB

Сфинкс, кажется, может извлечь строки документации атрибутов класса и включить их в readthedocs, так что я надеюсь, что есть способ

Ответы [ 2 ]

3 голосов
/ 23 января 2020

К сожалению, в настоящее время нет такой реализации строк документации атрибутов в Python. Был PEP , который предлагал реализовать эту функцию, но он был отклонен.

3 голосов
/ 23 января 2020

Не думаю, что можно добавить строку документации для указанного поля c, но вместо этого можно использовать аргумент help_text поля:

Hotel = models.CharField(max_length=255, help_text="Name of hotel")
...