xref: /aosp_15_r20/external/bazelbuild-rules_python/python/py_library.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_library."""
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_library_macro_bazel.bzl", _starlark_py_library = "py_library")
21
22# buildifier: disable=native-python
23_py_library_impl = _starlark_py_library if config.enable_pystar else native.py_library
24
25def py_library(**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    {bzl:obj}`py_library <//python/private/common:py_library_rule_bazel.bzl%py_library>`
31    for detailed attribute documentation.
32
33    This macro affects the following args:
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
39          {bzl:obj}`py_library <//python/private/common:py_library_rule_bazel.bzl%py_library>`
40    """
41    if attrs.get("srcs_version") in ("PY2", "PY2ONLY"):
42        fail("Python 2 is no longer supported: https://github.com/bazelbuild/rules_python/issues/886")
43
44    _py_library_impl(**add_migration_tag(attrs))
45
46register_extension_info(
47    extension = py_library,
48    label_regex_for_dep = "{extension_name}",
49)
50