開発用の Matplotlib のセットアップ#

開発用に Matplotlib をセットアップするには、次の手順に従います。

コードの最新バージョンを取得する#

Matplotlib はhttps://github.com/matplotlib/matplotlib.gitでホストされています。

コマンドを使用して最新のソースを取得できます (詳細については 、フォークのセットアップを参照してください) 。

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

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

これには、事前にSSH キーを設定する必要がありますが、接続のたびにパスワードを入力する手間が省けます。

matplotlibこれにより、現在の作業ディレクトリの下のディレクトリにソースが配置されます。次のディレクトリに移動します。

cd matplotlib

専用環境を作成する#

専用の環境をセットアップして、システム上の他の Python および Matplotlib インストールから Matplotlib 開発を分離する必要があります。

これを行う最も簡単な方法は、Python の仮想環境 venvまたはcondaを使用することです。

で新しいvenv環境を作成します

python -m venv <file folder location>

次のいずれかでアクティブ化します

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

で新しいconda環境を作成します

conda env create -f environment.yml

マンバがインストールされている場合は、上記のコマンドのmamba代わりに使用できます。conda

を使用して環境をアクティブ化します

conda activate mpl-dev

Matplotlib の作業を開始するたびに、環境を有効にすることを忘れないでください。

Matplotlib を編集可能モードでインストールする#

matplotlibコマンドを使用してディレクトリから編集可能モードで Matplotlib をインストールします。

python -m pip install -ve .

「編集可能/開発モード」では、すべてをビルドし、Python 環境にリンクを配置して、Python が開発ソース ディレクトリから Matplotlib をインポートできるようにします。これにより、変更のたびに再インストールすることなく、変更したバージョンの Matplotlib をインポートできます。これは*.pyファイルにのみ当てはまることに注意してください。C 拡張ソースを変更した場合 (ブランチを変更した場合にも発生する可能性があります)、再実行する必要があります。 python -m pip install -ve .

追加の開発依存関係をインストールする#

Matplotlib を構築するための依存関係を参照してください。

pre-commit フックをインストールする (オプション) #

pre-commitフックは、実行時に flake8 およびその他のスタイルの問題を自動的にチェックします。フックは最上位ファイルで定義されます。フックを取り付けるにはgit commit.pre-commit-config.yaml

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

フックは手動で実行することもできます。.pre-commit-config.yamlすべてのフックは、 にリストされている順序で、完全なコードベースに対して実行できます。

pre-commit run --all-files

特定のフックを手動で実行するには、フック IDで実行しますpre-commit run

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