L'une des meilleures choses sur open source logiciel est la possibilité de réutiliser le code d'autres personnes. La réutilisation du code vous permet de gagner du temps, de découvrir de nouvelles fonctionnalités et d’apprendre d’autres styles de programmation. Il existe deux façons principales de réutiliser le code :
-
**copier et coller un extrait de code directement dans votre projet.** Si vous débutez avec le codage, il s’agit du moyen le plus rapide de commencer à réutiliser du code. -
**Importer une bibliothèque dans votre projet.** Bien que cette approche prenne un certain temps pour apprendre, elle est finalement plus facile et plus efficace. Il s’agit également d’une compétence fondamentale pour le développement de logiciels.
Dans cet article, nous allons apprendre à la fois en suivant un exemple : réutiliser le code Python qui calcule la factorielle d'un nombre.
Utiliser des extraits de code d'autres personnes dans votre projet
Lorsque vous apprenez à coder, vous pouvez commencer par réutiliser le code en copiant et en collant des extraits de code d’autres développeurs dans votre projet. Il s’agit d’un excellent moyen de gagner du temps, mais vous devez toujours suivre quelques étapes clés avant de copier le code d’un autre développeur.
1. Recherche et compréhension d’un extrait de code
Tout d’abord, vous devez trouver et comprendre l’extrait de code que vous souhaitez réutiliser. Pour cet exemple, nous allons choisir le référentiel new2code/python-factorial.
Tout d'abord, ouvrezfactorial_finder.py, qui implémente la calculatrice en utilisant une boucle :
# Initialize the factorial result to 1
factorial = 1
# Initialize the input number to 6
number = 6
# Loop from 1 to number (inclusive) and multiply factorial by each number
for i in range(1, number + 1):
factorial *= i
print(f"The factorial of {number} is {factorial}")
Ensuite, dans la barre de menus en haut du fichier, cliquez pour démarrer une conversation avec Copilot.
Dans la fenêtre de conversation, demandez Copilot:
Explain this program.
Explain this program.
2. Présentation des licences de projet
Avant de pouvoir réutiliser le code que vous avez trouvé, vous devez comprendre ses licences. Les licences déterminent comment vous pouvez utiliser le code dans un projet, y compris votre capacité à copier, modifier et distribuer ce code.
Pour identifier la licence de new2code/python-factorial, localisez la section « À propos » sur la page principale du référentiel. Vous y verrez que le référentiel est sous licence MIT. Pour lire la licence, cliquez sur Licence MIT.
Nous voulons copier l’intégralité du fichier factorial_finder.py , de sorte que la licence MIT indique que nous devons inclure une copie de la licence dans notre propre projet. En haut de votre fichier Python, collez la licence en tant que commentaire.
Conseil
Vous pouvez découvrir ce qui est autorisé par d’autres licences courantes grâce à l’outil Choisir une licence.
3. Utilisation et modification d’extraits de code
Vous êtes maintenant prêt à coller l’extrait de code dans votre projet. Bien que vous puissiez parfois utiliser des extraits de code tels quels, vous aurez souvent besoin de les modifier pour votre cas d’utilisation spécifique. Passons maintenant à la pratique !
Supposons que nous voulions calculer rapidement les factorielles de 5, 7, 9 et 10. Au lieu de copier et coller l’ensemble du programme pour chaque nombre, nous pouvons déplacer notre calculatrice dans une fonction qui prend un nombre comme argument.
Permet Tchat Copilot de suggérer et d’expliquer une implémentation. Collez notre code actuel dans la fenêtre de conversation, suivi de ce prompt :
Wrap the Python code above in a function.
Wrap the Python code above in a function.
Copilot génère du code qui ressemble à ceci :
def calculate_factorial(number):
# Initialize the factorial result to 1
factorial = 1
# Loop from 1 to number (inclusive) and multiply factorial by each number
for i in range(1, number + 1):
factorial *= i
return factorial
def calculate_factorial(number):
# Initialize the factorial result to 1
factorial = 1
# Loop from 1 to number (inclusive) and multiply factorial by each number
for i in range(1, number + 1):
factorial *= i
return factorial
Avec notre nouvelle fonction, nous pouvons facilement trouver les factorielles de nos nombres en ajoutant le code suivant à notre projet, puis en exécutant le programme Python :
print(calculate_factorial(5)) print(calculate_factorial(7)) print(calculate_factorial(9)) print(calculate_factorial(10))
print(calculate_factorial(5))
print(calculate_factorial(7))
print(calculate_factorial(9))
print(calculate_factorial(10))
Félicitations ! Vous avez trouvé, compris et modifié un exemple d’extrait de code.
Utiliser le code des bibliothèques dans votre projet
Apprenons maintenant à utiliser les bibliothèques, ce qui est une pratique courante pour les développeurs. Les bibliothèques sont essentiellement des collections de code écrites par d’autres développeurs pour effectuer des tâches spécifiques. Vous pouvez importer des bibliothèques dans votre projet pour utiliser le code préécrit, ce qui vous permet de gagner du temps et des efforts.
Dans cette section, nous allons continuer à utiliser l'exemple de calculatrice factorielle Python de la section précédente. Pour référence, voici notre code actuel :
def calculate_factorial(number):
# Initialize the factorial result to 1
factorial = 1
# Loop from 1 to number (inclusive) and multiply factorial by each number
for i in range(1, number + 1):
factorial *= i
return factorial
print(calculate_factorial(5))
print(calculate_factorial(7))
print(calculate_factorial(9))
print(calculate_factorial(10))
def calculate_factorial(number):
# Initialize the factorial result to 1
factorial = 1
# Loop from 1 to number (inclusive) and multiply factorial by each number
for i in range(1, number + 1):
factorial *= i
return factorial
print(calculate_factorial(5))
print(calculate_factorial(7))
print(calculate_factorial(9))
print(calculate_factorial(10))
1. Recherche d’une bibliothèque
Une fois que vous connaissez les fonctionnalités que vous souhaitez ajouter à votre projet, vous pouvez rechercher une bibliothèque avec du code approprié. Tchat Copilot est un moyen simple de rechercher des bibliothèques, car vous pouvez utiliser le langage naturel pour décrire exactement ce que vous recherchez.
Trouver une factorielle est une fonction assez courante, et il y a de fortes chances que quelqu’un ait inclus cette fonction dans une bibliothèque existante. Ouvrez Tchat Copilot, puis demandez :
Is there a Python library with a function for calculating a factorial?
Is there a Python library with a function for calculating a factorial?
Copilot indique qu’une fonction factorielle est incluse dans le [`math`](https://docs.python.org/3/library/math.html) module à partir de la bibliothèque Python standard.
2. Hiérarchisation de la sécurité dans votre projet
Lorsque vous ajoutez une bibliothèque ou un module à votre projet, vous créez ce que l’on appelle une dépendance. Les dépendances sont des ensembles de codes pré-écrits dont votre projet dépend pour fonctionner correctement. Si elles ne sont pas soigneusement écrites ou gérées, elles peuvent introduire des failles de sécurité dans votre travail.
Heureusement, vous pouvez prendre certaines mesures pour mieux protéger votre projet. Apprenons à les utiliser.
Utilisation de bibliothèques populaires
Les bibliothèques populaires sont plus susceptibles d’être sécurisées, car elles sont activement gérées et utilisées par de nombreux développeurs. Un bon marqueur de popularité est le nombre d’étoiles qu’un référentiel possède. Si vous ne trouvez pas le GitHub référentiel pour une dépendance, vous pouvez demander de l’aide à Copilot.
Ouvrez Tchat Copilot, puis demandez :
Find the GitHub repository containing the code for the math module in Python.
Find the GitHub repository containing the code for the math module in Python.
Copilot vous indiquera que le `math` module est défini dans [`python/cpython`](https://github.com/python/cpython), qui a plus de 64 000 étoiles.
Activer Dependabot alerts pour votre projet
Lorsqu’elle est activée, Dependabot alerts sont générées automatiquement lors Dependabot de la détection d’un problème de sécurité dans vos dépendances, ce qui vous aide à corriger rapidement les vulnérabilités. Dependabot est disponible gratuitement sur tous les référentiels open source GitHub .
Activez Dependabot alerts pour votre dépôt maintenant. Cliquez sur l’onglet Security and quality du dépôt GitHub de votre projet. En regard de Dependabot alerts, cliquez sur Activer Dependabot alerts. Vous pouvez accéder à Dependabot alerts partir de l’onglet Dependabot de la barre latérale.
3. Mise en œuvre d'un code provenant d'une bibliothèque
Vous êtes maintenant prêt à importer la bibliothèque dans votre projet, puis à utiliser son contenu dans votre code. Vous pouvez lire la documentation de la bibliothèque pour apprendre à le faire vous-même, ou vous pouvez demander Copilot de suggérer et d’expliquer une implémentation pour vous.
Ouvrez Tchat Copilot, puis demandez :
How do I use the factorial function of the math module in my Python project?
How do I use the factorial function of the math module in my Python project?
Copilot suggérera ensuite une version du code suivant :
import math
# Calculate the factorial of a number
number = 5
result = math.factorial(number)
print(f"The factorial of {number} is {result}")
import math
# Calculate the factorial of a number
number = 5
result = math.factorial(number)
print(f"The factorial of {number} is {result}")
Après avoir remplacé le code existant dans votre projet par l’implémentation ci-dessus, vous avez utilisé avec succès le code d’une bibliothèque dans votre projet d’exemple !
Partage de votre travail
Grâce à ce tutoriel, vous avez appris à réutiliser en toute sécurité le code d’autres utilisateurs dans votre propre travail. À cette occasion, partagez la manière dont vous avez réutilisé le code et généré le projet d’exemple dans notre discussion communautaire.
Pour aller plus loin
-
[AUTOTITLE](/get-started/learning-to-code/finding-and-understanding-example-code)