ルール
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 からモックリソースを設定するなど)、適切な方法では他のバイナリまたはテストをそのデータ セクションの 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 に追加するインポート ディレクトリのリスト。
"Makevariable" 置換の対象となります。これらのインポート ディレクトリは、このルールとそれに依存するすべてのルールに追加されます(注: このルールが依存するルールではありません)。各ディレクトリは、このルールに依存する
絶対パス( |
legacy_create_init
|
--incompatible_default_to_explicit_init_py を使用しない限り true です。false の場合、ユーザーは(空の場合もあります)__init__.py ファイルを作成し、必要に応じて Python ターゲットの srcs に追加する必要があります。
|
main
|
srcs にも存在している必要があります。指定しない場合は、上記の name が使用されます(上記を参照)。name が srcs のファイル名と一致しない場合は、main を指定する必要があります。 |
python_version
|
deps )をビルドするかどうか。有効な値は "PY2" と "PY3" (デフォルト)です。
Python バージョンは、コマンドラインで指定されたバージョンや、この属性に依存する上位の他のターゲットに関係なく、この属性で指定されたバージョンにデフォルトで(場合によってはデフォルトで)リセットされます。 現在の Python バージョンで バグに関する警告: この属性は、Bazel がターゲットをビルドするバージョンを設定しますが、#4815 のため、結果のスタブ スクリプトは実行時に誤ったインタプリタ バージョンを呼び出す可能性があります。こちらの回避策をご覧ください。必要に応じて、Python バージョンのいずれかを指す |
srcs_version
|
srcs が Python 2、Python 3、またはその両方と互換性があることを宣言します。実際に Python ランタイム バージョンを設定するには、実行可能な Python ルールの python_version 属性(py_binary または py_test )を使用します。指定できる値は なお、実行可能ルール( ターゲットの依存関係にバージョン要件を導入する診断情報を取得するには、ターゲットで bazel build <your target> \ --aspects=@rules_python//python:defs.bzl%find_requirements \ --output_groups=pyversioninfo。これにより、接尾辞 -pyversioninfo.txt が付いたファイルがビルドされます。これにより、ターゲットでいずれかの Python バージョンが必要な理由に関する情報が提供されます。バージョンの競合が原因で特定のターゲットがビルドに失敗した場合でも機能します。 |
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 に追加するインポート ディレクトリのリスト。
"Makevariable" 置換の対象となります。これらのインポート ディレクトリは、このルールとそれに依存するすべてのルールに追加されます(注: このルールが依存するルールではありません)。各ディレクトリは、このルールに依存する
絶対パス( |
srcs_version
|
srcs が Python 2、Python 3、またはその両方と互換性があることを宣言します。実際に Python ランタイム バージョンを設定するには、実行可能な Python ルールの python_version 属性(py_binary または py_test )を使用します。指定できる値は なお、実行可能ルール( ターゲットの依存関係にバージョン要件を導入する診断情報を取得するには、ターゲットで bazel build <your target> \ --aspects=@rules_python//python:defs.bzl%find_requirements \ --output_groups=pyversioninfo。これにより、接尾辞 -pyversioninfo.txt が付いたファイルがビルドされます。これにより、ターゲットでいずれかの Python バージョンが必要な理由に関する情報が提供されます。バージョンの競合が原因で特定のターゲットがビルドに失敗した場合でも機能します。 |
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 に追加するインポート ディレクトリのリスト。
"Makevariable" 置換の対象となります。これらのインポート ディレクトリは、このルールとそれに依存するすべてのルールに追加されます(注: このルールが依存するルールではありません)。各ディレクトリは、このルールに依存する
絶対パス( |
legacy_create_init
|
--incompatible_default_to_explicit_init_py を使用しない限り true です。false の場合、ユーザーは(空の場合もあります)__init__.py ファイルを作成し、必要に応じて Python ターゲットの srcs に追加する必要があります。
|
main
|
srcs にも存在している必要があります。指定しない場合は、上記の name が使用されます(上記を参照)。name が srcs のファイル名と一致しない場合は、main を指定する必要があります。 |
python_version
|
deps )をビルドするかどうか。有効な値は "PY2" と "PY3" (デフォルト)です。
Python バージョンは、コマンドラインで指定されたバージョンや、この属性に依存する上位の他のターゲットに関係なく、この属性で指定されたバージョンにデフォルトで(場合によってはデフォルトで)リセットされます。 現在の Python バージョンで バグに関する警告: この属性は、Bazel がターゲットをビルドするバージョンを設定しますが、#4815 のため、結果のスタブ スクリプトは実行時に誤ったインタプリタ バージョンを呼び出す可能性があります。こちらの回避策をご覧ください。必要に応じて、Python バージョンのいずれかを指す |
srcs_version
|
srcs が Python 2、Python 3、またはその両方と互換性があることを宣言します。実際に Python ランタイム バージョンを設定するには、実行可能な Python ルールの python_version 属性(py_binary または py_test )を使用します。指定できる値は なお、実行可能ルール( ターゲットの依存関係にバージョン要件を導入する診断情報を取得するには、ターゲットで bazel build <your target> \ --aspects=@rules_python//python:defs.bzl%find_requirements \ --output_groups=pyversioninfo。これにより、接尾辞 -pyversioninfo.txt が付いたファイルがビルドされます。これにより、ターゲットでいずれかの Python バージョンが必要な理由に関する情報が提供されます。バージョンの競合が原因で特定のターゲットがビルドに失敗した場合でも機能します。 |
stamp
|
|
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
|
|
coverage_tool
|
py_binary ターゲットと py_test ターゲットからコード カバレッジ情報を収集するために使用するターゲットです。設定する場合、ターゲットは単一のファイルを生成するか、実行可能ターゲットにする必要があります。単一のファイルへのパス、またはターゲットが実行可能ファイルの場合の実行可能ファイルは、Python カバレッジ ツールのエントリ ポイントを決定します。ターゲットとそのランファイルは、カバレッジが有効になるとランファイルに追加されます。 ツールのエントリ ポイントは、Python インタープリタ( |
files
|
|
interpreter
|
|
interpreter_path
|
|
python_version
|
"PY2" と "PY3" です。
デフォルト値は |
stub_shebang
|
py_binary ターゲットの実行時に使用されるブートストラップ Python スクリプトの先頭にある「Shebang」式。阻害要因については、問題 8685 をご覧ください。 Windows には適用されません。 |