Когда я пытаюсь следовать PEP8 и документировать строку класса, который включает наследование, проверка PyCharm/PyCode для PEP8 всегда выдает мне предупреждение о том, что унаследованные параметры не имеют ссылки. Эти лучше просто удалить? Должен ли я вообще упоминать параметры в классе, который является подклассом?
Например
МОДУЛЬ 1
class Parent:
"""Parent class
:param plugin: a plugin
:type plugin: plugin type
"""
def __init___(self,plugin):
self.plugin = plugin
МОДУЛЬ 2
class Child(Parent):
"""
:param plugin: the plugin from parent class
"""
Модуль 2 выдаст мне предупреждение о том, что плагин не имеет ссылки. Лучшая практика для PEP8?
__init__(plugin)в дочернем элементе, даже если он содержит толькоsuper().__init__(plugin), чтобы сигнатура была понятна читателю (особенно если определения классов находятся в отдельных файлах). Это также удовлетворило бы проверку PyCharm. Однако помните, что важна читабельность/чистота кода, а не то, работает ли чекер без предупреждений. В конце концов, он призван помочь вам как разработчику. - person IonicSolutions schedule 25.06.2018