Подтвердить что ты не робот

Можно ли отключить palint missing docstring error для коротких функций и методов?

Pylint сообщает об ошибке для каждой функции и метода (кроме __init__), у которой нет docstring.

Это обычно желательно, поэтому я не хочу отключать его глобально (в pylintrc или на уровне файла).

Однако, на мой взгляд, бывают случаи, когда докшрин не нужен и даже вреден. Например:

def get_foo(self, foo_id):
  """Gets foo by its id."""" 
  return foos[foo_id]

Этот метод является простым геттером, который полностью описывается его сигнатурой. Требование написать docstring вредно в том, что оно создает дублирующее обслуживание, если метод изменен.

Я хотел бы установить (например, в pylintrc) что-то вроде docstring_threshold=3, чтобы подавить отсутствующие ошибки docstring, если функция или метод короче 3 строк кода. Есть ли способ сделать это?

4b9b3361

Ответ 1

Используя pylint 1.3.1, добавьте к вам строку pylintrc docstring-min-length=10, например.

Он описывается в сгенерированном файле pylintrc pylint --generate-rcfile как

Минимальная длина строки для функций/классов, для которых требуются докстры, более короткие освобождаются.

Ссылка на документацию.