Рефакторинг кода в PyCharm
Рефакторинг кода — это процесс оптимизации внутренней структуры кода без изменения его внешнего поведения.
Цель рефакторинга — улучшить читаемость, сопровождаемость и расширяемость кода, а не добавлять новые функции или исправлять ошибки.
PyCharm предоставляет разработчикам Python мощный и безопасный набор инструментов автоматизированного рефакторинга, делая рефакторинг эффективным и менее подверженным ошибкам.
Краткий обзор распространённых операций рефакторинга
Ниже приведена сравнительная таблица наиболее часто используемых операций рефакторинга и их сочетаний клавиш в PyCharm.
| Операция рефакторинга | Горячая клавиша | Описание |
|---|---|---|
| Переименовать | Shift + F6 | Переименование таких символов, как переменные, функции, классы и файлы, с автоматическим обновлением всех ссылок |
| Извлечь переменную | Ctrl + Alt + V | Извлечь выбранное выражение в переменную |
| Извлечение метода | Ctrl + Alt + M | Извлечь выбранный блок кода в отдельный метод или функцию |
| Извлечь константу | Ctrl + Alt + C | Извлечь выбранный литерал в константу |
| Встроенный | Ctrl + Alt + N | Встроить переменные, методы или константы, чтобы устранить ненужные промежуточные слои |
| Изменить сигнатуру | Ctrl + F6 | Изменить сигнатуру функции или метода, включая имена параметров, типы, значения по умолчанию и порядок |
Приведённые выше сочетания клавиш основаны на стандартных назначениях клавиш для Windows/Linux. Пользователям macOS следует заменить Ctrl на Command, а Alt на Option.
Практика: переименование переменных
Переименование — наиболее частая операция рефакторинга. Ниже показан полный процесс переименования на конкретном примере.
Предположим, у нас есть фрагмент кода, который вычисляет скорость объекта, где имя переменнойspeedнедостаточно точное и его нужно изменить наvelocity。
Исходный код до рефакторинга
Пример
def calculate_motion(distance, time):
speed = distance / time # 'speed' больше склоняется к темпу, тогда как 'velocity' подчёркивает векторную скорость
return speed
result = calculate_motion(100, 10)
print(result)
Шаги
- Поместите курсор на имя переменнойspeed.
- Нажмите сочетание клавишShift + F6, PyCharm выделит все ссылки на переменную.
- Просто введите новое имяvelocity, и PyCharm в реальном времени покажет все места, которые будут изменены.
- НажмитеEnterдля подтверждения, и все ссылки обновятся синхронно.
Либо можно дважды щёлкнуть, чтобы выделить переменную, затем щёлкнуть правой кнопкой мыши, выбрать Рефакторинг в контекстном меню, а затем Переименовать:

Переименование во всплывающем окне:

Отрефакторенный код
Пример
def calculate_motion(distance, time):
velocity = distance / time # Имя переменной было изменено с 'speed' на 'velocity'
return velocity
result = calculate_motion(100, 10)
print(result)

Рефакторинг переименования в PyCharm ищет ссылки по всему проекту, включая ссылки в комментариях и строках, гарантируя, что ничего не будет пропущено.
Вызов меню рефакторинга одним щелчком
Если вы не помните сочетания клавиш для различных операций рефакторинга, можно использовать универсальное сочетаниеCtrl + Alt + Shift + T(для macOS:Command + Option + Shift + T), чтобы вызвать меню рефакторинга.
В этом меню перечислены все операции рефакторинга, доступные в текущей позиции курсора; вам просто нужно выбрать нужную из меню.
Этот подход подходит для редко используемых операций рефакторинга или как переходное решение для начинающих.
Функция предварительного просмотра перед рефакторингом
Перед выполнением рефакторинга PyCharm предоставляет функцию предварительного просмотраPreview, позволяющую полностью понять область влияния рефакторинга до подтверждения.
Когда вы нажимаете сочетание клавиш для рефакторинга, PyCharm открывает диалоговое окно, содержащее кнопкуPreview.
Нажмите кнопку Preview, и PyCharm откроет окно сравнения внизу: исходный код слева, изменённый код справа.
Вы можете просмотреть каждое изменение по очереди, решить, сохранить его или пропустить, и после подтверждения, что всё правильно, нажатьDo Refactor, чтобы выполнить рефакторинг.
Настоятельно рекомендуется использовать функцию Preview при рефакторинге крупных проектов или основных модулей, чтобы избежать ошибок, вызванных непреднамеренными изменениями.
Что следует учитывать при рефакторинге
Хотя инструменты рефакторинга PyCharm очень надёжны, при рефакторинге всё равно нужно обращать внимание на следующие моменты.
- Перед рефакторингом убедитесь, что код был зафиксирован в системе контроля версий, чтобы можно было откатиться, если произойдёт что-то неожиданное.
- После рефакторинга немедленно запустите существующие модульные тесты, чтобы убедиться, что поведение не изменилось.
- Выполняйте только один тип рефакторинга за раз, чтобы избежать путаницы из-за изменения слишком многих вещей сразу.
- Если рефакторинг затрагивает публичный API, убедитесь, что все вызывающие стороны включены в область рефакторинга.
Освойте эти приёмы рефакторинга, и ваш код всегда будет оставаться чистым, понятным и лёгким в поддержке.
Другие расширения