Слова-паразиты в названиях

В коде программ тоже встречаются слова-паразиты, как и в обычном тексте. Прячутся эти паразиты в названиях переменных и функций.

data

Невероятно, но факт. Данные хранятся почти в каждой переменной любой программы написанной за последние полвека! Поэтому слово data в названии не сообщит программисту ничего нового и ничего полезного. Зато оно замусорит код, удлинит названия и усложнит чтение программы.

Та же ситуация с функциями. Если функция что-то вернёт, то почти наверняка это будут данные. Указывать data в названии не надо.

info

Ещё одна вариация на тему данных. Слово info не так сильно заезженно как data, но полезнее от этого не становится.

object

В Python всё есть объект. Буквально всё. Нет, я серьезно, ВСЁ является объектом: числа, строки, функции и даже импортированные модули. Единственная ситуация, в которой вам стоит использовать слово object — это когда вы понятия не имеете с чем работаете. Если вы не разрабатываете новый фреймворк, а пишете обычную программу, то вам точно следует избегать object в названиях переменных и функций.

item

Переменная item часто встречается в циклах. Очевидно, что итерируя по списку вы будете работать с отдельными его элементам, то есть c item. Это настолько очевидно, что теряет всякий смысл указывать это в названии. С тем же успехом можно было назвать переменную x или y, меньше бы смысла не стало.

key/value

То же самое, что и с предыдущими. Куда удобнее, когда вместо абстрактных “ключа” и “значения” вы работаете с конкретными объектами:

capitals = {
    "Россия": "Москва",
    ...
}

for key, value in capitals.items():
    pass

# Так куда понятнее:

for country, capital in capitals.items():
    pass

result

Понятно, результат работы какого-то кода. А что внутри этого результата? Сравните две записи:

return online_users

return result

В первом случае сразу понятно: функция вернёт пользователей, которые онлайн. Во втором она вернёт неведомый “результат”.