Типичные улучшения

Для поиска по тегу начните название тега с символа '@'.

Улучшения, показаны 50 из 98.

Переместите создание переменных ближе к их использованию

Cоздание переменных ближе к месту их использования помогает улучшить читаемость кода, удобство сопровождения и даже …

Используйте UPPER_CASE для переменных окружения

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

Уточните название переменной

Названия переменных важны. Хорошее название подсказывает программисту, что лежит в переменной и какие методы можно …

Введите дополнительную переменную

Если результат вычислений отличается от исходных данных своим типом, то не стоит его класть в …

Используйте в названиях правильный регистр букв

Верхний и нижний регистр букв в названиях имеют значение. По ним программист узнает тип сущности: …

Расскажите в README о переменных окружения

Программа берет настройки из нестандартных переменных окружения. Их не угадать без чтения кода.

Покажите чем отличаются переменные

Если в программе для отправки писем вы встретите переменные `letter_begin`, `letter_middle` и `letter_end`, то наверняка …

Добавьте DB к названию переменной окружения

По названию переменной сложно догадаться, что речь идёт о настройках базы данных. Обычно используют префикс …

Уточните название переменной

Названия переменных важны. Хорошее название подсказывает программисту, что лежит в переменной и какие методы можно …

Соберите переменные окружения в settings.py

Когда другой программист захочет развернуть проект, то первым делом он пойдёт искать переменные окружения в …

Сделайте logger глобальной переменной

Обычно логер нужен сразу внутри многих функций, и, чтобы не вызывать `getLogger` много раз внутри …

Избегайте глаголов в названиях переменных

Названия функций принято начинать с глагола. Это правило облегчает чтение кода, делает текст программы похожим …

Перенесите загрузку переменных окружения внутрь ifmain / def main

Функция `load_dotenv` меняет настройки окружения, общие для всей программы. Такой код нельзя размещать на уровне …

Используйте в названиях правильный регистр букв

Верхний и нижний регистр букв в названиях имеют значение. По ним программист узнает тип сущности: …

Создать .env и использовать в docker-compose по назначению

Создать .env и использовать в docker-compose по назначению

Не путайте порядок слов в названиях

Названия переменных редко укладываются в одно слово, порой важно уточнить, что речь не о каком-то …

Дайте токену специфичное название

Со временем в дополнение к одному API может понадобиться подключение еще нескольких. У них каждого …

Отделите шаблон от остального кода

Если вы назвали переменную "шаблон письма", то пусть в ней лежит именно шаблон. Вы же …

Подберите точные названия

Когда код исполняет компьютер, ему не важны названия, можно хоть a,b,c,x,y использовать, он справится. Названия …

Выберите между ifmain и defmain

`def main` — это особая функция. Внутри нее держат код, который будет запущен при запуске …

Укажите все аргументы функции

Функция может получать настройки из нескольких источников: из полученных аргументов и из глобальных констант и …

Изолируйте функцию от внешнего окружения

С функциями, которые берут свои настройки из переменных окружения сложно работать. Прочитайте объявление такой функции …

Разрешите пользователю указать другой путь к файлу

Зачастую пользователи хранят данные отдельно от программ. И тогда либо программа позволит указать нестандартный путь …

Требуйте меньше настроек CLI

Сейчас ваш проект очень муторно разворачивается: вы **требуете** от пользователя прописать кучу настроек для первого …

Избавьтесь от my_...

Если эта переменная "ваша", то кто создавал остальные? :) Из-за этого префикса `my_` весь проект …

Отделите заголовки от шаблона

Когда вы пишете программу, нужно всё время думать о том, как ей будут пользоваться. Мало …

Оберните код в ifmain / def main

Ваш файл с кодом `script.py` можно использовать двумя способами: запустить напрямую или подключить в качестве …

Не путайте JSON и полученные оттуда данные

JSON — это текстовый формат данных, в Python он представляется в виде строки. Результат декодирования …

Спрячьте SECRET_KEY

В файле settings.py есть настройка `SECRET_KEY` — это секретный ключ, с помощью которого шифруют пароли …

Вынесите настройку DEBUG

В файле settings.py есть настройка `DEBUG`, она включает отладочный режим работы сайта. На локальной машине …

Замените термины с программистских на продуктовые

Во время написания документации стоит избегать терминов из прогаммирования, чтобы текст читался как можно проще. …

Очистите код от индексов

Обращение к данным по индексу `voice_record[1][0]` сильно осложняет код. Программисту приходится держать в голове структуру …

Избавьтесь от комментариев, дублирующих код

Лишние комментарии нагромождают код, в нем сложнее ориентироваться. К тому же, они усложняют поддержку кода …

Разрешите конфликт имен

В Python есть названия, занятые стандартными функциями и классами — `dict`, `list`, `range`. Python разрешает …

Избавьтесь от типов в названиях

Вся приятность системы типов в Питоне заключается в том, что мы не указываем типы. Благодаря …

Уберите числа из названий

Когда какое-то значение не меняется, хочется записать его в имя. Например, если вам всегда надо …

Вынесите конфиг из кода

На то есть сразу несколько причин. Во-первых, пользователи не хотят лезть в код. А во-вторых, …

Поправьте множественное число в названиях

Программист ориентируется в коде по названиям переменных. Если сначала вам встретится переменная `apples`, а в …

Почините настройку DEBUG

Любое непустое значение в переменной окружения включает отладочный режим, даже если это `DEBUG=FALSE`.

Разбейте функцию на части

Функции — это строительные блоки вашей программы. Они похожи на детали конструктора Lego — из …

Укажите related_name

Писать запросы к БД будет проще, если обратные связи сразу получат говорящие названия — `related_name`. …

Укажите related_name во множественном числе

Если `related_name` указан в единственном числе, то запросы с его участием выглядят очень странно. Проблема …

Выделите вставки кода в документации

Названия переменных, код и консольные команды внутри документации принято оформлять особым образом — как вставки …

Вынесите chat_id из кода

Сейчас настройка `chat_id` намертво зашита в скрипте и без правок в коде её никак не …

Распакуйте параметры функции

Функции созданы для того, чтобы ими пользоваться. А чтобы функцией пользоваться, надо выяснить какие данные …

Разбейте профиль на отдельные настройки

Профили настроек вроде `production`, `test` или `development` для настроек -- это хоть и популярная, но …

Возьмите настройки из django.conf.settings

Импорт настроек проекта напрямую из файла `settings.py` ломает механизм конфигурации Django. Проблем здесь сразу несколько. …