Документирование атрибута класса
При попытке детерминировано очистить содержание Временной папки типа Файлов, Вы рискуете удалять файлы, которые используются другими процессами. Операционная система Windows обеспечивает инструменты, чтобы позволить пользователям удалять те файлы, когда доступное дисковое пространство объема достигает определенного порога.
Теперь, если можно решить, что после использования определенного временного файла, что он больше не будет необходим, тогда нет никакой оборотной стороны к удалению что определенный файл.
3 ответа
PEP 224 для строк документации атрибутов был отклонен (давным-давно), так что это тоже проблема для меня, иногда я не знаю, как выбрать класс атрибут или свойство экземпляра - второй может иметь строку документации.
Do it like this:
class MP3FileInfo(FileInfo):
"""Store ID3v1.0 MP3 tags."""
@property
def tagDataMap(self):
"""This function computes map of tags.
The amount of work necessary to compute is quite large, therefore
we memoize the result.
"""
...
Note though you really shouldn't make a separate docstring if the attribute has only a one-line description. Instead, use
class MP3FileInfo(FileInfo):
"""Store ID3v1.0 MP3 tags.
Here are the attributes:
tagDataMap -- contains a map of tags
"""
tagDataMap = ...