Как заставить PyCharm показывать произвольный текст в документации атрибута экземпляра? - PullRequest
Новая
       52

Как заставить PyCharm показывать произвольный текст в документации атрибута экземпляра?

0 голосов
/ 19 февраля 2019

Хотя PyCharm поддерживает строки документации для функций и подсказок типов, я не могу найти способ получить подробные описания того, что вы могли бы считать «общедоступными атрибутами» экземпляров классов.

Лучшее, что я могу получить, - это либо комментарийили явный намек на тип для отображения на панели «Документация» (ctrl-q по умолчанию), что в любом случае я могу получить путем самоанализа: моя цель - получить описание значения этой переменной, а не ее значения. 

from typing import List
class Example:
   def __init__(self, name: str = 'default'):
       """This object is an example, but has some attributes.

       :param name: this name is kind of special because...
       :ivar some_attr: this attr contains phone numbers of friends!
       :ivar some_other_attr: this attr contains phone numbers of enemies!
       """
       self.name = name
       self.some_attr: List[int] = []
       self.some_other_attr: List[int] = []

Я бы ожидал, что PyCharm скажет мне, что я не должен звонить по self.some_attr номерам в 3 часа ночи, и должен действительно сосредоточиться на этих неприятных цифрах в self.some_other_attr.В идеале это должно происходить в документации для __init__, но где-то лучше, чем нигде.

Однако я, кажется, полностью проигнорирован, и ctrl-q на self.some_attr просто говорит мне self.some_attr - это List[int], а ctrl-q на __init__ просто говорит мне, что у меня есть параметр name.

...