Python ルール

7.3 · 7.2 · 7.1 · 7.0 · 6.5

ルール

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 は実行可能な Python プログラムです。.py ソースファイル（他の py_library ルールに属する場合もあります）、実行時にプログラムが必要とするすべてのコードとデータを含む *.runfiles ディレクトリ ツリー、正しい初期環境とデータを使用してプログラムを起動するスタブ スクリプトで構成されます。

例

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 を実行する場合（たとえば、Python バイナリを実行して java_test 内からモック リソースを設定する場合）、他のバイナリまたはテストをデータ セクションの 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.py という名前の場合は、main という名前にします。
deps

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

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

ラベルのリスト（必須）

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

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

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

「変数を作成」による置換が適用されます。これらのインポート ディレクトリは、このルールとそれに依存するすべてのルールに追加されます（注: このルールが依存するルールではありません。各ディレクトリは、このルールに依存する py_binary ルールによって PYTHONPATH に追加されます。

絶対パス（/ で始まるパス）と実行ルートより上のパスを参照するパスは許可されておらず、エラーが発生します。
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" です。

このターゲット（およびその伝播 deps）を Python 2 または Python 3 用にビルドするかどうか。有効な値は "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
これにより、サフィックス -pyversioninfo.txt が付いたファイルがビルドされ、ターゲットにいずれかの Python バージョンが必要な理由が示されます。これは、バージョンの競合が原因で指定したターゲットのビルドに失敗した場合でも機能します。
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 に追加するインポート ディレクトリのリスト。

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

絶対パス（/ で始まるパス）と実行ルートより上のパスを参照するパスは許可されておらず、エラーが発生します。
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 に追加するインポート ディレクトリのリスト。

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

絶対パス（/ で始まるパス）と実行ルートより上のパスを参照するパスは許可されておらず、エラーが発生します。
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" です。

このターゲット（およびその伝播 deps）を Python 2 用と Python 3 用のどちらでビルドするか。有効な値は "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 です。

py_binary() 引数に関するセクションをご覧ください。ただし、テストではスタンプ引数がデフォルトで 0 に設定されます。

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 カバレッジ ツールのエントリ ポイントは、単一ファイルへのパス、またはターゲットが実行可能な場合は実行可能ファイルのパスによって決まります。カバレッジが有効になっている場合、ターゲットとそのランファイルがランファイルに追加されます。

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

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

ビルド内ランタイムの場合、これはこのランタイムを構成する一連のファイルです。これらのファイルは、このランタイムを使用する Python バイナリのランファイルに追加されます。プラットフォーム ランタイムの場合は、この属性を設定しないでください。
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 スクリプトの先頭に追加される「シェバン」式。

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

Windows には適用されません。