wikinotes

Cette page est en lecture seule. Vous pouvez afficher le texte source, mais ne pourrez pas le modifier. Contactez votre administrateur si vous pensez qu'il s'agit d'une erreur.
{{tag>dev python virtualenv venv environnement virtuel}}

====== Environnements virtuels en Python ======

Plusieurs solutions existent. Depuis python 3.3 la bibliothèque **venv** est intégrée, c'est la solution recommandée avec Python3, l'usage de **virtualenv** est déprécié ou réservé à des besoins spécifiques.

**virtualenv** est une bibliothèque externe qui peut être utile notamment avec les plus anciennes versions de python ou pour construire un environnement avec un interpréteur Python différent.

Chaque environnement virtuel est isolé des autres et du système. Le script ou l'application Python peut ainsi déployer ses dépendances dans l'environnement virtuel **actif** sans impacter indirectement  d'autres applications Python présentes sur le même système. Dans chaque environnement virtuel, on pourra utiliser une version spécifique de l’interpréteur Python, des modules et bibliothèques externes sans affecter les autres application ou le système hôte.

===== venv =====

==== Créer l’environnement virtuel ====

Dans cet exemple on crée un environnement virtuel que l'on nomme ''env1'':
<code batch>
python3 -m venv env1
</code>

L'opération aboutie à la création d'un dossier ''env1'' dans le répertoire courant. Il contient les binaires et l'arborescence nécessaire à la gestion de cet environnement virtuel.

<note>
Notons que le script ou le programme Python qui utilisera cet environnement **ne devra pas nécessairement se trouver dans le même répertoire** ni même dans env1. L'environnement virtuel devra simplement être activé avant appel du script. 
</note>


Parmi les options disponibles à la création de l'environnement virtuel on trouve notamment:

^ --no-site-packages  | n’inclura pas les paquets installés globalement sur le système hôte. |
^ --without-pip       | n’intègre pas pip à l'environnement virtuel                          |
^ --prompt            | définir le prompt de l'environnement virtuel                         |



==== Activer/désactiver l'environnement ====

Pour activer notre environnement virtuel ''env1'':
<code batch>
$ source ./env1/bin/activate
</code>

Lorsque le projet est actif, le prompt est modifié. Le nom de l'environnement virtuel apparait entre parenthèses. Pour sortir de l'environnement virtuel, exécuter le script **deactivate**:

<code batch>
(mon_projet)$ deactivate
</code>

==== Recréer l'environnement virtuel ====

L'environnement virtuel ne doit pas être suivi par les outils de gestion de révision (confère [[dev:python:environnement_virtuel_avec_git|Ignorer l'environnement virtuel Python dans Git]]). En général quand un programme python et redéployé ou déplacé, l'environnement virtuel est recréé (confère [[dev:python:deplacer_environnement_virtuel|Déplacer un programme Python]]. Les trois étapes sont les suivantes :

  - Recréer l'environnement ;
  - Activer l'environnement ;
  - Réinstaller les dépendances.

<code bash>
# Recréer l'environnement dans le dossier courant
python3 -m venv .venv

# Activer l'environnement virtuel .venv
source .venv/bin/activate

# Réinstaller les dépendances nécessaires au fonctionnement du programme
pip install -r requirements.txt
</code>


===== virtualenv =====

==== Installer virtualenv ====

<code bash>
$ pip install --user virtualenv
</code>

Le script python est placé dans ~/.local/ vérifier que les droit d'execution sont positionnés et faire un lien symbolique dans un dossier contenu dans le path pour l'utilisateur.

<code bash>
$ chmod 554 ~/.local/lib/python2.7/site-packages/virtualenv.py
$ ln -s ~/.local/lib/python2.7/site-packages/virtualenv.py ~/bin/virtualenv
</code>

==== Créer un environnement virtuel ====

Pour créer un environnement virtuel, invoquer la commande virtualenv avec le path du projet. Des options peuvent être spécifiées à la création de l'environnement:

^ %%--%%python=/chemin/interpreteur    | chemin de l’interpréteur python à utiliser.   |
^ %%--%%system-sites-packages          | L'environnement a accès aux bibliothèques de l'environnement global (par défaut ce n'est pas le cas) |
^ %%--%%no-site-packages               | L'environnement virtuel ne bénéficie pas des packages installés sur le système local. |

<code bash>
$ virtualenv  mon_projet
</code>


==== Activer/désactiver l'environnement virtuel ====

<code bash>
$ source mon_projet/env_monprojet/bin/activate
</code>

Lorsque l'environnement virtuel est actif, le nom de l'environnement apparaît entre parenthèses dans le prompt. Pour quitter l'environnement, il suffit de taper la commande **deactivate**:

<code bash>
$ deactivate
</code>


===== Dépannages =====

Quelques notes de troubleshooting autour des environnements virtuels Python :

  * [[dev:python:venv_script_activate_absent|Script activate absent de l’environnent virtuel Python nouvellement créé.]]


===== Références =====

  * http://sametmax.com/les-environnement-virtuels-python-virtualenv-et-virtualenvwrapper/
  * https://apprendre-python.com/page-virtualenv-python-environnement-virtuel
wikinotes

Outils pour utilisateurs

Outils du site

Outils de la page
