Configuration de Matplotlib pour le développement #

Pour configurer Matplotlib pour le développement, suivez ces étapes :

Récupérer la dernière version du code #

Matplotlib est hébergé sur https://github.com/matplotlib/matplotlib.git .

Vous pouvez récupérer les dernières sources avec la commande (voir Configurer votre fork pour plus de détails)

git clone https://github.com/matplotlib/matplotlib.git

git clone [email protected]:matplotlib/matplotlib.git

Cela vous oblige à configurer une clé SSH à l'avance, mais vous évite de taper votre mot de passe à chaque connexion.

Cela placera les sources dans un répertoire matplotlibsous votre répertoire de travail actuel. Changez dans ce répertoire :

cd matplotlib

Créer un environnement dédié #

Vous devez configurer un environnement dédié pour découpler votre développement Matplotlib des autres installations Python et Matplotlib sur votre système.

La façon la plus simple de le faire est d'utiliser l'environnement virtuel Python venv ou conda .

Créez un nouvel environnement venv avec

python -m venv <file folder location>

et activez-le avec l'un des éléments suivants

source <file folder location>/bin/activate  # Linux/macOS
<file folder location>\Scripts\activate.bat  # Windows cmd.exe
<file folder location>\Scripts\Activate.ps1  # Windows PowerShell

Créer un nouvel environnement conda avec

conda env create -f environment.yml

Vous pouvez utiliser à la mambaplace de condadans la commande ci-dessus si vous avez installé mamba .

Activez l'environnement à l'aide de

conda activate mpl-dev

N'oubliez pas d'activer l'environnement chaque fois que vous commencez à travailler sur Matplotlib.

Installer Matplotlib en mode modifiable #

Installez Matplotlib en mode modifiable depuis le matplotlibrépertoire à l'aide de la commande

python -m pip install -ve .

Le "mode éditable/développé", construit tout et place des liens dans votre environnement Python afin que Python puisse importer Matplotlib depuis votre répertoire source de développement. Cela vous permet d'importer votre version modifiée de Matplotlib sans réinstaller après chaque modification. Notez que cela n'est vrai que pour les *.pyfichiers. Si vous changez la source de l'extension C (ce qui peut également arriver si vous changez de branche), vous devrez relancer python -m pip install -ve .

Installer des dépendances de développement supplémentaires #

Voir Dépendances pour construire Matplotlib .

Installez les crochets de pré-commit (facultatif) #

les crochets de pré-validation vérifient automatiquement flake8 et d'autres problèmes de style lorsque vous exécutez . Les crochets sont définis dans le fichier de niveau supérieur . Pour installer les crochetsgit commit.pre-commit-config.yaml

python -m pip install pre-commit
pre-commit install

Les crochets peuvent également être exécutés manuellement. Tous les crochets peuvent être exécutés, dans l'ordre indiqué dans .pre-commit-config.yaml, sur la base de code complète avec

pre-commit run --all-files

Pour exécuter manuellement un crochet particulier, exécutez -le avec l'identifiant du crochetpre-commit run

pre-commit run <hook id> --all-files