Comment créer des paquets Python [2023]

Python est le troisième langage de programmation le plus utilisé selon une enquête Stackoverflow de 2023. Ce langage général peut être utilisé dans les domaines de la science des données, du développement web, de l'apprentissage automatique, de l'ingénierie logicielle et du calcul scientifique.

Un paquetage Python est l'un des termes que vous rencontrerez lorsque vous apprendrez et interagirez avec le langage Python. Qu'est-ce qu'un paquetage Python et comment pouvez-vous en créer ?

Cet article vous propose de

• Définir les paquets Python
• Expliquer l'importance des paquets Python dans la programmation
• Démontrer comment créer des paquets Python
• Démontrer comment utiliser et tester les paquets Python
• Démontrer comment télécharger des paquets Python

Que sont les paquets Python ?

Les paquets Python sont des éléments essentiels de la programmation. Sans paquets, les développeurs pourraient devoir tout écrire à partir de zéro, ce qui ferait de la programmation un processus long et stressant. Les paquets Python sont des collections de modules Python, c'est-à-dire une collection de code réutilisable.

En Python, un module est un fichier contenant du code Python qui peut être importé dans d'autres programmes Python. Pour créer un paquetage Python, vous devez stocker le code dans un répertoire contenant un fichier __init__.py.

Un paquet Python peut contenir d'autres paquets (imbrication), et des milliers de paquets Python sont disponibles en ligne. Certains de ces paquets sont officiels, d'autres non. La plupart des paquets Python sont disponibles sur https://pypi.org/.

Django, un cadre web Python, est un exemple de paquetage que vous pouvez utiliser pour créer des applications web. Scikit-learn, PyTorch et TensorFlow sont des packages populaires dans le domaine de l'apprentissage automatique.

Importance des packages Python

Pourquoi ne pas tout créer à partir de zéro en tant que programmeur ? Avons-nous besoin des paquets Python ? Voici quelques-unes des raisons pour lesquelles les paquets Python sont importants ;

• Gain de temps : Les paquets Python vous donnent accès à du code pré-écrit qui résout des problèmes courants. Vous pouvez utiliser les paquets Python au lieu de réinventer la roue chaque fois que vous voulez écrire un script Python.
• Facilite la distribution du code : La collaboration est très courante en programmation. Vous pouvez créer un paquetage Python que les membres de votre équipe pourront toujours importer lorsqu'ils collaboreront à un projet.
• Réutilisation du code : S'il y a un bloc de code que vous devez toujours écrire dans vos programmes Python, vous pouvez l'empaqueter et l'importer dans vos applications.
• Organisation du code : Les paquets Python vous permettent d'organiser votre code en modules logiques. Une telle approche facilite la lecture et la maintenance de votre code Python.

Comment créer votre premier paquetage Python

Nous avons déjà indiqué que Python est un langage à usage général. En tant que programmeur, vous pouvez créer différents types de paquets.

Par exemple, vous pouvez avoir un paquet qui automatise certaines tâches, un paquet qui vous aide à établir un budget ou même à apprendre une nouvelle langue. Cependant, avant de commencer à créer votre premier paquet, vous devez disposer des éléments suivants ;

Prérequis ;

• Python est installé sur votre machine locale. Si vous utilisez Linux, Python est installé par défaut avec votre système d'exploitation. Vous pouvez utiliser la commande python -version ou python3 -version pour vérifier si Python est installé. Si Python est installé, vous verrez quelque chose comme ceci dans votre terminal ;

Si vous n'avez pas Python, vous pouvez le télécharger à l'adresse https://www.python.org/downloads/.

• Compréhension de Python. Vous devez savoir comment écrire des classes, des modules et des fonctions Python.
• Un gestionnaire de paquets. Nous utiliserons pip pour cette démonstration. Vous pouvez vérifier si pip est installé à l'aide de cette commande ;

pip --version

S'il est installé, vous verrez quelque chose de similaire dans votre terminal.

Les exigences peuvent varier en fonction de la nature du paquetage que vous souhaitez installer.

Pour cette démonstration, je vais créer un paquetage Python simple qui vérifie si un nombre est premier. Vous pouvez suivre ;

• Première étape: Créez un dossier de projet. Je nommerai le mien primechecker.
• Deuxième étape: Créez un autre dossier à l'intérieur du dossier primechecker et nommez-le prime.
• Troisième étape : Créez un fichier dans le répertoire que vous avez créé à l'étape deux, et nommez-le prime.py. Vous pouvez combiner les trois étapes à l'aide de cette commande ;

 mkdir primechecker && cd primechecker && mkdir prime && cd prime && touch prime.py

• Troisième étape: Ouvrez votre projet dans votre éditeur de code. Vous pouvez alors ajouter ce code au fichier prime.py qui vérifie si un nombre est un nombre premier ;

def is_prime(number) :

 if number < 2 :

 return False

 for i in range(2, int(number ** 0.5) 1) :

 if number % i == 0 :

 return False

 return True

• Quatrième étape : Dans le dossier prime, créez un nouveau fichier et nommez-le __init__.py. Ce fichier permet à Python de reconnaître le dossier du projet que nous avons créé comme un paquetage.

Vous pouvez utiliser cette commande ;

touch prime/__init__.py

• Cinquième étape : Testez votre code. Nous pouvons créer un script dans un fichier test.py à l'intérieur du dossier racine qui vérifie si un nombre est premier. Retournez dans le dossier principal et utilisez cette commande ;

touch test.py

Vous pouvez ensuite ajouter ce code à ce fichier ;

from prime.prime import is_prime

number = int(input("Enter a number : "))

result = is_prime(number)

print(f"{number} is prime : {result}")

Exécutez cette commande pour vérifier votre code ;

python3 test.py

Vous pouvez maintenant entrer un nombre et vérifier s'il est premier.

Par exemple, j'ai vérifié si 5 et 1 sont des nombres premiers et j'ai obtenu le résultat suivant ;

Comment télécharger le paquet en ligne

Vous pouvez héberger le paquet que vous avez créé sur PyPI (Python Package Index). Il s'agit d'un dépôt central qui contient des milliers de paquets Python. Rendez-vous sur https://pypi.org/ et créez un compte si vous n'en avez pas.

Vous pouvez suivre les étapes suivantes pour télécharger votre paquet en ligne ;

• Étape 1 : Créez un nouveau fichier dans le dossier racine (le mien est primechecker) et nommez-le setup.py.
• Étape 2 : Modifiez le contenu du fichier setup.py pour qu'il contienne des informations sur le paquet que vous souhaitez mettre en ligne.

Le code de ce fichier devrait être le suivant ;

from setuptools import setup, find_packages

setup(

 name='primechecker',

 version='1.0.0',

 author='Your Name',

 author_email='your@email.com',

 description='A package for checking prime numbers',

 packages=find_packages(),

)

Modifiez le nom, l'auteur, l'adresse électronique de l'auteur et la description en fonction des détails de votre paquet.

• Étape 3 : Construisez votre paquet. Exécutez cette commande tout en restant dans le dossier racine ;

python3 setup.py sdist bdist_wheel

Si vous vérifiez votre dossier de projet, vous pouvez voir deux nouveaux dossiers (build et dist) dans le dossier racine.

• Étape 4 : Installez twine. C'est le paquetage nécessaire pour télécharger des paquets sur PyPI.

Utilisez cette commande ;

pip install twine

• Étape 5 : Téléchargez le paquet

Utilisez cette commande ;

twine upload dist/*

Vous serez invité à saisir votre nom d'utilisateur et votre mot de passe. Si le nom de votre paquet n'est pas déjà pris, le paquet sera publié en ligne, et vous obtiendrez un lien sur votre terminal.

Le paquet que vous venez de publier sera accessible au public. Toute personne souhaitant utiliser le paquet peut le télécharger à l'aide de pip.

Par exemple, le paquet que j'ai publié peut être téléchargé comme suit ;

pip install primechecker==1.0.0.

Meilleures pratiques pour la création de paquets Python

• Faites attention aux normes d'empaquetage de Python : Même si vous êtes libre de décider du type de paquet à créer, rappelez-vous toujours que les paquets Python ont des normes auxquelles vous devez adhérer. Vérifiez ces normes sur https://packaging.python.org/ avant de commencer à écrire votre code.
• Testez votre paquetage avant de le déployer : Les bogues sont fréquents en programmation. Créez des scripts pour générer des tests automatisés, en particulier lorsque vous créez de gros paquets. Une telle approche permet de s'assurer que vous téléchargez des paquets exempts de bogues.
• Versionnement : Un paquet correct doit suivre un versionnement sémantique. Le paquet que j'ai créé dans notre démonstration avait ces numéros 1.0.0. Le premier bit (1) est la version majeure, le deuxième bit (0) est la version mineure, et le dernier bit est le Patch.
• Spécifiez toutes les dépendances : Selon vos besoins, vous pouvez avoir diverses dépendances ou d'autres paquets à l'intérieur de votre paquet. Vous devez mentionner toutes les dépendances dans la description de votre paquet lors du téléchargement. Vous pouvez utiliser des outils comme setuptools ou poetry pour ajouter et gérer ces dépendances.
• Utilisez le contrôle de version : La programmation est un processus continu. Vous pouvez continuer à mettre à jour ou à améliorer votre paquetage pour y ajouter de nouvelles fonctionnalités ou le rendre plus efficace. Vous pouvez également inviter des contributeurs. Vous pouvez télécharger le code de votre paquet sur des plateformes telles que GitHub ou GitLab pour rendre votre code accessible et permettre la collaboration.
• Documentez votre code : Le paquet que nous avons créé l'a été à des fins de démonstration. Cependant, si vous avez l'intention de partager un tel paquet avec le public ou les membres de l'équipe, vous devez générer une documentation qui guide les utilisateurs. Vous pouvez utiliser des outils tels que Pydoc ou Sphinx pour générer votre documentation.

Où puis-je télécharger des paquets Python ?

Même si Python Package Index (PyPI) est le dépôt officiel des paquets Python, cela ne signifie pas que vous ne pouvez pas l'utiliser. Certains facteurs à prendre en compte pour déterminer où télécharger votre paquetage Python sont la taille des fichiers, la nature du paquetage, le niveau de support nécessaire et votre public cible.

Voici d'autres endroits où vous pouvez télécharger vos paquets Python ;

• GitHub : GitHub est la plus grande plateforme d'hébergement de code. Vous pouvez créer un dépôt et ajouter votre paquetage Python sous forme de fichier zip pour le redistribuer.
• Conda : Conda est un gestionnaire de paquets que vous pouvez utiliser pour vos paquets Python. Cette plateforme est réputée parmi les scientifiques des données. Créez un compte sur Conda et commencez à télécharger vos paquets pour les redistribuer.
• Miroirs PyPI : Il existe de nombreux miroirs PyPI qui reflètent le contenu de la plateforme PyPI. Choisissez celui qui correspond à vos besoins pour héberger votre paquet.

Conclusion

Vous connaissez maintenant les étapes de la création de paquets Python et de leur publication en ligne. Notre exemple était juste basique, mais vous pouvez vous amuser et créer des paquets complexes. Cependant, créez toujours la bonne structure de dossier lorsque vous créez des paquets Python.