Skip to content

Update dependency rules_python to v1 #388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Dec 6, 2024

This PR contains the following updates:

Package Type Update Change
rules_python bazel_dep major 0.37.2 -> 1.4.0

Release Notes

bazel-contrib/rules_python (rules_python)

v1.4.0

Compare Source

{#​1-4-0-changed}

Changed
  • (toolchain) The exec configuration toolchain now has the forwarded
    exec_interpreter now also forwards the ToolchainInfo provider. This is
    for increased compatibility with the RBE setups where access to the exec
    configuration interpreter is needed.
  • (toolchains) Use the latest astral-sh toolchain release 20250317 for Python versions:
    • 3.9.21
    • 3.10.16
    • 3.11.11
    • 3.12.9
    • 3.13.2
  • (pypi) Use xcrun xcodebuild --showsdks to find XCode root.
  • (toolchains) Remove all but 3.8.20 versions of the Python 3.8 interpreter who has
    reached EOL. If users still need other versions of the 3.8 interpreter, please supply
    the URLs manually {bzl:obj}python.toolchain or {bzl:obj}python_register_toolchains calls.
  • (toolchains) Previously #​2636
    changed the semantics of ignore_root_user_error from "ignore" to "warning". This is now
    flipped back to ignoring the issue, and will only emit a warning when the attribute is set
    False.
  • (pypi) The PyPI extension will no longer write the lock file entries as the
    extension has been marked reproducible.
    Fixes #​2434.
  • (gazelle) Lazily load and parse manifest files when running Gazelle. This ensures no
    manifest files are loaded when Gazelle is run over a set of non-python directories
    PR #​2746.
  • (rules) {attr}py_binary.srcs and {attr}py_test.srcs is no longer mandatory when
    main_module is specified (for --bootstrap_impl=script)

{#​1-4-0-fixed}

Fixed
  • (pypi) Platform specific extras are now correctly handled when using
    universal lock files with environment markers. Fixes #​2690.
  • (runfiles) ({obj}--bootstrap_impl=script) Follow symlinks when searching for runfiles.
  • (toolchains) Do not try to run chmod when downloading non-windows hermetic toolchain
    repositories on Windows. Fixes
    #​2660.
  • (logging) Allow repo rule logging level to be set to FAIL via the RULES_PYTHON_REPO_DEBUG_VERBOSITY environment variable.
  • (toolchains) The toolchain matching is has been fixed when writing
    transitions transitioning on the python_version flag.
    Fixes #​2685.
  • (toolchains) Run the check on the Python interpreter in isolated mode, to ensure it's not affected by userland environment variables, such as PYTHONPATH.
  • (toolchains) Ensure temporary .pyc and .pyo files are also excluded from the interpreters repository files.
  • (pypi) Run interpreter version call in isolated mode, to ensure it's not affected by userland environment variables, such as PYTHONPATH.
  • (packaging) An empty requires_file is treated as if it were omitted, resulting in a valid METADATA file.
  • (rules) py_wheel and sphinxdocs rules now propagate target_compatible_with to all targets they create.
    PR #​2788.
  • (pypi) Correctly handle METADATA entries when python_full_version is used in
    the environment marker.
    Fixes #​2319.
  • (pypi) Correctly handle python_version parameter and transition the requirement
    locking to the right interpreter version when using
    {obj}compile_pip_requirements rule.
    See #​2819.

{#​1-4-0-added}

Added
  • (pypi) From now on sha256 values in the requirements.txt is no longer
    mandatory when enabling {attr}pip.parse.experimental_index_url feature.
    This means that rules_python will attempt to fetch metadata for all
    packages through SimpleAPI unless they are pulled through direct URL
    references. Fixes #​2023.
    In case you see issues with rules_python being too eager to fetch the SimpleAPI
    metadata, you can use the newly added {attr}pip.parse.experimental_skip_sources
    to skip metadata fetching for those packages.
  • (uv) A {obj}lock rule that is the replacement for the
    {obj}compile_pip_requirements. This may still have rough corners
    so please report issues with it in the
    #​1975.
    Main highlights - the locking can be done within a build action or outside
    it, there is no more automatic test target (but it can be added on the user
    side by using native_test). For customizing the uv version that is used,
    please check the {obj}uv.configure tag class.
  • Add support for riscv64 linux platform.
  • (toolchains) Add python 3.13.2 and 3.12.9 toolchains
  • (providers) (experimental) {obj}PyInfo.site_packages_symlinks field added to
    allow specifying links to create within the venv site packages (only
    applicable with {obj}--bootstrap_impl=script)
    (#​2156).
  • (toolchains) Local Python installs can be used to create a toolchain
    equivalent to the standard toolchains. See [Local toolchains] docs for how to
    configure them.
  • (toolchains) Expose $(PYTHON2_ROOTPATH) and $(PYTHON3_ROOTPATH) which are runfiles
    locations equivalents of $(PYTHON2) and `$(PYTHON3) respectively.

{#​1-4-0-removed}

Removed
  • Nothing removed.

{#v1-3-0}

v1.3.0

Compare Source

{#v1-3-0-changed}

Changed
  • (deps) platforms 0.0.4 -> 0.0.11
  • (py_wheel) Package py_library.pyi_srcs (.pyi files) in the wheel.
  • (py_package) Package py_library.pyi_srcs (.pyi files) in py_package.
  • (gazelle) The generated manifest file (default: gazelle_python.yaml) will now include the
    YAML document start --- line. Implemented in
    #​2656.

{#v1-3-0-fixed}

Fixed
  • (pypi) The ppc64le is now pointing to the right target in the platforms package.
  • (gazelle) No longer incorrectly merge py_binary targets during partial updates in
    file generation mode. Fixed in #​2619.
  • (bzlmod) Running as root is no longer an error. ignore_root_user_error=True
    is now the default. Note that running as root may still cause spurious
    Bazel cache invalidation
    (#​1169).
  • (gazelle) Don't collapse depsets to a list or into args when generating the modules mapping file.
    Support spilling modules mapping args into a params file.
  • (coverage) Fix missing files in the coverage report if they have no tests.
  • (pypi) From now on python invocations in repository and module extension
    evaluation contexts will invoke Python interpreter with -B to avoid
    creating .pyc files.
  • (deps) doublestar 4.7.1 (required for recent Gazelle versions)

{#v1-3-0-added}

Added
  • (python) {attr}python.defaults has been added to allow users to
    set the default python version in the root module by reading the
    default version number from a file or an environment variable.
  • {obj}//python/bin:python: convenience target for directly running an
    interpreter. {obj}--//python/bin:python_src can be used to specify a
    binary whose interpreter to use.
  • (uv) Now the extension can be fully configured via bzlmod APIs without the
    need to patch rules_python. The documentation has been added to rules_python
    docs but usage of the extension may result in your setup breaking without any
    notice. What is more, the URLs and SHA256 values will be retrieved from the
    GitHub releases page metadata published by the uv project.
  • (pypi) An extra argument to add the interpreter lib dir to LDFLAGS when
    building wheels from sdist.
  • (pypi) Direct HTTP urls for wheels and sdists are now supported when using
    {obj}experimental_index_url (bazel downloader).
    Partially fixes #​2363.
  • (rules) APIs for creating custom rules based on the core py_binary, py_test,
    and py_library rules
    (#​1647)
  • (rules) Added env-var to allow additional interpreter args for stage1 bootstrap.
    See {obj}RULES_PYTHON_ADDITIONAL_INTERPRETER_ARGS environment variable.
    Only applicable for {obj}--bootstrap_impl=script.
  • (rules) Added {obj}interpreter_args attribute to py_binary and py_test,
    which allows pass arguments to the interpreter before the regular args.
  • (rules) Added {obj}main_module attribute to py_binary and py_test,
    which allows specifying a module name to run (i.e. python -m <module>).

{#v1-3-0-removed}

Removed
  • Nothing removed.

{#v1-2-0}

v1.2.0

Compare Source

{#v1-2-0-changed}

Changed
  • (rules) py_proto_library is deprecated in favour of the
    implementation in https://github.com/protocolbuffers/protobuf. It will be
    removed in the future release.
  • (pypi) {obj}pip.override will now be ignored instead of raising an error,
    fixes #​2550.
  • (rules) deprecation warnings for deprecated symbols have been turned off by
    default for now and can be enabled with RULES_PYTHON_DEPRECATION_WARNINGS
    env var.
  • (pypi) Downgraded versions of packages: pip from 24.3.2 to 24.0.0 and
    packaging from 24.2 to 24.0.

{#v1-2-0-fixed}

Fixed
  • (rules) python_zip_file output with --bootstrap_impl=script works again
    (#​2596).
  • (docs) Using python_version attribute for specifying python versions introduced in v1.1.0
  • (gazelle) Providing multiple input requirements files to gazelle_python_manifest now works correctly.
  • (pypi) Handle trailing slashes in pip index URLs in environment variables,
    fixes #​2554.
  • (runfiles) Runfile manifest and repository mapping files are now interpreted
    as UTF-8 on all platforms.
  • (coverage) Coverage with --bootstrap_impl=script is fixed
    (#​2572).
  • (pypi) Non deterministic behaviour in requirement file usage has been fixed
    by reverting #​2514.
    The related issue is #​908.
  • (sphinxdocs) Do not crash when tag_class does not have a populated doc value.
    Fixes (#​2579).
  • (binaries/tests) Fix packaging when using --bootstrap_impl=script: set
    {obj}--venvs_use_declare_symlink=no to have it not create symlinks at
    build time (they will be created at runtime instead).
    (Fixes #​2489)

{#v1-2-0-added}

Added
  • Nothing added.

{#v1-2-0-removed}

Removed
  • Nothing removed.

{#v1-1-0}

v1.1.0

Compare Source

{#v1-1-0-changed}

Changed
  • (toolchains) 3.13 means 3.13.1 (previously 3.13.0)
  • Bazel 6 support is dropped and Bazel 7.4.1 is the minimum supported
    version, per our Bazel support matrix. Earlier versions are not
    tested by CI, so functionality cannot be guaranteed.
  • ({bzl:obj}pip.parse) From now we will make fewer calls to indexes when
    fetching the metadata from SimpleAPI. The calls will be done in parallel to
    each index separately, so the extension evaluation time might slow down if
    not using {bzl:obj}pip.parse.experimental_index_url_overrides.
  • ({bzl:obj}pip.parse) Only query SimpleAPI for packages that have
    sha values in the requirements.txt file.
  • (rules) The version-aware rules have been folded into the base rules and
    the version-aware rules are now simply aliases for the base rules. The
    python_version attribute is still used to specify the Python version.
  • (pypi) Updated versions of packages: pip to 24.3.1 and
    packaging to 24.2.

{#v1-1-0-deprecations}

Deprecations
  • //python/config_settings:transitions.bzl and its py_binary and py_test
    wrappers are deprecated. Use the regular rules instead.

{#v1-1-0-fixed}

Fixed
  • (py_wheel) Use the default shell environment when building wheels to allow
    toolchains that search PATH to be used for the wheel builder tool.
  • (pypi) The requirement argument parsed to whl_library will now not have env
    marker information allowing bazel query to work in cases where the whl is
    available for all of the platforms and the sdist can be built. This fix is
    for both WORKSPACE and bzlmod setups.
    Fixes #​2450.
  • (gazelle) Gazelle will now correctly parse Python3.12 files that use PEP 695 Type
    Parameter Syntax
    . (#​2396)
  • (pypi) Using {bzl:obj}pip_parse.experimental_requirement_cycles and
    {bzl:obj}pip_parse.use_hub_alias_dependencies together now works when
    using WORKSPACE files.
  • (pypi) The error messages when the wheel distributions do not match anything
    are now printing more details and include the currently active flag
    values. Fixes #​2466.
  • (py_proto_library) Fix import paths in Bazel 8.
  • (whl_library) Now the changes to the dependencies are correctly tracked when
    PyPI packages used in {bzl:obj}whl_library during the repository_rule phase
    change. Fixes #​2468.
  • (gazelle) Gazelle no longer ignores setup.py files by default. To restore
    this behavior, apply the # gazelle:python_ignore_files setup.py directive.
  • Don't re-fetch whl_library, python_repository, etc. repository rules
    whenever PATH changes. Fixes
    #​2551.

{#v1-1-0-added}

Added
  • (gazelle) Added include_stub_packages flag to modules_mapping. When set to True, this
    automatically includes corresponding stub packages for third-party libraries
    that are present and used (e.g., boto3boto3-stubs), improving
    type-checking support.
  • (pypi) Freethreaded packages are now fully supported in the
    {obj}experimental_index_url usage or the regular pip.parse usage.
    To select the free-threaded interpreter in the repo phase, please use
    the documented env variables.
    Fixes #​2386.
  • (toolchains) Use the latest astrahl-sh toolchain release 20241206 for Python versions:
    • 3.9.21
    • 3.10.16
    • 3.11.11
    • 3.12.8
    • 3.13.1
  • (rules) Attributes for type definition files (.pyi files) and type-checking
    only dependencies added. See {obj}py_library.pyi_srcs and
    py_library.pyi_deps (and the same named attributes for py_binary and
    py_test).
  • (pypi) pypi-generated targets set pyi_srcs to include *.pyi files.
  • (providers) {obj}PyInfo has new fields to aid static analysis tools:
    {obj}direct_original_sources, {obj}direct_pyi_files,
    {obj}transitive_original_sources, {obj}transitive_pyi_files.

{#v1-1-0-removed}

Removed
  • find_requirements in //python:defs.bzl has been removed.

{#v1-0-0}

v1.0.0

Compare Source

{#v1-0-0-changed}

Changed

Breaking:

  • (toolchains) stop exposing config settings in python toolchain alias repos.
    Please consider depending on the flags defined in
    //python/config_setting/... and the @platforms package instead.
  • (toolchains) consumers who were depending on the MACOS_NAME and the arch
    attribute in the PLATFORMS list, please update your code to respect the new
    values. The values now correspond to the values available in the
    @platforms// package constraint values.
  • (toolchains) host_platform and interpreter constants are no longer created
    in the toolchain generated alias .bzl files. If you need to access the
    host interpreter during the repository_rule evaluation, please use the
    @python_{version}_host//:python targets created by
    {bzl:obj}python_register_toolchains and
    {bzl:obj}python_register_multi_toolchains macros or the {bzl:obj}python
    bzlmod extension.
  • (bzlmod) pip.parse.parse_all_requirements_files attribute has been removed.
    See notes in the previous versions about what to do.
  • (deps) rules_cc 0.1.0 (workspace) and 0.0.16 (bzlmod).
  • (deps) protobuf 29.0-rc2 (workspace; bzlmod already specifying that version).

Other changes:

  • (python_repository) Start honoring the strip_prefix field for zstd archives.
  • (pypi) {bzl:obj}pip_parse.extra_hub_aliases now works in WORKSPACE files.
  • (binaries/tests) For {obj}--bootstrap_impl=script, a binary-specific (but
    otherwise empty) virtual env is used to customize sys.path initialization.
  • (deps) bazel_skylib 1.7.0 (workspace; bzlmod already specifying that version)
  • (deps) bazel_features 1.21.0; necessary for compatiblity with Bazel 8 rc3
  • (deps) stardoc 0.7.2 to support Bazel 8.

{#v1-0-0-fixed}

Fixed
  • (toolchains) stop depending on uname to get the value of the host platform.
  • (pypi): Correctly handle multiple versions of the same package in the requirements
    files which is useful when including different PyTorch builds (e.g. <pytorch+cpu> vs <pytorch+cu118> ) for different target platforms.
    Fixes (2337).
  • (uv): Correct the sha256sum for the uv binary for aarch64-apple-darwin.
    Fixes (2411).
  • (binaries/tests) ({obj}--bootstrap_impl=scipt) Using sys.executable will
    use the same sys.path setup as the calling binary.
    (2169).
  • (workspace) Corrected protobuf's name to com_google_protobuf, the name is
    hardcoded in Bazel, WORKSPACE mode.
  • (pypi): {bzl:obj}compile_pip_requirements no longer fails on Windows when --enable_runfiles is not enabled.
  • (pypi): {bzl:obj}compile_pip_requirements now correctly updates files in the source tree on Windows when --windows_enable_symlinks is not enabled.
  • (repositories): Add libs/python3.lib and pythonXY.dll to the libpython target
    defined by a repository template. This enables stable ABI builds of Python extensions
    on Windows (by defining Py_LIMITED_API).
  • (rules) py_test and py_binary targets no longer incorrectly remove the
    first sys.path entry when using {obj}--bootstrap_impl=script

{#v1-0-0-added}

Added
  • (gazelle): Parser failures will now be logged to the terminal. Additional
    details can be logged by setting RULES_PYTHON_GAZELLE_VERBOSE=1.
  • (toolchains) allow users to select which variant of the support host toolchain
    they would like to use through
    RULES_PYTHON_REPO_TOOLCHAIN_{VERSION}_{OS}_{ARCH} env variable setting. For
    example, this allows one to use freethreaded python interpreter in the
    repository_rule to build a wheel from sdist.
  • (toolchain) The python interpreters targeting muslc libc have been added
    for the latest toolchain versions for each minor Python version. You can control
    the toolchain selection by using the
    {bzl:obj}//python/config_settings:py_linux_libc build flag.
  • (providers) Added {obj}py_runtime_info.site_init_template and
    {obj}PyRuntimeInfo.site_init_template for specifying the template to use to
    initialize the interpreter via venv startup hooks.
  • (runfiles) (Bazel 7.4+) Added support for spaces and newlines in runfiles paths

{#v1-0-0-removed}

Removed
  • (pypi): Remove pypi_install_dependencies macro that has been included in
    {bzl:obj}py_repositories for a long time.
  • (bzlmod): Remove DEFAULT_PYTHON_VERSION from interpreters.bzl file. If
    you need the version, please use it from the versions.bzl file instead.

{#v0-40-0}

v0.40.0

Compare Source

{#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.txt for the twine dependencies.
    Please use requirements_linux.txt instead.
  • (python_repository) Use bazel's built in zstd support and remove attributes
    for customizing the zstd binary to be used for zstd archives in the
    {bzl:obj}python_repository repository_rule. This affects the
    {bzl:obj}python_register_toolchains and
    {bzl:obj}python_register_multi_toolchains callers in the WORKSPACE.

{#v0-39-0}

v0.39.0

Compare Source

{#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 bzlmod spoke repositories have changed as
    all of the given requirements.txt files are now parsed by default, 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_toolchain is 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_freethreaded to toggle the
    selection of the free-threaded toolchains.
  • (toolchain) {obj}py_runtime.abi_flags attribute and
    {obj}PyRuntimeInfo.abi_flags field added.

{#v0-39-0-removed}

Removed
  • Support for Bazel 6 using bzlmod has been dropped.

{#v0-38-0}

v0.38.0

Compare Source

{#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 twine publishing rule.
  • (whl_library) Remove --no-build-isolation to 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 in
    pip.parse#extra_pip_args
  • (pip.parse) {attr}pip.parse.whl_modifications now normalizes the given whl names
    and now pyyaml and PyYAML will both work.
  • (bzlmod) pip.parse spoke 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 the hub
    repository directly and make use of {bzl:obj}pip.parse.extra_hub_aliases
    feature 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_url is set, we need to still
    pass the extra_pip_args value when building an sdist.
  • (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_url is set by any module
    or not. To opt into this behavior, set
    pip.parse.parse_all_requirements_files, which will become the
    default in future releases leading up to 1.0.0. Fixes
    #​2268. A known
    issue is that it may break bazel query and in these use cases it is
    advisable to use cquery or switch to download_only = True

{#v0-38-0-added}

Added
  • (publish) The requirements file for the twine publishing rules have been
    updated to have a new convention: requirements_darwin.txt,
    requirements_linux.txt, requirements_windows.txt for each respective OS
    and one extra file requirements_universal.txt if you prefer a single file.
    The requirements.txt file 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_aliases can now be used to expose extra
    targets created by annotations in whl repositories.
    Fixes #​2187.
  • (bzlmod) pip.parse now supports whl-only setup using
    download_only = True where users can specify multiple requirements files
    and use the pip backend 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}


  • If you want to rebase/retry this PR, check this box

View the repository job log

@github-actions github-actions bot added dependencies Pull requests that update a dependency file lang-python Python rules specific labels Dec 6, 2024
@michaelschuett-tomtom
Copy link

This PR would be awesome to get landed as it is stopping me from moving to the new rules_python. It looks like it is mostly working but possibly has an issue with some of the workspace rules.

@renovate renovate bot force-pushed the renovate/rules_python-1.x branch from e6952fb to 5d7c7fa Compare January 17, 2025 05:10
@michaelschuett-tomtom
Copy link

Just a note that I was actually able to do the upgrade without this being landed. I am not sure what changed but the initial error message was coming from this library and looked to be because of a difference with the rules_python module. I have lost the error messages at this point but just wanted to update.

@renovate renovate bot force-pushed the renovate/rules_python-1.x branch from 5d7c7fa to 79ce52f Compare February 27, 2025 11:27
@renovate renovate bot force-pushed the renovate/rules_python-1.x branch from 79ce52f to 8c37148 Compare March 27, 2025 21:55
@renovate renovate bot force-pushed the renovate/rules_python-1.x branch from 8c37148 to a9fb279 Compare May 5, 2025 18:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file lang-python Python rules specific
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant