Ну что, решений в комментах к прошлому посту скинули немало, пора их разобрать. Но сначала небольшое отступление.

Очень радует, когда люди не только отправляют свой код, но и помогают другим увидеть ошибки. Добавить бы ещё активных срачей, и будет совсем огонь :) Так что не стесняйтесь, обсуждайте решения других участников, для этого мы все здесь и собираемся.

Общие ошибки

Как и ожидалось, у многих встречаются одни и те же ошибки. В разном виде, в разном контексте, но суть одна и та же.

Их можно разделить на 2 группы:

- нейминг (названия объектов);

- структура/компоновка кода внутри функции.

В этом посте разберу компоновку, а в следующей серии подробнее расскажу про нейминг. Погнали :)

if/else в одну строку

@Amplicon, @kashinec, достаточно неплохие решения.

Малину немного попортило стремление впихнуть невпихуемое, а именно - записать тело `if/else` в одну строку.

Делать так категорически не рекомендуется. Против этого выступает как PEP8, так и Google Style Guide. Просто переносите тело на новую строку, даже если оно небольшое. Это выглядит гораздо красивее и читабельнее.

Пробелы

Почитать о том, как правильно использовать пробелы, можно по тем же ссылкам, что уже давались выше. Неверно расставленные пробелы в коде-  это  то же самое  ,  что и  невернорасставленныепробелывтексте. Они усложняют чтение.

Лишние слои

Следующая распространённая ошибка - это заворачивание куска кода в ненужный `if` или `else`. @DavidSarif, @Nikydzman, вы в телевизоре.

Ту же самую логику можно реализовать так:

Вместо того, чтобы использовать `if - pass` или `if - continue`, можно просто инвертировать условие, и код станет проще и линейнее.

Также стоит помнить о том, что `raise` и `return` прерывают выполнение, поэтому добавление `else` после `return` уже излишне.

P.S. Долго думал, разбирать ли код Nikydzman или нет, потому что он ЕДИНСТВЕННЫЙ НЕ ПОДПИСАЛСЯ 😈, но решил всё-таки разобрать, потому что он идеально иллюстрирует ситуацию с лишними слоями. Во второй раз такой халявы уже не будет)

Декомпозиция задачи

Отдельно отмечу решение @DarkPavlov. Дело в том, что он разбил большую задачу на отдельные функции. Это очень хороший подход, который значительно упрощает отладку и тестирование программы.

Сейчас выглядит довольно громоздко, но если убрать лишние слои `if/else`, то получается уже так:

Конечно, декомпозиция здесь выполнена не совсем верно, потому что однотипные действия выполняются несколько раз, и каждый раз перебирается вся исходная коллекция. Но такие вопросы рассмотрим уже в следующих постах, это отдельная большая тема.

UPD: Скорость выполнения кода

По совету @kashinec добавил результаты замеров скорости. Средние значения за 100 000 итераций, измеряются в микросекундах:

kashinec: 1.10

Nikydzman: 1.38

AnimalPy: 1.66

NuVasche: 1.79

Amplicon: 1.83

DavidSarif: 2.09

Mirakonda: 2.59

DarkPavlov: 3.24

budu.krokodit: 4.07

HaneLeiko: - (код не в виде функции)

Если кого-то забыл - прошу простить. Измерить можно самостоятельно с помощью модуля `timeit`. Абсолютная точность не гарантируется, на результаты могут повлиять разные факторы.

Что дальше?

Вчера много думал над тем, как правильно организовать выпуск постов, и пришёл к следующему варианту.

- раз в неделю буду публиковать очередную серию сериала "Чистый код" и задание. Тему буду выбирать исходя из ошибок, которые обнаружились в прошлой серии, но если вам интересен какой-то конкретный вопрос, то обозначьте его в комментарии. Если коммент заплюсуют, то можно будет рассмотреть этот вопрос в отдельном посте;

- спустя 1-2 дня после этого буду публиковать разбор задания. Пауза в 1-2 дня нужна для того, чтобы все успели почитать и написать код;

- спустя ещё пару дней буду выкладывать "прикладной" пост, в котором буду рассматривать какие-нибудь интересные фишки или давать полноценные идеи проектов для практики.

Таким образом, каждую неделю - новая итерация цикла. От таки дела :) Надеюсь, вам зайдёт.

Эта серия постов создаётся для тех, кто учится программировать на Python. А точнее для тех, кто хочет заниматься разработкой за деньги, а не просто для развлечения.

Первые посты будут предназначены для полных новичков, которые пока что знакомы лишь с самыми основами. Чем дальше, тем более сложные и интересные ситуации будут рассматриваться.

Чистый код

Есть навык, который нельзя развить с помощью книг или видеоуроков - это навык написания чистого и понятного кода. Чистым называется код, в котором:

- задачи правильно декомпозированы;

- отсутствует избыточность и дублирование;

- каждый класс и каждая функция отвечает за максимально узкий спектр задач, то есть классы и функции не являются божественными;

- для всех объектов подобраны хорошие, говорящие имена;

- соблюдаются стандарты, принятые в сообществе разработчиков в целом и в конкретной команде в частности. PEP8, Google Style Guide и прочие.

Зачем нужен чистый код?

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

Но если вы создаёте проект, который в дальнейшем будет активно развиваться, то лучше заранее позаботиться о том, чтобы в коде было легко разобраться. В любых более-менее живых проектах код читается гораздо больше раз, чем пишется.

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

Простейший пример

Есть задача: взять список и создать на его основе новый список, в котором все элементы будут удвоены. То есть из списка [1, 2, 3] нужно получить [2, 4, 6]. Решить эту задачу на Python можно разными способами.

Вариант №1: сделать всё "в лоб", перебрав исходный список по индексам. Для лучшего эффекта не будем использовать пустые строки и накосячим с отступами между оператором и операндами.

На C или подобных языках такой код вполне естественен. Но на Python его можно написать гораздо проще и лаконичнее.

Вариант №2: вместо ручного увеличения индекса воспользуемся встроенной функцией `range()`. Заодно поправим названия переменных и добавим пустую строку для разделения логических блоков кода.

Вариант №3: вообще не будем трогать индексы, а переберём исходный список поэлементно с помощью `for`.

Вариант №4: используем генератор списков.

Результат везде одинаковый, но читаемость кода в последнем варианте несравнимо лучше, чем в первом. И это лишь элементарный пример, простейшая операция по удвоению списка. В больших проектах возникают куда более сложные ситуации, и там разница между чистым кодом и "тяп-ляп" кодом становится ещё заметнее.

Сравниваем производительность

С помощью модуля `timeit` я замерил время выполнения кода в каждом из 4 вариантов. Исходный список `data` создал заранее, так как он используется без изменений в каждом варианте. Результаты следующие:

- Вариант №1: 573 наносекунды в среднем за 1 000 000 итераций;

- Вариант №2: 468 наносекунд в среднем за 1 000 000 итераций;

- Вариант №3: 257 наносекунд в среднем за 1 000 000 итераций;

- Вариант №4: 253 наносекунды в среднем за 1 000 000 итераций.

Самый короткий и наглядный вариант вдобавок оказался ещё и самым быстрым. Разница во времени выполнения кода между подходом "в лоб" и использованием генератора списков - в два с лишним раза.

Как научиться писать чистый код?

Есть 2 способа:

1. Учиться на своих ошибках. Написать хреновенький код, спустя некоторое время понять, что он непригоден для дальнейшего использования, погрустить и переделать. Повторять 100500 раз до тех пор, пока не начнёт получаться что-то нормальное;

2. Учиться на чужих ошибках. Этим я и предлагаю заняться прямо сейчас.

Ниже написана задача, которую вы можете решить и выложить своё решение в комментариях. Самые интересные решения я отдельно разберу в следующем посте.

ВАЖНО: не смотрите на чужие решения до того, как выложите своё. Суть именно в том, чтобы вы сначала попробовали сами решить задачу, и только потом сравнили свой код с тем, что получилось у остальных. Так вы сможете проанализировать свои ошибки и чему-то научиться. Если вы просто пробежитесь взглядом по чужим решениям, то в голове отложится гораздо меньше.

Задача

Создайте функцию, которая разобьёт IP-адрес на 4 октета. IP-адрес - это строка вида "127.0.0.1". Октет - это число от 0 до 255. Например, если передать в функцию строку "123.124.125.126", то она должна вернуть кортеж из 4 чисел: (123, 124, 125, 126). Если передать в неё некорректный IP-адрес, то должно возникнуть исключение ValueError.

Оформление решения

Код нужно представить в 2 форматах: изображение, сгенерированное на https://carbon.now.sh/, и текст, помещённый в цитату. Например:

print('Привет, мир!')

Это нужно для того, чтобы по решению можно было как пробежаться глазами прямо в посте, так и скопировать его к себе в IDE для экспериментов.

Если решение будет оформлено тяп-ляп, то по вполне понятным причинам я его разбирать не буду :) Да и остальные участники, скорее всего, тоже пропустят его. Поэтому, пожалуйста, уважайте других людей и оформляйте свой код качественно и аккуратно. Ссылки на внешние ресурсы также буду пропускать, тут уж извините. Только скриншот и код прямо в ленте комментариев.

Разбор интересных решений

Как уже говорилось выше, самые интересные решения я отдельно разберу в следующем посте. Будет ли это одно решение или несколько - ещё не знаю, зависит от трудозатрат на разбор.

Приоритет, естественно, буду отдавать подписчикам. Для меня подписка - это признак того, что человек заинтересован в следующих постах и гарантированно увидит разбор. Ну и в целом приятно, когда на тебя подписываются :)

Пробуйте, учитесь, становитесь лучше. По мере возможностей постараюсь помочь. Удачи!