forked from bazelbuild/rules_python
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
refactor(pkg_aliases): create a macro for creating whl aliases (bazel…
…build#2391) This just cleans up the code and moves more logic from the repository_rule (i.e. generation of `BUILD.bazel` files) to loading time (macro evaluation). This makes the unit testing easier and I plan to also move the code that is generating config setting names from filenames to this new macro, but wanted to submit this PR to reduce the review chunks. Summary: - Add a new `pkg_aliases` macro. - Move logic and tests for creating WORKSPACE aliases. - Move logic and tests bzlmod aliases. - Move logic and tests bzlmod aliases with groups. - Add a test for extra alias creation. - Use `whl_alias` in `pypi` extension integration tests. - Improve the serialization of `whl_alias` for passing to the pypi hub repo. Related to bazelbuild#260, bazelbuild#2386, bazelbuild#2337, bazelbuild#2319 - hopefully cleaning the code up will make it easier to address those feature requests later. --------- Co-authored-by: Richard Levasseur <[email protected]>
Showing
9 changed files
with
501 additions
and
443 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| # Copyright 2024 The Bazel Authors. All rights reserved. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| """pkg_aliases is a macro to generate aliases for selecting the right wheel for the right target platform. | ||
| This is used in bzlmod and non-bzlmod setups.""" | ||
|
|
||
| load("//python/private:text_util.bzl", "render") | ||
| load( | ||
| ":labels.bzl", | ||
| "DATA_LABEL", | ||
| "DIST_INFO_LABEL", | ||
| "PY_LIBRARY_IMPL_LABEL", | ||
| "PY_LIBRARY_PUBLIC_LABEL", | ||
| "WHEEL_FILE_IMPL_LABEL", | ||
| "WHEEL_FILE_PUBLIC_LABEL", | ||
| ) | ||
|
|
||
| _NO_MATCH_ERROR_TEMPLATE = """\ | ||
| No matching wheel for current configuration's Python version. | ||
| The current build configuration's Python version doesn't match any of the Python | ||
| wheels available for this wheel. This wheel supports the following Python | ||
| configuration settings: | ||
| {config_settings} | ||
| To determine the current configuration's Python version, run: | ||
| `bazel config <config id>` (shown further below) | ||
| and look for | ||
| {rules_python}//python/config_settings:python_version | ||
| If the value is missing, then the "default" Python version is being used, | ||
| which has a "null" version value and will not match version constraints. | ||
| """ | ||
|
|
||
| def _no_match_error(actual): | ||
| if type(actual) != type({}): | ||
| return None | ||
|
|
||
| if "//conditions:default" in actual: | ||
| return None | ||
|
|
||
| return _NO_MATCH_ERROR_TEMPLATE.format( | ||
| config_settings = render.indent( | ||
| "\n".join(sorted(actual.keys())), | ||
| ).lstrip(), | ||
| rules_python = "rules_python", | ||
| ) | ||
|
|
||
| def pkg_aliases( | ||
| *, | ||
| name, | ||
| actual, | ||
| group_name = None, | ||
| extra_aliases = None, | ||
| native = native, | ||
| select = select): | ||
| """Create aliases for an actual package. | ||
| Args: | ||
| name: {type}`str` The name of the package. | ||
| actual: {type}`dict[Label, str] | str` The name of the repo the aliases point to, or a dict of select conditions to repo names for the aliases to point to | ||
| mapping to repositories. | ||
| group_name: {type}`str` The group name that the pkg belongs to. | ||
| extra_aliases: {type}`list[str]` The extra aliases to be created. | ||
| native: {type}`struct` used in unit tests. | ||
| select: {type}`select` used in unit tests. | ||
| """ | ||
| native.alias( | ||
| name = name, | ||
| actual = ":" + PY_LIBRARY_PUBLIC_LABEL, | ||
| ) | ||
|
|
||
| target_names = { | ||
| PY_LIBRARY_PUBLIC_LABEL: PY_LIBRARY_IMPL_LABEL if group_name else PY_LIBRARY_PUBLIC_LABEL, | ||
| WHEEL_FILE_PUBLIC_LABEL: WHEEL_FILE_IMPL_LABEL if group_name else WHEEL_FILE_PUBLIC_LABEL, | ||
| DATA_LABEL: DATA_LABEL, | ||
| DIST_INFO_LABEL: DIST_INFO_LABEL, | ||
| } | { | ||
| x: x | ||
| for x in extra_aliases or [] | ||
| } | ||
| no_match_error = _no_match_error(actual) | ||
|
|
||
| for name, target_name in target_names.items(): | ||
| if type(actual) == type(""): | ||
| _actual = "@{repo}//:{target_name}".format( | ||
| repo = actual, | ||
| target_name = name, | ||
| ) | ||
| elif type(actual) == type({}): | ||
| _actual = select( | ||
| { | ||
| config_setting: "@{repo}//:{target_name}".format( | ||
| repo = repo, | ||
| target_name = name, | ||
| ) | ||
| for config_setting, repo in actual.items() | ||
| }, | ||
| no_match_error = no_match_error, | ||
| ) | ||
| else: | ||
| fail("The `actual` arg must be a dictionary or a string") | ||
|
|
||
| kwargs = {} | ||
| if target_name.startswith("_"): | ||
| kwargs["visibility"] = ["//_groups:__subpackages__"] | ||
|
|
||
| native.alias( | ||
| name = target_name, | ||
| actual = _actual, | ||
| **kwargs | ||
| ) | ||
|
|
||
| if group_name: | ||
| native.alias( | ||
| name = PY_LIBRARY_PUBLIC_LABEL, | ||
| actual = "//_groups:{}_pkg".format(group_name), | ||
| ) | ||
| native.alias( | ||
| name = WHEEL_FILE_PUBLIC_LABEL, | ||
| actual = "//_groups:{}_whl".format(group_name), | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| load(":pkg_aliases_test.bzl", "pkg_aliases_test_suite") | ||
|
|
||
| pkg_aliases_test_suite(name = "pkg_aliases_tests") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,217 @@ | ||
| # Copyright 2024 The Bazel Authors. All rights reserved. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| """pkg_aliases tests""" | ||
|
|
||
| load("@rules_testing//lib:test_suite.bzl", "test_suite") | ||
| load( | ||
| "//python/private/pypi:pkg_aliases.bzl", | ||
| "pkg_aliases", | ||
| ) # buildifier: disable=bzl-visibility | ||
|
|
||
| _tests = [] | ||
|
|
||
| def _test_legacy_aliases(env): | ||
| actual = [] | ||
| pkg_aliases( | ||
| name = "foo", | ||
| actual = "repo", | ||
| native = struct( | ||
| alias = lambda **kwargs: actual.append(kwargs), | ||
| ), | ||
| extra_aliases = ["my_special"], | ||
| ) | ||
|
|
||
| # buildifier: disable=unsorted-dict-items | ||
| want = [ | ||
| { | ||
| "name": "foo", | ||
| "actual": ":pkg", | ||
| }, | ||
| { | ||
| "name": "pkg", | ||
| "actual": "@repo//:pkg", | ||
| }, | ||
| { | ||
| "name": "whl", | ||
| "actual": "@repo//:whl", | ||
| }, | ||
| { | ||
| "name": "data", | ||
| "actual": "@repo//:data", | ||
| }, | ||
| { | ||
| "name": "dist_info", | ||
| "actual": "@repo//:dist_info", | ||
| }, | ||
| { | ||
| "name": "my_special", | ||
| "actual": "@repo//:my_special", | ||
| }, | ||
| ] | ||
|
|
||
| env.expect.that_collection(actual).contains_exactly(want) | ||
|
|
||
| _tests.append(_test_legacy_aliases) | ||
|
|
||
| def _test_config_setting_aliases(env): | ||
| # Use this function as it is used in pip_repository | ||
| actual = [] | ||
| actual_no_match_error = [] | ||
|
|
||
| def mock_select(value, no_match_error = None): | ||
| actual_no_match_error.append(no_match_error) | ||
| env.expect.that_str(no_match_error).equals("""\ | ||
| No matching wheel for current configuration's Python version. | ||
| The current build configuration's Python version doesn't match any of the Python | ||
| wheels available for this wheel. This wheel supports the following Python | ||
| configuration settings: | ||
| //:my_config_setting | ||
| To determine the current configuration's Python version, run: | ||
| `bazel config <config id>` (shown further below) | ||
| and look for | ||
| rules_python//python/config_settings:python_version | ||
| If the value is missing, then the "default" Python version is being used, | ||
| which has a "null" version value and will not match version constraints. | ||
| """) | ||
| return struct(value = value, no_match_error = no_match_error != None) | ||
|
|
||
| pkg_aliases( | ||
| name = "bar_baz", | ||
| actual = { | ||
| "//:my_config_setting": "bar_baz_repo", | ||
| }, | ||
| extra_aliases = ["my_special"], | ||
| native = struct( | ||
| alias = lambda **kwargs: actual.append(kwargs), | ||
| ), | ||
| select = mock_select, | ||
| ) | ||
|
|
||
| # buildifier: disable=unsorted-dict-items | ||
| want = [ | ||
| { | ||
| "name": "bar_baz", | ||
| "actual": ":pkg", | ||
| }, | ||
| { | ||
| "name": "pkg", | ||
| "actual": struct( | ||
| value = { | ||
| "//:my_config_setting": "@bar_baz_repo//:pkg", | ||
| }, | ||
| no_match_error = True, | ||
| ), | ||
| }, | ||
| { | ||
| "name": "whl", | ||
| "actual": struct( | ||
| value = { | ||
| "//:my_config_setting": "@bar_baz_repo//:whl", | ||
| }, | ||
| no_match_error = True, | ||
| ), | ||
| }, | ||
| { | ||
| "name": "data", | ||
| "actual": struct( | ||
| value = { | ||
| "//:my_config_setting": "@bar_baz_repo//:data", | ||
| }, | ||
| no_match_error = True, | ||
| ), | ||
| }, | ||
| { | ||
| "name": "dist_info", | ||
| "actual": struct( | ||
| value = { | ||
| "//:my_config_setting": "@bar_baz_repo//:dist_info", | ||
| }, | ||
| no_match_error = True, | ||
| ), | ||
| }, | ||
| { | ||
| "name": "my_special", | ||
| "actual": struct( | ||
| value = { | ||
| "//:my_config_setting": "@bar_baz_repo//:my_special", | ||
| }, | ||
| no_match_error = True, | ||
| ), | ||
| }, | ||
| ] | ||
| env.expect.that_collection(actual).contains_exactly(want) | ||
|
|
||
| _tests.append(_test_config_setting_aliases) | ||
|
|
||
| def _test_group_aliases(env): | ||
| # Use this function as it is used in pip_repository | ||
| actual = [] | ||
|
|
||
| pkg_aliases( | ||
| name = "foo", | ||
| actual = "repo", | ||
| group_name = "my_group", | ||
| native = struct( | ||
| alias = lambda **kwargs: actual.append(kwargs), | ||
| ), | ||
| ) | ||
|
|
||
| # buildifier: disable=unsorted-dict-items | ||
| want = [ | ||
| { | ||
| "name": "foo", | ||
| "actual": ":pkg", | ||
| }, | ||
| { | ||
| "name": "_pkg", | ||
| "actual": "@repo//:pkg", | ||
| "visibility": ["//_groups:__subpackages__"], | ||
| }, | ||
| { | ||
| "name": "_whl", | ||
| "actual": "@repo//:whl", | ||
| "visibility": ["//_groups:__subpackages__"], | ||
| }, | ||
| { | ||
| "name": "data", | ||
| "actual": "@repo//:data", | ||
| }, | ||
| { | ||
| "name": "dist_info", | ||
| "actual": "@repo//:dist_info", | ||
| }, | ||
| { | ||
| "name": "pkg", | ||
| "actual": "//_groups:my_group_pkg", | ||
| }, | ||
| { | ||
| "name": "whl", | ||
| "actual": "//_groups:my_group_whl", | ||
| }, | ||
| ] | ||
| env.expect.that_collection(actual).contains_exactly(want) | ||
|
|
||
| _tests.append(_test_group_aliases) | ||
|
|
||
| def pkg_aliases_test_suite(name): | ||
| """Create the test suite. | ||
| Args: | ||
| name: the name of the test suite | ||
| """ | ||
| test_suite(name = name, basic_tests = _tests) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters