Czy jest możliwe wyłączenie błędu braku pliku sterującego w pilocie dla krótkich funkcji i metod?

Question

Pylint zgłasza błąd dla każdej funkcji i metody (z wyjątkiem __init__), która nie ma docstringu.

Jest to ogólnie pożądane, więc nie chcę wyłączać go globalnie (w pylintrc lub na poziomie pliku).

Jednak moim zdaniem są przypadki, w których docstrukcja nie jest konieczna, a nawet szkodliwa. Na przykład:

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

Ta metoda jest prostym programem pobierającym, który jest całkowicie opisany przez jego podpis. Konieczność napisania docstringu jest szkodliwa, ponieważ powoduje duplikowanie konserwacji, jeśli metoda zostanie zmieniona.

Chciałbym móc ustawić (np. W pylintrc) coś jak docstring_threshold=3, aby pominąć brakujące błędy docletu, jeśli funkcja lub metoda jest krótsza niż 3 linie kodu. Czy istnieje jakiś sposób, aby to zrobić?

Answer 1

Za pomocą pylinta 1.3.1 dodaj na przykład linię pylintrc docstring-min-length=10.

Jest to opisane w generowanym pliku pylintrc pylint --generate-rcfile jak

Minimalna długość linii dla funkcji/klas, które wymagają docstrings, krótsze są zwolnione.

Documentation reference.