Installation des modules python (Version historique)

Auteur

Greg Ward

Note

The entire distutils package has been deprecated and will be removed in Python 3.12. This documentation is retained as a reference only, and will be removed with the package. See the What's New entry for more information.

Voir aussi

Installation de modules Python

le document à jour pour l'installation des modules. Pour une utilisation normale de Python, c'est ce document que vous cherchez plutôt que celui-ci.

Note

Cette page est conservée uniquement jusqu'à ce que la documentation setuptool sur https://setuptools.readthedocs.io/en/latest/setuptools.html couvre de manière indépendante toutes les informations pertinentes actuellement incluses ici.

Note

Ce guide ne couvre que les outils de base, fournis avec cette version de Python, pour construire et distribuer des extensions. D'autres outils peuvent être plus sécurisés et plus simple à utiliser. Consultez quick recommendations section dans le Python Packaging User Guide pour plus d'informations.

Introduction

Dans Python 2.0, l'API distutils a d'abord été ajoutée à la bibliothèque standard. Elle a donné aux mainteneurs de distributions Linux une façon standard d'intégrer des projets Python dans les paquets Linux, et aux administrateurs système une façon standard de les installer directement sur les systèmes cibles.

À l'époque où Python 2.0 a été publié, le fort couplage entre le système d'intégration et le gestionnaire de paquets avec le cycle de publication du langage était problématique, et il est désormais recommandé d'utiliser le gestionnaire de paquets pip ainsi que le système d'intégration setuptools plutôt que d'utiliser distutils directement.

Voir Installation de modules Python et Distribuer des modules Python pour plus de détails.

Cette ancienne documentation sera conservée jusqu'à ce que nous soyons certains que la documentation sur setuptools couvre tout ce qui est nécessaire.

Distributions basées sur distutils

If you download a module source distribution, you can tell pretty quickly if it was packaged and distributed in the standard way, i.e. using the Distutils. First, the distribution's name and version number will be featured prominently in the name of the downloaded archive, e.g. foo-1.0.tar.gz or widget-0.9.7.zip. Next, the archive will unpack into a similarly named directory: foo-1.0 or widget-0.9.7. Additionally, the distribution will contain a setup script setup.py, and a file named README.txt or possibly just README, which should explain that building and installing the module distribution is a simple matter of running one command from a terminal:

python setup.py install

Sous Windows, cette commande doit être lancée depuis une invite de commande (Démarrer ‣ Accessoires) :

setup.py install

Si toutes ces choses sont vérifiées, alors vous savez déjà comment construire et installer le module que vous venez de télécharger : en exécutant la commande ci-dessus. Sauf si vous avez besoin d'installer les choses d'une manière non standard ou de personnaliser le processus de construction, vous n'avez pas vraiment besoin de ce manuel. Ou plutôt, la commande ci-dessus est tout ce dont vous avez besoin de retenir de ce manuel.

Construction standard et installation

Comme décrit dans la section Distributions basées sur distutils, construire et installer une distribution de modules en utilisant les Distutils consiste généralement à exécuter une simple commande dans un terminal :

python setup.py install

Différences selon les plateformes

Vous devez toujours exécuter la commande setup à partir du répertoire racine de la distribution, à savoir le sous-répertoire de plus haut niveau dans l'arborescence où se sont décompressées les sources de la distribution du module. Par exemple, si vous venez de télécharger les sources d'une distribution du module foo-1.0.tar.gz sous un système UNIX, la méthode normale consiste à faire :

gunzip -c foo-1.0.tar.gz | tar xf -    # unpacks into directory foo-1.0
cd foo-1.0
python setup.py install

Sous Windows, vous avez probablement téléchargé foo-1.0.zip. Si vous avez téléchargé le fichier d'archive dans C:\Temp, il se décompressera alors dans C:\Temp\foo-1.0 ; vous pouvez utiliser soit un gestionnaire d'archives graphique (comme WinZip), soit un outil de ligne de commande (tels que unzip ou pkunzip) pour décompresser l'archive. Ensuite, ouvrez une fenêtre d'invite de commandes et exécutez :

cd c:\Temp\foo-1.0
python setup.py install

Fractionnement du travail

Exécuter setup.py install construit et installe tous les modules en un seul coup. Si vous préférez travailler progressivement — ce qui est particulièrement utile si vous souhaitez personnaliser le processus de construction ou si les choses vont mal — vous pouvez utiliser le script de configuration pour faire une chose à la fois. Cela est particulièrement utile lorsque la construction et l'installation doit être faite par différents utilisateurs — par exemple, vous pouvez vouloir construire une distribution d'un module et la transférer à un administrateur système pour l'installation (ou le faire vous-même, avec les privilèges de super-utilisateur).

Par exemple, vous pouvez construire tout en une seule étape et ensuite installer le tout dans une deuxième étape, en invoquant le script d'installation deux fois :

python setup.py build
python setup.py install

Si vous faites cela, vous remarquerez que l'exécution de la commande install lance d'abord la commande build, qui, dans ce cas, s'aperçoit vite qu'il n'a rien à faire, puisque tout dans le dossier build est à jour.

Il se peut que vous n'ayez pas souvent besoin de cette capacité à séparer les étapes si tout ce que vous faites est d'installer les modules téléchargés sur le Net, mais c'est très pratique pour des tâches plus avancées. Si vous en venez à distribuer vos propres modules et extensions Python, vous allez exécuter beaucoup de commandes individuelles de Distutils, indépendamment les unes des autres.

Comment fonctionne une construction

Comme sous-entendu ci-dessus, la commande build est chargée de mettre les fichiers à installer dans un répertoire de travail. Par défaut, c'est build à la racine de la distribution ; si vous êtes très préoccupés par la vitesse, ou si vous voulez conserver l'arborescence des sources d'origine, vous pouvez changer le répertoire de construction avec l'option --build-base. Par exemple :

python setup.py build --build-base=/path/to/pybuild/foo-1.0

(Ou vous pourriez le faire de façon permanente avec une directive dans votre système ou dans le fichier de configuration personnelle de Distutils ; voir la section Distutils Configuration Files.) Normalement, ce n'est pas nécessaire.

L'arborescence par défaut produite par la compilation se présente comme suit :

--- build/ --- lib/
or
--- build/ --- lib.<plat>/
               temp.<plat>/

où <plat> représente une brève description de l'actuel système d'exploitation / plateforme matérielle et la version Python. La première forme, avec juste un dossier lib est utilisée pour les « distributions de modules purs » — c'est-à-dire des distributions de module qui n'incorporent que des modules en Python. Si un module de la distribution contient au moins une extension (modules écrits en C/C++), alors il faut utiliser la deuxième forme, avec deux dossiers <plat>. Dans ce cas, le répertoire temp.plat contient les fichiers temporaires générés par le processus de compilation et de génération de liens (ils ne seront pas installés). Dans les deux cas, le dossier lib (ou lib.plat) contient tous les modules Python (Python pur et extensions) qui seront installés.

Dans l'avenir, d'autres répertoires seront ajoutés pour gérer les scripts Python, de la documentation, des exécutables binaires et tout ce qui est nécessaire pour gérer le travail de l'installation de modules et d'applications Python.

Comment fonctionne l'installation

Après l'exécution de la commande build (que vous l'ayez exécutée explicitement ou que la commande install l'ait fait pour vous), le travail de la commande install est relativement simple : tout ce qu'il a à faire est de copier tout ce qui est sous build/lib (ou build/lib.plat) dans le répertoire que vous avez choisi pour l'installation.

If you don't choose an installation directory---i.e., if you just run setup.py install---then the install command installs to the standard location for third-party Python modules. This location varies by platform and by how you built/installed Python itself. On Unix (and macOS, which is also Unix-based), it also depends on whether the module distribution being installed is pure Python or contains extensions ("non-pure"):

Plateforme	Emplacement standard de l'installation	Valeur par défaut	Notes
UNIX (pur)	prefix/lib/pythonX.Y/site-packages	/usr/local/lib/pythonX.Y/site-packages	(1)
UNIX (non-pur)	exec-prefix/lib/pythonX.Y/site-packages	/usr/local/lib/pythonX.Y/site-packages	(1)
Windows	prefix\Lib\site-packages	C:\PythonXY\Lib\site-packages	(2)

Notes :

1. La plupart des distributions Linux incluent Python comme un élément de base du système, donc prefix et exec-prefix sont généralement tous les deux /usr sous Linux. Si vous construisez vous-même Python sous Linux (ou tout autre système de type Unix), les valeurs par défaut de prefix et exec-prefix sont souvent /usr/local.

2. Sous Windows, le dossier d'installation par défaut était : C:\Program Files\Python sous Python 1.6a1, 1.5.2 et avant.

prefix and exec-prefix stand for the directories that Python is installed to, and where it finds its libraries at run-time. They are always the same under Windows, and very often the same under Unix and macOS. You can find out what your Python installation uses for prefix and exec-prefix by running Python in interactive mode and typing a few simple commands. Under Unix, just type python at the shell prompt. Under Windows, choose Start ‣ Programs ‣ Python X.Y ‣ Python (command line). Once the interpreter is started, you type Python code at the prompt. For example, on my Linux system, I type the three Python statements shown below, and get the output as shown, to find out my prefix and exec-prefix:

Python 2.4 (#26, Aug  7 2004, 17:19:02)
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> sys.prefix
'/usr'
>>> sys.exec_prefix
'/usr'

Quelques autres remplacements utilisés dans ce document : X.Y représente la version de Python, par exemple 3.2 ; abiflags sera remplacé par la valeur de sys.abiflags ou la chaîne vide pour les plateformes qui ne définissent pas d’indicateurs d’ABI ; distname sera remplacé par le nom de la distribution de modules en train d’être installée. Les points et la capitalisation sont importantes dans les chemins ; par exemple, une valeur qui utilise python3.2 sur Unix utilisera typiquement Python32 sur Windows.

Si vous ne voulez pas installer des modules à l'emplacement standard, ou si vous n'avez pas la permission d'écrire à cet endroit, alors lisez la section Installation alternative relative aux installations alternatives. Si vous souhaitez personnaliser encore plus vos répertoires d'installation, lisez la section Installation personnalisée sur les installations personnalisées.

Installation alternative

Il est souvent nécessaire ou désirable d’installer des modules à un emplacement autre que l’emplacement standard pour les modules Python tiers. Par exemple, sur un système Unix il est possible que vous n’ayez pas la permission d’écrire dans le dossier standard pour les modules tiers. Ou vous pouvez vouloir essayer un module avant d’en faire une partie standard de votre installation locale de Python. C’est surtout vrai lors d’une mise à jour d’une distribution déjà présente : vous voulez vous assurer que votre base de scripts fonctionne encore avec la nouvelle version avant de faire la mise à jour pour de bon.

La commande install de Distutils est conçue pour rendre l’installation de distributions de modules à un emplacement alternatif simple et sans douleur. L’idée de base est que vous lui fournissez un dossier de base pour l’installation, et la commande install choisit un ensemble de dossiers (appelé le schéma d’installation) dans lequel elle installe les fichiers. Les détails diffèrent d’une plateforme à une autre, donc lisez les sections ci-dessous qui s’appliquent à vous.

Notez que les différents schémas d’installation alternative sont mutuellement exclusifs : vous pouvez passer --user, ou --home, ou --prefix et --exc-prefix, ou --install-base et --install-platbase, mais vous ne pouvez pas mélanger ces groupes.

Installation alternative : le schéma user

Ce schéma est conçu pour être la solution la plus pratique pour les utilisateurs qui n’ont pas la permission d’écrire dans le dossier site-packages global, ou qui ne veulent pas y écrire. Il est activé avec une simple option :

python setup.py install --user

Files will be installed into subdirectories of site.USER_BASE (written as userbase hereafter). This scheme installs pure Python modules and extension modules in the same location (also known as site.USER_SITE). Here are the values for UNIX, including macOS:

Type de fichier	Dossier d'installation
modules	userbase/lib/pythonX.Y/site-packages
scripts	userbase/bin
données	userbase
en-têtes C	userbase/include/pythonX.Yabiflags/distname

Et voici les valeurs utilisées sur Windows :

Type de fichier	Dossier d'installation
modules	userbase\PythonXY\site-packages
scripts	userbase\PythonXY\Scripts
données	userbase
en-têtes C	userbase\PythonXY\Include{distname}

L’avantage d’utiliser ce schéma plutôt que les autres décrits plus bas est que le dossier site-package du schéma user est en temps normal toujours inclus dans sys.path (voir site pour plus d’informations), ce qui signifie qu’il n’y a rien d’autre à faire après avoir exécuté le script setup.py pour finaliser l’installation.

La commande build_ext possède aussi une option --user pour ajouter userbase/include dans les chemins où le compilateur recherche les fichiers d'en-têtes et userbase/lib dans les chemins où le compilateur recherche les bibliothèques ainsi que les bibliothèques C partagées chargeables à l'exécution (rpath).

Installation alternative : le schéma home

L’idée derrière le « schéma home » est que vous compilez et maintenez un espace personnel de modules Python. Le nom de ce schéma vient de l’idée du dossier « home » sur Unix, vu qu’il n’est pas rare pour un utilisateur UNIX d'agencer son dossier home avec la même disposition que /usr/ ou /usr/local/. Ce schéma peut être utilisé par n’importe qui, quel que soit le système d’exploitation.

Installer une nouvelle distribution de module est aussi simple que :

python setup.py install --home=<dir>

où vous pouvez fournir le dossier de votre choix à l’option --home. Sur Unix, les paresseux peuvent mettre un simple tilde (~) ; la commande install le remplacera par le chemin vers votre dossier personnel :

python setup.py install --home=~

Pour que Python puisse trouver les distributions installées avec ce schéma, vous devez modifier le chemin de recherche de Python ou modifier sitecustomize (voir site) pour appeler site.addsitedir() ou modifier sys.path.

L’option --home définit le dossier de base de l’installation. Les fichiers sont installés dans les dossiers suivants sous la base de l'installation de la façon suivante :

Type de fichier	Dossier d'installation
modules	home/lib/python
scripts	home/bin
données	home
en-têtes C	home/include/python/distname

(Remplacez mentalement les slashs avec des antislashs si vous êtes sur Windows.)

Installation alternative : Unix (le schéma de préfixe)

Le schéma de préfixe est utile quand vous voulez une installation de Python pour faire la compilation/l’installation (c.-à-d. exécuter le script setup), mais utiliser les modules tiers d’une installation Python différente (ou quelque chose qui ressemble à une installation Python différente). Si cela vous semble inhabituel, ça l’est — c’est pourquoi les schémas user et home viennent avant. Cependant, il y a au moins deux cas connus où le schéma prefix est utile.

Premièrement, considérez que beaucoup de distributions Linux mettent Python dans /usr, plutôt que le traditionnel /usr/local. C’est tout à fait approprié, puisque dans ces cas Python fait partie du « système » plutôt que d’une addition locale. Cependant, si vous installez des modules Python depuis leur source, vous voulez probablement qu’ils aillent dans /usr/local/lib/python2.X plutôt que dans /usr/lib/python2.X. Ça peut être fait avec :

/usr/bin/python setup.py install --prefix=/usr/local

Une autre possibilité est un système de fichiers réseau où le nom utilisé pour écrire dans un dossier distant est différent du nom utilisé pour le lire : par exemple, l’interpréteur Python auquel on accède par /usr/local/bin/python peut chercher les modules dans /usr/local/lib/python2.X, mais ces modules doivent être installés dans, par exemple, /mnt/@server/export/lib/python2.X. Ça peut être fait avec :

/usr/local/bin/python setup.py install --prefix=/mnt/@server/export

Dans les deux cas, l’option --prefix définit la base de l’installation et l’option --exec-prefix définit la base d’installation spécifique à la plateforme, qui est utilisée pour des fichiers spécifiques à la plateforme (actuellement, ça ne concerne que les distributions de modules non-purs, mais cela pourrait être étendu aux bibliothèques C, exécutables, etc.). Si l'option --exec-prefix n’est pas fournie, elle vaut par défaut --prefix. Les fichiers sont installés ainsi :

Type de fichier	Dossier d'installation
Modules Python	prefix/lib/pythonX.Y/site-packages
modules d'extension	exec-prefix/lib/pythonX.Y/site-packages
scripts	prefix/bin
données	prefix
en-têtes C	prefix/include/pythonX.Yabiflags/distname

Il n'est pas obligatoire que --prefix ou --exec-prefix pointent vers une installation alternative de Python. Si les dossiers listés ci-dessus n’existent pas, ils sont créés au moment de l’installation.

Accessoirement, la vraie raison pour laquelle le schéma prefix est important est simplement qu’une installation Unix standard utilise le schéma prefix, mais avec les options --prefix et --exec-prefix fournies par Python lui-même en tant que sys.prefix et sys.exec_prefix. Vous pouvez donc penser que vous n’utiliserez jamais le schéma prefix, mais à chaque fois que vous lancez python setup.py install sans autre option, vous l’utilisez.

Notez qu’installer des extensions à une installation Python alternative n’a aucun effet sur la façon dont ces extensions sont construites. En particulier, les fichiers en-têtes de Python (Python.h et ses amis) installés avec l’interpréteur Python utilisé pour exécuter le script setup seront utilisés pour compiler les extensions. Il est de votre responsabilité de vous assurer que l’interpréteur utilisé pour exécuter les extensions installées de cette façon est compatible avec celui utilisé pour les compiler. La meilleure façon pour cela est de s’assurer qu’ils sont exactement la même version de Python (possiblement des compilations différentes, ou différentes copies de la même). (Évidemment, si vos --prefix et --exec-prefix ne pointent pas vers une installation alternative de Python, cela n’a pas de sens.)

Installation alternative : Windows (le schéma de préfixe)

Windows n'a pas de concept de répertoire utilisateur, et comme l'installation standard de Python sur Windows est plus simple que sur Unix, l'--prefix option a traditionnellement été utilisée pour installer des paquets supplémentaires à des endroits séparés sur Windows.

python setup.py install --prefix="\Temp\Python"

pour installer des modules dans le dossier \Temp\Python du disque courant.

Le dossier racine de l'installation est défini par l'option --prefix. L'option --exec-prefix n'est pas gérée sur Windows, ce qui signifie que les modules Python et les modules d'extension sont installés au même endroit. Les fichiers sont installés selon ce tableau :

Type de fichier	Dossier d'installation
modules	prefix\Lib\site-packages
scripts	prefix\Scripts
données	prefix
en-têtes C	prefix\Include{distname}

Installation personnalisée

Parfois, les procédés d'installation alternatifs décrits dans la section Installation alternative ne font pas ce que vous attendiez. Vous pourriez vouloir modifier seulement un ou deux répertoires en conservant tout le reste sous la même racine, ou vouloir redéfinir l'ensemble du procédé d'installation. Quel que soit le cas, vous créez ainsi un procédé d'installation personnalisé.

Pour créer un modèle d'installation personnalisé, partez d'un modèle alternatif et remplacez les dossiers d'installation de types de fichiers donnés via ces options :

Type de fichier	Option
Modules Python	--install-purelib
modules d'extension	--install-platlib
tous les modules	--install-lib
scripts	--install-scripts
données	--install-data
en-têtes C	--install-headers

These override options can be relative, absolute, or explicitly defined in terms of one of the installation base directories. (There are two installation base directories, and they are normally the same---they only differ when you use the Unix "prefix scheme" and supply different --prefix and --exec-prefix options; using --install-lib will override values computed or given for --install-purelib and --install-platlib, and is recommended for schemes that don't make a difference between Python and extension modules.)

For example, say you're installing a module distribution to your home directory under Unix---but you want scripts to go in ~/scripts rather than ~/bin. As you might expect, you can override this directory with the --install-scripts option; in this case, it makes most sense to supply a relative path, which will be interpreted relative to the installation base directory (your home directory, in this case):

python setup.py install --home=~ --install-scripts=scripts

Another Unix example: suppose your Python installation was built and installed with a prefix of /usr/local/python, so under a standard installation scripts will wind up in /usr/local/python/bin. If you want them in /usr/local/bin instead, you would supply this absolute directory for the --install-scripts option:

python setup.py install --install-scripts=/usr/local/bin

(This performs an installation using the "prefix scheme", where the prefix is whatever your Python interpreter was installed with--- /usr/local/python in this case.)

If you maintain Python on Windows, you might want third-party modules to live in a subdirectory of prefix, rather than right in prefix itself. This is almost as easy as customizing the script installation directory---you just have to remember that there are two types of modules to worry about, Python and extension modules, which can conveniently be both controlled by one option:

python setup.py install --install-lib=Site

The specified installation directory is relative to prefix. Of course, you also have to ensure that this directory is in Python's module search path, such as by putting a .pth file in a site directory (see site). See section Modifying Python's Search Path to find out how to modify Python's search path.

If you want to define an entire installation scheme, you just have to supply all of the installation directory options. The recommended way to do this is to supply relative paths; for example, if you want to maintain all Python module-related files under python in your home directory, and you want a separate directory for each platform that you use your home directory from, you might define the following installation scheme:

python setup.py install --home=~ \
                        --install-purelib=python/lib \
                        --install-platlib=python/lib.$PLAT \
                        --install-scripts=python/scripts
                        --install-data=python/data

ou :

python setup.py install --home=~/python \
                        --install-purelib=lib \
                        --install-platlib='lib.$PLAT' \
                        --install-scripts=scripts
                        --install-data=data

$PLAT is not (necessarily) an environment variable---it will be expanded by the Distutils as it parses your command line options, just as it does when parsing your configuration file(s).

Obviously, specifying the entire installation scheme every time you install a new module distribution would be very tedious. Thus, you can put these options into your Distutils config file (see section Distutils Configuration Files):

[install]
install-base=$HOME
install-purelib=python/lib
install-platlib=python/lib.$PLAT
install-scripts=python/scripts
install-data=python/data

ou (équivalent),

[install]
install-base=$HOME/python
install-purelib=lib
install-platlib=lib.$PLAT
install-scripts=scripts
install-data=data

Note that these two are not equivalent if you supply a different installation base directory when you run the setup script. For example,

python setup.py install --install-base=/tmp

would install pure modules to /tmp/python/lib in the first case, and to /tmp/lib in the second case. (For the second case, you probably want to supply an installation base of /tmp/python.)

You probably noticed the use of $HOME and $PLAT in the sample configuration file input. These are Distutils configuration variables, which bear a strong resemblance to environment variables. In fact, you can use environment variables in config files on platforms that have such a notion but the Distutils additionally define a few extra variables that may not be in your environment, such as $PLAT. (And of course, on systems that don't have environment variables, such as Mac OS 9, the configuration variables supplied by the Distutils are the only ones you can use.) See section Distutils Configuration Files for details.

Note

When a virtual environment is activated, any options that change the installation path will be ignored from all distutils configuration files to prevent inadvertently installing projects outside of the virtual environment.

Modifying Python's Search Path

When the Python interpreter executes an import statement, it searches for both Python code and extension modules along a search path. A default value for the path is configured into the Python binary when the interpreter is built. You can determine the path by importing the sys module and printing the value of sys.path.

$ python
Python 2.2 (#11, Oct  3 2002, 13:31:27)
[GCC 2.96 20000731 (Red Hat Linux 7.3 2.96-112)] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> sys.path
['', '/usr/local/lib/python2.3', '/usr/local/lib/python2.3/plat-linux2',
 '/usr/local/lib/python2.3/lib-tk', '/usr/local/lib/python2.3/lib-dynload',
 '/usr/local/lib/python2.3/site-packages']
>>>

The null string in sys.path represents the current working directory.

The expected convention for locally installed packages is to put them in the .../site-packages/ directory, but you may want to install Python modules into some arbitrary directory. For example, your site may have a convention of keeping all software related to the web server under /www. Add-on Python modules might then belong in /www/python, and in order to import them, this directory must be added to sys.path. There are several different ways to add the directory.

The most convenient way is to add a path configuration file to a directory that's already on Python's path, usually to the .../site-packages/ directory. Path configuration files have an extension of .pth, and each line must contain a single path that will be appended to sys.path. (Because the new paths are appended to sys.path, modules in the added directories will not override standard modules. This means you can't use this mechanism for installing fixed versions of standard modules.)

Paths can be absolute or relative, in which case they're relative to the directory containing the .pth file. See the documentation of the site module for more information.

A slightly less convenient way is to edit the site.py file in Python's standard library, and modify sys.path. site.py is automatically imported when the Python interpreter is executed, unless the -S switch is supplied to suppress this behaviour. So you could simply edit site.py and add two lines to it:

import sys
sys.path.append('/www/python/')

However, if you reinstall the same major version of Python (perhaps when upgrading from 2.2 to 2.2.2, for example) site.py will be overwritten by the stock version. You'd have to remember that it was modified and save a copy before doing the installation.

There are two environment variables that can modify sys.path. PYTHONHOME sets an alternate value for the prefix of the Python installation. For example, if PYTHONHOME is set to /www/python, the search path will be set to ['', '/www/python/lib/pythonX.Y/', '/www/python/lib/pythonX.Y/plat-linux2', ...].

The PYTHONPATH variable can be set to a list of paths that will be added to the beginning of sys.path. For example, if PYTHONPATH is set to /www/python:/opt/py, the search path will begin with ['/www/python', '/opt/py']. (Note that directories must exist in order to be added to sys.path; the site module removes paths that don't exist.)

Finally, sys.path is just a regular Python list, so any Python application can modify it by adding or removing entries.

Distutils Configuration Files

As mentioned above, you can use Distutils configuration files to record personal or site preferences for any Distutils options. That is, any option to any command can be stored in one of two or three (depending on your platform) configuration files, which will be consulted before the command-line is parsed. This means that configuration files will override default values, and the command-line will in turn override configuration files. Furthermore, if multiple configuration files apply, values from "earlier" files are overridden by "later" files.

Location and names of config files

The names and locations of the configuration files vary slightly across platforms. On Unix and macOS, the three configuration files (in the order they are processed) are:

Type de fichier	Location and filename	Notes
system	prefix/lib/pythonver/distutils/distutils.cfg	(1)
personal	$HOME/.pydistutils.cfg	(2)
local	setup.cfg	(3)

And on Windows, the configuration files are:

Type de fichier	Location and filename	Notes
system	prefix\Lib\distutils\distutils.cfg	(4)
personal	%HOME%\pydistutils.cfg	(5)
local	setup.cfg	(3)

On all platforms, the "personal" file can be temporarily disabled by passing the --no-user-cfg option.

Notes :

1. Strictly speaking, the system-wide configuration file lives in the directory where the Distutils are installed; under Python 1.6 and later on Unix, this is as shown. For Python 1.5.2, the Distutils will normally be installed to prefix/lib/python1.5/site-packages/distutils, so the system configuration file should be put there under Python 1.5.2.

2. On Unix, if the HOME environment variable is not defined, the user's home directory will be determined with the getpwuid() function from the standard pwd module. This is done by the os.path.expanduser() function used by Distutils.

3. I.e., in the current directory (usually the location of the setup script).

4. (See also note (1).) Under Python 1.6 and later, Python's default "installation prefix" is C:\Python, so the system configuration file is normally C:\Python\Lib\distutils\distutils.cfg. Under Python 1.5.2, the default prefix was C:\Program Files\Python, and the Distutils were not part of the standard library---so the system configuration file would be C:\Program Files\Python\distutils\distutils.cfg in a standard Python 1.5.2 installation under Windows.

5. On Windows, if the HOME environment variable is not defined, USERPROFILE then HOMEDRIVE and HOMEPATH will be tried. This is done by the os.path.expanduser() function used by Distutils.

Syntax of config files

The Distutils configuration files all have the same syntax. The config files are grouped into sections. There is one section for each Distutils command, plus a global section for global options that affect every command. Each section consists of one option per line, specified as option=value.

For example, the following is a complete config file that just forces all commands to run quietly by default:

[global]
verbose=0

If this is installed as the system config file, it will affect all processing of any Python module distribution by any user on the current system. If it is installed as your personal config file (on systems that support them), it will affect only module distributions processed by you. And if it is used as the setup.cfg for a particular module distribution, it affects only that distribution.

You could override the default "build base" directory and make the build* commands always forcibly rebuild all files with the following:

[build]
build-base=blib
force=1

which corresponds to the command-line arguments

python setup.py build --build-base=blib --force

except that including the build command on the command-line means that command will be run. Including a particular command in config files has no such implication; it only means that if the command is run, the options in the config file will apply. (Or if other commands that derive values from it are run, they will use the values in the config file.)

You can find out the complete list of options for any command using the --help option, e.g.:

python setup.py build --help

and you can find out the complete list of global options by using --help without a command:

python setup.py --help

See also the "Reference" section of the "Distributing Python Modules" manual.

Building Extensions: Tips and Tricks

Whenever possible, the Distutils try to use the configuration information made available by the Python interpreter used to run the setup.py script. For example, the same compiler and linker flags used to compile Python will also be used for compiling extensions. Usually this will work well, but in complicated situations this might be inappropriate. This section discusses how to override the usual Distutils behaviour.

Tweaking compiler/linker flags

Compiling a Python extension written in C or C++ will sometimes require specifying custom flags for the compiler and linker in order to use a particular library or produce a special kind of object code. This is especially true if the extension hasn't been tested on your platform, or if you're trying to cross-compile Python.

In the most general case, the extension author might have foreseen that compiling the extensions would be complicated, and provided a Setup file for you to edit. This will likely only be done if the module distribution contains many separate extension modules, or if they often require elaborate sets of compiler flags in order to work.

A Setup file, if present, is parsed in order to get a list of extensions to build. Each line in a Setup describes a single module. Lines have the following structure:

module ... [sourcefile ...] [cpparg ...] [library ...]

Let's examine each of the fields in turn.

• module is the name of the extension module to be built, and should be a valid Python identifier. You can't just change this in order to rename a module (edits to the source code would also be needed), so this should be left alone.

• sourcefile is anything that's likely to be a source code file, at least judging by the filename. Filenames ending in .c are assumed to be written in C, filenames ending in .C, .cc, and .c++ are assumed to be C++, and filenames ending in .m or .mm are assumed to be in Objective C.

• cpparg is an argument for the C preprocessor, and is anything starting with -I, -D, -U or -C.

• library is anything ending in .a or beginning with -l or -L.

If a particular platform requires a special library on your platform, you can add it by editing the Setup file and running python setup.py build. For example, if the module defined by the line

foo foomodule.c

must be linked with the math library libm.a on your platform, simply add -lm to the line:

foo foomodule.c -lm

Arbitrary switches intended for the compiler or the linker can be supplied with the -Xcompiler arg and -Xlinker arg options:

foo foomodule.c -Xcompiler -o32 -Xlinker -shared -lm

The next option after -Xcompiler and -Xlinker will be appended to the proper command line, so in the above example the compiler will be passed the -o32 option, and the linker will be passed -shared. If a compiler option requires an argument, you'll have to supply multiple -Xcompiler options; for example, to pass -x c++ the Setup file would have to contain -Xcompiler -x -Xcompiler c++.

Compiler flags can also be supplied through setting the CFLAGS environment variable. If set, the contents of CFLAGS will be added to the compiler flags specified in the Setup file.

Using non-Microsoft compilers on Windows

Borland/CodeGear C++

This subsection describes the necessary steps to use Distutils with the Borland C++ compiler version 5.5. First you have to know that Borland's object file format (OMF) is different from the format used by the Python version you can download from the Python or ActiveState web site. (Python is built with Microsoft Visual C++, which uses COFF as the object file format.) For this reason you have to convert Python's library python25.lib into the Borland format. You can do this as follows:

coff2omf python25.lib python25_bcpp.lib

The coff2omf program comes with the Borland compiler. The file python25.lib is in the Libs directory of your Python installation. If your extension uses other libraries (zlib, ...) you have to convert them too.

The converted files have to reside in the same directories as the normal libraries.

How does Distutils manage to use these libraries with their changed names? If the extension needs a library (eg. foo) Distutils checks first if it finds a library with suffix _bcpp (eg. foo_bcpp.lib) and then uses this library. In the case it doesn't find such a special library it uses the default name (foo.lib.) 1

To let Distutils compile your extension with Borland C++ you now have to type:

python setup.py build --compiler=bcpp

If you want to use the Borland C++ compiler as the default, you could specify this in your personal or system-wide configuration file for Distutils (see section Distutils Configuration Files.)

Voir aussi

C++Builder Compiler

Information about the free C++ compiler from Borland, including links to the download pages.

Creating Python Extensions Using Borland's Free Compiler

Document describing how to use Borland's free command-line C++ compiler to build Python.

GNU C / Cygwin / MinGW

This section describes the necessary steps to use Distutils with the GNU C/C++ compilers in their Cygwin and MinGW distributions. 2 For a Python interpreter that was built with Cygwin, everything should work without any of these following steps.

Not all extensions can be built with MinGW or Cygwin, but many can. Extensions most likely to not work are those that use C++ or depend on Microsoft Visual C extensions.

To let Distutils compile your extension with Cygwin you have to type:

python setup.py build --compiler=cygwin

and for Cygwin in no-cygwin mode 3 or for MinGW type:

python setup.py build --compiler=mingw32

If you want to use any of these options/compilers as default, you should consider writing it in your personal or system-wide configuration file for Distutils (see section Distutils Configuration Files.)

Older Versions of Python and MinGW

The following instructions only apply if you're using a version of Python inferior to 2.4.1 with a MinGW inferior to 3.0.0 (with binutils-2.13.90-20030111-1).

These compilers require some special libraries. This task is more complex than for Borland's C++, because there is no program to convert the library. First you have to create a list of symbols which the Python DLL exports. (You can find a good program for this task at https://sourceforge.net/projects/mingw/files/MinGW/Extension/pexports/).

pexports python25.dll >python25.def

The location of an installed python25.dll will depend on the installation options and the version and language of Windows. In a "just for me" installation, it will appear in the root of the installation directory. In a shared installation, it will be located in the system directory.

Then you can create from these information an import library for gcc.

/cygwin/bin/dlltool --dllname python25.dll --def python25.def --output-lib libpython25.a

The resulting library has to be placed in the same directory as python25.lib. (Should be the libs directory under your Python installation directory.)

If your extension uses other libraries (zlib,...) you might have to convert them too. The converted files have to reside in the same directories as the normal libraries do.

Voir aussi

Building Python modules on MS Windows platform with MinGW

Information about building the required libraries for the MinGW environment.

Notes

1

This also means you could replace all existing COFF-libraries with OMF-libraries of the same name.

2

Check https://www.sourceware.org/cygwin/ for more information

3

Then you have no POSIX emulation available, but you also don't need cygwin1.dll.