• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Copyright 2023 The Bazel Authors. All rights reserved.
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7#     http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15"""Public entry point for py_binary."""
16
17load("@rules_python_internal//:rules_python_config.bzl", "config")
18load("//python/private:py_binary_macro.bzl", _starlark_py_binary = "py_binary")
19load("//python/private:register_extension_info.bzl", "register_extension_info")
20load("//python/private:util.bzl", "add_migration_tag")
21
22# buildifier: disable=native-python
23_py_binary_impl = _starlark_py_binary if config.enable_pystar else native.py_binary
24
25def py_binary(**attrs):
26    """Creates an executable Python program.
27
28    This is the public macro wrapping the underlying rule. Args are forwarded
29    on as-is unless otherwise specified. See the underlying {rule}`py_binary`
30    rule for detailed attribute documentation.
31
32    This macro affects the following args:
33    * `python_version`: cannot be `PY2`
34    * `srcs_version`: cannot be `PY2` or `PY2ONLY`
35    * `tags`: May have special marker values added, if not already present.
36
37    Args:
38      **attrs: Rule attributes forwarded onto the underlying {rule}`py_binary`.
39    """
40    if attrs.get("python_version") == "PY2":
41        fail("Python 2 is no longer supported: https://github.com/bazelbuild/rules_python/issues/886")
42    if attrs.get("srcs_version") in ("PY2", "PY2ONLY"):
43        fail("Python 2 is no longer supported: https://github.com/bazelbuild/rules_python/issues/886")
44
45    _py_binary_impl(**add_migration_tag(attrs))
46
47register_extension_info(
48    extension = py_binary,
49    label_regex_for_dep = "{extension_name}",
50)
51