Guide du débutant pour la création et l’utilisation de paquets en Python

Imaginez la tâche intimidante que représente le développement d’une application complète limitée à un seul fichier Python. Bien que techniquement réalisable, cela va à l’encontre des principes fondamentaux de la construction de logiciels efficaces, maintenables et réutilisables. C’est pourquoi les paquets et les modules sont essentiels à la construction et au développement de logiciels.

Qu’est-ce qu’un paquetage ?

En Python, un paquetage permet d’organiser des modules et des ressources logiquement liés entre eux. Il s’agit d’un répertoire qui contient plusieurs modules Python, des sous-paquets et d’autres ressources.

Les paquets fournissent une structure hiérarchique, vous permettant d’organiser le code de votre projet à différents niveaux d’abstraction.

Différence entre les paquets et les modules

Bien que vous puissiez utiliser à la fois les packages et les modules pour organiser le code, il existe des différences entre eux :

• Module: Un module est un fichier qui contient du code Python. Il définit des fonctions, des classes, des variables et d’autres objets que vous pouvez importer et utiliser dans votre code.
• Paquet: Un package est une collection d’un ou plusieurs modules et peut également inclure des sous-packages.

Comment créer un package en Python

Pour créer un paquetage, suivez les étapes suivantes.

Étape 1 : Créer un répertoire de projet

Commencez par créer un répertoire de projet.

Étape 2 : Créer un répertoire de paquets

Dans le répertoire de votre projet, créez un autre répertoire qui servira de répertoire de paquetage. Donnez-lui un nom significatif qui représente l’objectif ou la fonctionnalité du paquet. Le répertoire package contiendra les modules et les sous-packages liés à votre package.

Étape 3 : définir le fichier __init__.py du paquetage

Dans le répertoire du package, créez un fichier __init__.py init__.py fichier. La présence d’un fichier __init__.py est ce qui fait du répertoire un paquetage en Python.

Si vous avez besoin d’initialiser un code à chaque fois que vous utilisez le package, incluez-le dans le fichier __init__.py.init__.py sinon il sera toujours vide.

Étape 4 : Ajouter des modules au paquetage

Dans le répertoire du paquetage, ajoutez des modules Python (.py) qui définissent des fonctions, des classes ou des variables.

Ces modules contiennent le code réel qui fournit les fonctionnalités de votre package. Vous pouvez créer plusieurs modules dans le répertoire package.

Étape 5 : ajout de sous-paquets au paquetage

Si votre paquetage doit avoir une structure hiérarchique ou contient des fonctionnalités distinctes, vous pouvez créer des sous-paquets dans le répertoire du paquetage.

Un sous-paquet est simplement un autre répertoire de paquets à l’intérieur du répertoire de paquets principal. Chaque sous-paquet doit avoir son propre __init__.py fichier. Les sous-paquets permettent d’organiser et de séparer davantage le code.

Au cours de ces étapes, vous avez créé un outil mathématique et ajouté deux modules (operations.py et statistics.py), et deux sous-paquets géométrie et calcul ayant chacun leurs modules.

En suivant ces étapes, vous pouvez facilement organiser des fonctionnalités connexes à l’aide d’un paquet et de sous-paquets, ce qui facilite la gestion et la réutilisation du code.

Comment travailler avec un paquetage en Python

Pour travailler avec un package, vous devez l’importer. Les import et à partir de vous permettent d’importer et d’utiliser un paquet dans votre code.

Vous pouvez également utiliser la notation point pour importer des modules, des sous-paquets ou des propriétés spécifiques d’un paquetage. La notation par points vous permet de naviguer dans la structure du répertoire du paquetage. La notation par points rend vos importations plus lisibles et plus faciles à maintenir.

Dans le code ci-dessus, vous avez navigué depuis le répertoire du paquetage (math_tool) vers le répertoire opérations en utilisant la notation par points et importé deux fonctions (ajouter et multiplier).

Importations absolues et importations relatives

Avec absolues importations vous spécifiez le chemin complet du paquetage de niveau supérieur (le paquetage racine) vers le module ou le sous-paquet désiré. Il s’agit de la méthode la plus courante et la plus recommandée pour importer des modules et des paquets en Python.

A partir de math_tool allez dans la section géométrie trouver le sous-paquet shapes.py et importez le module parallélogramme .

Alors que relatif importations permet d’effectuer des importations relatives à l’emplacement du module actuel en utilisant la notation point pour spécifier les importations relatives.

Par exemple, dans le module calculus/integrations.py vous pouvez utiliser l’importation relative pour importer une fonction du module shapes.py dans le module géométrie sous-paquet.

Le double point (« . ») indique à Python de :

• Démarrer à partir du répertoire du sous-paquet (calcul) où se trouve le module (integrations.py) existe.
• Allez dans le paquetage parent (math_tool) du sous-paquet.
• Trouvez le répertoire géométrie dans le répertoire parent.
• Allez dans le sous-paquet shapes.py et importez losange à partir de ce module.

La notation par points représente donc le nombre de répertoires vers lesquels naviguer à partir du répertoire actuel du module.

Importations d’alias pour plus de commodité

Vous pouvez attribuer un alias à une importation afin d’y faire référence plus facilement dans votre code. Les alias sont pratiques lorsqu’il s’agit de longs noms de paquets ou de modules.

Pour attribuer un alias, utilisez la commande comme comme mot-clé.

Comment distribuer votre paquetage en Python

Python vous fournit des outils et une plateforme pour construire et distribuer votre paquetage. La distribution de votre paquetage vous permet de partager votre code avec d’autres développeurs, de promouvoir la collaboration, de simplifier l’installation pour les utilisateurs et de contribuer à la communauté Python au sens large.

Étape 1 : Créer un compte sur PyPI

Index des paquets Python (PyPI) est le dépôt par défaut des paquets Python. Vous pouvez publier vos paquets sur PyPI afin que d’autres développeurs puissent facilement les trouver et les installer.

Veillez à vous souvenir de votre nom d’utilisateur et mot de passe car vous en aurez besoin pour l’authentification lors du téléchargement de votre paquet sur PyPI.

Étape 2 : Installation des outils de gestion des paquets

Ces outils facilitent la configuration, la construction et la diffusion d’un paquetage distribuable en une seule commande.

Étape 3 : Créer un fichier setup.py

Pour distribuer votre paquetage, créez un fichier setup.py dans le répertoire racine de votre projet. Le fichier setup.py contient des métadonnées sur votre paquetage, telles que son nom, sa version, son auteur, sa description, ses dépendances, etc.

Les outils de gestion des paquets utiliseront le fichier setup.py pour configurer et construire votre paquet.

Étape 4 : Construction du paquet

Une fois que vous avez le fichier setup.py est prêt, vous pouvez l’utiliser pour créer un paquet distribuable. Dans votre terminal ou votre invite de commande, naviguez jusqu’au répertoire contenant le fichier setup.py et exécutez la commande suivante :

Cette commande génère un fichier dist contenant un paquet de distribution source (.tar.gz) et un paquet de distribution roue (.whl). Vous verrez également un répertoire build et info répertoire.

Étape 5 : Télécharger le paquet sur PyPI

Votre paquetage étant prêt, vous pouvez le télécharger sur PyPI.

Exécutez la commande suivante :

Visitez votre PyPI pour voir votre paquet.

Maintenant, les autres développeurs qui trouvent votre paquet utile peuvent l’installer et l’utiliser localement.

Comment installer un paquetage Python

Les gestionnaires de paquets comme pip facilitent l’installation et la gestion des paquets Python à partir de diverses sources, notamment le Python Package Index (PyPI). Pour installer un paquetage en utilisant pip Ouvrez votre terminal ou votre invite de commande et utilisez la commande suivante :

Pour voir toutes les commandes et options disponibles pour pip utilisez le menu –help option.

Écrire des modules propres

Les paquets contiennent des modules et des sous-paquets qui, à leur tour, contiennent d’autres modules. C’est une bonne pratique de modulariser votre code, en particulier lorsque vous travaillez sur des projets plus importants, car cela favorise une meilleure organisation du code et une meilleure lisibilité. Il est donc important d’écrire les modules avec clarté lorsque vous développez avec Python.