规则
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 的导入目录列表。
需遵循替换 "Make variable" 的规定。系统会为此规则以及依赖于它的所有规则添加这些导入目录(注意:不是此规则依赖的规则)。每个目录都将由依赖于此规则的
不允许使用绝对路径(以 |
legacy_create_init
|
整数;默认值为 --incompatible_default_to_explicit_init_py 。如果为 false,用户负责创建(可能为空)__init__.py 文件,并根据需要将其添加到 Python 目标的 srcs 。
|
main
|
标签;默认值为 srcs 中列出。如果未指定,则系统会改用 name (见上文)。如果 name 与 srcs 中的任何文件名都不匹配,则必须指定 main 。
|
python_version
|
字符串;不可配置;默认值为 deps )。有效值为 "PY2" 和 "PY3" (默认值)。
无论命令行或依赖于此目标的其他更高级别目标指定了哪个版本,Python 版本始终会重置(可能默认)为此属性指定的任何版本。 如果您想在当前 Python 版本上执行 错误警告:此属性用于设置 Bazel 构建目标的版本,但由于 #4815,生成的桩脚本在运行时可能仍会调用错误的解释器版本。请参阅此解决方法,其中涉及定义一个 |
srcs_version
|
字符串;默认值为 srcs 与 Python 2、Python 3 或两者兼容。如需实际设置 Python 运行时版本,请使用可执行的 Python 规则(py_binary 或 py_test )的 python_version 属性。允许的值包括: 请注意,只有可执行规则 ( 如需获取有关哪些依赖项引入了版本要求的诊断信息,您可以对目标运行 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 的一般说明,请参阅大多数 build 规则定义的典型属性。
这些规则通常是 py_library 规则。
|
srcs
|
标签列表;默认值为 .py ) 文件的列表。
这包括您已提交的所有代码和任何生成的源文件。
|
imports
|
字符串列表;默认值为 PYTHONPATH 的导入目录的列表。
需遵循“Make 变量”替换规则。系统会为此规则以及依赖于它的所有规则添加这些导入目录(注意:并非此规则所依赖的规则。每个目录将通过依赖于此规则的
不允许使用绝对路径(以 |
srcs_version
|
字符串;默认值为 srcs 与 Python 2 和/或 Python 3 兼容。如需实际设置 Python 运行时版本,请使用可执行 Python 规则 (py_binary 或 py_test ) 的 python_version 属性。
允许的值包括: 请注意,只有可执行规则 ( 如需获取有关哪些依赖项引入了版本要求的诊断信息,您可以对目标运行 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 的导入目录列表。
需遵循“Make 变量”替换规则。系统会为此规则以及依赖于它的所有规则添加这些导入目录(注意:并非此规则所依赖的规则。每个目录都将由依赖于此规则的
不允许使用绝对路径(以 |
legacy_create_init
|
整数;默认值为 --incompatible_default_to_explicit_init_py 。如果为 false,则用户负责创建(可能为空的)__init__.py 文件,并根据需要将其添加到 Python 目标的 srcs 中。 |
main
|
标签;默认值为 srcs 中列出。如果未指定,则改用 name (参见上文)。如果 name 与 srcs 中的任何文件名都不匹配,则必须指定 main 。
|
python_version
|
字符串;不可配置;默认值为 deps )。有效值为 "PY2" 和 "PY3" (默认值)。
无论命令行或依赖于此目标的其他更高级别目标指定了哪个版本,Python 版本始终会重置(可能默认)为此属性指定的任何版本。 如果要对当前的 Python 版本执行 bug 警告:此属性设置 Bazel 构建目标的版本,但由于 #4815,生成的存根脚本可能仍会在运行时调用错误的解释器版本。请参阅此解决方法,其中涉及根据需要定义指向任一 Python 版本的 |
srcs_version
|
字符串;默认值为 srcs 与 Python 2、Python 3 或两者兼容。如需实际设置 Python 运行时版本,请使用可执行 Python 规则 (py_binary 或 py_test ) 的 python_version 属性。
允许的值包括: 请注意,只有可执行规则 ( 如需获取有关哪些依赖项引入了版本要求的诊断信息,您可以对目标运行 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
目标可以表示平台运行时或构建内运行时。平台运行时会访问已知路径中的系统安装的解释器,而 build 内运行时会指向用作解释器的可执行目标。在这两种情况下,“解释器”是指能够按照与标准 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 覆盖率工具的入口点。启用覆盖率功能后,目标及其 runfile 将添加到 runfile 中。 该工具的入口点必须可由 Python 解释器(例如 |
files
|
标签列表;默认值为 |
interpreter
|
标签;默认值为 |
interpreter_path
|
字符串;默认值为 |
python_version
|
字符串;默认值为 "PY2" 和 "PY3" 。
默认值由 |
stub_shebang
|
字符串;默认值为 py_binary 目标。
如需了解原因,请参阅问题 8685。 不适用于 Windows。 |