blob: 12354a7deb326bfa56a317d11a0c7aafe566cf4b [file] [log] [blame]
Richard Levasseur756264a2023-03-09 14:38:05 -08001# 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
Richard Levasseurd8966b82023-09-25 10:39:38 -070017load("@rules_python_internal//:rules_python_config.bzl", "config")
Richard Levasseur7c5e7cf2024-10-29 20:32:35 -070018load("//python/private:py_library_macro.bzl", _starlark_py_library = "py_library")
Richard Levasseur754b26a2023-10-08 12:40:52 -070019load("//python/private:register_extension_info.bzl", "register_extension_info")
Richard Levasseur3b9c85e2023-03-23 12:59:58 -070020load("//python/private:util.bzl", "add_migration_tag")
Richard Levasseurd8966b82023-09-25 10:39:38 -070021
22# buildifier: disable=native-python
23_py_library_impl = _starlark_py_library if config.enable_pystar else native.py_library
Richard Levasseur756264a2023-03-09 14:38:05 -080024
Richard Levasseur3b9c85e2023-03-23 12:59:58 -070025def py_library(**attrs):
Richard Levasseur3b183bf2024-08-10 15:35:33 -070026 """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
Richard Levasseurdd5db652024-10-15 16:33:37 -070030 {rule}`py_library` for detailed attribute documentation.
Richard Levasseur3b183bf2024-08-10 15:35:33 -070031
32 This macro affects the following args:
33 * `srcs_version`: cannot be `PY2` or `PY2ONLY`
34 * `tags`: May have special marker values added, if not already present.
Richard Levasseur3b9c85e2023-03-23 12:59:58 -070035
36 Args:
Richard Levasseurdd5db652024-10-15 16:33:37 -070037 **attrs: Rule attributes forwarded onto {rule}`py_library`.
Richard Levasseur3b9c85e2023-03-23 12:59:58 -070038 """
39 if attrs.get("srcs_version") in ("PY2", "PY2ONLY"):
40 fail("Python 2 is no longer supported: https://github.com/bazelbuild/rules_python/issues/886")
41
Richard Levasseurd8966b82023-09-25 10:39:38 -070042 _py_library_impl(**add_migration_tag(attrs))
Richard Levasseur754b26a2023-10-08 12:40:52 -070043
44register_extension_info(
45 extension = py_library,
46 label_regex_for_dep = "{extension_name}",
47)