Как документировать атрибуты экземпляра в Python? [дубликат] ⇐ Python

[Anonymous]

Существует множество информации о том, как документировать атрибуты класса, но как насчет атрибутов экземпляра?
Рассмотрим следующий пример:

Код: Выделить всё

class Orchestra:
def ___init__(self):
self.musicians = dict() # Musicians will be stored here.

def hire_musician(self, name:str, instrument:str):
self.musicians[name] = instrument

Я хочу, чтобы пользователи Orchestra имели доступ к self.musicians. Как это будет документировано? В строке документации __init__? Вот так:

Код: Выделить всё

class Orchestra:
def ___init__(self):
"""
Instance attributes
-------------------
musicians:
A dictionary of the form `{name: instrument}` with `name` and `instrument` strings.
"""
self.musicians = dict() # Musicians will be stored here.

Есть ли предпочтительный/стандартный способ?


Подробнее здесь: https://stackoverflow.com/questions/791 ... -in-python