feat: enable pyproject.toml as single source of truth for Python version #3514
+474
−26
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| python/features.bzl export-subst | ||
| tools/publish/*.txt linguist-generated=true | ||
| requirements_lock.txt linguist-generated=true |
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -19,6 +19,7 @@ load("@pythons_hub//:versions.bzl", "MINOR_MAPPING") | |
| load("@rules_python_internal//:rules_python_config.bzl", rp_config = "config") | ||
| load("//python/private:auth.bzl", "AUTH_ATTRS") | ||
| load("//python/private:normalize_name.bzl", "normalize_name") | ||
| load("//python/private:pyproject_utils.bzl", "read_pyproject_version") | ||
| load("//python/private:repo_utils.bzl", "repo_utils") | ||
| load(":evaluate_markers.bzl", EVALUATE_MARKERS_SRCS = "SRCS") | ||
| load(":hub_builder.bzl", "hub_builder") | ||
|
|
@@ -86,12 +87,23 @@ def build_config( | |
| """ | ||
| defaults = { | ||
| "platforms": {}, | ||
| "python_version": None, | ||
| } | ||
| for mod in module_ctx.modules: | ||
| if not (mod.is_root or mod.name == "rules_python"): | ||
| continue | ||
|
|
||
| for tag in mod.tags.default: | ||
| pyproject_toml = getattr(tag, "pyproject_toml", None) | ||
| if pyproject_toml: | ||
| pyproject_version = read_pyproject_version( | ||
| module_ctx, | ||
| pyproject_toml, | ||
| logger = None, | ||
| ) | ||
| if pyproject_version: | ||
| defaults["python_version"] = pyproject_version | ||
|
|
||
| platform = tag.platform | ||
| if platform: | ||
| specific_config = defaults["platforms"].setdefault(platform, {}) | ||
|
|
@@ -125,6 +137,7 @@ def build_config( | |
| return struct( | ||
| auth_patterns = defaults.get("auth_patterns", {}), | ||
| netrc = defaults.get("netrc", None), | ||
| python_version = defaults.get("python_version", None), | ||
| platforms = { | ||
| name: _plat(**values) | ||
| for name, values in defaults["platforms"].items() | ||
|
|
@@ -155,6 +168,8 @@ def parse_modules( | |
| Returns: | ||
| A struct with the following attributes: | ||
| """ | ||
| config = build_config(module_ctx = module_ctx, enable_pipstar = enable_pipstar, enable_pipstar_extract = enable_pipstar_extract) | ||
|
|
||
| whl_mods = {} | ||
| for mod in module_ctx.modules: | ||
| for whl_mod in mod.tags.whl_mods: | ||
|
|
@@ -186,8 +201,6 @@ You cannot use both the additive_build_content and additive_build_content_file a | |
| srcs_exclude_glob = whl_mod.srcs_exclude_glob, | ||
| ) | ||
|
|
||
| # TODO @aignas 2025-06-03: Merge override API with the builder? | ||
| _overriden_whl_set = {} | ||
| whl_overrides = {} | ||
|
|
@@ -228,6 +241,10 @@ You cannot use both the additive_build_content and additive_build_content_file a | |
|
|
||
| for mod in module_ctx.modules: | ||
| for pip_attr in mod.tags.parse: | ||
| python_version = pip_attr.python_version or config.python_version | ||
| if not python_version: | ||
| _fail("pip.parse() requires either python_version attribute or pip.default(pyproject_toml=...) to be set") | ||
|
|
||
| hub_name = pip_attr.hub_name | ||
| if hub_name not in pip_hub_map: | ||
| builder = hub_builder( | ||
|
|
@@ -264,6 +281,7 @@ You cannot use both the additive_build_content and additive_build_content_file a | |
| builder.pip_parse( | ||
| module_ctx, | ||
| pip_attr = pip_attr, | ||
| python_version = python_version, | ||
| ) | ||
|
|
||
| # Keeps track of all the hub's whl repos across the different versions. | ||
|
|
@@ -409,7 +427,7 @@ Either this or {attr}`env` `platform_machine` key should be specified. | |
| """, | ||
| ), | ||
| "config_settings": attr.label_list( | ||
| mandatory = False, | ||
|
Collaborator
There was a problem hiding this comment. I think a recent PR fixed this?
Contributor
Author
There was a problem hiding this comment. @rickeylev do you happen to know which one? i havent found it.. could also split this out as a separate PR if you'd prefer it merged independently. |
||
| doc = """\ | ||
| The list of labels to `config_setting` targets that need to be matched for the platform to be | ||
| selected. | ||
|
|
@@ -471,6 +489,21 @@ If you are defining custom platforms in your project and don't want things to cl | |
| [isolation] feature. | ||
|
|
||
| [isolation]: https://bazel.build/rules/lib/globals/module#use_extension.isolate | ||
| """, | ||
| ), | ||
| "pyproject_toml": attr.label( | ||
| mandatory = False, | ||
| doc = """\ | ||
| Label pointing to pyproject.toml file to read the default Python version from. | ||
| When specified, reads the `requires-python` field from pyproject.toml and uses | ||
| it as the default python_version for all `pip.parse()` calls that don't | ||
| explicitly specify one. | ||
|
|
||
| The version must be specified as `==X.Y.Z` (exact version with full semver). | ||
| This is designed to work with dependency management tools like Renovate. | ||
|
|
||
| :::{versionadded} VERSION_NEXT_FEATURE | ||
| ::: | ||
| """, | ||
| ), | ||
| "whl_abi_tags": attr.string_list( | ||
|
|
@@ -651,14 +684,18 @@ find in case extra indexes are specified. | |
| default = True, | ||
| ), | ||
| "python_version": attr.string( | ||
| mandatory = False, | ||
|
Collaborator
There was a problem hiding this comment. update python_version attr doc to indicate the other option add e.g. |
||
| doc = """ | ||
| The Python version the dependencies are targetting, in Major.Minor format | ||
| (e.g., "3.11") or patch level granularity (e.g. "3.11.1"). | ||
|
|
||
| If an interpreter isn't explicitly provided (using `python_interpreter` or | ||
| `python_interpreter_target`), then the version specified here must have | ||
| a corresponding `python.toolchain()` configured. | ||
|
|
||
| :::{seealso} | ||
| The {obj}`pyproject_toml` attribute for getting the version from a project file. | ||
| ::: | ||
| """, | ||
| ), | ||
| "simpleapi_skip": attr.string_list( | ||
|
|
@@ -707,6 +744,14 @@ The list of labels to use as SRCS for the marker evaluation code. This ensures t | |
| code will be re-evaluated when any of files in the default changes. | ||
| """, | ||
| ), | ||
| "_toml2json": attr.label( | ||
| default = "//tools/private/toml2json:toml2json.py", | ||
| ), | ||
| # TODO: Set a proper default once interpreter bootstrapping is resolved. | ||
| # See https://github.com/bazel-contrib/rules_python/pull/3557 | ||
| "_tool_python_interpreter": attr.label( | ||
| default = None, | ||
| ), | ||
| }, **ATTRS) | ||
| attrs.update(AUTH_ATTRS) | ||
|
|
||
|
|
||
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The pyproject tag will always be present, so this can use normal
.for accessing.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Kept
getattrbecause the existing unit tests intests/pypi/extension/create mock tag structs that don't includepyproject_toml. Usingtag.pyproject_tomlbreakstest_simple. Happy to update the test mocks instead if preferred.