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:register_extension_info.bzl", "register_extension_info") 19load("//python/private:util.bzl", "add_migration_tag") 20load("//python/private/common:py_binary_macro_bazel.bzl", _starlark_py_binary = "py_binary") 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 30 the underlying {bzl:obj}`py_binary rule<//python/private/common:py_binary_rule_bazel.bzl%py_binary>` 31 for detailed attribute documentation. 32 33 This macro affects the following args: 34 * `python_version`: cannot be `PY2` 35 * `srcs_version`: cannot be `PY2` or `PY2ONLY` 36 * `tags`: May have special marker values added, if not already present. 37 38 Args: 39 **attrs: Rule attributes forwarded onto the underlying 40 {bzl:obj}`py_binary rule<//python/private/common:py_binary_rule_bazel.bzl%py_binary>` 41 """ 42 if attrs.get("python_version") == "PY2": 43 fail("Python 2 is no longer supported: https://github.com/bazelbuild/rules_python/issues/886") 44 if attrs.get("srcs_version") in ("PY2", "PY2ONLY"): 45 fail("Python 2 is no longer supported: https://github.com/bazelbuild/rules_python/issues/886") 46 47 _py_binary_impl(**add_migration_tag(attrs)) 48 49register_extension_info( 50 extension = py_binary, 51 label_regex_for_dep = "{extension_name}", 52) 53