Skip to main content
Skip to content

Pythonの構築とテスト

継続的インテグレーション (CI) ワークフローを作成して、Python プロジェクトをビルドしてテストする方法について説明します。

はじめに

このガイドでは、Python パッケージをビルド、テスト、発行する方法について説明します。

GitHub ホストランナーには、Pythonと PyPy を含む、プレインストールされたソフトウェアを含むツール キャッシュがあります。 自分では何もインストールする必要がありません! 最新のソフトウェアと、Python および PyPy のプリインストール済みのバージョンの完全な一覧については、GitHub ホステッド ランナー を参照してください。

前提条件

YAML と GitHub Actionsの構文について理解している必要があります。 詳しくは、「ワークフローの書き込み」をご覧ください。

Pythonと pip の基本的な理解をお勧めします。 詳細については、以下を参照してください:

Python ワークフロー テンプレートの使用

すぐに開始するには、リポジトリの .github/workflows ディレクトリにワークフロー テンプレートを追加します。

GitHub には、リポジトリに少なくとも 1 つの .py ファイルが既に含まれている場合に機能するPythonのワークフロー テンプレートが用意されています。 このガイドの以降のセクションでは、このワークフロー テンプレートをカスタマイズする方法の例を示します。

  1. GitHub で、リポジトリのメイン ページに移動します。

  2. リポジトリ名の下にある [ Actions] をクリックします。

    "github/docs" リポジトリのタブのスクリーンショット。 [アクション] タブがオレンジ色の枠線で強調表示されています。

  3. ワークフローが既にリポジトリ内にある場合は、 [新しいワークフロー] をクリックします。

  4. [ワークフローの選択] ページには、推奨されるワークフロー テンプレートの選択が表示されます。 "Python アプリケーション" を検索します。

  5. [Python アプリケーション] ワークフローで、Configure をクリックします。

  6. 必要に応じてワークフローを編集します。 たとえば、Pythonバージョンを変更します。

  7. [Commit changes] をクリックします。

python-app.yml ワークフロー ファイルがリポジトリの.github/workflows ディレクトリに追加されます。

Python バージョンの指定

GitHub ホストランナーでプレインストールされたバージョンのPythonまたは PyPy を使用するには、setup-python アクションを使用します。 このアクションでは、各ランナーのツール キャッシュから特定のバージョンのPythonまたは PyPy を検索し、必要なバイナリを PATH に追加します。このバイナリはジョブの残りの部分で保持されます。 特定のバージョンのPythonがツール キャッシュにプレインストールされていない場合、setup-python アクションは、python-versions リポジトリから適切なバージョンをダウンロードして設定します。

setup-python アクションを使用すると、GitHub Actions でPythonを使用することをお勧めします。これは、異なるランナーと異なるバージョンのPythonで一貫した動作が保証されるためです。 セルフホステッド ランナーを使用している場合は、Pythonをインストールし、PATH に追加する必要があります。 詳細については、「setup-pythonアクション」を参照してください。

次の表は、各 GitHubホストランナーのツール キャッシュの場所を示しています。

UbuntuMacWindows
ツール キャッシュ ディレクトリ