Как к классу документов приписывает в Python? [закрытый]

Чтобы избежать путаницы: термин свойство имеет конкретное значение в Python. Вы говорите о том, что мы называем атрибутами класса . Поскольку они всегда обрабатываются через их класс, я считаю, что имеет смысл задокументировать их в строке документации класса. Примерно так:

class Albatross(object):
    """A bird with a flight speed exceeding that of an unladen swallow.

    Attributes:
        flight_speed     The maximum speed that such a bird can attain.
        nesting_grounds  The locale where these birds congregate to reproduce.
    """
    flight_speed = 691
    nesting_grounds = "Throatwarbler Man Grove"

Я думаю, что это намного проще для глаз, чем подход в вашем примере.Если бы я действительно хотел, чтобы копии значений атрибутов отображались в строке документа, я бы поместил их рядом или под описанием каждого атрибута.

Имейте в виду, что в Python строки документации являются фактическими членами документируемых объектов, а не просто аннотациями исходного кода. Поскольку переменные атрибутов класса не являются объектами сами по себе, а являются ссылками на объекты, они не могут содержать собственные строки документов. Я предполагаю, что вы могли бы привести аргументы в пользу наличия строк документации по ссылкам, возможно, для описания «что должно быть здесь» вместо «что на самом деле здесь», но я считаю, что это достаточно легко сделать в строке документа содержащего класса.