Aller au contenu

Environnements virtuels

🌐 Traduction par IA et humains

Cette traduction a Ă©tĂ© rĂ©alisĂ©e par une IA guidĂ©e par des humains. đŸ€

Elle peut contenir des erreurs d'interprĂ©tation du sens original, ou paraĂźtre peu naturelle, etc. đŸ€–

Vous pouvez améliorer cette traduction en nous aidant à mieux guider le LLM d'IA.

Version anglaise

Lorsque vous travaillez sur des projets Python, vous devriez probablement utiliser un environnement virtuel (ou un mécanisme similaire) pour isoler les packages que vous installez pour chaque projet.

Info

Si vous connaissez dĂ©jĂ  les environnements virtuels, comment les crĂ©er et les utiliser, vous pouvez passer cette section. đŸ€“

Astuce

Un environnement virtuel est diffĂ©rent d’une variable d’environnement.

Une variable d’environnement est une variable du systĂšme qui peut ĂȘtre utilisĂ©e par des programmes.

Un environnement virtuel est un répertoire contenant certains fichiers.

Info

Cette page vous apprendra Ă  utiliser les environnements virtuels et Ă  comprendre leur fonctionnement.

Si vous ĂȘtes prĂȘt Ă  adopter un outil qui gĂšre tout pour vous (y compris l’installation de Python), essayez uv.

Créer un projet

Commencez par créer un répertoire pour votre projet.

Ce que je fais gĂ©nĂ©ralement, c’est crĂ©er un rĂ©pertoire nommĂ© code dans mon rĂ©pertoire personnel/utilisateur.

Et Ă  l’intĂ©rieur, je crĂ©e un rĂ©pertoire par projet.

// Aller au répertoire personnel
$ cd
// Créer un répertoire pour tous vos projets de code
$ mkdir code
// Entrer dans ce répertoire code
$ cd code
// Créer un répertoire pour ce projet
$ mkdir awesome-project
// Entrer dans ce répertoire de projet
$ cd awesome-project

Créer un environnement virtuel

Lorsque vous commencez à travailler sur un projet Python pour la premiÚre fois, créez un environnement virtuel dans votre projet.

Astuce

Vous n’avez besoin de faire cela qu’une seule fois par projet, pas à chaque fois que vous travaillez.

Pour créer un environnement virtuel, vous pouvez utiliser le module venv fourni avec Python.

$ python -m venv .venv
Que signifie cette commande
  • python : utiliser le programme nommĂ© python
  • -m : appeler un module comme un script, nous prĂ©ciserons ensuite quel module
  • venv : utiliser le module nommĂ© venv qui est normalement installĂ© avec Python
  • .venv : crĂ©er l’environnement virtuel dans le nouveau rĂ©pertoire .venv

Si vous avez installĂ© uv, vous pouvez l’utiliser pour crĂ©er un environnement virtuel.

$ uv venv

Astuce

Par défaut, uv créera un environnement virtuel dans un répertoire appelé .venv.

Mais vous pouvez le personnaliser en passant un argument supplémentaire avec le nom du répertoire.

Cette commande crée un nouvel environnement virtuel dans un répertoire appelé .venv.

.venv ou autre nom

Vous pourriez crĂ©er l’environnement virtuel dans un autre rĂ©pertoire, mais il est d’usage de l’appeler .venv.

Activer l’environnement virtuel

Activez le nouvel environnement virtuel afin que toute commande Python que vous exĂ©cutez ou tout package que vous installez l’utilise.

Astuce

Faites cela à chaque fois que vous démarrez une nouvelle session de terminal pour travailler sur le projet.

$ source .venv/bin/activate

$ .venv\Scripts\Activate.ps1

Ou si vous utilisez Bash pour Windows (par exemple Git Bash) :

$ source .venv/Scripts/activate

Astuce

Chaque fois que vous installez un nouveau package dans cet environnement, activez de nouveau l’environnement.

Vous vous assurez ainsi que si vous utilisez un programme de terminal (CLI) installĂ© par ce package, vous utilisez celui de votre environnement virtuel et non un autre qui pourrait ĂȘtre installĂ© globalement, probablement avec une version diffĂ©rente de celle dont vous avez besoin.

VĂ©rifier que l’environnement virtuel est actif

VĂ©rifiez que l’environnement virtuel est actif (la commande prĂ©cĂ©dente a fonctionnĂ©).

Astuce

C’est facultatif, mais c’est une bonne maniĂšre de vĂ©rifier que tout fonctionne comme prĂ©vu et que vous utilisez l’environnement virtuel voulu.

$ which python

/home/user/code/awesome-project/.venv/bin/python

S’il affiche le binaire python Ă  .venv/bin/python, dans votre projet (dans cet exemple awesome-project), alors cela a fonctionnĂ©. 🎉

$ Get-Command python

C:\Users\user\code\awesome-project\.venv\Scripts\python

S’il affiche le binaire python Ă  .venv\Scripts\python, dans votre projet (dans cet exemple awesome-project), alors cela a fonctionnĂ©. 🎉

Mettre Ă  niveau pip

Astuce

Si vous utilisez uv, vous l’utiliserez pour installer des Ă©lĂ©ments Ă  la place de pip, vous n’avez donc pas besoin de mettre pip Ă  niveau. 😎

Si vous utilisez pip pour installer des packages (il est fourni par défaut avec Python), vous devez le mettre à niveau vers la derniÚre version.

Beaucoup d’erreurs exotiques lors de l’installation d’un package se rĂ©solvent simplement en mettant d’abord pip Ă  niveau.

Astuce

Vous feriez normalement cela une seule fois, juste aprĂšs avoir crĂ©Ă© l’environnement virtuel.

Vous devez vous assurer que l’environnement virtuel est actif (avec la commande ci-dessus), puis exĂ©cuter :

$ python -m pip install --upgrade pip

---> 100%

Astuce

Parfois, vous pourriez obtenir une erreur No module named pip en essayant de mettre Ă  niveau pip.

Si cela arrive, installez et mettez Ă  niveau pip avec la commande ci-dessous :

$ python -m ensurepip --upgrade

---> 100%

Cette commande installera pip s’il n’est pas dĂ©jĂ  installĂ© et garantit aussi que la version de pip installĂ©e est au moins aussi rĂ©cente que celle disponible dans ensurepip.

Ajouter .gitignore

Si vous utilisez Git (vous devriez), ajoutez un fichier .gitignore pour exclure tout ce qui se trouve dans votre .venv de Git.

Astuce

Si vous avez utilisĂ© uv pour crĂ©er l’environnement virtuel, il l’a dĂ©jĂ  fait pour vous, vous pouvez passer cette Ă©tape. 😎

Astuce

Faites cela une seule fois, juste aprĂšs avoir crĂ©Ă© l’environnement virtuel.

$ echo "*" > .venv/.gitignore
Que signifie cette commande
  • echo "*" : va « afficher » le texte * dans le terminal (la partie suivante change un peu cela)
  • > : tout ce qui est affichĂ© dans le terminal par la commande Ă  gauche de > ne doit pas ĂȘtre affichĂ© mais Ă©crit dans le fichier Ă  droite de >
  • .gitignore : le nom du fichier dans lequel le texte doit ĂȘtre Ă©crit

Et * signifie pour Git « tout ». Ainsi, il ignorera tout dans le répertoire .venv.

Cette commande créera un fichier .gitignore avec le contenu :

*

Installer des packages

AprĂšs avoir activĂ© l’environnement, vous pouvez y installer des packages.

Astuce

Faites cela une seule fois lorsque vous installez ou mettez à niveau les packages nécessaires à votre projet.

Si vous devez mettre Ă  niveau une version ou ajouter un nouveau package, vous le referez.

Installer des packages directement

Si vous ĂȘtes pressĂ© et ne souhaitez pas utiliser un fichier pour dĂ©clarer les dĂ©pendances de votre projet, vous pouvez les installer directement.

Astuce

C’est une trĂšs bonne idĂ©e de placer les packages et leurs versions nĂ©cessaires Ă  votre programme dans un fichier (par exemple requirements.txt ou pyproject.toml).

$ pip install "fastapi[standard]"

---> 100%

Si vous avez uv :

$ uv pip install "fastapi[standard]"
---> 100%

Installer depuis requirements.txt

Si vous avez un requirements.txt, vous pouvez maintenant l’utiliser pour installer ses packages.

$ pip install -r requirements.txt
---> 100%

Si vous avez uv :

$ uv pip install -r requirements.txt
---> 100%
requirements.txt

Un requirements.txt avec quelques packages pourrait ressembler Ă  :

fastapi[standard]==0.113.0
pydantic==2.8.0

Exécuter votre programme

AprĂšs avoir activĂ© l’environnement virtuel, vous pouvez exĂ©cuter votre programme, et il utilisera le Python de votre environnement virtuel avec les packages que vous y avez installĂ©s.

$ python main.py

Hello World

Configurer votre Ă©diteur

Vous utiliserez probablement un Ă©diteur, assurez-vous de le configurer pour utiliser le mĂȘme environnement virtuel que vous avez crĂ©Ă© (il le dĂ©tectera probablement automatiquement) afin d’avoir l’autocomplĂ©tion et les erreurs inline.

Par exemple :

Astuce

Vous devez normalement faire cela une seule fois, lorsque vous crĂ©ez l’environnement virtuel.

DĂ©sactiver l’environnement virtuel

Une fois que vous avez fini de travailler sur votre projet, vous pouvez dĂ©sactiver l’environnement virtuel.

$ deactivate

Ainsi, lorsque vous exĂ©cutez python, il n’essaiera pas de l’exĂ©cuter depuis cet environnement virtuel avec les packages qui y sont installĂ©s.

PrĂȘt Ă  travailler

Vous ĂȘtes maintenant prĂȘt Ă  commencer Ă  travailler sur votre projet.

Astuce

Voulez-vous comprendre tout ce qui précÚde ?

Continuez la lecture. đŸ‘‡đŸ€“

Pourquoi des environnements virtuels

Pour travailler avec FastAPI, vous devez installer Python.

Ensuite, vous devrez installer FastAPI et tout autre package que vous souhaitez utiliser.

Pour installer des packages, vous utiliseriez normalement la commande pip fournie avec Python (ou des alternatives similaires).

NĂ©anmoins, si vous utilisez simplement pip directement, les packages seraient installĂ©s dans votre environnement Python global (l’installation globale de Python).

Le problĂšme

Alors, quel est le problùme d’installer des packages dans l’environnement Python global ?

À un moment donnĂ©, vous finirez probablement par Ă©crire de nombreux programmes diffĂ©rents qui dĂ©pendent de packages diffĂ©rents. Et certains de ces projets sur lesquels vous travaillez dĂ©pendront de versions diffĂ©rentes du mĂȘme package. đŸ˜±

Par exemple, vous pourriez crĂ©er un projet appelĂ© philosophers-stone, ce programme dĂ©pend d’un autre package appelĂ© harry, en version 1. Vous devez donc installer harry.

flowchart LR
    stone(philosophers-stone) -->|requires| harry-1[harry v1]

Puis, plus tard, vous créez un autre projet appelé prisoner-of-azkaban, et ce projet dépend aussi de harry, mais il a besoin de harry en version 3.

flowchart LR
    azkaban(prisoner-of-azkaban) --> |requires| harry-3[harry v3]

Mais maintenant, le problùme est que, si vous installez les packages globalement (dans l’environnement global) au lieu de dans un environnement virtuel local, vous devrez choisir quelle version de harry installer.

Si vous voulez exĂ©cuter philosophers-stone, vous devrez d’abord installer harry en version 1, par exemple avec :

$ pip install "harry==1"

Et vous vous retrouverez avec harry en version 1 installé dans votre environnement Python global.

flowchart LR
    subgraph global[global env]
        harry-1[harry v1]
    end
    subgraph stone-project[philosophers-stone project]
        stone(philosophers-stone) -->|requires| harry-1
    end

Mais si vous voulez ensuite exécuter prisoner-of-azkaban, vous devrez désinstaller harry version 1 et installer harry version 3 (ou bien installer la version 3 désinstallerait automatiquement la version 1).

$ pip install "harry==3"

Et vous vous retrouverez alors avec harry version 3 installé dans votre environnement Python global.

Et si vous essayez d’exĂ©cuter Ă  nouveau philosophers-stone, il y a une chance que cela ne fonctionne pas car il a besoin de harry version 1.

flowchart LR
    subgraph global[global env]
        harry-1[<strike>harry v1</strike>]
        style harry-1 fill:#ccc,stroke-dasharray: 5 5
        harry-3[harry v3]
    end
    subgraph stone-project[philosophers-stone project]
        stone(philosophers-stone) -.-x|⛔| harry-1
    end
    subgraph azkaban-project[prisoner-of-azkaban project]
        azkaban(prisoner-of-azkaban) --> |requires| harry-3
    end

Astuce

Il est trÚs courant que les packages Python fassent de leur mieux pour éviter les changements cassants dans les nouvelles versions, mais il vaut mieux jouer la sécurité et installer de nouvelles versions intentionnellement et lorsque vous pouvez exécuter les tests pour vérifier que tout fonctionne correctement.

Maintenant, imaginez cela avec beaucoup d’autres packages dont tous vos projets dĂ©pendent. C’est trĂšs difficile Ă  gĂ©rer. Et vous finiriez probablement par exĂ©cuter certains projets avec des versions incompatibles des packages, sans savoir pourquoi quelque chose ne fonctionne pas.

De plus, selon votre systĂšme d’exploitation (par exemple Linux, Windows, macOS), il se peut qu’il soit livrĂ© avec Python dĂ©jĂ  installĂ©. Et dans ce cas, il avait probablement des packages prĂ©installĂ©s avec des versions spĂ©cifiques nĂ©cessaires Ă  votre systĂšme. Si vous installez des packages dans l’environnement Python global, vous pourriez finir par casser certains des programmes fournis avec votre systĂšme d’exploitation.

OĂč les packages sont-ils installĂ©s

Lorsque vous installez Python, il crée des répertoires avec des fichiers sur votre ordinateur.

Certains de ces répertoires sont chargés de contenir tous les packages que vous installez.

Lorsque vous exécutez :

// Ne l’exĂ©cutez pas maintenant, c’est juste un exemple đŸ€“
$ pip install "fastapi[standard]"
---> 100%

Cela téléchargera un fichier compressé avec le code de FastAPI, normalement depuis PyPI.

Il tĂ©lĂ©chargera Ă©galement des fichiers pour d’autres packages dont FastAPI dĂ©pend.

Ensuite, il extraira tous ces fichiers et les placera dans un répertoire de votre ordinateur.

Par dĂ©faut, il placera ces fichiers tĂ©lĂ©chargĂ©s et extraits dans le rĂ©pertoire fourni avec votre installation de Python, c’est l’environnement global.

Qu’est-ce qu’un environnement virtuel

La solution aux problĂšmes posĂ©s par le fait d’avoir tous les packages dans l’environnement global est d’utiliser un environnement virtuel pour chaque projet sur lequel vous travaillez.

Un environnement virtuel est un rĂ©pertoire, trĂšs similaire Ă  celui global, oĂč vous pouvez installer les packages pour un projet.

De cette maniÚre, chaque projet aura son propre environnement virtuel (répertoire .venv) avec ses propres packages.

flowchart TB
    subgraph stone-project[philosophers-stone project]
        stone(philosophers-stone) --->|requires| harry-1
        subgraph venv1[.venv]
            harry-1[harry v1]
        end
    end
    subgraph azkaban-project[prisoner-of-azkaban project]
        azkaban(prisoner-of-azkaban) --->|requires| harry-3
        subgraph venv2[.venv]
            harry-3[harry v3]
        end
    end
    stone-project ~~~ azkaban-project

Que signifie activer un environnement virtuel

Lorsque vous activez un environnement virtuel, par exemple avec :

$ source .venv/bin/activate

$ .venv\Scripts\Activate.ps1

Ou si vous utilisez Bash pour Windows (par exemple Git Bash) :

$ source .venv/Scripts/activate

Cette commande crĂ©era ou modifiera certaines variables d’environnement qui seront disponibles pour les prochaines commandes.

L’une de ces variables est la variable PATH.

Astuce

Vous pouvez en savoir plus sur la variable d’environnement PATH dans la section Variables d’environnement.

Activer un environnement virtuel ajoute son chemin .venv/bin (sur Linux et macOS) ou .venv\Scripts (sur Windows) à la variable d’environnement PATH.

Disons qu’avant d’activer l’environnement, la variable PATH ressemblait à ceci :

/usr/bin:/bin:/usr/sbin:/sbin

Cela signifie que le systùme chercherait des programmes dans :

  • /usr/bin
  • /bin
  • /usr/sbin
  • /sbin
C:\Windows\System32

Cela signifie que le systùme chercherait des programmes dans :

  • C:\Windows\System32

AprĂšs avoir activĂ© l’environnement virtuel, la variable PATH ressemblerait Ă  quelque chose comme ceci :

/home/user/code/awesome-project/.venv/bin:/usr/bin:/bin:/usr/sbin:/sbin

Cela signifie que le systùme commencera maintenant par chercher des programmes dans :

/home/user/code/awesome-project/.venv/bin

avant de chercher dans les autres répertoires.

Ainsi, lorsque vous tapez python dans le terminal, le systĂšme trouvera le programme Python dans

/home/user/code/awesome-project/.venv/bin/python

et utilisera celui-ci.

C:\Users\user\code\awesome-project\.venv\Scripts;C:\Windows\System32

Cela signifie que le systùme commencera maintenant par chercher des programmes dans :

C:\Users\user\code\awesome-project\.venv\Scripts

avant de chercher dans les autres répertoires.

Ainsi, lorsque vous tapez python dans le terminal, le systĂšme trouvera le programme Python dans

C:\Users\user\code\awesome-project\.venv\Scripts\python

et utilisera celui-ci.

Un dĂ©tail important est qu’il placera le chemin de l’environnement virtuel au dĂ©but de la variable PATH. Le systĂšme le trouvera avant de trouver tout autre Python disponible. Ainsi, lorsque vous exĂ©cutez python, il utilisera le Python de l’environnement virtuel au lieu de tout autre python (par exemple, un python d’un environnement global).

Activer un environnement virtuel change aussi deux ou trois autres choses, mais c’est l’un des points les plus importants.

VĂ©rifier un environnement virtuel

Lorsque vous vérifiez si un environnement virtuel est actif, par exemple avec :

$ which python

/home/user/code/awesome-project/.venv/bin/python

$ Get-Command python

C:\Users\user\code\awesome-project\.venv\Scripts\python

Cela signifie que le programme python qui sera utilisĂ© est celui dans l’environnement virtuel.

Vous utilisez which sous Linux et macOS et Get-Command sous Windows PowerShell.

La façon dont cette commande fonctionne est qu’elle va vĂ©rifier la variable d’environnement PATH, en parcourant chaque chemin dans l’ordre, Ă  la recherche du programme nommĂ© python. Une fois trouvĂ©, elle vous affichera le chemin vers ce programme.

La partie la plus importante est que lorsque vous appelez python, c’est exactement « python » qui sera exĂ©cutĂ©.

Ainsi, vous pouvez confirmer si vous ĂȘtes dans le bon environnement virtuel.

Astuce

Il est facile d’activer un environnement virtuel, d’obtenir un Python, puis d’aller vers un autre projet.

Et le second projet ne fonctionnerait pas parce que vous utilisez le Python incorrect, provenant d’un environnement virtuel d’un autre projet.

Il est utile de pouvoir vĂ©rifier quel python est utilisĂ©. đŸ€“

Pourquoi désactiver un environnement virtuel

Par exemple, vous pourriez travailler sur un projet philosophers-stone, activer cet environnement virtuel, installer des packages et travailler avec cet environnement.

Puis vous souhaitez travailler sur un autre projet prisoner-of-azkaban.

Vous allez vers ce projet :

$ cd ~/code/prisoner-of-azkaban

Si vous ne dĂ©sactivez pas l’environnement virtuel de philosophers-stone, lorsque vous exĂ©cutez python dans le terminal, il essaiera d’utiliser le Python de philosophers-stone.

$ cd ~/code/prisoner-of-azkaban

$ python main.py

// Erreur lors de l'import de sirius, il n'est pas installĂ© đŸ˜±
Traceback (most recent call last):
    File "main.py", line 1, in <module>
        import sirius

Mais si vous dĂ©sactivez l’environnement virtuel et activez le nouveau pour prisoner-of-askaban, alors lorsque vous exĂ©cuterez python, il utilisera le Python de l’environnement virtuel de prisoner-of-azkaban.

$ cd ~/code/prisoner-of-azkaban

// Vous n’avez pas besoin d’ĂȘtre dans l’ancien rĂ©pertoire pour dĂ©sactiver, vous pouvez le faire oĂč que vous soyez, mĂȘme aprĂšs ĂȘtre allĂ© dans l’autre projet 😎
$ deactivate

// Activer l’environnement virtuel dans prisoner-of-azkaban/.venv 🚀
$ source .venv/bin/activate

// Maintenant, lorsque vous exĂ©cutez python, il trouvera le package sirius installĂ© dans cet environnement virtuel ✹
$ python main.py

I solemnly swear đŸș

Alternatives

Ceci est un guide simple pour vous lancer et vous montrer comment tout fonctionne en dessous.

Il existe de nombreuses alternatives pour gérer les environnements virtuels, les dépendances de packages (requirements), les projets.

Lorsque vous ĂȘtes prĂȘt et souhaitez utiliser un outil pour gĂ©rer l’ensemble du projet, les dĂ©pendances, les environnements virtuels, etc., je vous suggĂšre d’essayer uv.

uv peut faire beaucoup de choses, il peut :

  • Installer Python pour vous, y compris diffĂ©rentes versions
  • GĂ©rer l’environnement virtuel pour vos projets
  • Installer des packages
  • GĂ©rer les dĂ©pendances de packages et leurs versions pour votre projet
  • Vous assurer d’avoir un ensemble exact de packages et de versions Ă  installer, y compris leurs dĂ©pendances, afin que vous puissiez ĂȘtre certain d’exĂ©cuter votre projet en production exactement comme sur votre ordinateur pendant le dĂ©veloppement, cela s’appelle le locking
  • Et bien d’autres choses

Conclusion

Si vous avez lu et compris tout cela, vous en savez maintenant bien plus sur les environnements virtuels que beaucoup de dĂ©veloppeurs. đŸ€“

ConnaĂźtre ces dĂ©tails vous sera trĂšs probablement utile Ă  l’avenir lorsque vous dĂ©boguerez quelque chose qui semble complexe, mais vous saurez comment tout fonctionne en dessous. 😎