L’installation de modules Python

Email:distutils-sig@python.org

En temps que logiciel libre populaire, Python bénéficie d’une communauté active de contributeurs et d’utilisateurs qui rendent à leur tour leurs logiciels disponibles, sous licence libre, pour les autres développeurs Python.

Cela permet aux utilisateurs de Python de partager et de collaborer efficacement, bénéficiant des solutions que les autres ont déjà crées pour résoudre les problèmes communs (ou même, parfois, rares !), aussi que de partager leurs propres solutions à tous.

Ce guide couvre la partie installation. Pour un guide sur la création et le partage de vos propres projets Python, voyez le guide de distribution.

Note

Pour les entreprises et autres institutions, gardez en tête que certaines organisations ont leur propres règles sur l’utilisation et la contribution au logiciel libre. Prennez ces règles en compte lorsque vous utilisez les outils de distribution et d’installation fournis par Python.

Vocabulaire

  • pip est l’outil d’installation de prédilection. À partir de Python 3.4, il est inclus par défaut avec l’installateur de Python.
  • Un environnement virtuel est un environnement Python semi-isolé qui autorise les paquets à être installés pour une application particulière, plutôt que d’être installés au niveau du système.
  • venv est l’outil standard pour créer des environnements virtuels, et est intégré à Python depuis la version 3.3. Depuis Python 3.4, il installe aussi pip dans tous les environnements virtuels créés.
  • virtualenv est une alternative tierce à venv (et son prédécesseur). Elle permet la création d’environnements virtuels pour les versions de Python antérieures à 3.4, qui ne fournissent pas de venv, ou ne sont pas capables d’installer automatiquement pip dans les environnements créés.
  • L”Index des Paquets Python est un dépôt public des paquets sous licence ouverte disponibles pour tous les utilisateurs Python.
  • l”Autorité des Paquets Python est le groupe de développeurs et d’auteurs de documentation responsable de la maintenance et l’évolution des outils d’empaquetage standards et des métadonnées associées, ainsi que des standards sur les formats de fichiers. Ils maintiennent une multitude d’outils, documentations, et des systèmes de tickets sur GitHub et BitBucket.
  • distutils est le premier système de construction et de distribution ajouté à la bibliothèque standard en 1998. Bien que l’utilisation directe de distutils soit progressivement supprimée, elle reste le fondement de l’infrastructure actuelle de construction de paquet et de distribution. Au delà de rester dans la bibliothèque standard, son nom vit aussi sous d’autres formes, tel que la liste de diffusion utilisée pour coordonner le développement et les standards de la création de paquet.

Obsolète depuis la version 3.6: pyvenv était l’outil recommandé pour créer des environnements sous Python 3.3 et 3.4, et est déprécié depuis Python 3.6.

Modifié dans la version 3.5: L’utilisation de venv est maintenant recommandée pour créer vos environnements virtuels.

Utilisation de base

Les outils standards de création de paquets sont tous conçus pour être utilisés à partir de la ligne de commande.

La commande suivante va installer la dernière version d’un module et ses dépendances depuis le Python Package Index

python -m pip install SomePackage

Note

Pour les utilisateurs POSIX (y compris Mac OS X et Linux), les exemples de ce guide supposent l’utilisation d’un environnement virtuel.

Pour les utilisateurs de Windows, les exemples de ce quide supposent que l’option proposant de modifier la variable d’environnement PATH à été cochée lors de l’installation de Python.

Il est aussi possible de préciser une version minimum exacte directement depuis la ligne de commande. Utiliser des caractères de comparaison tel que >, < ou d’autres caractères spéciaux qui sont interprétés par le shell, le nom du paquet et la version doivent être mis entre guillemets:

python -m pip install SomePackage==1.0.4    # specific version
python -m pip install "SomePackage>=1.0.4"  # minimum version

Normalement, si un module approprié est déjà installé, l’installer à nouveau n’aura aucun effet. La mise à jour de modules existants doit être demandée explicitement :

python -m pip install --upgrade SomePackage

Plus d’informations et de ressources concernant pip et ses capacités peuvent être trouvées dans le Python Packaging User Guide.

La création d’environnements virtuels est réalisée grâce au module venv. Installer des paquets au sein de l’environnement virtuel courant utilise les commandes montrées précédemment.

Comment puis-je …?

Ce sont des réponses rapides ou des liens pour certaines tâches courantes.

… Installer pip avec une version de Python antérieures à la 3.4 ?

Python n’a commencé à fournir pip depuis Python 3.4. Pour les versions précédentes, pip a besoin d’être « amorcé » tel que décrit dans le Python Packaging User Guide.

… Installer des paquets juste pour l’utilisateur actuel ?

Donner l’option --user à python -m pip install lui fera installer un paquet juste pour l’utilisateur en cours, plutôt que pour tous les utilisateurs du système.

… Installer des paquets Python scientifiques ?

Un certain nombre de paquets scientifiques Python ont des dépendances binaires complexes, et ne sont pas actuellement faciles à installer directement avec pip. Pour le moment, il est souvent plus simple pour les utilisateurs d’installer ces paquets par d’autres moyens plutôt que d’essayer de les installer avec pip.

… Travailler avec plusieurs versions de Python installés en parallèle ?

Sous Linux, Max OS X et autres systèmes POSIX, utiliser les commandes Python de la version souhaitée en combinaison avec l’option -m permet de lancer la version appropriée de pip :

python2   -m pip install SomePackage  # default Python 2
python2.7 -m pip install SomePackage  # specifically Python 2.7
python3   -m pip install SomePackage  # default Python 3
python3.4 -m pip install SomePackage  # specifically Python 3.4

Les versions appropriées des commandes pip peuvent aussi être disponibles.

Sous Windows, utilisez le lanceur Python py en combinaison avec l’option -m

py -2   -m pip install SomePackage  # default Python 2
py -2.7 -m pip install SomePackage  # specifically Python 2.7
py -3   -m pip install SomePackage  # default Python 3
py -3.4 -m pip install SomePackage  # specifically Python 3.4

Les problèmes d’installation typiques

Installer dans le Python du système sur Linux

Sur les systèmes Linux, une installation de Python sera généralement inclue dans le cadre de la distribution. Installer dans cette installation de Python nécessite un accès root sur le système, et peut interférer avec le fonctionnement du gestionnaire de paquets du système et d’autres composants du système si un composant est mis à jour de façon inattendue en utilisant pip.

Sur de tels systèmes, il est souvent préférable d’utiliser un environnement virtuel ou une installation par l’utilisateur lors de l’installation des paquets avec pip.

Pip n’est pas installé

Il est possible que pip ne soit pas installé par défaut. Une solution est :

python -m ensurepip --default-pip

Voir aussi installing pip.

Installation d’extensions binaires

Python a généralement beaucoup misé sur une distribution basée sur les sources, avec laquelle les utilisateurs finaux devaient compiler, lors de l’installation, les modules d’extension à partir des sources.

Avec l’introduction du format binaire wheel, et la possibilité de publier des wheels, pour, au moins Windows et Mac OS X, via le Python Package Index, ce problème devrait diminuer au fil du temps, car les utilisateurs sont plus régulièrement en mesure d’installer des extensions pré-compilées plutôt que de devoir les compiler eux-mêmes.

Certaines solutions pour installer des paquets scientifiques qui ne sont pas encore disponibles comme wheel pré-construites peuvent aussi aider à obtenir d’autres extensions binaires sans devoir les construire localement.