Refactorisation du code PyCharm

La refactorisation de code est le processus d'optimisation de la structure interne du code sans modifier son comportement externe.

Le but de la refactorisation est d'améliorer la lisibilité, la maintenabilité et l'extensibilité du code, plutôt que d'ajouter de nouvelles fonctionnalités ou de corriger des bogues.

PyCharm fournit aux développeurs Python un ensemble puissant et sûr d'outils de refactorisation automatisée, ce qui rend la refactorisation efficace et moins sujette aux erreurs.


Aperçu rapide des opérations de refactorisation courantes

Voici un tableau comparatif des opérations de refactorisation les plus couramment utilisées et de leurs raccourcis clavier dans PyCharm.

Opération de refactorisation Raccourci Description
Renommer Shift + F6 Renommer des symboles tels que les variables, les fonctions, les classes et les fichiers, en mettant automatiquement à jour toutes les références
Extraire la variable Ctrl + Alt + V Extraire l'expression sélectionnée dans une variable
Extraire la méthode Ctrl + Alt + M Extraire le bloc de code sélectionné dans une méthode ou une fonction distincte
Extraire une constante Ctrl + Alt + C Extraire le littéral sélectionné dans une constante
En ligne Ctrl + Alt + N Développer en ligne les variables, les méthodes ou les constantes afin d'éliminer les couches intermédiaires inutiles
Modifier la signature Ctrl + F6 Modifier la signature d'une fonction ou d'une méthode, y compris les noms des paramètres, les types, les valeurs par défaut et l'ordre

Les raccourcis ci-dessus sont basés sur les mappages de touches par défaut pour Windows/Linux. Les utilisateurs de macOS doivent remplacer Ctrl par Command et Alt par Option.


Exercice pratique : Renommer les variables

Le renommage est l'opération de refactorisation la plus fréquente. Ci-dessous, un processus complet de renommage illustré par un exemple concret.

Supposons que nous ayons un morceau de code qui calcule la vitesse d'un objet, où le nom de la variablespeedn'est pas suffisamment précis et doit être remplacé parvelocity。

Code original avant refactorisation

Exemple

# Code d'origine : le nom de la variable 'speed' n'est pas suffisamment précis d'un point de vue sémantique
def calculate_motion(distance, time):
    speed = distance / time  # 'speed' tend davantage vers la notion de taux, tandis que 'velocity' met l'accent sur la vitesse vectorielle
    return speed

result = calculate_motion(100, 10)
print(result)

Étapes

  1. Placez le curseur sur le nom de la variablespeed.
  2. Appuyez sur le raccourciShift + F6, PyCharm surlignera toutes les références à la variable.
  3. Saisissez directement le nouveau nomvelocity, PyCharm prévisualisera en temps réel tous les emplacements à modifier.
  4. Appuyez surEnterpour confirmer, et toutes les références sont mises à jour de manière synchrone.

Vous pouvez également double-cliquer pour sélectionner la variable, puis faire un clic droit, choisir Refactor dans le menu contextuel, puis Rename :

Rename dans la fenêtre contextuelle :

Code refactorisé

Exemple

# Code refactorisé : le nom de variable 'velocity' exprime plus précisément la signification de la vitesse vectorielle
def calculate_motion(distance, time):
    velocity = distance / time  # Le nom de variable a été renommé de 'speed' à 'velocity'
    return velocity

result = calculate_motion(100, 10)
print(result)
[/mycode4]

Le refactoring Rename de PyCharm recherche les références dans l'ensemble du projet, y compris les références dans les commentaires et les chaînes de caractères, afin de garantir que rien n'est manqué.


Afficher le menu de refactoring en un clic

Si vous ne vous souvenez pas des raccourcis pour les différentes opérations de refactoring, vous pouvez utiliser le raccourci universelCtrl + Alt + Shift + T(Pour macOS :Command + Option + Shift + T) pour afficher le menu de refactoring.

Ce menu répertorie toutes les opérations de refactoring disponibles à la position actuelle du curseur ; il vous suffit de sélectionner dans le menu.

Cette approche convient aux opérations de refactoring rarement utilisées, ou comme solution transitoire pour les débutants.


Fonctionnalité d'aperçu avant refactorisation

Avant d'exécuter une refactorisation, PyCharm fournit une fonctionnalité d'aperçuqui vous permet de comprendre pleinement la portée de l'impact de la refactorisation avant de confirmer.

Lorsque vous appuyez sur le raccourci de refactorisation, PyCharm affiche une boîte de dialogue qui contient un boutonAperçu.

Cliquez sur le bouton Aperçu, et PyCharm ouvrira une fenêtre de comparaison en bas, avec le code original à gauche et le code modifié à droite.

Vous pouvez examiner chaque modification une par une, décider de la conserver ou de la passer, et après avoir confirmé que tout est correct, cliquez surDo Refactorpour exécuter la refactorisation.

Il est fortement recommandé d'utiliser la fonctionnalité Aperçu lors de la refactorisation de grands projets ou de modules centraux, afin d'éviter les bogues causés par des modifications involontaires.


Considérations relatives à la refactorisation

Bien que les outils de refactorisation de PyCharm soient très fiables, vous devez tout de même faire attention aux points suivants lors d'une refactorisation.

  • Avant de refactoriser, assurez-vous que le code a été validé dans un système de gestion de versions afin de pouvoir revenir en arrière si quelque chose d'inattendu se produit.
  • Après la refactorisation, exécutez immédiatement les tests unitaires existants pour vous assurer que le comportement n'a pas changé.
  • N'effectuez qu'un seul type de refactorisation à la fois, afin d'éviter la confusion causée par la modification de trop de choses en même temps.
  • Si la refactorisation implique une API publique, assurez-vous que tous les appelants sont inclus dans la portée de la refactorisation.

Maîtrisez ces techniques de refactoring et votre code restera toujours propre, clair et facile à maintenir.

Autres extensions