Python 规则

规则

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 = [":testlib"],
)

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

参数

属性
name

Name; required

此目标的唯一名称。


如果未指定 main，则应与作为应用主入口点的源文件的名称相同（减去扩展名）。例如，如果您的入口点名为 main.py，您的名称应为 main。
deps

List of labels; optional

要链接到二进制目标的其他库的列表。请参阅 大多数构建规则定义的典型属性中有关 deps 的一般注释。这些规则通常是 py_library 规则。
srcs

List of labels; required

为创建目标而处理的源 (.py) 文件的列表。这包括所有已签入的代码以及所有生成的源文件。库目标属于 deps，而运行时所需的其他二进制文件属于 data。
imports

List of strings; optional

要添加到 PYTHONPATH 的导入目录的列表。

可使用“生成变量”替换值。系统将为此规则以及依赖于此规则的所有规则添加这些导入目录（注意：不是此规则所依赖的规则，每个目录将由依赖于此规则的 py_binary 规则添加到 PYTHONPATH。

不允许使用绝对路径（以 / 开头的路径）和引用执行根目录之上的路径的路径，否则会导致错误。
legacy_create_init

Integer; optional; default is -1

是否在 runfiles 树中隐式创建空 __init__.py 文件。 系统会在包含 Python 源代码或共享库的每个目录中创建这些文件，以及这些目录的每个父目录（代码库根目录除外）。除非使用 --incompatible_default_to_explicit_init_py，否则默认值 auto 表示 true。如果为 false，则由用户负责创建（可能为空的）__init__.py 文件，并根据需要将这些文件添加到 Python 目标的 srcs 中。
main

Label; optional

作为应用主入口点的源文件的名称。此文件还必须列在 srcs 中。如果未指定，则改用 name（参见上文）。如果 name 与 srcs 中的任何文件名都不匹配，则必须指定 main。
python_version

String; optional; nonconfigurable; default is "_INTERNAL_SENTINEL"

是针对 Python 2 还是 Python 3 构建此目标（及其传递 deps）。有效值为 "PY2" 和 "PY3"（默认值）。

Python 版本始终会重置（可能默认）为此属性指定的任意版本，而不考虑命令行中指定的版本或依赖于此版本的其他更高目标指定的版本。

如果要对当前的 Python 版本执行 select()，可以检查 @rules_python//python:python_version 的值。如需了解详情，请点击此处。

bug 警告：此属性用于设置 Bazel 构建目标的版本，但由于 #4815 问题，生成的桩脚本可能仍会在运行时调用错误的解释器版本。请参阅此权宜解决方法，其中包括根据需要定义指向任一 Python 版本的 py_runtime 目标，并通过设置 --python_top 激活此 py_runtime。

srcs_version

String; optional; default is "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
这将构建后缀为 -pyversioninfo.txt 的文件，以说明您的目标为何需要某个 Python 版本。请注意，即使给定目标因版本冲突而未能构建，它也能工作。

stamp

Integer; optional; default is -1

是否将 build 信息编码到二进制文件中。可能的值包括：
  • stamp = 1：始终将 build 信息压印到二进制文件中，即使在 --nostamp build 中也是如此。应避免此设置，因为它可能会终止对该二进制文件的远程缓存以及依赖于该二进制文件的任何下游操作。
  • stamp = 0：始终用常量值替换 build 信息。这样可以提供良好的构建结果缓存。
  • stamp = -1：build 信息的嵌入由 --[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

Name; required

此目标的唯一名称。
deps

List of labels; optional

要链接到二进制目标的其他库的列表。请参阅 大多数构建规则定义的典型属性中有关 deps 的一般注释。这些规则通常是 py_library 规则。
srcs

List of labels; optional

为创建目标而处理的源 (.py) 文件的列表。这包括所有已签入的代码以及所有生成的源文件。
imports

List of strings; optional

要添加到 PYTHONPATH 的导入目录的列表。

可使用“生成变量”替换值。系统将为此规则以及依赖于此规则的所有规则添加这些导入目录（注意：不是此规则所依赖的规则，每个目录将由依赖于此规则的 py_binary 规则添加到 PYTHONPATH。

不允许使用绝对路径（以 / 开头的路径）和引用执行根目录之上的路径的路径，否则会导致错误。
srcs_version

String; optional; default is "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
这将构建后缀为 -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

Name; required

此目标的唯一名称。
deps

List of labels; optional

要链接到二进制目标的其他库的列表。请参阅 大多数构建规则定义的典型属性中有关 deps 的一般注释。这些规则通常是 py_library 规则。
srcs

List of labels; required

为创建目标而处理的源 (.py) 文件的列表。这包括所有已签入的代码以及所有生成的源文件。库目标属于 deps，而运行时所需的其他二进制文件属于 data。
imports

List of strings; optional

要添加到 PYTHONPATH 的导入目录的列表。

可使用“生成变量”替换值。系统将为此规则以及依赖于此规则的所有规则添加这些导入目录（注意：不是此规则所依赖的规则，每个目录将由依赖于此规则的 py_binary 规则添加到 PYTHONPATH。

不允许使用绝对路径（以 / 开头的路径）和引用执行根目录之上的路径的路径，否则会导致错误。
legacy_create_init

Integer; optional; default is -1

是否在 runfiles 树中隐式创建空 __init__.py 文件。 系统会在包含 Python 源代码或共享库的每个目录中创建这些文件，以及这些目录的每个父目录（代码库根目录除外）。除非使用 --incompatible_default_to_explicit_init_py，否则默认值 auto 表示 true。如果为 false，则由用户负责创建（可能为空的）__init__.py 文件，并根据需要将这些文件添加到 Python 目标的 srcs 中。
main

Label; optional

作为应用主入口点的源文件的名称。此文件还必须列在 srcs 中。如果未指定，则改用 name（参见上文）。如果 name 与 srcs 中的任何文件名都不匹配，则必须指定 main。
python_version

String; optional; nonconfigurable; default is "_INTERNAL_SENTINEL"

是针对 Python 2 还是 Python 3 构建此目标（及其传递 deps）。有效值为 "PY2" 和 "PY3"（默认值）。

Python 版本始终会重置（可能默认）为此属性指定的任意版本，而不考虑命令行中指定的版本或依赖于此版本的其他更高目标指定的版本。

如果要对当前的 Python 版本执行 select()，可以检查 @rules_python//python:python_version 的值。如需了解详情，请点击此处。

bug 警告：此属性用于设置 Bazel 构建目标的版本，但由于 #4815 问题，生成的桩脚本可能仍会在运行时调用错误的解释器版本。请参阅此权宜解决方法，其中包括根据需要定义指向任一 Python 版本的 py_runtime 目标，并通过设置 --python_top 激活此 py_runtime。

srcs_version

String; optional; default is "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
这将构建后缀为 -pyversioninfo.txt 的文件，以说明您的目标为何需要某个 Python 版本。请注意，即使给定目标因版本冲突而未能构建，它也能工作。

stamp

Integer; optional; default is 0

请参阅有关 py_binary() 参数的部分，但默认情况下，对于测试，戳记参数设置为 0。

py_runtime 

py_runtime(name, 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 中的运行时。平台运行时访问位于已知路径的系统安装的解释器，而构建中的运行时指向充当解释器的可执行目标。在这两种情况下，“解释器”是指任何能够运行在命令行上传递的 Python 脚本的可执行二进制文件或封装容器脚本，并遵循与标准 CPython 解释器相同的惯例。

平台运行时本质上是非封闭的。它要求目标平台在特定路径上具有解释器。build 内运行时不一定是封闭的，具体取决于它是否指向签入的解释器，或指向访问系统解释器的封装容器脚本。

例如：

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

Name; required

此目标的唯一名称。
coverage_tool

Label; optional

这是一个目标，用于从 py_binary 和 py_test 目标收集代码覆盖率信息。

如果设置此参数，则目标必须生成单个文件或者是可执行目标。单个文件的路径，如果目标为可执行文件，则是可执行文件的路径，决定了 Python Coverage 工具的入口点。启用覆盖率后，目标及其 runfile 将添加到 runfile 中。

该工具的入口点必须可由 Python 解释器（例如 .py 或 .pyc 文件）加载。它必须接受 coverage.py 的命令行参数，至少包含 run 和 lcov 子命令。

files

List of labels; optional

对于 build 内运行时，这是构成此运行时的一组文件。这些文件将添加到使用此运行时的 Python 二进制文件的运行文件中。对于平台运行时，不得设置此属性。
interpreter

Label; optional

对于构建内运行时，这是要作为解释器调用的目标。对于平台运行时，不得设置此属性。
interpreter_path

String; optional

对于平台运行时，这是目标平台上 Python 解释器的绝对路径。对于 build 运行时，不得设置此属性。
python_version

String; optional; default is "_INTERNAL_SENTINEL"

此运行时是否适用于 Python 主要版本 2 或 3。有效值为 "PY2" 和 "PY3"。

默认值由 --incompatible_py3_is_default 标志控制。不过，将来该属性是必需属性，且没有默认值。

stub_shebang

String; optional; default is "#!/usr/bin/env python3"

“Shebang”表达式，位于执行 py_binary 目标时使用的引导式 Python 桩脚本前面。

如需了解动机，请参阅问题 8685。

不适用于 Windows。