Почему pylint возражает против односимвольных имен переменных?

Я все еще привыкаю к ​​соглашениям Python и использую его, pylintчтобы сделать свой код более питоническим, но меня озадачивает тот факт, что pylint не любит односимвольные имена переменных. У меня есть несколько таких петель:

for x in x_values:
   my_list.append(x)

и когда я бегу pylint, я получаю Invalid name "x" for type variable (should match [a-z_][a-z0-9_]{2,30}- это говорит о том, что допустимое имя переменной должно быть длиной от 3 до 31 символа, но я просмотрел соглашения об именах PEP8 и не вижу ничего явного относительно одиночных строчных букв , и я действительно вижу много примеров, в которых они используются.

Что-то мне не хватает в PEP8, или это уникальный стандарт для pylint?

PyLint проверяет не только рекомендации PEP8. У него также есть свои собственные рекомендации, одна из которых заключается в том, что имя переменной должно быть описательным и не слишком коротким.

Вы можете использовать это, чтобы избежать таких коротких имен:

my_list.extend(x_values)

Или настройте конфигурацию PyLint, чтобы указать PyLint, какие имена переменных подходят.

Немного подробнее о том, что заметил Алекс Герни: вы можете указать PyLint, чтобы он делал исключения для имен переменных, которые (вы ругаетесь) совершенно ясны, даже если меньше трех символов. Найдите или добавьте в свой файл pylintrc под [FORMAT]заголовком:

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

Здесь pk (для первичного ключа), x и y - добавленные мной имена переменных.

В строго типизированных языках переменные имени из одной буквы могут быть нормальными, потому что вы обычно получаете тип рядом с именем в объявлении переменной или в прототипе функции / метода:

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

В Python вы не получите эту информацию, поэтому, если вы напишете:

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

вы не оставляете команде обслуживания абсолютно никаких подсказок относительно того, что может делать функция, как она вызывается и что возвращает. Итак, в Python вы склонны использовать описательные имена:

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

и вы даже добавляете строку документации, объясняющую, что делает этот материал и какие типы ожидаются.

В настоящее время также есть возможность переопределить регулярное выражение. Т.е. если вы хотите разрешить одиночные символы в качестве переменных:

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

Таким образом, pylintбудет соответствовать PEP8 и не принесет дополнительных нарушений. Также вы можете добавить его в .pylintrc.

Глубинная причина в том , что вы , возможно , помните , что вы хотели a, b, c, x, y, и zиметь в виду , когда вы писали код, но когда другие читают его, или даже когда вы вернетесь в свой код, код становится гораздо более удобным для чтения , когда вы даете это семантическое имя. Мы не пишем что-то один раз на доске, а потом стираем. Мы пишем код, который может просуществовать десять или более лет и быть прочитанным много-много раз.

Используйте семантические имена. Семантические имена , которые я использовал, были , как ratio, denominator, obj_generator, pathи т.д. Это может занять дополнительное второе или два типа их, но время вы сэкономить , пытаясь выяснить , что вы написали , даже полчаса с тех пор так и стоит .