kipp
kipp copied to clipboard
Update dependency rules_python to v0.40.0
This PR contains the following updates:
| Package | Type | Update | Change |
|---|---|---|---|
| rules_python | http_archive | minor | 0.5.0 -> 0.40.0 |
Release Notes
bazelbuild/rules_python (rules_python)
v0.40.0
{#v0-40-changed}
Changed
- Nothing changed.
{#v0-40-fixed}
Fixed
- (rules) Don't drop custom import paths if Bazel-builtin PyInfo is removed. (2414).
{#v0-40-added}
Added
- Nothing added.
{#v0-40-removed}
Removed
- (publish) Remove deprecated
requirements.txtfor thetwinedependencies. Please userequirements_linux.txtinstead. - (python_repository) Use bazel's built in
zstdsupport and remove attributes for customizing thezstdbinary to be used forzstdarchives in the {bzl:obj}python_repositoryrepository_rule. This affects the {bzl:obj}python_register_toolchainsand {bzl:obj}python_register_multi_toolchainscallers in theWORKSPACE.
{#v0-39-0}
v0.39.0
{#v0-39-0-changed}
Changed
- (deps) bazel_skylib 1.6.1 -> 1.7.1
- (deps) rules_cc 0.0.9 -> 0.0.14
- (deps) protobuf 24.4 -> 29.0-rc2
- (deps) rules_proto 6.0.0-rc1 -> 6.0.2
- (deps) stardoc 0.6.2 -> 0.7.1
- For bzlmod, Bazel 7.4 is now the minimum Bazel version.
- (toolchains) Use the latest indygreg toolchain release 20241016 for Python versions:
- 3.9.20
- 3.10.15
- 3.11.10
- 3.12.7
- 3.13.0
- (pypi) The naming scheme for the
bzlmodspoke repositories have changed as all of the givenrequirements.txtfiles are now parsed bydefault, to temporarily restore the behavior, you can use {bzl:obj}pip.parse.extra_hub_aliases, which will be removed or made noop in the future.
{#v0-39-0-fixed}
Fixed
- (precompiling) Skip precompiling (instead of erroring) if the legacy
@bazel_tools//tools/python:autodetecting_toolchainis being used (#2364).
{#v0-39-0-added}
Added
- Bazel 8 is now supported.
- (toolchain) Support for freethreaded Python toolchains is now available. Use
the config flag
//python/config_settings:py_freethreadedto toggle the selection of the free-threaded toolchains. - (toolchain) {obj}
py_runtime.abi_flagsattribute and {obj}PyRuntimeInfo.abi_flagsfield added.
{#v0-39-0-removed}
Removed
- Support for Bazel 6 using bzlmod has been dropped.
{#v0-38-0}
v0.38.0
{#v0-38-0-changed}
Changed
- (deps) (WORKSPACE only) rules_cc 0.0.13 and protobuf 27.0 is now the default version used; this for Bazel 8+ support (previously version was rules_cc 0.0.9 and no protobuf version specified) (2310).
- (publish) The dependencies have been updated to the latest available versions
for the
twinepublishing rule. - (whl_library) Remove
--no-build-isolationto allow non-hermetic sdist builds by default. Users wishing to keep this argument and to enforce more hermetic builds can do so by passing the argument inpip.parse#extra_pip_args - (pip.parse) {attr}
pip.parse.whl_modificationsnow normalizes the given whl names and nowpyyamlandPyYAMLwill both work. - (bzlmod)
pip.parsespoke repository naming will be changed in an upcoming release in places where the users specify different package versions per platform in the same hub repository. The naming of the spoke repos is considered an implementation detail and we advise the users to use thehubrepository directly and make use of {bzl:obj}pip.parse.extra_hub_aliasesfeature added in this release.
{#v0-38-0-fixed}
Fixed
- (pypi) (Bazel 7.4+) Allow spaces in filenames included in
whl_librarys (617). - (pypi) When {attr}
pip.parse.experimental_index_urlis set, we need to still pass theextra_pip_argsvalue when building ansdist. - (pypi) The patched wheel filenames from now on are using local version specifiers which fixes usage of the said wheels using standard package managers.
- (bzlmod) The extension evaluation has been adjusted to always generate the
same lock file irrespective if
experimental_index_urlis set by any module or not. To opt into this behavior, set {bzl:obj}pip.parse.parse_all_requirements_files, which will become the default in future releases leading up to1.0.0. Fixes #2268. A known issue is that it may breakbazel queryand in these use cases it is advisable to usecqueryor switch todownload_only = True
{#v0-38-0-added}
Added
- (publish) The requirements file for the
twinepublishing rules have been updated to have a new convention:requirements_darwin.txt,requirements_linux.txt,requirements_windows.txtfor each respective OS and one extra filerequirements_universal.txtif you prefer a single file. Therequirements.txtfile may be removed in the future. - The rules_python version is now reported in
//python/features.bzl#features.version - (pip.parse) {attr}
pip.parse.extra_hub_aliasescan now be used to expose extra targets created by annotations in whl repositories. Fixes #2187. - (bzlmod)
pip.parsenow supportswhl-onlysetup usingdownload_only = Truewhere users can specify multiple requirements files and use thepipbackend to do the downloading. This was only available for users setting {bzl:obj}pip.parse.experimental_index_url, but now users have more options whilst we continue to work on stabilizing the experimental feature.
{#v0-37-2}
v0.37.2
Using Bzlmod
Add to your MODULE.bazel file:
bazel_dep(name = "rules_python", version = "0.37.2")
pip = use_extension("@​rules_python//python/extensions:pip.bzl", "pip")
pip.parse(
hub_name = "pip",
python_version = "3.11",
requirements_lock = "//:requirements_lock.txt",
)
use_repo(pip, "pip")
Using WORKSPACE
Paste this snippet into your WORKSPACE file:
load("@​bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name = "rules_python",
sha256 = "c6fb25d0ba0246f6d5bd820dd0b2e66b339ccc510242fd4956b9a639b548d113",
strip_prefix = "rules_python-0.37.2",
url = "https://github.com/bazelbuild/rules_python/releases/download/0.37.2/rules_python-0.37.2.tar.gz",
)
load("@​rules_python//python:repositories.bzl", "py_repositories")
py_repositories()
Gazelle plugin
Paste this snippet into your WORKSPACE file:
load("@​bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name = "rules_python_gazelle_plugin",
sha256 = "c6fb25d0ba0246f6d5bd820dd0b2e66b339ccc510242fd4956b9a639b548d113",
strip_prefix = "rules_python-0.37.2/gazelle",
url = "https://github.com/bazelbuild/rules_python/releases/download/0.37.2/rules_python-0.37.2.tar.gz",
)
### To compile the rules_python gazelle extension from source,
### we must fetch some third-party go dependencies that it uses.
load("@​rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")
_py_gazelle_deps()
Full Changelog: https://github.com/bazelbuild/rules_python/compare/0.37.1...0.37.2
v0.37.1
{#v0-37-1-fixed}
Fixed
- (rules) Setting
--incompatible_python_disallow_native_rulesno longer causes rules_python rules to fail (#2326).
{#v0-37-0}
v0.37.0
{#v0-37-0-changed}
Changed
- BREAKING
py_libraryno longer puts its source files or generated pyc files in runfiles; it's the responsibility of consumers (e.g. binaries) to populate runfiles with the necessary files. Adding source files to runfiles can be temporarily restored by setting {obj}--add_srcs_to_runfiles=enabled, but this flag will be removed in a subsequent releases. - {obj}
PyInfo.transitive_sourcesis now added to runfiles. These files are.pyfiles that are required to be added to runfiles by downstream binaries (or equivalent). - (toolchains)
py_runtime.implementation_namenow defaults tocpython(previously it defaulted to None). - (toolchains) The exec tools toolchain is enabled by default. It can be
disabled by setting
{obj}
--@​rules_python//python/config_settings:exec_tools_toolchain=disabled. - (deps) stardoc 0.6.2 added as dependency.
{#v0-37-0-fixed}
Fixed
- (bzlmod) The
python.override(minor_mapping)now merges the default and the overridden versions ensuring that the resultantminor_mappingwill always have all of the python versions. - (bzlmod) The default value for the {obj}
--python_versionflag will now be always set to the default python toolchain version value. - (bzlmod) correctly wire the {attr}
pip.parse.extra_pip_argsall the way to {obj}whl_library. What is more we will pass theextra_pip_argsto {obj}whl_libraryforsdistdistributions when using {attr}pip.parse.experimental_index_url. See #2239. - (whl_filegroup): Provide per default also the
RECORDfile - (py_wheel):
RECORDfile entry elements are now quoted if necessary when a wheel is created - (whl_library) truncate progress messages from the repo rule to better handle
case where a requirement has many
--hash=sha256:...flags - (rules)
compile_pip_requirementspassesenvto theX.updatetarget (and not only to theX_testtarget, a bug introduced in #1067). - (bzlmod) In hybrid bzlmod with WORKSPACE builds,
python_register_toolchains(register_toolchains=True)is respected (#1675). - (precompiling) The {obj}
pyc_collectionattribute now correctly enables (or disables) using pyc files from targets transitively - (pip) Skip patching wheels not matching
pip.override'sfile(#2294). - (chore): Add a
rules_shelldev dependency and moved ash_testtarget outside of the//:BUILD.bazelfile. Fixes #2299.
{#v0-37-0-added}
Added
- (py_wheel) Now supports
compress = (True|False)to allow disabling compression to speed up development. - (toolchains): A public
//python/config_settings:python_version_major_minorhas been exposed for users to be able to match on theX.Yversion of a Python interpreter. - (api) Added {obj}
merge_py_infos()so user rules can merge and propagatePyInfowithout losing information. - (toolchains) New Python versions available: 3.13.0 using the 20241008 release.
- (toolchains): Bump default toolchain versions to:
3.8 -> 3.8.203.9 -> 3.9.203.10 -> 3.10.153.11 -> 3.11.103.12 -> 3.12.7
- (coverage) Add support for python 3.13 and bump
coverage.pyto 7.6.1. - (bzlmod) Add support for
download_onlyflag to disable usage ofsdistswhen {bzl:attr}pip.parse.experimental_index_urlis set. - (api) PyInfo fields: {obj}
PyInfo.transitive_implicit_pyc_files, {obj}PyInfo.transitive_implicit_pyc_source_files.
{#v0-37-0-removed}
Removed
- (precompiling) {obj}
--precompile_add_to_runfileshas been removed. - (precompiling) {obj}
--pyc_collectionhas been removed. Thepyc_collectionattribute now bases its default on {obj}--precompile. - (precompiling) The {obj}
precompile=if_generated_sourcevalue has been removed. - (precompiling) The {obj}
precompile_source_retention=omit_if_generated_sourcevalue has been removed.
{#v0-36-0}
v0.36.0
Changed
- (gazelle): Update error messages when unable to resolve a dependency to be more human-friendly.
- (flags) The {obj}
--python_versionflag now also returns {obj}config_common.FeatureFlagInfo. - (toolchain): The toolchain patches now expose the
patch_stripattribute that one should use when patching toolchains. Please set it if you are patching python interpreter. In the next release the default will be set to0which better reflects the defaults used in publicbazelAPIs. - (toolchains) When {obj}
py_runtime.interpreter_version_infoisn't specified, the {obj}--python_versionflag will determine the value. This allows specifying the build-time Python version for the {obj}runtime_env_toolchains. - (toolchains) {obj}
py_cc_toolchain.libsand {obj}PyCcToolchainInfo.libsis optional. This is to support situations where only the Python headers are available. - (bazel) Minimum bazel 7 version that we test against has been bumped to
7.1.
Fixed
- (whl_library): Remove
--no-indexand add--no-build-isolationto thepip installcommand when installing a wheel from a local file, which happens whenexperimental_index_urlflag is used. - (bzlmod) get the path to the host python interpreter in a way that results in platform non-dependent hashes in the lock file when the requirement markers need to be evaluated.
- (bzlmod) correctly watch sources used for evaluating requirement markers for any changes so that the repository rule or module extensions can be re-evaluated when the said files change.
- (gazelle): Fix incorrect use of
t.Fatal/t.Fatalfin tests. - (toolchain) Omit third-party python packages from coverage reports from stage2 bootstrap template.
- (bzlmod) Properly handle relative path URLs in parse_simpleapi_html.bzl
- (gazelle) Correctly resolve deps that have top-level module overlap with a gazelle_python.yaml dep module
- (rules) Make
RUNFILES_MANIFEST_FILE-based invocations work when used with {obj}--bootstrap_impl=script. This fixes invocations using non-sandboxed test execution with--enable_runfiles=false --build_runfile_manifests=true. (#2186). - (py_wheel) Fix incorrectly generated
Required-Distwhen specifying requirements with markers in extra_requires in py_wheel rule. - (rules) Prevent pytest from trying run the generated stage2
bootstrap .py file when using {obj}
--bootstrap_impl=script - (toolchain) The {bzl:obj}
gen_python_config_settingshas been fixed to include the flag_values from the platform definitions.
Added
- (bzlmod): Toolchain overrides can now be done using the new
{bzl:obj}
python.override, {bzl:obj}python.single_version_overrideand {bzl:obj}python.single_version_platform_overridetag classes. See #2081. - (rules) Executables provide {obj}
PyExecutableInfo, which contains executable-specific information useful for packaging an executable or or deriving a new one from the original. - (py_wheel) Removed use of bash to avoid failures on Windows machines which do not have it installed.
- (docs) Automatically generated documentation for {bzl:obj}
python_register_toolchainsand related symbols. - (toolchains) Added {attr}
python_repository.patch_stripattribute for allowing values that are other than1, which has been hard-coded up until now. If you are relying on the undocumentedpatchessupport inTOOL_VERSIONSfor registering patched toolchains please consider setting thepatch_stripexplicitly to1if you depend on this value - in the future the value may change to default to0. - (toolchains) Added
//python:none, a special target for use with {obj}py_exec_tools_toolchain.exec_interpreterto treat the value asNone.
Removed
- (toolchains): Removed accidentally exposed
http_archivesymbol frompython/repositories.bzl. - (toolchains): An internal is_python_config_setting macro has been removed.
v0.35.0
Changed
- (whl_library) A better log message when the wheel is built from an sdist or
when the wheel is downloaded using
download_onlyfeature to aid debugging. - (gazelle): Simplify and make gazelle_python.yaml have only top level package name. It would work well in cases to reduce merge conflicts.
- (toolchains): Change some old toochain versions to use 20240726 release to
include dependency updates
3.8.19,3.9.19,3.10.14,3.11.9 - (toolchains): Bump default toolchain versions to:
3.12 -> 3.12.4
- (rules)
PYTHONSAFEPATHis inherited from the calling environment to allow disabling it (Requires {obj}--bootstrap_impl=script) (#2060).
Fixed
- (rules)
compile_pip_requirementsnow sets theUSERPROFILEenv variable on Windows to work around an issue wheresetuptoolsfails to locate the user's home directory. - (rules) correctly handle absolute URLs in parse_simpleapi_html.bzl.
- (rules) Fixes build targets linking against
@rules_python//python/cc:current_py_cc_libsin host platform builds on macOS, by editing theLC_ID_DYLIBfield of the hermetic interpreter'slibpython3.x.dylibusinginstall_name_tool, setting it to its absolute path under Bazel's execroot. - (rules) Signals are properly received when using {obj}
--bootstrap_impl=script(for non-zip builds). (#2043) - (rules) Fixes Python builds when the
--build_python_zipis set tofalseon Windows. See #1840. - (rules) Fixes Mac +
--build_python_zip+ {obj}--bootstrap_impl=script(#2030). - (rules) User dependencies come before runtime site-packages when using
{obj}
--bootstrap_impl=script. (#2064). - (rules) Version-aware rules now return both
@_builtinsand@rules_pythonproviders instead of only one. (#2114). - (pip) Fixed pypi parse_simpleapi_html function for feeds with package metadata containing ">" sign
- (toolchains) Added missing executable permission to
//python/runtime_env_toolchainsinterpreter script so that it is runnable. (#2085). - (pip) Correctly use the
sdistdownloaded by the bazel downloader when usingexperimental_index_urlfeature. Fixes #2091. - (gazelle) Make
gazelle_python_manifest.updatemanual to avoid unnecessary network behavior. - (bzlmod): The conflicting toolchains during
pythonextension will no longer cause warnings by default. In order to see the warnings for diagnostic purposes set the env varRULES_PYTHON_REPO_DEBUG_VERBOSITYto one ofINFO,DEBUGorTRACE. Fixes #1818. - (runfiles) Make runfiles lookups work for the situation of Bazel 7, Python 3.9 (or earlier, where safepath isn't present), and the Rlocation call in the same directory as the main file. Fixes #1631.
Added
- (rules)
compile_pip_requirementssupports multiple requirements input files assrcs. - (rules)
PYTHONSAFEPATHis inherited from the calling environment to allow disabling it (Requires {obj}--bootstrap_impl=script) (#2060). - (gazelle) Added
python_generation_mode_per_package_require_test_entry_pointin order to better accommodate users who use a custom macro,pytest-bazel, rules_python_pytest orrules_pypy_test_main in order to integrate withpytest. Currently the default flag value is set totruefor backwards compatible behaviour, but in the future the flag will be flipped befalseby default. - (toolchains) New Python versions available:
3.12.4using the 20240726 release. - (pypi) Support env markers in requirements files. Note, that this means that if your requirements files contain env markers, the Python interpreter will need to be run during bzlmod phase to evaluate them. This may incur downloading an interpreter (for hermetic-based builds) or cause non-hermetic behavior (if using a system Python).
v0.34.0
Changed
protobuf/com_google_protobufdependency bumped tov24.4- (bzlmod): optimize the creation of config settings used in pip to reduce the total number of targets in the hub repo.
- (toolchains) The exec tools toolchain now finds its interpreter by reusing the regular interpreter toolchain. This avoids having to duplicate specifying where the runtime for the exec tools toolchain is.
- (toolchains) ({obj}
//python:autodetecting_toolchain) is deprecated. It is replaced by {obj}//python/runtime_env_toolchains:all. The old target will be removed in a future release.
Fixed
- (bzlmod): When using
experimental_index_urltheall_requirements,all_whl_requirementsandall_data_requirementswill now only include common packages that are available on all target platforms. This is to ensure that packages that are only present for some platforms are pulled only via thedepsof the materializedpy_library. If you would like to include platform specific packages, using aselectstatement with references to the specific package will still work (e.g. my_attr = all_requirements + select( { "@platforms//os:linux": ["@pypi//foo_available_only_on_linux"], "//conditions:default": [], } ) - (bzlmod): Targets in
all_requirementsnow use the same form as targets returned by therequirementmacro. - (rules) Auto exec groups are enabled. This allows actions run by the rules, such as precompiling, to pick an execution platform separately from what other toolchains support.
- (providers) {obj}
PyRuntimeInfodoesn't require passing theinterpreter_version_infoarg. - (bzlmod) Correctly pass
isolated,quietandtimeoutvalues towhl_libraryand drop the defaults from the lock file. - (whl_library) Correctly handle arch-specific dependencies when we encounter a
platform specific wheel and use
experimental_target_platforms. Fixes #1996. - (rules) The first element of the default outputs is now the executable again.
- (pip) Fixed crash when pypi packages lacked a sha (e.g. yanked packages)
Added
- (toolchains) {obj}
//python/runtime_env_toolchains:all, which is a drop-in replacement for the "autodetecting" toolchain. - (gazelle) Added new
python_label_conventionandpython_label_normalizationdirectives. These directive allows altering default Gazelle label format to third-party dependencies useful for re-using Gazelle plugin with other rules, includingrules_pycross. See #1939.
Removed
- (pip): Removes the
entrypointmacro that was replaced bypy_console_script_binaryin 0.26.0.
v0.33.2
{#v0-33-2-fixed}
Fixed
- (toolchains) The {obj}
exec_tools_toolchain_typeis disabled by default. To enable it, set {obj}--//python/config_settings:exec_tools_toolchain=enabled. This toolchain must be enabled for precompilation to work. This toolchain will be enabled by default in a future release. Fixes #1967.
{#v0-33-1}
v0.33.1
{#v0-33-1-fixed}
Fixed
- (py_binary) Fix building of zip file when using
--build_python_zipargument. Fixes #1954.
{#v0-33-0}
v0.33.0
{#v0-33-0-changed}
Changed
- (deps) Upgrade the
pip_installdependencies to pick up a new version of pip. - (toolchains) Optional toolchain dependency:
py_binary,py_test, andpy_librarynow depend on the//python:exec_tools_toolchain_typefor build tools. - (deps): Bumped
bazel_skylibto 1.6.1. - (bzlmod): The
pythonand internalrules_pythonextensions have been marked asreproducibleand will not include any lock file entries from now on. - (gazelle): Remove gazelle plugin's python deps and make it hermetic.
Introduced a new Go-based helper leveraging tree-sitter for syntax analysis.
Implemented the use of
pypi/stdlib-listfor standard library module verification. - (pip.parse): Do not ignore yanked packages when using
experimental_index_url. This is to mimic whatuvis doing. We will print a warning instead. - (pip.parse): Add references to all supported wheels when using
experimental_index_urlto allowing to correctly fetch the wheels for the right platform. See the updated docs on how to use the feature. This is work towards addressing #735 and #260. The spoke repository names when using this flag will have a structure of{pip_hub_prefix}_{wheel_name}_{py_tag}_{abi_tag}_{platform_tag}_{sha256}, which is an implementation detail which should not be relied on and is there purely for better debugging experience. - (bzlmod) The
pythons_hub//:interpreters.bzlno longer has platform-specific labels which where left there for compatibility reasons. Move topython_{version}_hostkeys if you would like to have access to a Python interpreter that can be used in a repository rule context.
{#v0-33-0-fixed}
Fixed
- (gazelle) Remove
visibilityfromNonEmptyAttr. Now empty(have nodeps/main/srcs/importsattr)py_library/test/binaryrules will be automatically deleted correctly. For example, ifpython_generation_modeis set to package, when__init__.pyis deleted, thepy_librarygenerated for this package before will be deleted automatically. - (whl_library): Use is_python_config_setting to correctly handle multi-python
version dependency select statements when the
experimental_target_platformsincludes the Python ABI. The default python version case within the select is also now handled correctly, stabilizing the implementation. - (gazelle) Fix Gazelle failing on Windows with "panic: runtime error: invalid memory address or nil pointer dereference"
- (bzlmod) remove
pip.parse(annotations)attribute as it is unused and has been replaced by whl_modifications. - (pip) Correctly select wheels when the python tag includes minor versions. See (#1930)
- (pip.parse): The lock file is now reproducible on any host platform if the
experimental_index_urlis not used by any of the modules in the dependency chain. To make the lock file identical on eachosandarch, please use theexperimental_index_urlfeature which will fetch metadata from PyPI or a different private index and write the contents to the lock file. Fixes #1643. - (pip.parse): Install
yankedpackages and print a warning instead of ignoring them. This better matches the behaviour ofuv pip install. - (toolchains): Now matching of the default hermetic toolchain is more robust
and explicit and should fix rare edge-cases where the host toolchain
autodetection would match a different toolchain than expected. This may yield
to toolchain selection failures when the python toolchain is not registered,
but is requested via
//python/config_settings:python_versionflag setting. - (doc) Fix the
WORKSPACErequirement vendoring example. Fixes #1918.
{#v0-33-0-added}
Added
- (rules) Precompiling Python source at build time is available. but is
disabled by default, for now. Set
@rules_python//python/config_settings:precompile=enabledto enable it by default. A subsequent release will enable it by default. See the Precompiling docs and API reference docs for more information on precompiling. Note this requires Bazel 7+ and the Pystar rule implementation enabled. (#1761) - (rules) Attributes and flags to control precompile behavior:
precompile,precompile_optimize_level,precompile_source_retention,precompile_invalidation_mode, andpyc_collection - (toolchains) The target runtime toolchain (
//python:toolchain_type) has two new optional attributes:pyc_tag(tells the pyc filename infix to use) andimplementation_name(tells the Python implementation name). - (toolchains) A toolchain type for build tools has been added:
//python:exec_tools_toolchain_type. - (providers)
PyInfohas two new attributes:direct_pyc_filesandtransitive_pyc_files, which tell the pyc files a target makes available directly and transitively, respectively. //python:features.bzladded to allow easy feature-detection in the future.- (pip) Allow specifying the requirements by (os, arch) and add extra
validations when parsing the inputs. This is a non-breaking change for most
users unless they have been passing multiple
requirements_*files together withextra_pip_args = ["--platform=manylinux_2_4_x86_64"], that was an invalid usage previously but we were not failing the build. From now on this is explicitly disallowed. - (toolchains) Added riscv64 platform definition for python toolchains.
- (gazelle) The
python_visibilitydirective now supports the$python_root$placeholder, just like thepython_default_visibilitydirective does. - (rules) A new bootstrap implementation that doesn't require a system Python
is available. It can be enabled by setting
{obj}
--@​rules_python//python/config_settings:bootstrap_impl=script. It will become the default in a subsequent release. (#691) - (providers)
PyRuntimeInfohas two new attributes: {obj}PyRuntimeInfo.stage2_bootstrap_templateand {obj}PyRuntimeInfo.zip_main_template. - (toolchains) A replacement for the Bazel-builtn autodetecting toolchain is
available. The
//python:autodetecting_toolchainalias now uses it. - (pip): Support fetching and using the wheels for other platforms. This
supports customizing whether the linux wheels are pulled for
muslorglibc, whetheruniversal2or arch-specific MacOS wheels are preferred and it also allows to select a particularlibcversion. All of this is done via thestring_flagsin@rules_python//python/config_settings. If there are no wheels that are supported for the target platform,rules_pythonwill fallback onto building thesdistfrom source. This behaviour can be disabled if desired using one of the available string flags as well. - (whl_filegroup) Added a new
whl_filegrouprule to extract files from a wheel file. This is useful to extract headers for use in acc_library.
{#v0-32-2}
v0.32.2
{#v0-32-2-fixed}
Fixed
- Workaround existence of infinite symlink loops on case insensitive filesystems when targeting linux platforms with recent Python toolchains. Works around an upstream issue. Fixes #1800.
{#v0-32-0}
v0.32.1
Using Bzlmod with Bazel 6
NOTE: bzlmod support is still beta. APIs subject to change.
Add to your MODULE.bazel file:
bazel_dep(name = "rules_python", version = "0.32.1")
pip = use_extension("@​rules_python//python/extensions:pip.bzl", "pip")
pip.parse(
hub_name = "pip",
python_version = "3.11",
requirements_lock = "//:requirements_lock.txt",
)
use_repo(pip, "pip")
Using WORKSPACE
Paste this snippet into your WORKSPACE file:
load("@​bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name = "rules_python",
sha256 = "b289b0b023c71b80f26d39476e5e2c3cf72d21cb2759bcf02638ba3cc480e9df",
strip_prefix = "rules_python-0.32.1",
url = "https://github.com/bazelbuild/rules_python/releases/download/0.32.1/rules_python-0.32.1.tar.gz",
)
load("@​rules_python//python:repositories.bzl", "py_repositories")
py_repositories()
Gazelle plugin
Paste this snippet into your WORKSPACE file:
load("@​bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name = "rules_python_gazelle_plugin",
sha256 = "b289b0b023c71b80f26d39476e5e2c3cf72d21cb2759bcf02638ba3cc480e9df",
strip_prefix = "rules_python-0.32.1/gazelle",
url = "https://github.com/bazelbuild/rules_python/releases/download/0.32.1/rules_python-0.32.1.tar.gz",
)
### To compile the rules_python gazelle extension from source,
### we must fetch some third-party go dependencies that it uses.
load("@​rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")
_py_gazelle_deps()
What's Changed
Changed
- (bzlmod): The
MODULE.bazel.lockwhl_libraryrule attributes are now sorted in the attributes section. We are also removing values that are not default in order to reduce the size of the lock file. - (coverage) Bump
coverage.pyto 7.4.3. - (deps): Bumped bazel_features to 1.9.1 to detect optional support non-blocking downloads.
- (deps): Updated
pip_toolsto >= 7.4.0 - (toolchains): Change some old toolchain versions to use 20240224 release to
include security fixes
3.8.18,3.9.18and3.10.13 - (toolchains): Bump default toolchain versions to:
3.8 -> 3.8.193.9 -> 3.9.193.10 -> 3.10.143.11 -> 3.11.93.12 -> 3.12.3
Fixed
- (whl_library): Fix the experimental_target_platforms overriding for platform specific wheels when the wheels are for any python interpreter version. Fixes #1810.
- (whl_library): Stop generating duplicate dependencies when encountering duplicates in the METADATA. Fixes #1873.
- (gazelle) In
projectorpackagegeneration modes, do not generatepy_testrules when there are no test files and do not setmain = "__test__.py"when that file doesn't exist. - (whl_library) The group redirection is only added when the package is part of
the group potentially fixing aspects that want to traverse a
py_librarygraph. Fixes #1760. - (bzlmod) Setting a particular micro version for the interpreter and the
pip.parseextension is now possible, see theexamples/pip_parse/MODULE.bazelfor how to do it. See #1371. - (refactor) The pre-commit developer workflow should now pass
isortandblackchecks (see #1674).
Added
- (toolchains) Added armv7 platform definition for python toolchains.
- (toolchains) New Python versions available:
3.11.8,3.12.2using the 20240224 release. - (toolchains) New Python versions available:
3.8.19,3.9.19,3.10.14,3.11.9,3.12.3using the 20240415 release. - (gazelle) Added a new
python_visibilitydirective to control visibility of generated targets by appending additional visibility labels. - (gazelle) Added a new
python_default_visibilitydirective to control the default visibility of generated targets. See the docs for details. - (gazelle) Added a new
python_test_file_patterndirective. This directive tells gazelle which python files should be mapped to thepy_testrule. See the original issue and the docs for details. - (wheel) Add support for
data_filesattributes in py_wheel rule (#1777) - (py_wheel)
bzlmodinstallations now provide atwinesetup for the default Python toolchain inrules_pythonfor version 3.11. - (bzlmod) New
experimental_index_url,experimental_extra_index_urlsandexperimental_index_url_overridestopip.parsefor using the bazel downloader. If you see any issues, report in #1357. The URLs for the whl and sdist files will be written to the lock file. Controlling whether the downloading of metadata is done in parallel can be done usingparallel_downloadattribute. - (gazelle) Add a new annotation
include_dep. Also add documentation for annotations togazelle/README.md. - (deps):
rules_pythondepends now onrules_cc0.0.9 - (pip_parse): A new flag
use_hub_alias_dependencieshas been added that is going to become default in the next release. This makes use ofdep_templateflag in thewhl_libraryrule. This also affects theexperimental_requirement_cyclesfeature where the dependencies that are in a group would be only accessible via the hub repo aliases. If you still depend on legacy labels instead of the hub repo aliases and you use theexperimental_requirement_cycles, now is a good time to migrate.
Full Changelog: https://github.com/bazelbuild/rules_python/compare/0.32.0...0.32.1
v0.32.0
{#v0-32-0-changed}
Changed
- (bzlmod): The
MODULE.bazel.lockwhl_libraryrule attributes are now sorted in the attributes section. We are also removing values that are not default in order to reduce the size of the lock file. - (coverage) Bump
coverage.pyto 7.4.3. - (deps): Bumped
bazel_featuresto 1.9.1 to detect optional support non-blocking downloads. - (deps): Updated
pip_toolsto >= 7.4.0 - (toolchains): Change some old toolchain versions to use 20240224 release to
include security fixes
3.8.18,3.9.18and3.10.13 - (toolchains): Bump default toolchain versions to:
3.8 -> 3.8.193.9 -> 3.9.193.10 -> 3.10.143.11 -> 3.11.93.12 -> 3.12.3
Fixed
- (whl_library): Fix the experimental_target_platforms overriding for platform specific wheels when the wheels are for any python interpreter version. Fixes #1810.
- (whl_library): Stop generating duplicate dependencies when encountering duplicates in the METADATA. Fixes #1873.
- (gazelle) In
projectorpackagegeneration modes, do not generatepy_testrules when there are no test files and do not setmain = "__test__.py"when that file doesn't exist. - (whl_library) The group redirection is only added when the package is part of
the group potentially fixing aspects that want to traverse a
py_librarygraph. Fixes #1760. - (bzlmod) Setting a particular micro version for the interpreter and the
pip.parseextension is now possible, see theexamples/pip_parse/MODULE.bazelfor how to do it. See #1371. - (refactor) The pre-commit developer workflow should now pass
isortandblackchecks (see #1674).
Added
- (toolchains) Added armv7 platform definition for python toolchains.
- (toolchains) New Python versions available:
3.11.8,3.12.2using the 20240224 release. - (toolchains) New Python versions available:
3.8.19,3.9.19,3.10.14,3.11.9,3.12.3using the 20240415 release. - (gazelle) Added a new
python_visibilitydirective to control visibility of generated targets by appending additional visibility labels. - (gazelle) Added a new
python_default_visibilitydirective to control the default visibility of generated targets. See the docs for details. - (gazelle) Added a new
python_test_file_patterndirective. This directive tells gazelle which python files should be mapped to thepy_testrule. See the original issue and the docs for details. - (wheel) Add support for
data_filesattributes in py_wheel rule (#1777) - (py_wheel)
bzlmodinstallations now provide atwinesetup for the default Python toolchain inrules_pythonfor version 3.11. - (bzlmod) New
experimental_index_url,experimental_extra_index_urlsandexperimental_index_url_overridestopip.parsefor using the bazel downloader. If you see any issues, report in #1357. The URLs for the whl and sdist files will be written to the lock file. Controlling whether the downloading of metadata is done in parallel can be done usingparallel_downloadattribute. - (gazelle) Add a new annotation
include_dep. Also add documentation for annotations togazelle/README.md. - (deps):
rules_pythondepends now onrules_cc0.0.9 - (pip_parse): A new flag
use_hub_alias_dependencieshas been added that is going to become default in the next release. This makes use ofdep_templateflag in thewhl_libraryrule. This also affects theexperimental_requirement_cyclesfeature where the dependencies that are in a group would be only accessible via the hub repo aliases. If you still depend on legacy labels instead of the hub repo aliases and you use theexperimental_requirement_cycles, now is a good time to migrate.
v0.31.0
Changed
- For Bazel 7, the core rules and providers are now implemented in rules_python
directly and the rules bundled with Bazel are not used. Bazel 6 and earlier
continue to use the Bazel builtin symbols. Of particular note, this means,
under Bazel 7, the builtin global symbol
PyInfois not the same as what is loaded from rules_python. The same is true ofPyRuntimeInfo.
v0.30.0
Changed
-
(toolchains) Windows hosts always ignore pyc files in the downloaded runtimes. This fixes issues due to pyc files being created at runtime and affecting the definition of what files were considered part of the runtime.
-
(pip_parse) Added the
envsubstparameter, which enables environment variable substitutions in theextra_pip_argsattribute. -
(pip_repository) Added the
envsubstparameter, which enables environment variable substitutions in theextra_pip_argsattribute.
Fixed
-
(bzlmod) pip.parse now does not fail with an empty
requirements.txt. -
(py_wheel) Wheels generated by
py_wheelnow preserve executable bits when being extracted byinstallerand/orpip. -
(coverage) During the running of lcov, the stdout/stderr was causing test failures. By default, suppress output when generating lcov. This can be overridden by setting 'VERBOSE_COVERAGE'. This change only affect bazel 7.x.x and above.
-
(toolchain) Changed the
host_toolchainto symlink all files to support Windows host environments without symlink support. -
(PyRuntimeInfo) Switch back to builtin PyRuntimeInfo for Bazel 6.4 and when pystar is disabled. This fixes an error about
target ... does not have ... PyRuntimeInfo. (#1732)
Added
-
(py_wheel) Added
requires_fileandextra_requires_filesattributes. -
(whl_library) experimental_target_platforms now supports specifying the Python version explicitly and the output
BUILD.bazelfile will be correct irrespective of the python interpreter that is generating the file and extracting thewhldistribution. Multiple python target version can be specified and the code generation will generate version specific dependency closures but that is not yet ready to be used and may break the build if the default python version is not selected usingcommon --@​rules_python//python/config_settings:python_version=X.Y.Z. -
New Python versions available:
3.11.7,3.12.1using https://github.com/indygreg/python-build-standalone/releases/tag/20240107. -
(toolchain) Allow setting
x.yas thepython_versionparameter in the version-awarepy_binaryandpy_testrules. This allows users to use the same rule import for testing with specific Python versions and rely on toolchain configuration and how the latest version takes precedence if e.g.3.8is selected. That also simplifies.bazelrcfor any users that set the defaultpython_versionstring flag in that way. -
(toolchain) The runtime's shared libraries (libpython.so et al) can be accessed using
@rules_python//python/cc:current_py_cc_libs. This uses toolchain resolution, so the files are from the same runtime used to run a target. If you were previously using e.g.@python_3_11//:libpython, then switch to:current_py_cc_libsfor looser coupling to the underlying runtime repo implementation. -
(repo rules) The environment variable
RULES_PYTHON_REPO_DEBUG=1can be set to make repository rules log detailed information about what they're up to. -
(coverage) Add support for python 3.12 and bump
coverage.pyto 7.4.1.
v0.29.0
Changed
- BREAKING The deprecated
incompatible_generate_aliasesfeature flags frompip_parseandgazellegot removed. They had been flipped toTruein 0.27.0 release. - BREAKING (wheel) The
incompatible_normalize_nameandincompatible_normalize_versionflags have been removed. They had been flipped toTruein 0.27.0 release. - (bzlmod) The pip hub repository now uses the newly introduced config settings
using the
X.Ypython version notation. This improves cross module interoperability and allows to share wheels built by interpreters using different patch versions.
Fixed
-
(bzlmod pip.parse) Use a platform-independent reference to the interpreter pip uses. This reduces (but doesn't eliminate) the amount of platform-specific content in
MODULE.bazel.lockfiles; Follow #1643 for removing platform-specific content inMODULE.bazel.lockfiles. -
(wheel) The stamp variables inside the distribution name are no longer lower-cased when normalizing under PEP440 conventions.
Added
-
(toolchains)
python_register_toolchainsnow also generates a repository that is suffixed with_host, that has a single label:pythonthat is a symlink to the python interpreter for the host platform. The intended use is mainly inrepository_rule, which are always run usinghostplatform Python. This means thatWORKSPACEusers can now copy therequirements.bzlfile for vendoring as seen in the updatedpip_parse_vendoredexample. -
(runfiles)
rules_python.python.runfiles.Runfilesnow has a staticCreatemethod to make imports more ergonomic. Users should only need to import theRunfilesobject to locate runfiles. -
(toolchains)
PyRuntimeInfonow includes ainterpreter_version_infofield that contains the static version information for the given interpreter. This can be set viapy_runtimewhen registering an interpreter toolchain, and will done automatically for the builtin interpreter versions registered viapython_register_toolchains. Note that this only available on the Starlark implementation of the provider. -
(config_settings) Added
//python/config_settings:is_python_X.Yconfig settings to match on minor Python version. These settings match anyX.Yversion instead of just an exactX.Y.Zversion.
v0.28.0
Changed
-
BREAKING (pip_install) the deprecated
pip_installmacro and related items have been removed. -
BREAKING Support for Bazel 5 has been officially dropped. This release was only partially tested with Bazel 5 and may or may not work with Bazel 5. Subequent versions will no longer be tested under Bazel 5.
-
(runfiles)
rules_python.python.runfilesnow directly implements type hints and drops support for python2 as a result. -
(toolchains)
py_runtime,py_runtime_pair, andPyRuntimeInfonow use the rules_python Starlark implementation, not the one built into Bazel. NOTE: This only applies to Bazel 6+; Bazel 5 still uses the builtin implementation. -
(pip_parse) The parameter
experimental_requirement_cyclesmay be provided a map of names to lists of requirements which form a dependency cycle.pip_parsewill break the cycle for you transparently. This behavior is also available under bzlmod aspip.parse(experimental_requirement_cycles={}). -
(toolchains)
py_runtimecan now take an executable target. Note: runfiles from the target are not supported yet. (#1612) -
(gazelle) When
python_generation_modeis set tofile, create onepy_binarytarget for each file withif __name__ == "__main__"instead of just onepy_binaryfor the whole module. -
(gazelle) the Gazelle manifest integrity field is now optional. If the
requirementsargument togazelle_python_manifestis unset, no integrity field will be generated.
Fixed
-
(gazelle) The gazelle plugin helper was not working with Python toolchains 3.11 and above due to a bug in the helper components not being on PYTHONPATH.
-
(pip_parse) The repositories created by
whl_librarycan now parse thewhlMETADATA and generate dependency closures irrespective of the host platform the generation is executed on. This can be turned on by supplyingexperimental_target_platforms = ["all"]to thepip_parseor thebzlmod
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
- [ ] If you want to rebase/retry this PR, check this box
This PR was generated by Mend Renovate. View the repository job log.