Warum widerspricht Pylint den Namen einzelner Zeichenvariablen?

Ich pylintgewöhne mich immer noch an Python-Konventionen und verwende es , um meinen Code pythonischer zu gestalten, aber ich bin verwirrt darüber, dass pylint keine Variablennamen für einzelne Zeichen mag. Ich habe ein paar Schleifen wie diese:

for x in x_values:
   my_list.append(x)

und wenn ich laufe pylint, bekomme ich Invalid name "x" for type variable (should match [a-z_][a-z0-9_]{2,30}- das deutet darauf hin, dass ein gültiger Variablenname zwischen 3 und 31 Zeichen lang sein muss, aber ich habe die PEP8-Namenskonventionen durchgesehen und sehe nichts Explizites in Bezug auf einzelne Kleinbuchstaben und ich sehe viele Beispiele, die sie verwenden.

Fehlt mir etwas in PEP8 oder ist dies ein Standard, der nur für Pylint gilt?

PyLint überprüft nicht nur die PEP8-Empfehlungen. Es hat auch seine eigenen Empfehlungen, von denen eine ist, dass ein Variablenname beschreibend und nicht zu kurz sein sollte.

Sie können dies verwenden, um solche Kurznamen zu vermeiden:

my_list.extend(x_values)

Oder optimieren Sie die Konfiguration von PyLint, um PyLint mitzuteilen, welche Variablennamen gut sind.

Ein bisschen mehr Details zu dem, was gurney alex bemerkt hat: Sie können PyLint anweisen, Ausnahmen für Variablennamen zu machen, die (Sie schwören , kleiner Finger ) vollkommen klar sind, obwohl sie weniger als drei Zeichen enthalten. Suchen Sie in Ihrer pylintrc- Datei unter der [FORMAT]Überschrift:

# Good variable names which should always be accepted, separated by a comma
good-names=i,j,k,ex,Run,_,pk,x,y

Hier sind pk (für Primärschlüssel), x und y Variablennamen, die ich hinzugefügt habe.

In stark typisierten Sprachen können 1-Buchstaben-Namensvariablen in Ordnung sein, da Sie den Typ in der Regel neben dem Namen in der Deklaration der Variablen oder im Funktions- / Methodenprototyp erhalten:

bool check_modality(string a, Mode b, OptionList c) {
    ModalityChecker v = build_checker(a, b);
    return v.check_option(c);
}

In Python erhalten Sie diese Informationen nicht. Wenn Sie also schreiben:

def check_modality(a, b, c):
    v = build_checker(a, b)
    return v.check_option(c)

Sie lassen dem Wartungsteam absolut keine Ahnung, was die Funktion tun könnte, wie sie aufgerufen wird und was sie zurückgibt. In Python verwenden Sie daher häufig beschreibende Namen:

def check_modality(name, mode, option_list):
    checker = build_checker(name, mode)
    return checker.check_option(option_list)

und Sie fügen sogar eine Dokumentzeichenfolge hinzu, die erklärt, was das Zeug tut und welche Typen erwartet werden.

Heutzutage gibt es auch eine Option, um regulären Ausdruck zu überschreiben. Dh wenn Sie einzelne Zeichen als Variablen zulassen möchten:

pylint --variable-rgx="[a-z0-9_]{1,30}$" <filename>

So pylintwird PEP8 entsprechen und wird nicht bringen zusätzliche Verletzungen an der Spitze. Sie können es auch hinzufügen .pylintrc.

Der tiefere Grund ist , dass Sie sich vielleicht erinnern , was Sie beabsichtigt a, b, c, x, y, undz zu meinen , wenn Sie Ihren Code geschrieben, aber wenn andere es lesen, oder sogar , wenn Sie zurückkommen , um Ihren Code, wird der Code viel besser lesbar , wenn Sie geben es ist ein semantischer Name. Wir schreiben keine Sachen einmal an eine Tafel und löschen sie dann. Wir schreiben Code, der möglicherweise ein Jahrzehnt oder länger anhält und viele, viele Male gelesen wird.

Verwenden Sie semantische Namen. Semantische Namen, die ich verwendet habe, waren wieratio , denominator, obj_generator, pathusw. Es kann eine zusätzliche oder zwei Sekunden dauern , sie zu geben, aber die Zeit sparen Sie versuchen, herauszufinden , was Sie geschrieben haben sogar eine halbe Stunde von da ist es wert .