| # Copyright 2023 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. |
| |
| "pip module extension for use with bzlmod" |
| |
| load("@pythons_hub//:interpreters.bzl", "INTERPRETER_LABELS") |
| 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:repo_utils.bzl", "repo_utils") |
| load(":evaluate_markers.bzl", EVALUATE_MARKERS_SRCS = "SRCS") |
| load(":hub_builder.bzl", "hub_builder") |
| load(":hub_repository.bzl", "hub_repository", "whl_config_settings_to_json") |
| load(":parse_whl_name.bzl", "parse_whl_name") |
| load(":pep508_env.bzl", "env") |
| load(":pip_repository_attrs.bzl", "ATTRS") |
| load(":platform.bzl", _plat = "platform") |
| load(":simpleapi_download.bzl", "simpleapi_download") |
| load(":whl_library.bzl", "whl_library") |
| |
| def _whl_mods_impl(whl_mods_dict): |
| """Implementation of the pip.whl_mods tag class. |
| |
| This creates the JSON files used to modify the creation of different wheels. |
| """ |
| for hub_name, whl_maps in whl_mods_dict.items(): |
| whl_mods = {} |
| |
| # create a struct that we can pass to the _whl_mods_repo rule |
| # to create the different JSON files. |
| for whl_name, mods in whl_maps.items(): |
| whl_mods[whl_name] = json.encode(struct( |
| additive_build_content = mods.build_content, |
| copy_files = mods.copy_files, |
| copy_executables = mods.copy_executables, |
| data = mods.data, |
| data_exclude_glob = mods.data_exclude_glob, |
| srcs_exclude_glob = mods.srcs_exclude_glob, |
| )) |
| |
| _whl_mods_repo( |
| name = hub_name, |
| whl_mods = whl_mods, |
| ) |
| |
| def _configure(config, *, override = False, **kwargs): |
| """Set the value in the config if the value is provided""" |
| env = kwargs.get("env") |
| if env: |
| for key in env: |
| if key not in _SUPPORTED_PEP508_KEYS: |
| fail("Unsupported key in the PEP508 environment: {}".format(key)) |
| |
| for key, value in kwargs.items(): |
| if value and (override or key not in config): |
| config[key] = value |
| |
| def build_config( |
| *, |
| module_ctx, |
| enable_pipstar): |
| """Parse 'configure' and 'default' extension tags |
| |
| Args: |
| module_ctx: {type}`module_ctx` module context. |
| enable_pipstar: {type}`bool` a flag to enable dropping Python dependency for |
| evaluation of the extension. |
| |
| Returns: |
| A struct with the configuration. |
| """ |
| defaults = { |
| "platforms": {}, |
| } |
| for mod in module_ctx.modules: |
| if not (mod.is_root or mod.name == "rules_python"): |
| continue |
| |
| for tag in mod.tags.default: |
| platform = tag.platform |
| if platform: |
| specific_config = defaults["platforms"].setdefault(platform, {}) |
| _configure( |
| specific_config, |
| arch_name = tag.arch_name, |
| config_settings = tag.config_settings, |
| env = tag.env, |
| os_name = tag.os_name, |
| marker = tag.marker, |
| name = platform.replace("-", "_").lower(), |
| whl_abi_tags = tag.whl_abi_tags, |
| whl_platform_tags = tag.whl_platform_tags, |
| override = mod.is_root, |
| ) |
| |
| if platform and not (tag.arch_name or tag.config_settings or tag.env or tag.os_name or tag.whl_abi_tags or tag.whl_platform_tags or tag.marker): |
| defaults["platforms"].pop(platform) |
| |
| _configure( |
| defaults, |
| override = mod.is_root, |
| # extra values that we just add |
| auth_patterns = tag.auth_patterns, |
| netrc = tag.netrc, |
| # TODO @aignas 2025-05-19: add more attr groups: |
| # * for index/downloader config. This includes all of those attributes for |
| # overrides, etc. Index overrides per platform could be also used here. |
| ) |
| |
| return struct( |
| auth_patterns = defaults.get("auth_patterns", {}), |
| netrc = defaults.get("netrc", None), |
| platforms = { |
| name: _plat(**values) |
| for name, values in defaults["platforms"].items() |
| }, |
| enable_pipstar = enable_pipstar, |
| ) |
| |
| def parse_modules( |
| module_ctx, |
| _fail = fail, |
| simpleapi_download = simpleapi_download, |
| enable_pipstar = False, |
| **kwargs): |
| """Implementation of parsing the tag classes for the extension and return a struct for registering repositories. |
| |
| Args: |
| module_ctx: {type}`module_ctx` module context. |
| simpleapi_download: Used for testing overrides |
| enable_pipstar: {type}`bool` a flag to enable dropping Python dependency for |
| evaluation of the extension. |
| _fail: {type}`function` the failure function, mainly for testing. |
| **kwargs: Extra arguments passed to the hub_builder. |
| |
| Returns: |
| A struct with the following attributes: |
| """ |
| whl_mods = {} |
| for mod in module_ctx.modules: |
| for whl_mod in mod.tags.whl_mods: |
| if whl_mod.whl_name in whl_mods.get(whl_mod.hub_name, {}): |
| # We cannot have the same wheel name in the same hub, as we |
| # will create the same JSON file name. |
| _fail("""\ |
| Found same whl_name '{}' in the same hub '{}', please use a different hub_name.""".format( |
| whl_mod.whl_name, |
| whl_mod.hub_name, |
| )) |
| return None |
| |
| build_content = whl_mod.additive_build_content |
| if whl_mod.additive_build_content_file != None and whl_mod.additive_build_content != "": |
| _fail("""\ |
| You cannot use both the additive_build_content and additive_build_content_file arguments at the same time. |
| """) |
| return None |
| elif whl_mod.additive_build_content_file != None: |
| build_content = module_ctx.read(whl_mod.additive_build_content_file) |
| |
| whl_mods.setdefault(whl_mod.hub_name, {})[whl_mod.whl_name] = struct( |
| build_content = build_content, |
| copy_files = whl_mod.copy_files, |
| copy_executables = whl_mod.copy_executables, |
| data = whl_mod.data, |
| data_exclude_glob = whl_mod.data_exclude_glob, |
| srcs_exclude_glob = whl_mod.srcs_exclude_glob, |
| ) |
| |
| config = build_config(module_ctx = module_ctx, enable_pipstar = enable_pipstar) |
| |
| # TODO @aignas 2025-06-03: Merge override API with the builder? |
| _overriden_whl_set = {} |
| whl_overrides = {} |
| for module in module_ctx.modules: |
| for attr in module.tags.override: |
| if not module.is_root: |
| # Overrides are only supported in root modules. Silently |
| # ignore the override: |
| continue |
| |
| if not attr.file.endswith(".whl"): |
| fail("Only whl overrides are supported at this time") |
| |
| whl_name = normalize_name(parse_whl_name(attr.file).distribution) |
| |
| if attr.file in _overriden_whl_set: |
| fail("Duplicate module overrides for '{}'".format(attr.file)) |
| _overriden_whl_set[attr.file] = None |
| |
| for patch in attr.patches: |
| if whl_name not in whl_overrides: |
| whl_overrides[whl_name] = {} |
| |
| if patch not in whl_overrides[whl_name]: |
| whl_overrides[whl_name][patch] = struct( |
| patch_strip = attr.patch_strip, |
| whls = [], |
| ) |
| |
| whl_overrides[whl_name][patch].whls.append(attr.file) |
| |
| # Used to track all the different pip hubs and the spoke pip Python |
| # versions. |
| pip_hub_map = {} |
| simpleapi_cache = {} |
| |
| for mod in module_ctx.modules: |
| for pip_attr in mod.tags.parse: |
| hub_name = pip_attr.hub_name |
| if hub_name not in pip_hub_map: |
| builder = hub_builder( |
| name = hub_name, |
| module_name = mod.name, |
| config = config, |
| whl_overrides = whl_overrides, |
| simpleapi_download_fn = simpleapi_download, |
| simpleapi_cache = simpleapi_cache, |
| # TODO @aignas 2025-09-06: do not use kwargs |
| minor_mapping = kwargs.get("minor_mapping", MINOR_MAPPING), |
| evaluate_markers_fn = kwargs.get("evaluate_markers", None), |
| available_interpreters = kwargs.get("available_interpreters", INTERPRETER_LABELS), |
| logger = repo_utils.logger(module_ctx, "pypi:hub:" + hub_name), |
| ) |
| pip_hub_map[pip_attr.hub_name] = builder |
| elif pip_hub_map[hub_name].module_name != mod.name: |
| # We cannot have two hubs with the same name in different |
| # modules. |
| fail(( |
| "Duplicate cross-module pip hub named '{hub}': pip hub " + |
| "names must be unique across modules. First defined " + |
| "by module '{first_module}', second attempted by " + |
| "module '{second_module}'" |
| ).format( |
| hub = hub_name, |
| first_module = pip_hub_map[hub_name].module_name, |
| second_module = mod.name, |
| )) |
| |
| else: |
| builder = pip_hub_map[pip_attr.hub_name] |
| |
| builder.pip_parse( |
| module_ctx, |
| pip_attr = pip_attr, |
| ) |
| |
| # Keeps track of all the hub's whl repos across the different versions. |
| # dict[hub, dict[whl, dict[version, str pip]]] |
| # Where hub, whl, and pip are the repo names |
| hub_whl_map = {} |
| hub_group_map = {} |
| exposed_packages = {} |
| extra_aliases = {} |
| whl_libraries = {} |
| for hub in pip_hub_map.values(): |
| out = hub.build() |
| |
| for whl_name, lib in out.whl_libraries.items(): |
| if whl_name in whl_libraries: |
| fail("'{}' already in created".format(whl_name)) |
| else: |
| whl_libraries[whl_name] = lib |
| |
| exposed_packages[hub.name] = out.exposed_packages |
| extra_aliases[hub.name] = out.extra_aliases |
| hub_group_map[hub.name] = out.group_map |
| hub_whl_map[hub.name] = out.whl_map |
| |
| return struct( |
| config = config, |
| exposed_packages = exposed_packages, |
| extra_aliases = extra_aliases, |
| hub_group_map = hub_group_map, |
| hub_whl_map = hub_whl_map, |
| whl_libraries = whl_libraries, |
| whl_mods = whl_mods, |
| platform_config_settings = { |
| hub_name: { |
| platform_name: sorted([str(Label(cv)) for cv in p.config_settings]) |
| for platform_name, p in config.platforms.items() |
| } |
| for hub_name in hub_whl_map |
| }, |
| ) |
| |
| def _pip_impl(module_ctx): |
| """Implementation of a class tag that creates the pip hub and corresponding pip spoke whl repositories. |
| |
| This implementation iterates through all of the `pip.parse` calls and creates |
| different pip hub repositories based on the "hub_name". Each of the |
| pip calls create spoke repos that uses a specific Python interpreter. |
| |
| In a MODULES.bazel file we have: |
| |
| pip.parse( |
| hub_name = "pip", |
| python_version = 3.9, |
| requirements_lock = "//:requirements_lock_3_9.txt", |
| requirements_windows = "//:requirements_windows_3_9.txt", |
| ) |
| pip.parse( |
| hub_name = "pip", |
| python_version = 3.10, |
| requirements_lock = "//:requirements_lock_3_10.txt", |
| requirements_windows = "//:requirements_windows_3_10.txt", |
| ) |
| |
| For instance, we have a hub with the name of "pip". |
| A repository named the following is created. It is actually called last when |
| all of the pip spokes are collected. |
| |
| - @@rules_python~override~pip~pip |
| |
| As shown in the example code above we have the following. |
| Two different pip.parse statements exist in MODULE.bazel provide the hub_name "pip". |
| These definitions create two different pip spoke repositories that are |
| related to the hub "pip". |
| One spoke uses Python 3.9 and the other uses Python 3.10. This code automatically |
| determines the Python version and the interpreter. |
| Both of these pip spokes contain requirements files that includes websocket |
| and its dependencies. |
| |
| We also need repositories for the wheels that the different pip spokes contain. |
| For each Python version a different wheel repository is created. In our example |
| each pip spoke had a requirements file that contained websockets. We |
| then create two different wheel repositories that are named the following. |
| |
| - @@rules_python~override~pip~pip_39_websockets |
| - @@rules_python~override~pip~pip_310_websockets |
| |
| And if the wheel has any other dependencies subsequent wheels are created in the same fashion. |
| |
| The hub repository has aliases for `pkg`, `data`, etc, which have a select that resolves to |
| a spoke repository depending on the Python version. |
| |
| Also we may have more than one hub as defined in a MODULES.bazel file. So we could have multiple |
| hubs pointing to various different pip spokes. |
| |
| Some other business rules notes. A hub can only have one spoke per Python version. We cannot |
| have a hub named "pip" that has two spokes that use the Python 3.9 interpreter. Second |
| we cannot have the same hub name used in sub-modules. The hub name has to be globally |
| unique. |
| |
| This implementation also handles the creation of whl_modification JSON files that are used |
| during the creation of wheel libraries. These JSON files used via the annotations argument |
| when calling wheel_installer.py. |
| |
| Args: |
| module_ctx: module contents |
| """ |
| |
| mods = parse_modules(module_ctx, enable_pipstar = rp_config.enable_pipstar) |
| |
| # Build all of the wheel modifications if the tag class is called. |
| _whl_mods_impl(mods.whl_mods) |
| |
| for name, args in mods.whl_libraries.items(): |
| whl_library(name = name, **args) |
| |
| for hub_name, whl_map in mods.hub_whl_map.items(): |
| hub_repository( |
| name = hub_name, |
| repo_name = hub_name, |
| extra_hub_aliases = mods.extra_aliases.get(hub_name, {}), |
| whl_map = { |
| key: whl_config_settings_to_json(values) |
| for key, values in whl_map.items() |
| }, |
| packages = mods.exposed_packages.get(hub_name, []), |
| platform_config_settings = mods.platform_config_settings.get(hub_name, {}), |
| groups = mods.hub_group_map.get(hub_name), |
| ) |
| |
| return module_ctx.extension_metadata( |
| reproducible = True, |
| ) |
| |
| _default_attrs = { |
| "arch_name": attr.string( |
| doc = """\ |
| The CPU architecture name to be used. |
| You can use any cpu name from the `@platforms//cpu:` package. |
| |
| :::{note} |
| Either this or {attr}`env` `platform_machine` key should be specified. |
| ::: |
| """, |
| ), |
| "config_settings": attr.label_list( |
| mandatory = True, |
| doc = """\ |
| The list of labels to `config_setting` targets that need to be matched for the platform to be |
| selected. |
| """, |
| ), |
| "env": attr.string_dict( |
| doc = """\ |
| The values to use for environment markers when evaluating an expression. |
| |
| The keys and values should be compatible with the [PyPA dependency specifiers |
| specification](https://packaging.python.org/en/latest/specifications/dependency-specifiers/). |
| |
| Missing values will be set to the specification's defaults or computed using |
| available toolchain information. |
| |
| Supported keys: |
| * `implementation_name`, defaults to `cpython`. |
| * `os_name`, defaults to a value inferred from the {attr}`os_name`. |
| * `platform_machine`, defaults to a value inferred from the {attr}`arch_name`. |
| * `platform_release`, defaults to an empty value. |
| * `platform_system`, defaults to a value inferred from the {attr}`os_name`. |
| * `platform_version`, defaults to `0`. |
| * `sys_platform`, defaults to a value inferred from the {attr}`os_name`. |
| |
| ::::{note} |
| This is only used if the {envvar}`RULES_PYTHON_ENABLE_PIPSTAR` is enabled. |
| :::: |
| """, |
| ), |
| "marker": attr.string( |
| doc = """\ |
| An environment marker expression that is used to enable/disable platforms for specific python |
| versions, operating systems or CPU architectures. |
| |
| If specified, the expression is evaluated during the `bzlmod` extension evaluation phase and if it |
| evaluates to `True`, then the platform will be used to construct the hub repositories, otherwise, it |
| will be skipped. |
| |
| This is especially useful for setting up freethreaded platform variants only for particular Python |
| versions for which the interpreter builds are available. However, this could be also used for other |
| things, such as setting up platforms for different `libc` variants. |
| """, |
| ), |
| # The values for PEP508 env marker evaluation during the lock file parsing |
| "os_name": attr.string( |
| doc = """\ |
| The OS name to be used. |
| You can use any OS name from the `@platforms//os:` package. |
| |
| :::{note} |
| Either this or the appropriate `env` keys should be specified. |
| ::: |
| """, |
| ), |
| "platform": attr.string( |
| doc = """\ |
| A platform identifier which will be used as the unique identifier within the extension evaluation. |
| If you are defining custom platforms in your project and don't want things to clash, use extension |
| [isolation] feature. |
| |
| [isolation]: https://bazel.build/rules/lib/globals/module#use_extension.isolate |
| """, |
| ), |
| "whl_abi_tags": attr.string_list( |
| doc = """\ |
| A list of ABIs to select wheels for. The values can be either strings or include template |
| parameters like `{major}` and `{minor}` which will be replaced with python version parts. e.g. |
| `cp{major}{minor}` will result in `cp313` given the full python version is `3.13.5`. |
| Will always include `"none"` even if it is not specified. |
| |
| :::{note} |
| We select a single wheel and the last match will take precedence. |
| ::: |
| |
| :::{seealso} |
| See official [docs](https://packaging.python.org/en/latest/specifications/platform-compatibility-tags/#abi-tag) for more information. |
| ::: |
| """, |
| ), |
| "whl_platform_tags": attr.string_list( |
| doc = """\ |
| A list of `platform_tag` matchers so that we can select the best wheel based on the user |
| preference. |
| Will always include `"any"` even if it is not specified. |
| |
| The items in this list can contain a single `*` character that is equivalent to matching the |
| lowest available version component in the platform_tag. If the wheel platform tag does not |
| have a version component, e.g. `linux_x86_64` or `win_amd64`, then `*` will act as a regular character. |
| |
| :::{note} |
| Normally, the `*` in the matcher means that we will target the lowest platform version that we can |
| and will give preference to whls built targeting the older versions of the platform. If you |
| specify the version, then we will use the MVS (Minimal Version Selection) algorithm to select the |
| compatible wheel. As such, you need to keep in mind how to configure the target platforms to |
| select a particular wheel of your preference. |
| |
| We select a single wheel and the last match will take precedence, if the platform_tag that we |
| match has a version component (e.g. `android_x_arch`, then the version `x` will be used in the |
| MVS matching algorithm). |
| |
| Common patterns: |
| * To select any versioned wheel for an `<os>`, `<arch>`, use `<os>_*_<arch>`, e.g. |
| `manylinux_2_17_x86_64`. |
| * To exclude versions up to `X.Y` - **submit a PR supporting this feature**. |
| * To exclude versions above `X.Y`, provide the full platform tag specifier, e.g. |
| `musllinux_1_2_x86_64`, which will ensure that no wheels with `musllinux_1_3_x86_64` or higher |
| are selected. |
| ::: |
| |
| :::{seealso} |
| See official [docs](https://packaging.python.org/en/latest/specifications/platform-compatibility-tags/#platform-tag) for more information. |
| ::: |
| :::{versionchanged} 1.6.3 |
| The matching of versioned platforms have been switched to MVS (Minimal Version Selection) |
| algorithm for easier evaluation logic and fewer surprises. The legacy platform tags are |
| supported from this version without extra handling from the user. |
| ::: |
| """, |
| ), |
| } | AUTH_ATTRS |
| |
| _SUPPORTED_PEP508_KEYS = [ |
| "implementation_name", |
| "os_name", |
| "platform_machine", |
| "platform_release", |
| "platform_system", |
| "platform_version", |
| "sys_platform", |
| ] |
| |
| def _pip_parse_ext_attrs(**kwargs): |
| """Get the attributes for the pip extension. |
| |
| Args: |
| **kwargs: A kwarg for setting defaults for the specific attributes. The |
| key is expected to be the same as the attribute key. |
| |
| Returns: |
| A dict of attributes. |
| """ |
| attrs = dict({ |
| "experimental_extra_index_urls": attr.string_list( |
| doc = """\ |
| The extra index URLs to use for downloading wheels using bazel downloader. |
| Each value is going to be subject to `envsubst` substitutions if necessary. |
| |
| The indexes must support Simple API as described here: |
| https://packaging.python.org/en/latest/specifications/simple-repository-api/ |
| |
| This is equivalent to `--extra-index-urls` `pip` option. |
| |
| :::{versionchanged} 1.1.0 |
| Starting with this version we will iterate over each index specified until |
| we find metadata for all references distributions. |
| ::: |
| """, |
| default = [], |
| ), |
| "experimental_index_url": attr.string( |
| default = kwargs.get("experimental_index_url", ""), |
| doc = """\ |
| The index URL to use for downloading wheels using bazel downloader. This value is going |
| to be subject to `envsubst` substitutions if necessary. |
| |
| The indexes must support Simple API as described here: |
| https://packaging.python.org/en/latest/specifications/simple-repository-api/ |
| |
| In the future this could be defaulted to `https://pypi.org` when this feature becomes |
| stable. |
| |
| This is equivalent to `--index-url` `pip` option. |
| |
| :::{versionchanged} 0.37.0 |
| If {attr}`download_only` is set, then `sdist` archives will be discarded and `pip.parse` will |
| operate in wheel-only mode. |
| ::: |
| |
| :::{versionchanged} 1.4.0 |
| Index metadata will be used to deduct `sha256` values for packages even if the |
| `sha256` values are not present in the requirements.txt lock file. |
| ::: |
| """, |
| ), |
| "experimental_index_url_overrides": attr.string_dict( |
| doc = """\ |
| The index URL overrides for each package to use for downloading wheels using |
| bazel downloader. This value is going to be subject to `envsubst` substitutions |
| if necessary. |
| |
| The key is the package name (will be normalized before usage) and the value is the |
| index URL. |
| |
| This design pattern has been chosen in order to be fully deterministic about which |
| packages come from which source. We want to avoid issues similar to what happened in |
| https://pytorch.org/blog/compromised-nightly-dependency/. |
| |
| The indexes must support Simple API as described here: |
| https://packaging.python.org/en/latest/specifications/simple-repository-api/ |
| """, |
| ), |
| "hub_name": attr.string( |
| mandatory = True, |
| doc = """ |
| The name of the repo pip dependencies will be accessible from. |
| |
| This name must be unique between modules; unless your module is guaranteed to |
| always be the root module, it's highly recommended to include your module name |
| in the hub name. Repo mapping, `use_repo(..., pip="my_modules_pip_deps")`, can |
| be used for shorter local names within your module. |
| |
| Within a module, the same `hub_name` can be specified to group different Python |
| versions of pip dependencies under one repository name. This allows using a |
| Python version-agnostic name when referring to pip dependencies; the |
| correct version will be automatically selected. |
| |
| Typically, a module will only have a single hub of pip dependencies, but this |
| is not required. Each hub is a separate resolution of pip dependencies. This |
| means if different programs need different versions of some library, separate |
| hubs can be created, and each program can use its respective hub's targets. |
| Targets from different hubs should not be used together. |
| """, |
| ), |
| "parallel_download": attr.bool( |
| doc = """\ |
| The flag allows to make use of parallel downloading feature in bazel 7.1 and above |
| when the bazel downloader is used. This is by default enabled as it improves the |
| performance by a lot, but in case the queries to the simple API are very expensive |
| or when debugging authentication issues one may want to disable this feature. |
| |
| NOTE, This will download (potentially duplicate) data for multiple packages if |
| there is more than one index available, but in general this should be negligible |
| because the simple API calls are very cheap and the user should not notice any |
| extra overhead. |
| |
| If we are in synchronous mode, then we will use the first result that we |
| find in case extra indexes are specified. |
| """, |
| default = True, |
| ), |
| "python_version": attr.string( |
| mandatory = True, |
| 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. |
| """, |
| ), |
| "simpleapi_skip": attr.string_list( |
| doc = """\ |
| The list of packages to skip fetching metadata for from SimpleAPI index. You should |
| normally not need this attribute, but in case you do, please report this as a bug |
| to `rules_python` and use this attribute until the bug is fixed. |
| |
| EXPERIMENTAL: this may be removed without notice. |
| |
| :::{versionadded} 1.4.0 |
| ::: |
| """, |
| ), |
| "target_platforms": attr.string_list( |
| default = ["{os}_{arch}"], |
| doc = """\ |
| The list of platforms for which we would evaluate the requirements files. If you need to be able to |
| only evaluate for a particular platform (e.g. "linux_x86_64"), then put it in here. |
| |
| If you want `freethreaded` variant, then you can use `_freethreaded` suffix as `rules_python` is |
| defining target platforms for these variants in its `MODULE.bazel` file. The identifiers for this |
| function in general are the same as used in the {obj}`pip.default.platform` attribute. |
| |
| If you only care for the host platform and do not have a usecase to cross-build, then you can put in |
| a string `"{os}_{arch}"` as the value here. You could also use `"{os}_{arch}_freethreaded"` as well. |
| |
| :::{include} /_includes/experimental_api.md |
| ::: |
| |
| :::{versionadded} VERSION_NEXT_FEATURE |
| ::: |
| """, |
| ), |
| "whl_modifications": attr.label_keyed_string_dict( |
| mandatory = False, |
| doc = """\ |
| A dict of labels to wheel names that is typically generated by the whl_modifications. |
| The labels are JSON config files describing the modifications. |
| """, |
| ), |
| "_evaluate_markers_srcs": attr.label_list( |
| default = EVALUATE_MARKERS_SRCS, |
| doc = """\ |
| The list of labels to use as SRCS for the marker evaluation code. This ensures that the |
| code will be re-evaluated when any of files in the default changes. |
| """, |
| ), |
| }, **ATTRS) |
| attrs.update(AUTH_ATTRS) |
| |
| return attrs |
| |
| def _whl_mod_attrs(): |
| attrs = { |
| "additive_build_content": attr.string( |
| doc = "(str, optional): Raw text to add to the generated `BUILD` file of a package.", |
| ), |
| "additive_build_content_file": attr.label( |
| doc = """\ |
| (label, optional): path to a BUILD file to add to the generated |
| `BUILD` file of a package. You cannot use both additive_build_content and additive_build_content_file |
| arguments at the same time.""", |
| ), |
| "copy_executables": attr.string_dict( |
| doc = """\ |
| (dict, optional): A mapping of `src` and `out` files for |
| [@bazel_skylib//rules:copy_file.bzl][cf]. Targets generated here will also be flagged as |
| executable.""", |
| ), |
| "copy_files": attr.string_dict( |
| doc = """\ |
| (dict, optional): A mapping of `src` and `out` files for |
| [@bazel_skylib//rules:copy_file.bzl][cf]""", |
| ), |
| "data": attr.string_list( |
| doc = """\ |
| (list, optional): A list of labels to add as `data` dependencies to |
| the generated `py_library` target.""", |
| ), |
| "data_exclude_glob": attr.string_list( |
| doc = """\ |
| (list, optional): A list of exclude glob patterns to add as `data` to |
| the generated `py_library` target.""", |
| ), |
| "hub_name": attr.string( |
| doc = """\ |
| Name of the whl modification, hub we use this name to set the modifications for |
| pip.parse. If you have different pip hubs you can use a different name, |
| otherwise it is best practice to just use one. |
| |
| You cannot have the same `hub_name` in different modules. You can reuse the same |
| name in the same module for different wheels that you put in the same hub, but you |
| cannot have a child module that uses the same `hub_name`. |
| """, |
| mandatory = True, |
| ), |
| "srcs_exclude_glob": attr.string_list( |
| doc = """\ |
| (list, optional): A list of labels to add as `srcs` to the generated |
| `py_library` target.""", |
| ), |
| "whl_name": attr.string( |
| doc = "The whl name that the modifications are used for.", |
| mandatory = True, |
| ), |
| } |
| return attrs |
| |
| # NOTE: the naming of 'override' is taken from the bzlmod native |
| # 'archive_override', 'git_override' bzlmod functions. |
| _override_tag = tag_class( |
| attrs = { |
| "file": attr.string( |
| doc = """\ |
| The Python distribution file name which needs to be patched. This will be |
| applied to all repositories that setup this distribution via the pip.parse tag |
| class.""", |
| mandatory = True, |
| ), |
| "patch_strip": attr.int( |
| default = 0, |
| doc = """\ |
| The number of leading path segments to be stripped from the file name in the |
| patches.""", |
| ), |
| "patches": attr.label_list( |
| doc = """\ |
| A list of patches to apply to the repository *after* 'whl_library' is extracted |
| and BUILD.bazel file is generated.""", |
| mandatory = True, |
| ), |
| }, |
| doc = """\ |
| Apply any overrides (e.g. patches) to a given Python distribution defined by |
| other tags in this extension.""", |
| ) |
| |
| pypi = module_extension( |
| doc = """\ |
| This extension is used to make dependencies from pip available. |
| |
| pip.parse: |
| To use, call `pip.parse()` and specify `hub_name` and your requirements file. |
| Dependencies will be downloaded and made available in a repo named after the |
| `hub_name` argument. |
| |
| Each `pip.parse()` call configures a particular Python version. Multiple calls |
| can be made to configure different Python versions, and will be grouped by |
| the `hub_name` argument. This allows the same logical name, e.g. `@pip//numpy` |
| to automatically resolve to different, Python version-specific, libraries. |
| |
| pip.whl_mods: |
| This tag class is used to help create JSON files to describe modifications to |
| the BUILD files for wheels. |
| """, |
| implementation = _pip_impl, |
| tag_classes = { |
| "default": tag_class( |
| attrs = _default_attrs, |
| doc = """\ |
| This tag class allows for more customization of how the configuration for the hub repositories is built. |
| |
| |
| :::{include} /_includes/experimtal_api.md |
| ::: |
| |
| :::{seealso} |
| The [environment markers][environment_markers] specification for the explanation of the |
| terms used in this extension. |
| |
| [environment_markers]: https://packaging.python.org/en/latest/specifications/dependency-specifiers/#environment-markers |
| ::: |
| |
| :::{versionadded} 1.6.0 |
| ::: |
| """, |
| ), |
| "override": _override_tag, |
| "parse": tag_class( |
| attrs = _pip_parse_ext_attrs(), |
| doc = """\ |
| This tag class is used to create a pip hub and all of the spokes that are part of that hub. |
| This tag class reuses most of the attributes found in {bzl:obj}`pip_parse`. |
| The exception is it does not use the arg 'repo_prefix'. We set the repository |
| prefix for the user and the alias arg is always True in bzlmod. |
| """, |
| ), |
| "whl_mods": tag_class( |
| attrs = _whl_mod_attrs(), |
| doc = """\ |
| This tag class is used to create JSON file that are used when calling wheel_builder.py. These |
| JSON files contain instructions on how to modify a wheel's project. Each of the attributes |
| create different modifications based on the type of attribute. Previously to bzlmod these |
| JSON files where referred to as annotations, and were renamed to whl_modifications in this |
| extension. |
| """, |
| ), |
| }, |
| ) |
| |
| def _whl_mods_repo_impl(rctx): |
| rctx.file("BUILD.bazel", "") |
| for whl_name, mods in rctx.attr.whl_mods.items(): |
| rctx.file("{}.json".format(whl_name), mods) |
| |
| _whl_mods_repo = repository_rule( |
| doc = """\ |
| This rule creates json files based on the whl_mods attribute. |
| """, |
| implementation = _whl_mods_repo_impl, |
| attrs = { |
| "whl_mods": attr.string_dict( |
| mandatory = True, |
| doc = "JSON endcoded string that is provided to wheel_builder.py", |
| ), |
| }, |
| ) |
