Python ルール

Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 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.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" と同じであり、避けるべきです。

実行可能なルール（py_binary と py_library ）のみが、この属性の値に対して現在の Python バージョンを実際に検証します。（これは機能です。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 に追加するインポート ディレクトリのリスト。

「変数を作成」の置換の対象となります。これらのインポート ディレクトリは、このルールとそれに依存するすべてのルールに追加されます（注: このルールが依存するルールではありません）。各ディレクトリは、このルールに依存する 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" と同じであり、避けるべきです。

実行可能なルール（py_binary と py_library ）のみが、この属性の値に対して現在の Python バージョンを実際に検証します。（これは機能です。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" と同じであり、避けるべきです。

実行可能なルール（py_binary と py_library ）のみが、この属性の値に対して現在の Python バージョンを実際に検証します。（これは機能です。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() 引数に関するセクションをご覧ください。ただし、テストでは stamp 引数はデフォルトで 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 には適用されません。