xref: /aosp_15_r20/external/bazelbuild-rules_python/python/py_runtime.bzl (revision 60517a1edbc8ecf509223e9af94a7adec7d736b8)
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_runtime."""
16
17load("//python/private:util.bzl", "IS_BAZEL_6_OR_HIGHER", "add_migration_tag")
18load("//python/private/common:py_runtime_macro.bzl", _starlark_py_runtime = "py_runtime")
19
20# buildifier: disable=native-python
21_py_runtime_impl = _starlark_py_runtime if IS_BAZEL_6_OR_HIGHER else native.py_runtime
22
23def py_runtime(**attrs):
24    """Creates an executable Python program.
25
26    This is the public macro wrapping the underlying rule. Args are forwarded
27    on as-is unless otherwise specified. See
28    {bzl:obj}`py_runtime <//python/private/common:py_runtime_rule.bzl%py_runtime>`
29    for detailed attribute documentation.
30
31    This macro affects the following args:
32    * `python_version`: cannot be `PY2`
33    * `srcs_version`: cannot be `PY2` or `PY2ONLY`
34    * `tags`: May have special marker values added, if not already present.
35
36    Args:
37      **attrs: Rule attributes forwarded onto
38          {bzl:obj}`py_runtime <//python/private/common:py_runtime_rule.bzl%py_runtime>`
39    """
40    if attrs.get("python_version") == "PY2":
41        fail("Python 2 is no longer supported: see https://github.com/bazelbuild/rules_python/issues/886")
42
43    _py_runtime_impl(**add_migration_tag(attrs))
44