Added `stamp` attribute to `py_wheel` (#554)
* Added `stamp` attribute to `py_wheel`
* Add stable status to wheel stamping
diff --git a/python/packaging.bzl b/python/packaging.bzl
index 5eac83a..ea21f97 100644
--- a/python/packaging.bzl
+++ b/python/packaging.bzl
@@ -14,6 +14,19 @@
"""Rules for building wheels."""
+load("//python/private:stamp.bzl", "is_stamping_enabled")
+
+PyWheelInfo = provider(
+ doc = "Information about a wheel produced by `py_wheel`",
+ fields = {
+ "name_file": (
+ "File: A file containing the canonical name of the wheel (after " +
+ "stamping, if enabled)."
+ ),
+ "wheel": "File: The wheel file itself.",
+ },
+)
+
def _path_inside_wheel(input_file):
# input_file.short_path is sometimes relative ("../${repository_root}/foobar")
# which is not a valid path within a zip file. Fix that.
@@ -110,6 +123,8 @@
_escape_filename_segment(ctx.attr.platform),
]) + ".whl")
+ name_file = ctx.actions.declare_file(ctx.label.name + ".name")
+
inputs_to_package = depset(
direct = ctx.files.deps,
)
@@ -133,9 +148,16 @@
args.add("--python_requires", ctx.attr.python_requires)
args.add("--abi", ctx.attr.abi)
args.add("--platform", ctx.attr.platform)
- args.add("--out", outfile.path)
+ args.add("--out", outfile)
+ args.add("--name_file", name_file)
args.add_all(ctx.attr.strip_path_prefixes, format_each = "--strip_path_prefix=%s")
+ # Pass workspace status files if stamping is enabled
+ if is_stamping_enabled(ctx.attr):
+ args.add("--volatile_status_file", ctx.version_file)
+ args.add("--stable_status_file", ctx.version_file)
+ other_inputs.extend([ctx.version_file, ctx.info_file])
+
args.add("--input_file_list", packageinputfile)
extra_headers = []
@@ -193,15 +215,21 @@
ctx.actions.run(
inputs = depset(direct = other_inputs, transitive = [inputs_to_package]),
- outputs = [outfile],
+ outputs = [outfile, name_file],
arguments = [args],
executable = ctx.executable._wheelmaker,
progress_message = "Building wheel",
)
- return [DefaultInfo(
- files = depset([outfile]),
- data_runfiles = ctx.runfiles(files = [outfile]),
- )]
+ return [
+ DefaultInfo(
+ files = depset([outfile]),
+ runfiles = ctx.runfiles(files = [outfile]),
+ ),
+ PyWheelInfo(
+ wheel = outfile,
+ name_file = name_file,
+ ),
+ ]
def _concat_dicts(*dicts):
result = {}
@@ -247,9 +275,35 @@
default = "py3",
doc = "Supported Python version(s), eg `py3`, `cp35.cp36`, etc",
),
+ "stamp": attr.int(
+ doc = """\
+Whether to encode build information into the wheel. Possible values:
+
+- `stamp = 1`: Always stamp the build information into the wheel, even in \
+[--nostamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) builds. \
+This setting should be avoided, since it potentially kills remote caching for the target and \
+any downstream actions that depend on it.
+
+- `stamp = 0`: Always replace build information by constant values. This gives good build result caching.
+
+- `stamp = -1`: Embedding of build information is controlled by the \
+[--[no]stamp](https://docs.bazel.build/versions/main/user-manual.html#flag--stamp) flag.
+
+Stamped targets are not rebuilt unless their dependencies change.
+ """,
+ default = -1,
+ values = [1, 0, -1],
+ ),
"version": attr.string(
mandatory = True,
- doc = "Version number of the package",
+ doc = (
+ "Version number of the package. Note that this attribute " +
+ "supports stamp format strings. Eg `1.2.3-{BUILD_TIMESTAMP}`"
+ ),
+ ),
+ "_stamp_flag": attr.label(
+ doc = "A setting used to determine whether or not the `--stamp` flag is enabled",
+ default = Label("//python/private:stamp"),
),
}
diff --git a/python/private/BUILD b/python/private/BUILD
index 90fcd3b..6babd88 100644
--- a/python/private/BUILD
+++ b/python/private/BUILD
@@ -12,6 +12,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.
+load(":stamp.bzl", "stamp_build_setting")
+
licenses(["notice"]) # Apache 2.0
filegroup(
@@ -36,6 +38,10 @@
exports_files(
[
"reexports.bzl",
+ "stamp.bzl",
],
visibility = ["//docs:__pkg__"],
)
+
+# Used to determine the use of `--stamp` in Starlark rules
+stamp_build_setting(name = "stamp")
diff --git a/python/private/stamp.bzl b/python/private/stamp.bzl
new file mode 100644
index 0000000..86ea3fc
--- /dev/null
+++ b/python/private/stamp.bzl
@@ -0,0 +1,73 @@
+"""A small utility module dedicated to detecting whether or not the `--stamp` flag is enabled
+
+This module can be removed likely after the following PRs ar addressed:
+- https://github.com/bazelbuild/bazel/issues/11164
+"""
+
+StampSettingInfo = provider(
+ doc = "Information about the `--stamp` command line flag",
+ fields = {
+ "value": "bool: Whether or not the `--stamp` flag was enabled",
+ },
+)
+
+def _stamp_build_setting_impl(ctx):
+ return StampSettingInfo(value = ctx.attr.value)
+
+_stamp_build_setting = rule(
+ doc = """\
+Whether to encode build information into the binary. Possible values:
+
+- stamp = 1: Always stamp the build information into the binary, even in [--nostamp][stamp] builds. \
+This setting should be avoided, since it potentially kills remote caching for the binary and \
+any downstream actions that depend on it.
+- stamp = 0: Always replace build information by constant values. This gives good build result caching.
+- stamp = -1: Embedding of build information is controlled by the [--[no]stamp][stamp] flag.
+
+Stamped binaries are not rebuilt unless their dependencies change.
+[stamp]: https://docs.bazel.build/versions/main/user-manual.html#flag--stamp
+ """,
+ implementation = _stamp_build_setting_impl,
+ attrs = {
+ "value": attr.bool(
+ doc = "The default value of the stamp build flag",
+ mandatory = True,
+ ),
+ },
+)
+
+def stamp_build_setting(name, visibility = ["//visibility:public"]):
+ native.config_setting(
+ name = "stamp_detect",
+ values = {"stamp": "1"},
+ visibility = visibility,
+ )
+
+ _stamp_build_setting(
+ name = name,
+ value = select({
+ ":stamp_detect": True,
+ "//conditions:default": False,
+ }),
+ visibility = visibility,
+ )
+
+def is_stamping_enabled(attr):
+ """Determine whether or not build staming is enabled
+
+ Args:
+ attr (struct): A rule's struct of attributes (`ctx.attr`)
+
+ Returns:
+ bool: The stamp value
+ """
+ stamp_num = getattr(attr, "stamp", -1)
+ if stamp_num == 1:
+ return True
+ elif stamp_num == 0:
+ return False
+ elif stamp_num == -1:
+ stamp_flag = getattr(attr, "_stamp_flag", None)
+ return stamp_flag[StampSettingInfo].value if stamp_flag else False
+ else:
+ fail("Unexpected `stamp` value: {}".format(stamp_num))
