Si vous êtes développeur, vous savez peut-être que lorsque vous travaillez sur un projet Python ou un projet de science des données, il est essentiel de toujours travailler dans un environnement qui rend votre projet réutilisable et reproductible sans créer de problème pour quiconque reprend votre projet. Donc, avant de discuter de la façon de créer un fichier d'exigence .txt en Python, faites-nous savoir ce qu'est require.txt et pourquoi nous en avons besoin.
Qu’est-ce que le fichier require.txt en Python ?
Dans Python exigence.txt Un fichier est un type de fichier qui stocke généralement des informations sur toutes les bibliothèques, modules et packages utilisés lors du développement d'un projet particulier. Il stocke également tous les fichiers et packages dont ce projet dépend ou nécessite son exécution. Généralement, ce fichier « exigence.txt » est stocké (ou réside) dans le répertoire racine de vos projets. Ici se pose une autre question essentielle : pourquoi avons-nous besoin de ce type de fichier dans nos projets.
Pourquoi avons-nous besoin de require.txt ?
Cela nous aide de plusieurs manières, même lorsque nous revisiterons notre projet dans le futur, car cela résout presque tous les problèmes de compatibilité. Si vous avez déjà travaillé sur un projet Python ou développé un projet, vous savez sûrement que nous avons généralement besoin de plusieurs nombres de packages. Cependant, lors du développement d’un projet, nous utilisions généralement une version particulière des packages. Plus tard, le gestionnaire ou le responsable du package peut apporter des modifications, et ces modifications peuvent facilement interrompre l'ensemble de votre application. Par conséquent, garder une trace de chaque modification dans les packages représente trop de travail. Concrètement, lorsque le projet est trop volumineux, il est essentiel de garder une trace de chaque package que nous utilisons pour éviter les surprises inattendues.
L’un des moyens standard de résoudre ce type de problèmes consiste à utiliser un environnement virtuel. La raison en est qu'il existe deux principaux types de packages et d'emplacements où les bibliothèques Python sont généralement stockées, et nous n'avons généralement pas besoin de tous les types de ces packages lorsque nous travaillons sur un projet particulier ; il est donc nécessaire de savoir lequel est requis par projet pour faciliter la reproductibilité.
exemples d'arbres binaires
Il s'agit généralement des fichiers suivants :
- Packages système faisant partie de la bibliothèque Python standard
- Packages de site (packages tiers) que vous installez à l'aide de pip.
Qu'est-ce qu'un environnement virtuel ?
Un environnement virtuel est un type d'espace de travail isolé ou artificiel qui maintient les packages de l'utilisateur séparés de l'installation du système local (ou principal). Cela nous permet de créer un environnement isolé « virtuel » pour chaque projet Python. Cela permet à chaque projet d'être plus facilement indépendant de l'autre projet, en particulier lorsqu'ils partagent les mêmes dépendances. Il existe différents packages disponibles qui peuvent être utilisés pour créer un environnement virtuel. Certains des forfaits de base sont les suivants :
- environnement virtuel
- pipenv
Ainsi, une fois l’environnement virtuel créé pour notre projet, voyons comment installer les packages et les bibliothèques. Il est très facile d'obtenir tous les packages requis que nous devons utiliser dans notre projet avec l'environnement virtuel. Voyons d'abord comment utiliser le « virtualenv ».
A. virtualenv
C'est un type de bibliothèque qui nous permet de créer un environnement virtuel et de l'utiliser. Pour installer virtualenv, vous pouvez suivre les instructions données :
1. Ouvrez le Cmd, tapez la commande suivante et appuyez sur le bouton Entrée comme indiqué dans l'image ci-dessous :
Commande
pip install virtualenv
Sortir
2. Création du nouveau répertoire de travail pour le projet
Créez maintenant un nouvel environnement virtuel dans le répertoire de ce projet pour éviter les problèmes inutiles.
Commande
Python3 -m venv name_of_env
Sortir
3. Maintenant, pour utiliser cet environnement virtuel nouvellement créé, il suffit de l'activer. Pour activer cet environnement isolé, tapez la commande suivante et appuyez sur le bouton Entrée comme indiqué ci-dessous :
Commande
name_of_envirnmentScriptsactivate
Sortir
Pour vérifier que notre nouvel environnement virtuel est créé, vous pouvez voir dans l'invite que le préfixe est modifié avec le nom de votre nouvel environnement virtuel, comme dans notre cas, nous avons nommé notre environnement virtuel comme « nom_de_envirnmnet ». Vous pouvez également le vérifier en ouvrant le répertoire du projet ou le dossier dans lequel un nouveau répertoire portant le nom spécifié sera créé.
4. Voyons maintenant comment créer le fichier require.txt
Afin de créer le fichier require.txt, il sera bon de savoir ce qu'il contient.
Les fichiers require.txt incluent tous les types de packages et de bibliothèques standard utilisés dans ce projet particulier. Par conséquent, ce fichier require.txt joue un rôle essentiel lors du développement de projets petits ou grands. Cela nous aide également à rendre nos projets plus portables.
Avec l'aide du fichier 'requirement.txt', plusieurs problèmes majeurs peuvent être facilement évités. Pour le comprendre plus en détail, vous pouvez considérer l’exemple suivant :
Exemple:
Supposons que vous ayez créé un nouveau projet, tel qu'une application compatible avec la version spécifique de la bibliothèque et des packages. Ainsi, pour une raison quelconque, vous transmettez cette candidature à votre ami.
Puisque vous n'avez pas utilisé le fichier require.txt, il est possible que votre application ne fonctionne pas correctement ou même ne démarre pas sur le système de votre ami. La principale raison en est que tous les utilisateurs n’utilisent pas la même version des bibliothèques et des packages. Cependant, si vous avez utilisé le fichier require.txt, n'importe qui peut exécuter et utiliser votre projet ou application car tous les packages et bibliothèques requis ou utilisés sont également spécifiés sous la forme d'un fichier (requirement.txt) avec votre projet.
Dans ce fichier .txt d'exigences, l'utilisateur peut facilement sélectionner, stocker et conserver les fichiers requis selon ses besoins.
Comment obtenir le fichier Requirements.txt : à l'aide de Virtualenv
Ici, nous pouvons obtenir le fichier exigences.txt. Pour créer le fichier require.txt, nous pouvons utiliser la commande suivante :
Commande
pip3 freeze > requirements.txt
Sortir
Comment obtenir le fichier Requirements.txt : à l'aide de Pipenv
Pipenv est également un excellent outil de bibliothèque de création d'environnement virtuel doté de fonctionnalités intéressantes. Vous pouvez utiliser les instructions suivantes pour obtenir le fichier require.txt.
1. Tapez la commande suivante pour installer le pipenv
Commande
pip install pipenv
Sortir
2. Tapez maintenant la commande suivante et appuyez sur le bouton Entrée.
Commande
pipenv install mypackage
La commande ci-dessus est utilisée pour installer les packages requis pour les projets.
Sortir
- Après avoir installé les packages du projet, nous devons activer l'environnement virtuel. Ainsi pour activer l'environnement virtuel, vous pouvez utiliser les commandes suivantes :
Commande
pipenv shell
Ou
pipenv run
Ces commandes peuvent être utilisées pour activer l'environnement virtuel nouvellement créé, comme indiqué ci-dessous :
Sortir
Tapez maintenant la commande suivante pour exécuter le script dans l'environnement virtuel.
Commande
pipenv run Python myscript.py
Explication
Cette commande est utilisée pour exécuter le script spécifié dans l'environnement virtuel comme indiqué ci-dessous :
Sortir
Comme c'est plus simple, il garde également automatiquement une trace de toutes les bibliothèques utilisées pour le projet dans un fichier pip et un fichier pip. fichier de verrouillage. Ces fichiers jouent le même rôle qu'un fichier require.txt et stockent également des informations supplémentaires sur plusieurs éléments qui ne sont pas inclus dans le fichier require.txt.
Ainsi, vous pouvez utiliser ce fichier pip comme alternative au fichier exigences.txt. Cependant, si vous souhaitez toujours utiliser le fichier exigences.txt, vous pouvez utiliser la commande suivante :
pipenv -r lock >> requirements.txt
Sortir
Comment obtenir le fichier Requirements.txt : sans Virtualenv à l'aide de Pipreqs
Pipreqs est un des outils les plus efficaces et simples à utiliser, qui ne nécessite pas de créer un environnement virtuel. C'est donc très utile si un utilisateur n'a besoin que des packages et des bibliothèques utilisés dans une application ou un projet.
L'une des choses les plus importantes est qu'il analyse automatiquement les scripts ou les fichiers Python à la recherche de leurs bibliothèques importées et génère un fichier requis.txt.
Voyons comment cela fonctionne :
1. Tout d'abord, vous devez installer « pipreqs », donc pour le télécharger, tapez la commande suivante dans le cmd et appuyez sur le bouton Entrée :
Commande
pip install pipreqs
Sortir
2. Une fois l'installation terminée, vous pouvez alors démarrer « pipreqs » pour obtenir le fichier require.txt en le pointant vers l'emplacement où se trouve le dossier de votre projet.
Commande
pipreqs /path/to/project
Sortir
Pour vérifier que le fichier require.txt a été créé avec succès, vous pouvez voir dans le dossier de votre projet qu'un nouveau fichier « require.txt » sera créé, comme indiqué ci-dessous :
