Rivalry2

HTML Diff

0 added 0 removed

Original 2026-01-01

Modified 2026-02-21

1 <a>#База знаний</a>

2 <ul><li>25 май 2021</li>

3 <li>0</li>

4 </ul>Чтобы код оставался понятным, в нём регулярно надо убираться. Рассказываем, что и где прибирать.

5 Программист, консультант, специалист по документированию. Легко и доступно рассказывает о сложных вещах в программировании и дизайне.

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

7 Чтобы не допустить этого, при разработке периодически проводятрефакторинг - вносят изменения, которые делают код понятнее, но не меняют его функциональность.

8 Важно!Рефакторинг более эффективен и безопасен, когда пошаговые изменения проверяются запусками тестов.

9 Если вы только-только столкнулись с рефакторингом - сперва<a>прочтите эту статью</a>.

10 В языке Python есть много приёмов улучшения кода. Однако перед тем, как применять более сложные, нужно почистить код от накопившегося мусора.

11 Удаляйте закомментированные куски кода. Они сбивают с толку разработчиков, которые работают с исходниками после вас.

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

13 Это тоже мусор. Если они всего лишь помогали вам увидеть промежуточные результаты, то их следует удалить сразу после того, как вы разобрались в работе программы.

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

15 Не забудьте удалить из кода соответствующие команды импорта - обычно редакторы их подсвечивают. Так, в IDE<a>PyCharm</a>текст команды становится бледным и при компиляции выдаётся предупреждение "Unused import statement…".

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

17 Найти эти переменные легко - редакторы их подсвечивают, а при компиляции выдаётся предупреждение: "Variable is not used".

18 Например:

19 Здесь PyCharm выделяет серым и ненужный модуль os, и неиспользуемые переменные unused1 и unused2.

20 Проводя рефакторинг, важно оформить код так, чтобы его было удобно читать.

21 Создатель языка Python Гвидо ван Россум сказал: "Код читают гораздо чаще, чем пишут".

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

23 Гвидо ван Россум считал удобочитаемость одним из важнейших принципов языка Python. Поэтому вместе с соратниками разработалсвод рекомендаций по оформлению кода -<a>PEP 8</a>. Рассмотрим некоторые из них подробнее.

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

25 Например, имя переменной в выражении sc += 1 нам мало о чём говорит.

26 А если изменить его на score, то станет ясно, что речь идёт о счёте.

27 Есть два важнейших правила именования сущностей в Python - их нарушение вызывает ошибку:

28 <ul><li>имена могут состоять только из цифр, букв и знаков подчёркивания;</li>

29 <li>имя не может начинаться с цифры.</li>

30 </ul>PEP 8<a>предписывает</a>задавать имена определённым образом:

31 <ul><li>Имена функций и модулей пишутся строчными буквами. Они могут состоять из одного или нескольких слов, которые разделяются подчёркиванием (например: function, my_function).</li>

32 <li>Имена переменных тоже задаются в нижнем регистре. Они могут состоять из одной буквы, слова или нескольких слов. Слова в составе имени тоже разделяются подчёркиванием: x, variable, my_var.</li>

33 <li>Название константы задаётся символом, словом или несколькими словами в верхнем регистре. Слова в составе имени разделяются знаком подчёркивания.Например:

34 C, CONST, MY_CONST.</li>

35 <li>Имена классов состоят из одного (Class) или нескольких слов (MyClass) без разделителей.Во втором случае, как вы заметили, каждое слово начинается с прописной буквы. Такой стиль называетсяCamelCase("верблюжий стиль").

36 </li>

37 <li>Имена модулей задаются в нижнем регистре. Они не должны быть длинными. Знак подчёркивания уместен, если с ним имя модуля читабельнее, а его назначение понятнее.Например:

38 pyclbr, py_compile.</li>

39 </ul><ul></ul>PEP 8 описывает и <a>принципы оформления кода</a>:

40 <ul><li>как отделять функции и классы от остального текста;</li>

41 <li>какой должна быть максимальная длина строки, как правильно разбивать длинные строки;</li>

42 <li>какими должны быть отступы;</li>

43 <li>где ставить пробелы в выражениях и утверждениях</li>

44 <li>и другие.</li>

45 </ul>Обнаружить ошибки форматирования помогают специальные программы -линтеры. Они анализируют код и выдают предупреждения, например:

46 Здесьлинтер flake8в PyCharm выдаёт предупреждения о лишних пробелах внутри скобок и перед ними.

47 Для разных языков программирования есть свои линтеры. Например, для HTML - Beautify, для JavaScript - JSLint и так далее.

48 Популярные линтеры для Python:

49 <ul><li><a>Pycodestyle</a>,</li>

50 <li><a>Pyflakes</a>,</li>

51 <li><a>Pylint</a>,</li>

52 <li><a>Flake8</a>.</li>

53 </ul>Все они легко интегрируются в среды разработки. А самым умным считаетсяpylint. Он проверяет:

54 <ul><li>все ли подключённые модули используются в программе;</li>

55 <li>есть ли лишние переменные;</li>

56 <li>не превышает ли длина строк 79 символов;</li>

57 <li>правильно ли заданы имена;</li>

58 <li>верно ли используются аргументы;</li>

59 <li>есть ли синтаксические ошибки;</li>

60 <li>как используются типы данных</li>

61 <li>и многое другое.</li>

62 </ul>Обнаруженные ошибки можно исправить вручную или с помощью утилит для форматирования кода -форматтеров, которые совместимы с IDE PyCharm или Visual Studio.

63 Популярные форматтеры:

64 <ul><li><a>Autopep8</a>,</li>

65 <li><a>YAPF</a>,</li>

66 <li><a>Black</a>.</li>

67 </ul>Если похожие участки кода (или делающий то же самое код) встречаются в нескольких местах программы, это и есть дублирование.

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

69 А ещё повторами часто грешат начинающие программисты. Они видят в проекте почти такой же код, как нужен им, и копируют его в другое место, немного изменив. Это приводит к проблемам:

70 <ul><li>Возникают куски одинакового текста, различающиеся лишь некоторыми строками или символами - и не сразу понятно какими. Это затрудняет понимание программы.</li>

71 <li>Текст программы раздувается, в нём труднее разобраться.</li>

72 <li>Когда нужно менять функциональность, за которую отвечает дублирующийся код, изменения приходится вносить сразу во много мест программы. Это чревато ошибками.</li>

73 </ul>Чтобы избавиться от дублирования, применяют приём рефакторинга "извлечение метода": дублирующийся участок выносят в отдельный метод или функцию и везде заменяют вызовом этого метода/функции.

74 Рассмотрим на примере:

75 while True : a1 = int(input( "Введите цену товара: ")) if a1 < 0 : print ("Значение не должно быть отрицательным!") else : break while True : a2 = int(input("Введите количество товара: ")) if a2 < 0 : print ("Значение не должно быть отрицательным!") else : break a3 = a1 * a2 print("Стоимость товара: ", a3)Этот код явно нуждается в рефакторинге. И вот почему:

76 <ul><li>два блока выполняют практически одинаковые действия;</li>

77 <li>названия переменных a1, a2, a3 не говорят об их предназначении.</li>

78 </ul>Мы видим в коде два блока, которые отличаются только сообщениями пользователю: "Введите цену товара: " и "Введите количество товара: ".

79 Такое дублирование - это плохо:

80 <ul><li>Например, поменялись бизнес-правила: нас больше не интересуют товары с нулевой стоимостью. И нужно поставить условие: количество и цена должны быть больше нуля. Нам придётся вносить изменения в оба блока кода.</li>

81 <li>Или мы захотим, скажем, добавить в расчёт стоимости скидку/наценку. Тогда нам придётся создать ещё один похожий блок с новым сообщением: "Введите процент скидки (или наценки) на товар: ". А потом ещё один и ещё. Код быстро разрастётся.</li>

82 </ul>Чтобы упростить код, преобразуем цикл while в функцию, а сообщения для пользователя будем передавать в неё как аргументы. Назовём функцию input_value() ("ввод значения"), добавим в неё команду return a1 и уберём break.

83 Вот что у нас выйдет:

84 def input_value() : while True : a1 = int (input("Введите цену товара: ")) if a1 < 0 : print ("Значение не должно быть отрицательным!") else : return a1Чтобы сообщать пользователю, что вводить (цену, количество товара и так далее), вместо приглашения "Введите цену товара: " добавим параметр функции и назовём его prompt ("подсказка").

85 Вот что получится:

86 def input_value(prompt): while True: a1 = int(input(prompt)) if a1 < 0 : print ("Значение не должно быть отрицательным!") else : return a1Теперь заменим одинаковые блоки кода вызовами функции с соответствующими значениями параметра. Сразу же дадим переменным новые, осмысленные имена: value, price, quantity, cost.

87 Исправленный код будет выглядеть так:

88 def input_value(prompt): while True: value = int( input( prompt ) ) if value < 0 : print ("Значение не должно быть отрицательным!") else : return value price = input_value("Введите цену товара: ") quantity = input_value("Введите количество товара: ") cost = price * quantity print("Стоимость товара: ", cost)Переменная cost не используется в дальнейших вычислениях: она всего лишь хранит результат подсчёта стоимости товара для передачи его в качестве аргумента функции print().

89 Поэтому переменную cost можно смело убирать, а в print () передавать выражение price * quantity. Это сократит код, улучшит читабельность и уменьшит используемые ресурсы:

90 def input_value(prompt): while True: value = int( input( prompt ) ) if value < 0 : print ("Значение не должно быть отрицательным!") else : return value price = input_value ("Введите цену товара: ") quantity = input_value ("Введите количество товара: ") print ("Стоимость товара: ", price * quantity)Важно!Иногда временные переменные вовсе не бесполезны. Например, когда они служат для кэширования - хранят результат затратной, ресурсоёмкой или длительной операции, который при работе программы используется несколько раз.

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

92 В результате рефакторинга:

93 <ul><li>мы убрали дублирующийся код,</li>

94 <li>дали переменным осмысленные имена,</li>

95 <li>вынесли ввод и проверку значений в отдельную функцию.</li>

96 </ul>Программа стала короче, нагляднее и вдобавок универсальнее. Например, теперь легко добавить скидку в расчёт стоимости товара:

97 def input_value(prompt): while True: value = int( input( prompt ) ) if value < 0 : print ("Значение не должно быть отрицательным!") else : return value price = input_value ("Введите цену товара: ") quantity = input_value ("Введите количество товара: ") discount = input_value ("Введите процент скидки: ") print ("Стоимость товара: ", price * quantity * (1 - discount/100))Рефакторинг не ограничивается чисткой кода и улучшением его структуры. Python - язык гибкий, одну и ту же операцию позволяет реализовать по-разному.

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

99 Рассмотрим несколько простых приёмов рефакторинга, которые позволяют уменьшить объём кода.

100 Для создания списков, словарей и множеств в языке Python часто применяют генераторы. Один из практикуемых приёмов рефакторинга - заменить таким генератором цикл for. Код сокращается, становится нагляднее, к тому же работает быстрее.

101 Пример первый

102 Есть список из нескольких чисел. Нам нужно получить список квадратов этих чисел.

103 Реализация с использованием цикла:

104 spisok = [1, 25, 44, 213, 14, 27, 56, 8] square_spisok = [] for item in spisok: square_spisok.append(item**2) print(square_spisok) --OUTPUT> [1, 625, 1936, 45369, 196, 729, 3136, 64]После рефакторинга с переходом к генератору:

105 spisok = [1, 25, 44, 213, 14, 27, 56, 8] square_spisok = [item**2 for item in spisok] print(square_spisok) --OUTPUT> [1, 625, 1936, 45369, 196, 729, 3136, 64]Пример второй

106 Вычисление суммы двух матриц. С циклами реализация выглядит так:

107 a = [[1, 2, 3], [11,12,13], [21,22,23], [31,32,33]] b = [[41, 42, 43], [51,52,53], [61,62,63], [71,72,73]] summa_a_b = [[0,0,0], [0,0,0], [0,0,0], [0,0,0]] for i in range(len(a)): for j in range(len(a[0])): summa_a_b[i][j] = a[i][j] + b[i][j] print(summa_a_b) --OUTPUT> [[42, 44, 46], [62, 64, 66], [82, 84, 86], [102, 104, 106]]Заменим цикл генератором списка:

108 a = [[1, 2, 3], [11,12,13], [21,22,23], [31,32,33]] b = [[41, 42, 43], [51,52,53], [61,62,63], [71,72,73]] summa_a_b = [[a[i][j] + b[i][j] for j in range(len(a[0]))] for i in range(len(a))] print(summa_a_b) --OUTPUT> [[42, 44, 46], [62, 64, 66], [82, 84, 86], [102, 104, 106]]После рефакторинга код стал короче.

109 Почти в каждой программе приходится совершать операции над всеми элементами контейнерных типов данных: списков, словарей, кортежей.

110 Иногда для этого создают переменную-счётчик и с её помощью перебирают элементы в цикле for, например:

111 spisok = [154,127,98,89,77,55,32,14] for i in range(len(spisok)): print(i + 1, spisok[i]) --OUTPUT> 1 154 2 127 3 98 4 89 5 77 6 55 7 32 8 14Получается, что программа перебирает не элементы списка, а значения переменной i, и каждый раз ищет нужный элемент. В сложных циклах это может привести к ошибкам. Кроме того, чтобы вывести на печать нумерованный список, в функции print() приходится прибавлять единицу к переменной i.

112 Можно улучшить код - использовать функцию enumerate(), которая перебирает элементы контейнера без промежуточной переменной. У этой функции два аргумента: переменная контейнерного типа (spisok) и начальное значение счёта (переменная i). Зададим второму аргументу значение 1, чтобы счёт начинался с единицы.

113 После рефакторинга код будет выглядеть так:

114 spisok = [154,127,98,89,77] for i, spisok in enumerate(spisok, 1): print(i, spisok) --OUTPUT> 1 154 2 127 3 98 4 89 5 77Если переменная принимает разные значения в зависимости от того, выполняется или нет какое-то условие, то условный оператор if…else можно заменить тернарным выражением.

115 Рассмотрим пример:

116 def even_odd(number): if number % 2 == 0: state = "Even" else: state = "Odd" return state print(even_odd(128))Заменим условие тернарным выражением:

117 def even_odd(number): return "Even" if number % 2 == 0 else "Odd"Код стал короче и проще. Но у этого приёма есть ограничения - его стоит применять только к простым условным выражениям. В результате рефакторинга не должны появляться вложенные тернарные операторы, потому что их очень сложно читать.

118 Например:

119 def f_if_else(x,y): if (x==1): if(y==2): return 1 else: return 2 else: if(y==3): return 3 else: return 4Если в функции выше заменить условное выражение тернарным оператором, то в результате получим:

120 def f_nested_if_else(x,y): return ((1) if (y == 2) else (2)) if (x == 1) else ((3) if (y == 3) else (4))Код стал короче, но разобраться в нём теперь намного сложнее.

121 Присвоить значение сразу нескольким переменным в Python можно одной строкой.

122 Пользоваться этой возможностью надо аккуратно - не усложнять понимание программы. Чтобы не запутаться, в одну строку объявляют переменные, которые связаны по смыслу.

123 Пример первый

124 name1 = 'Аня' name2 = 'Катя' name3 = 'Антон' name4 = 'Света'Эти переменные можно объявить в одной строке. И код станет короче:

125 name1,name2,name3,name4 = 'Аня', 'Катя', 'Антон', 'Света'Пример второй

126 Иногда переменным нужно присвоить диапазон значений:

127 one = 1 two = 2 three = 3 four = 4 print(' one is',one,'\n', 'two is', two, '\n', 'three is', three, '\n', 'four is', four) --OUTPUT> one is 1 two is 2 three is 3 four is 4В этом случае Python позволяет использовать множественное присваивание совместно с функцией range():

128 one, two, three, four = range(1,5) print(' one is',one,'\n', 'two is', two, '\n', 'three is', three, '\n', 'four is', four)Предположим, у нас есть два списка: первый - с именами друзей, а второй - это города, где они живут. Нужно объединить элементы списков в словарь вида "имя: город".

129 Это можно сделать с помощью цикла for:

130 friends = ["Катя", "Лена", "Даша", "Костя", "Дима"] cities = ["Москва", "Пенза", "Екатеринбург", "Минск"] friends_cities = {} for i in range(min(len(friends), len(cities))): friends_cities[friends[i]] = cities[i] print(friends_cities) --OUTPUT> {'Катя': 'Москва', 'Лена': 'Пенза', 'Даша': 'Екатеринбург', 'Костя': 'Минск'}Однако в Python встроена функция zip, которая делает то же самое - короче и проще.

131 Её аргументами могут быть списки, кортежи, множества и словари. Функция zip возвращает итератор, объединяющий элементы из объектов-источников.

132 Например, передадим в zip аргументами строку, список и множество:

133 arg1 = 'абвгдеж' arg2 = ['1','2','3','4','5'] arg3 = {'!','@','#','$','%','^'} zip_obj = zip(arg1, arg2, arg3) print(zip_obj) for i in zip_obj: print(i) --OUTPUT> <zip object at 0x000001D228F06BC0> ('а', '1', '!') ('б', '2', '@') ('в', '3', '#') ('г', '4', '$') ('д', '5', '%')В результате получим массив кортежей, каждый из которых содержит по одному элементу из каждого аргумента.

134 Теперь создадим словарь "имя: город" с использованием zip. Код будет выглядеть так:

135 friends = ["Катя", "Лена", "Даша", "Костя", "Дима"] cities = ["Москва", "Пенза", "Екатеринбург", "Минск"] friends_cities = dict(zip(friends, cities)) print(friends_cities) --OUTPUT> {'Катя': 'Москва', 'Лена': 'Пенза', 'Даша': 'Екатеринбург', 'Костя': 'Минск'}Функция zip работает до тех пор, пока не закончатся элементы в самом коротком из итерируемых объектов-аргументов.

136 Если нужно ориентироваться на самый длинный список, то используют функцию zip_longest из модуля itertools:

137 from itertools import zip_longest friends = ["Катя", "Лена", "Даша", "Костя", "Дима"] cities = ["Москва", "Пенза", "Екатеринбург", "Минск"] friends_cities = dict(zip_longest(friends, cities)) print(friends_cities) --OUTPUT> {'Катя': 'Москва', 'Лена': 'Пенза', 'Даша': 'Екатеринбург', 'Костя': 'Минск', 'Дима': None}В среде разработки приложений<a>PyCharm</a>есть инструменты, которые помогают проводить рефакторинг. Они доступны через пунктRefactorглавного меню. Научимся улучшать код с их помощью.

138 ОткрываемIDEи устанавливаем параметры рефакторинга в настройках редактора (File | Settings | Editor | Code Editing) в разделеRefactorings.

139 Если мы выберем режимIn modal dialogs(во всплывающих окнах), то при использовании инструментовExtract/Introduceредактирование имён параметров, констант, полей и переменных будет происходить в открывающихся модальных окнах:

140 Если же мы предпочтём режимIn the editor(в редакторе), то имена параметров, констант, полей и переменных будем редактировать прямо в редакторе:

141 Для примера установимIn modal dialogs.

142 Теперь создадим в окне редактора новый проект (File | New Project) с именемrefactorProject. Добавим в него новый файл (File | New | Python File), а назовём его, скажем,refactor.py.

143 Разберём извлечение метода в PyCharm на одном из наших примеров:

144 while True : a1 = int(input( "Введите цену товара: ")) if a1 < 0 : print ("Значение не должно быть отрицательным!") else : break while True : a2 = int(input("Введите количество товара: ")) if a2 < 0 : print ("Значение не должно быть отрицательным!") else : break a3 = a1 * a2 print("Стоимость товара: ", a3)Копируем этот код в окно редактора:

145 Выделим первый цикл while и используем инструментRefactor | Extract/Introduce | Methodиз главного или контекстного меню (горячие клавишиCtrl + Alt + M).

146 В нужное поле открывшегося окна вводим название функции - input_value ():

147 Чтобы добавить параметр функции, выделим подсказку "Введите стоимость товара: " и выберем в главном/контекстном меню инструментRefactor | Introduce Parameter(Ctrl + Alt + P):

148 В появившемся модальном окне введём название параметра - prompt (в переводе с английского - "подсказка"):

149 У нас получилось:

150 def input_value(prompt): while True: a1 = int(input(prompt)) if a1 < 0 : print ("Значение не должно быть отрицательным!") else : return a1Заменим название переменной a1 на value с помощью инструмента рефакторинга "Переименование". Выделим a1 и выберемRefactor | Rename(Shift + F6):

151 Дадим новым переменным осмысленные имена: price, quantity, cost.

152 Теперь заменим дубли в нашем коде на вызовы функции с соответствующими значениями параметров. Исправленный код будет выглядеть так:

153 def input_value(prompt): while True: value = int( input( prompt ) ) if value < 0 : print ("Значение не должно быть отрицательным!") else : return value price = input_value("Введите цену товара: ") quantity = input_value("Введите количество товара: ") cost = price * quantity print("Стоимость товара: ", cost)Как мы помним, переменной cost присваивается результат простого выражения (price * quantity) и больше с ней ничего не делается.

154 Поэтому нам можно от неё избавиться - заменить обращения к этой переменной выражением price * quantity. Сделаем это с помощью инструментов рефакторинга.

155 Выделим переменную cost и выберем в менюRefactorинструментInline("Встраивание") или вызовем его горячими клавишамиCtrl + Alt + N.

156 PyCharmопределит число вхождений и попросит подтвердить действие:

157 Нажимаем OK. Программа убирает выражение, в котором создаётся переменная cost, и везде подставляет вместо неё price * quantity:

158 def input_value(prompt): while True: value = int( input( prompt ) ) if value < 0 : print ("Значение не должно быть отрицательным!") else : return value price = input_value ("Введите цену товара: ") quantity = input_value ("Введите количество товара: ") print ("Стоимость товара: ", price * quantity)Чем объёмнее код, тем выгоднее применять инструменты рефакторинга. С ними уборка в коде ускоряется и ошибки сводятся к минимуму.

159 Мы рассмотрели лишь несколько приёмов рефакторинга - в Python их намного больше. Будучи быстрыми и несложными, вместе они здорово повышают качество проекта. Главное - проводить рефакторинг регулярно и не забывать затем тестировать приложение.

160 <a>Бесплатный курс по Python ➞Мини-курс для новичков и для опытных кодеров. 4 крутых проекта в портфолио, живое общение со спикером. Кликните и узнайте, чему можно научиться на курсе. Смотреть программу</a>