E 'possibile disabilitare l'errore di docstring di pylint mancante per funzioni e metodi brevi?

Question

Pylint segnala un errore per ogni funzione e metodo (eccetto __init__) senza docstring.

Questo è generalmente auspicabile, quindi non voglio disabilitarlo globalmente (in pylintrc, oa livello di file).

Tuttavia, a mio parere, vi sono casi in cui una docstring non è necessaria e persino dannosa. Ad esempio:

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

Questo metodo è un getter semplice che è completamente descritto dalla sua firma. Dover scrivere una docstring è dannoso in quanto crea una manutenzione duplicata se il metodo viene modificato.

Mi piacerebbe essere in grado di impostare (ad esempio in pylintrc) qualcosa come docstring_threshold=3, per sopprimere gli errori di docstring mancanti se la funzione o il metodo è più breve di 3 righe di codice. C'è un modo per farlo?

Answer 1

Utilizzando pylint 1.3.1 aggiungere una riga a voi pilastro docstring-min-length=10 per esempio.

E 'descritto nel file pylintrc pylint --generate-rcfile generato come

Lunghezza minima linea per le funzioni/classi che richiedono docstrings, quelle più corte sono esenti.

Documentation reference.