setup python

セットアップ-Python

このアクションは、GitHub Actions ユーザーに次の機能を提供します。

• Python または PyPy のバージョンをインストールし、(デフォルトで) PATH に追加します。
• オプションで pip、pipenv、poetry の依存関係をキャッシュします
• エラー出力用の問題マッチャーの登録

基本的な使い方

action.yml を参照してください。

パイソン

 steps :
- uses : actions/checkout@v4
- uses : actions/setup-python@v5
  with :
    python-version : ' 3.13 ' 
- run : python my_script.py

ピピ

 steps :
- uses : actions/checkout@v4
- uses : actions/setup-python@v5 
  with :
    python-version : ' pypy3.10 ' 
- run : python my_script.py

グラルパイ

 steps :
- uses : actions/checkout@v4
- uses : actions/setup-python@v5 
  with :
    python-version : ' graalpy-24.0 ' 
- run : python my_script.py

python-version入力はオプションです。指定しない場合、アクションはデフォルトの.python-versionファイルからバージョンを解決しようとします。 .python-versionファイルが存在しない場合は、PATH からの Python または PyPy バージョンが使用されます。 PATH の Python または PyPy のデフォルト バージョンはランナーによって異なり、予期せず変更される可能性があるため、常にpython-versionまたはpython-version-file入力を使用して Python バージョンを明示的に設定することをお勧めします。

このアクションでは、まずローカル ツール キャッシュでサーバーの一致がチェックされます。ツール キャッシュで特定のバージョンが見つからない場合、アクションは Python のバージョンを GitHub Releases から、PyPy のバージョンを公式 PyPy の dist からダウンロードしようとします。

GitHub でホストされているランナー上でローカルにキャッシュされたバージョンの Python または PyPy については、GitHub Actions Runner Images を確認してください。

サポートされているバージョンの構文

python-version入力は、セマンティック バージョニング仕様といくつかの特別なバージョン表記 (例: semver ranges 、 xy-dev syntaxなど) をサポートしています。詳細な例については、高度な使用法ガイドの「Python-version 入力の使用」セクションを参照してください。

サポートされているアーキテクチャ

architecture入力を使用すると、必要な Python または PyPy インタープリタ アーキテクチャ ( x86 、 x64 、またはarm64を指定できます。入力が指定されていない場合、アーキテクチャはデフォルトでホスト OS アーキテクチャになります。

パッケージの依存関係をキャッシュする

このアクションには、依存関係をキャッシュおよび復元するための機能が組み込まれています。依存関係をキャッシュするために内部でツールキット/キャッシュを使用しますが、必要な構成設定は少なくなります。サポートされているパッケージ マネージャーは、 pip 、 pipenvおよびpoetryです。 cache入力はオプションであり、キャッシュはデフォルトではオフになっています。

このアクションのデフォルトでは、リポジトリ内で依存関係ファイル (pip の場合はrequirements.txtまたはpyproject.toml 、pipenv の場合はPipfile.lock 、詩の場合はpoetry.lock ) を検索し、そのハッシュをキャッシュ キーの一部として使用します。入力cache-dependency-path複数の依存関係ファイルが使用され、使用するハッシュの異なるサブディレクトリまたは異なるファイルに配置されている場合に使用されます。

• pipの場合、アクションはグローバル キャッシュ ディレクトリをキャッシュします。
• pipenvの場合、アクションは virtualenv ディレクトリをキャッシュします
• poetryの場合、このアクションは、見つかった詩プロジェクトごとに 1 つずつ、virtualenv ディレクトリをキャッシュします。

pip 依存関係のキャッシュ:

 steps :
- uses : actions/checkout@v4
- uses : actions/setup-python@v5
  with :
    python-version : ' 3.13 '
    cache : ' pip ' # caching pip dependencies
- run : pip install -r requirements.txt

注: requirements.txt ファイルが長期間更新されず、新しいバージョンの依存関係が利用可能な場合、復元されたキャッシュは使用されず、合計ビルド時間の増加につながる可能性があります。

要件ファイル形式では、論理演算子 (chardet>=3.0.4 など) を使用して依存関係のバージョンを指定したり、バージョンを指定せずに依存関係を指定したりできます。この場合、 pip install -rrequirements.txt コマンドは常に、利用可能な最新のパッケージ バージョンのインストールを試みます。キャッシュが確実に使用されるようにするには、特定の依存関係バージョンを使用し、必要に応じて手動で更新してください。

pipenvとpoetryのcacheとcache-dependency-pathパスの使用例については、高度な使用法ガイドの「パッケージのキャッシュ」セクションを参照してください。

高度な使用法

• Python バージョンの入力を使用する
• Python-version-file 入力の使用
• 最新バージョンを確認する
• パッケージのキャッシュ
• 出力と環境変数
• Python、PyPy、GraalPy の利用可能なバージョン
• ホスト型ツールキャッシュ
• 自己ホスト型ランナーでのsetup-pythonの使用
• GHES でのsetup-pythonの使用
• プレリリースを許可する

ライセンス

このプロジェクトのスクリプトとドキュメントは、MIT ライセンスに基づいてリリースされています。

貢献

貢献は大歓迎です！寄稿者ガイドをご覧ください。