Python ルール

Nightly · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 7.7

ルール

py_binary

ルールのソースを表示 
py_binary(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, exec_compatible_with, exec_properties, features, imports, legacy_create_init, licenses, main, output_licenses, python_version, restricted_to, srcs_version, stamp, tags, target_compatible_with, testonly, toolchains, visibility)

py_binary は、.py ソースファイル（他の py_library ルールに属している可能性あり）のコレクション、プログラムの実行時に必要なすべてのコードとデータを含む *.runfiles ディレクトリ ツリー、正しい初期環境とデータでプログラムを起動するスタブ スクリプトで構成される実行可能な Python プログラムです。

例

py_binary(
    name = "foo",
    srcs = ["foo.py"],
    data = [":transform"],  # a cc_binary which we invoke at run time
    deps = [
        ":foolib",  # a py_library
    ],
)

別のバイナリまたは テスト内から py_binary を実行する場合（たとえば、java_test 内から Python バイナリを実行してモックリソースを設定する場合）、正しい方法は、他のバイナリまたは テストのデータ セクションで py_binary に依存するようにすることです。これにより、他の バイナリはソース ディレクトリを基準にしてpy_binaryを見つけることができます。 

py_binary(
    name = "test_main",
    srcs = ["test_main.py"],
    deps = [":testing"],
)

java_library(
    name = "testing",
    srcs = glob(["*.java"]),
    data = [":test_main"]
)

引数

属性
name

名前（必須）

このターゲットの一意の名前。


`main` が指定されていない場合は、アプリケーションのメイン エントリ ポイントであるソースファイルの名前から拡張子を除いたものと同じにする必要があります。mainたとえば、エントリ ポイントが main.py という名前の場合は、名前を main にする必要があります。
deps

ラベルのリスト。デフォルトは[]

バイナリ ターゲットにリンクされる他のライブラリのリスト。 deps に関する一般的なコメントについては、 ほとんどのビルドルールで定義される一般的な属性をご覧ください。通常、これらは py_library ルールです。
srcs

ラベルのリスト（必須）

ターゲットの作成時に処理されるソース（.py）ファイルのリスト。 これには、チェックイン済みのすべてのコードと、生成されたソースファイルが含まれます。ライブラリ ターゲットは deps に配置され、実行時に必要な他のバイナリファイルは data に配置されます。
imports

文字列のリスト。デフォルトは []

PYTHONPATH に追加するインポート ディレクトリのリスト。

[変数の作成] の置換の対象となります。これらのインポート ディレクトリは、このルールと、このルールに依存するすべてのルールに追加されます（このルールが依存するルールではありません）。各ディレクトリは、このルールに依存する PYTHONPATH ルールによって py_binary に追加されます。

絶対パス（/ で始まるパス）と、実行ルートより上のパスを参照するパスは許可されず、エラーが発生します。
legacy_create_init

整数。デフォルトは -1

runfiles ツリーに空の __init__.py ファイルを暗黙的に作成するかどうか。 これらは、Python ソースコードまたは 共有ライブラリを含むすべてのディレクトリと、リポジトリのルート ディレクトリを除く、それらのディレクトリのすべての親ディレクトリに作成されます。デフォルトの auto は、 --incompatible_default_to_explicit_init_py が使用されていない限り、true を意味します。false の場合、ユーザーは 必要に応じて __init__.py ファイル（空の場合もあります）を作成し、Python ターゲットの srcs に追加する必要があります。
main

ラベル。デフォルトは None

アプリケーションのメイン エントリ ポイントであるソースファイルの名前。 このファイルは srcs にもリストする必要があります。指定しない場合は、 name が使用されます（上記を参照）。name が srcs 内のどのファイル名とも一致しない場合は、main を指定する必要があります。
python_version

文字列。構成不可。デフォルトは"_INTERNAL_SENTINEL"

Python 2 または Python 3 用にこのターゲット（およびその推移的な deps）をビルドするかどうか。有効な値は "PY2" と "PY3"（デフォルト）です。

Python のバージョンは常に（デフォルトで）この属性で指定されたバージョンにリセットされます。これは、コマンドラインで指定されたバージョンや、このターゲットに依存する他の上位ターゲットで指定されたバージョンに関係ありません。

現在の Python バージョンで select() を行う場合は、 @rules_python//python:python_version の値を確認します。詳細については、 こちら をご覧ください。

バグに関する警告: この属性は、Bazel がターゲットをビルドするバージョンを設定しますが、 #4815 により、 結果のスタブ スクリプトが実行時に誤ったインタープリタ バージョンを呼び出す可能性があります。この回避策をご覧ください。この回避策では、必要に応じて Python バージョンを指す py_runtime ターゲットを定義し、--python_top を設定してこの py_runtime を有効にします。
srcs_version

文字列。デフォルトは "PY2AND3"

この属性は、ターゲットの srcs が Python 2、Python 3、またはその両方と互換性があることを宣言します。Python ランタイム バージョンを実際に設定するには、実行可能な Python ルール（py_binary または py_test）の python_version 属性を使用します。

使用できる値は、"PY2AND3"、"PY2"、"PY3" です。 歴史的な理由から "PY2ONLY" と "PY3ONLY" の値も使用できますが、これらは基本的に "PY2" と "PY3" と同じであるため、使用しないでください。

現在の Python バージョンがこの属性の値と照合して実際に検証されるのは、実行可能ルール（py_binary と py_library ）のみです。 （これは機能です。py_library は現在の Python バージョンを変更しないため、検証を行うと、同じ呼び出しで PY2ONLY と PY3ONLY ライブラリの両方をビルドすることはできません）。また、バージョンの不一致がある場合、エラーは実行フェーズでのみ報告されます。特に、 エラーはbazel build --nobuildの呼び出しでは表示されません）。

どの依存関係がバージョンの要件を導入しているかに関する診断情報を取得するには、 ターゲットで find_requirements アスペクトを実行します: 

          bazel build <your target> \
              --aspects=@rules_python//python:defs.bzl%find_requirements \
              --output_groups=pyversioninfo
これにより、ターゲットが特定の Python バージョンを必要とする理由に関する情報を含む、接尾辞 -pyversioninfo.txt のファイルがビルドされます。 指定されたターゲットがバージョンの競合によりビルドに失敗した場合でも機能します。
stamp

整数。デフォルトは -1

ビルド情報をバイナリにエンコードするかどうか。返される可能性のある値は以下のとおりです。
  • stamp = 1: ビルドでも、ビルド情報を常にバイナリにスタンプします。--nostampこの 設定は避ける必要があります。バイナリと、それに依存するダウンストリーム アクションのリモート キャッシュが失われる可能性があります。
  • stamp = 0: ビルド情報を常に定数値に置き換えます。これにより、ビルド結果のキャッシュが適切に行われます。
  • stamp = -1: ビルド情報の埋め込みは、 --[no]stamp フラグによって制御されます。

スタンプされたバイナリは、依存関係が変更されない限り再ビルドされません。

py_library

ルールのソースを表示 
py_library(name, deps, srcs, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, imports, licenses, restricted_to, srcs_version, tags, target_compatible_with, testonly, visibility)

引数

属性
name

名前（必須）

このターゲットの一意の名前。
deps

ラベルのリスト。デフォルトは[]

バイナリ ターゲットにリンクされる他のライブラリのリスト。 deps に関する一般的なコメントについては、 ほとんどのビルドルールで定義される一般的な属性をご覧ください。通常、これらは py_library ルールです。
srcs

ラベルのリスト。デフォルトは[]

ターゲットの作成時に処理されるソース（.py）ファイルのリスト。 これには、チェックイン済みのすべてのコードと、生成されたソースファイルが含まれます。
imports

文字列のリスト。デフォルトは []

PYTHONPATH に追加するインポート ディレクトリのリスト。

[変数の作成] の置換の対象となります。これらのインポート ディレクトリは、このルールと、このルールに依存するすべてのルールに追加されます（このルールが依存するルールではありません）。各ディレクトリは、このルールに依存する PYTHONPATH ルールによって py_binary に追加されます。

絶対パス（/ で始まるパス）と、実行ルートより上のパスを参照するパスは許可されず、エラーが発生します。
srcs_version

文字列。デフォルトは "PY2AND3"

この属性は、ターゲットの srcs が Python 2、Python 3、またはその両方と互換性があることを宣言します。Python ランタイム バージョンを実際に設定するには、実行可能な Python ルール（py_binary または py_test）の python_version 属性を使用します。

使用できる値は、"PY2AND3"、"PY2"、"PY3" です。 歴史的な理由から "PY2ONLY" と "PY3ONLY" の値も使用できますが、これらは基本的に "PY2" と "PY3" と同じであるため、使用しないでください。

現在の Python バージョンがこの属性の値と照合して実際に検証されるのは、実行可能ルール（py_binary と py_library ）のみです。 （これは機能です。py_library は現在の Python バージョンを変更しないため、検証を行うと、同じ呼び出しで PY2ONLY と PY3ONLY ライブラリの両方をビルドすることはできません）。また、バージョンの不一致がある場合、エラーは実行フェーズでのみ報告されます。特に、 エラーはbazel build --nobuildの呼び出しでは表示されません）。

どの依存関係がバージョンの要件を導入しているかに関する診断情報を取得するには、 ターゲットで find_requirements アスペクトを実行します: 

          bazel build <your target> \
              --aspects=@rules_python//python:defs.bzl%find_requirements \
              --output_groups=pyversioninfo
これにより、ターゲットが特定の Python バージョンを必要とする理由に関する情報を含む、接尾辞 -pyversioninfo.txt のファイルがビルドされます。 指定されたターゲットがバージョンの競合によりビルドに失敗した場合でも機能します。

py_test

ルールのソースを表示 
py_test(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, imports, legacy_create_init, licenses, local, main, python_version, restricted_to, shard_count, size, srcs_version, stamp, tags, target_compatible_with, testonly, timeout, toolchains, visibility)

py_test() ルールはテストをコンパイルします。テストは、テストコードのバイナリ ラッパー です。

例

py_test(
    name = "runtest_test",
    srcs = ["runtest_test.py"],
    deps = [
        "//path/to/a/py/library",
    ],
)

メイン モジュールを指定することもできます。

py_test(
    name = "runtest_test",
    srcs = [
        "runtest_main.py",
        "runtest_lib.py",
    ],
    main = "runtest_main.py",
)

引数

属性
name

名前（必須）

このターゲットの一意の名前。
deps

ラベルのリスト。デフォルトは[]

バイナリ ターゲットにリンクされる他のライブラリのリスト。 deps に関する一般的なコメントについては、 ほとんどのビルドルールで定義される一般的な属性をご覧ください。通常、これらは py_library ルールです。
srcs

ラベルのリスト（必須）

ターゲットの作成時に処理されるソース（.py）ファイルのリスト。 これには、チェックイン済みのすべてのコードと、生成されたソースファイルが含まれます。ライブラリ ターゲットは deps に配置され、実行時に必要な他のバイナリファイルは data に配置されます。
imports

文字列のリスト。デフォルトは []

PYTHONPATH に追加するインポート ディレクトリのリスト。

[変数の作成] の置換の対象となります。これらのインポート ディレクトリは、このルールと、このルールに依存するすべてのルールに追加されます（このルールが依存するルールではありません）。各ディレクトリは、このルールに依存する PYTHONPATH ルールによって py_binary に追加されます。

絶対パス（/ で始まるパス）と、実行ルートより上のパスを参照するパスは許可されず、エラーが発生します。
legacy_create_init

整数。デフォルトは -1

runfiles ツリーに空の __init__.py ファイルを暗黙的に作成するかどうか。 これらは、Python ソースコードまたは 共有ライブラリを含むすべてのディレクトリと、リポジトリのルート ディレクトリを除く、それらのディレクトリのすべての親ディレクトリに作成されます。デフォルトの auto は、 --incompatible_default_to_explicit_init_py が使用されていない限り、true を意味します。false の場合、ユーザーは 必要に応じて __init__.py ファイル（空の場合もあります）を作成し、Python ターゲットの srcs に追加する必要があります。
main

ラベル。デフォルトは None

アプリケーションのメイン エントリ ポイントであるソースファイルの名前。 このファイルは srcs にもリストする必要があります。指定しない場合は、 name が使用されます（上記を参照）。name が srcs 内のどのファイル名とも一致しない場合は、main を指定する必要があります。
python_version

文字列。構成不可。デフォルトは"_INTERNAL_SENTINEL"

Python 2 または Python 3 用にこのターゲット（およびその推移的な deps）をビルドするかどうか。有効な値は "PY2" と "PY3"（デフォルト）です。

Python のバージョンは常に（デフォルトで）この属性で指定されたバージョンにリセットされます。これは、コマンドラインで指定されたバージョンや、このターゲットに依存する他の上位ターゲットで指定されたバージョンに関係ありません。

現在の Python バージョンで select() を行う場合は、 @rules_python//python:python_version の値を確認します。詳細については、 こちら をご覧ください。

バグに関する警告: この属性は、Bazel がターゲットをビルドするバージョンを設定しますが、 #4815 により、 結果のスタブ スクリプトが実行時に誤ったインタープリタ バージョンを呼び出す可能性があります。この回避策をご覧ください。この回避策では、必要に応じて Python バージョンを指す py_runtime ターゲットを定義し、--python_top を設定してこの py_runtime を有効にします。
srcs_version

文字列。デフォルトは "PY2AND3"

この属性は、ターゲットの srcs が Python 2、Python 3、またはその両方と互換性があることを宣言します。Python ランタイム バージョンを実際に設定するには、実行可能な Python ルール（py_binary または py_test）の python_version 属性を使用します。

使用できる値は、"PY2AND3"、"PY2"、"PY3" です。 歴史的な理由から "PY2ONLY" と "PY3ONLY" の値も使用できますが、これらは基本的に "PY2" と "PY3" と同じであるため、使用しないでください。

現在の Python バージョンがこの属性の値と照合して実際に検証されるのは、実行可能ルール（py_binary と py_library ）のみです。 （これは機能です。py_library は現在の Python バージョンを変更しないため、検証を行うと、同じ呼び出しで PY2ONLY と PY3ONLY ライブラリの両方をビルドすることはできません）。また、バージョンの不一致がある場合、エラーは実行フェーズでのみ報告されます。特に、 エラーはbazel build --nobuildの呼び出しでは表示されません）。

どの依存関係がバージョンの要件を導入しているかに関する診断情報を取得するには、 ターゲットで find_requirements アスペクトを実行します: 

          bazel build <your target> \
              --aspects=@rules_python//python:defs.bzl%find_requirements \
              --output_groups=pyversioninfo
これにより、ターゲットが特定の Python バージョンを必要とする理由に関する情報を含む、接尾辞 -pyversioninfo.txt のファイルがビルドされます。 指定されたターゲットがバージョンの競合によりビルドに失敗した場合でも機能します。
stamp

整数。デフォルトは 0

テストでは stamp 引数がデフォルトで 0 に設定されていることを除き、py_binary() 引数に関するセクションをご覧ください。

py_runtime

ルールのソースを表示 
py_runtime(name, bootstrap_template, compatible_with, coverage_tool, deprecation, distribs, features, files, interpreter, interpreter_path, licenses, python_version, restricted_to, stub_shebang, tags, target_compatible_with, testonly, visibility)

Python コードの実行に使用される Python ランタイムを表します。

py_runtime ターゲットは、プラットフォーム ランタイムまたは ビルド内ランタイムを表すことができます。プラットフォーム ランタイムは、既知の パスにあるシステムにインストールされたインタープリタにアクセスしますが、ビルド内ランタイムは、インタープリタとして機能する実行可能ターゲットを指します。どちらの場合も、「インタープリタ」とは、標準の CPython インタープリタと同じ規則に従って、コマンドラインで渡された Python スクリプトを実行できる実行可能バイナリまたはラッパー スクリプトを意味します。

プラットフォーム ランタイムは、本質的に非ハーメチックです。特定のパスにインタープリタがあることをターゲット プラットフォーム に要求します。ビルド内ランタイムは、ハーメチックである場合とそうでない場合があります。 チェックインされたインタープリタを指すか、 システム インタープリタにアクセスするラッパー スクリプトを指すかによって異なります。

例:

py_runtime(
    name = "python-2.7.12",
    files = glob(["python-2.7.12/**"]),
    interpreter = "python-2.7.12/bin/python",
)

py_runtime(
    name = "python-3.6.0",
    interpreter_path = "/opt/pyenv/versions/3.6.0/bin/python",
)

引数

属性
name

名前（必須）

このターゲットの一意の名前。
bootstrap_template

ラベル。デフォルトは "@bazel_tools//tools/python:python_bootstrap_template.txt"

以前は「Python スタブ スクリプト」と呼ばれていましたが、これはすべての Python 実行可能ターゲットの エントリ ポイントです。
coverage_tool

ラベル。デフォルトは None

py_binary ターゲットと py_test ターゲットからコード カバレッジ情報を収集するために使用するターゲットです。

設定する場合、ターゲットは単一のファイルを生成するか、実行可能ターゲットである必要があります。 単一のファイルへのパス、またはターゲットが実行可能である場合は実行可能ファイルが、 Python カバレッジ ツールのエントリ ポイントを決定します。カバレッジが有効になっている場合、ターゲットとその runfiles が runfiles に追加されます。

ツールのエントリ ポイントは、Python インタープリタ（ .py や .pyc ファイルなど）で読み込める必要があります。coverage.py のコマンドライン引数 （少なくとも run サブコマンドと lcov サブコマンドを含む）を受け入れる必要があります。
files

ラベルのリスト。デフォルトは[]

ビルド内ランタイムの場合、これはこのランタイムを構成するファイルのセットです。これらのファイルは、このランタイムを使用する Python バイナリの runfiles に追加されます。プラットフォーム ランタイムの場合、この属性は設定しないでください。
interpreter

ラベル。デフォルトは None

ビルド内ランタイムの場合、これはインタープリタとして呼び出すターゲットです。プラットフォーム ランタイムの場合、この属性は設定しないでください。
interpreter_path

文字列。デフォルトは ""

プラットフォーム ランタイムの場合、これはターゲット プラットフォーム上の Python インタープリタの絶対パスです。ビルド内ランタイムの場合、この属性は設定しないでください。
python_version

文字列。デフォルトは "_INTERNAL_SENTINEL"

このランタイムが Python メジャー バージョン 2 または 3 用であるかどうか。有効な値は "PY2" および "PY3" です。

デフォルト値は --incompatible_py3_is_default フラグによって制御されます。 ただし、今後、この属性は必須となり、デフォルト値は設定されなくなります。

stub_shebang

文字列。デフォルトは "#!/usr/bin/env python3"

`py_binary` ターゲットの実行時に使用されるブートストラップ Python スクリプトの先頭に付加される「Shebang」式。

動機については、問題 8685 をご覧ください。

Windows には適用されません。